Spring-Boot--日志操作【全局异常捕获消息处理☞日志控制台输出+日志文件记录】

       最好的演示说明,不是上来就贴配置文件和代码,而是,先来一波配置文件的注释,再来一波代码的测试过程,最后再出个技术在项目中的应用效果,这样的循序渐进的方式,才会让读者更加清楚的理解一项技术是如何运用在项目中的,虽然本篇很简单,几乎不用手写什么代码,但是,比起网上其他人写的同类型的文章来说,我只能说,我很认真,认真的有点帅,哈哈哈哈。




一、日志记录相关依赖,首选Spring-Boot"原生态"的logback


Logback是由 log4j创始人设计的又一个开源日志组件


logback当前分成三个模块:


logback-core

logback- classic

logback-access


logback-core是其它两个模块的基础模块


如果在你的pom.xml中,依赖了如下内容


Spring-Boot--日志操作【全局异常捕获消息处理☞日志控制台输出+日志文件记录】_第1张图片


恭喜你,本篇你可以不用再添加日志组件的依赖了,为什么呢,我们看下spring-boot-starter-web的依赖树


Spring-Boot--日志操作【全局异常捕获消息处理☞日志控制台输出+日志文件记录】_第2张图片



二、当前Spring-Boot项目的目录结构


说明:如果只是为了贴代码,而不结合项目演示的话,我写本篇的初衷也就没什么意义了


Spring-Boot--日志操作【全局异常捕获消息处理☞日志控制台输出+日志文件记录】_第3张图片


三、本篇重点,logback-boot.xml内容解说

(1)主要看注释

    
        
    
    
        
            
            %d %p (%file:%line\)- %m%n  
            
            UTF-8   
            
        
    
    
    
        
        log/sys.log    
        
        
            
            
            
            log/sys.%d.%i.log 
             
            30   
                
                  
                1KB    
                
            
            
            
                
                %d %p (%file:%line\)- %m%n  
                
            
            UTF-8    
            
        
    
        
            
        
    
    
    
        
            
        
  



(2)application.properties中初始化logback-boot.xml




#在application.properties文件中引入日志配置文件
#=====================================  log  =============================
logging.config=classpath:logback-boot.xml


Spring-Boot--日志操作【全局异常捕获消息处理☞日志控制台输出+日志文件记录】_第4张图片


logback日志的配置我们已经弄完了,接下来就是演示了



四、定义全局异常捕获类【含异常消息的日志辅助记录】


主要看内容,内容看懂了,就知道logback日志记录在什么时候发挥作用了


(1)GlobalExceptionHandler.java


package com.appleyk.exception;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.dao.DuplicateKeyException;
import org.springframework.web.bind.MissingServletRequestParameterException;
import org.springframework.web.bind.annotation.CrossOrigin;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

import com.appleyk.result.ResponseResult;

@CrossOrigin
@RestControllerAdvice
public class GlobalExceptionHandler {

	private static Logger LOGGER = LoggerFactory.getLogger(GlobalExceptionHandler.class);

	@ExceptionHandler
	public ResponseResult processException(Exception ex, HttpServletRequest request, HttpServletResponse response) {

		if (ex instanceof MissingServletRequestParameterException) {
			return new ResponseResult(400, ex);
		}
		if (ex instanceof NoPermissions) {

			LOGGER.error("=======" + ex.getMessage() + "=======");
			return new ResponseResult(401, "sorry,无权限!");

		}

		if (ex instanceof DuplicateKeyException) {
			LOGGER.error("=======违反主键约束:主键重复插入=======");
			return new ResponseResult(400, "主键重复插入!");
		}

		/**
		 * 未知异常
		 */
		LOGGER.error(ex.toString());
		return new ResponseResult(500, ex.getMessage());

	}

}

(2)注意


Spring-Boot--日志操作【全局异常捕获消息处理☞日志控制台输出+日志文件记录】_第5张图片



(3)我们看下这个自定义异常类NoPermissions长什么样


Spring-Boot--日志操作【全局异常捕获消息处理☞日志控制台输出+日志文件记录】_第6张图片


(4)NoPermissions这个异常我们在哪里抛出呢?


本篇,日志功能的测试是放在Controller中进行的,因此,这个自定义异常,也是放在Controller中抛出By手动




五、创建测试Controller


(1)LogTestController.java


package com.appleyk.controller;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import com.appleyk.exception.NoPermissions;
import com.appleyk.result.ExceptionEnum;
import com.appleyk.result.ResponseMessage;
import com.appleyk.result.ResponseResult;

@RestController
public class LogTestController {

	protected static Logger logger=LoggerFactory.getLogger(HelloController.class);  
	@RequestMapping("/test")
	public ResponseResult Test(@RequestParam(value="role") Integer role) throws Exception{
		
		logger.info("访问Controller");
		int i = role;
		
		if(i<0){
			throw new NoPermissions(ExceptionEnum.WRONG_PERMISSONS.toString());
			
		}
		else{
		   return new ResponseResult(ResponseMessage.OK);
		}
		
		
	}
	
}



(2)注意

Spring-Boot--日志操作【全局异常捕获消息处理☞日志控制台输出+日志文件记录】_第7张图片



(3)我们来看一下自定义异常枚举里面的消息


Spring-Boot--日志操作【全局异常捕获消息处理☞日志控制台输出+日志文件记录】_第8张图片




六、测试Controller,测试日志记录功能


(1)测试前


Spring-Boot--日志操作【全局异常捕获消息处理☞日志控制台输出+日志文件记录】_第9张图片


(2)再看一下,logback-boot.xml中,配置的日志输出路径是什么


Spring-Boot--日志操作【全局异常捕获消息处理☞日志控制台输出+日志文件记录】_第10张图片


(3)启动Spring-boot项目


Spring-Boot--日志操作【全局异常捕获消息处理☞日志控制台输出+日志文件记录】_第11张图片



(4)浏览器中测试


A. 先测试成功的: http://localhost:8080/test?role=100


1.浏览器返回数据json解析效果


Spring-Boot--日志操作【全局异常捕获消息处理☞日志控制台输出+日志文件记录】_第12张图片

2.控制台日志info级别的输出




3.文件日志info级别的写入


Spring-Boot--日志操作【全局异常捕获消息处理☞日志控制台输出+日志文件记录】_第13张图片


4.由于日志文件的大小在logback-boot.xml中配置了超过1KB就产生新的日志文件,命名规则见配置文件,因此


多次刷新浏览器,我们会发现如下:【注意,得多刷几十次,才能出来效果,因为1KB的内容还是不少的】


Spring-Boot--日志操作【全局异常捕获消息处理☞日志控制台输出+日志文件记录】_第14张图片



5:注意


A.控制台日志输出级别:INFO


Spring-Boot--日志操作【全局异常捕获消息处理☞日志控制台输出+日志文件记录】_第15张图片


B.日志记录到文件级别:DEBUG


Spring-Boot--日志操作【全局异常捕获消息处理☞日志控制台输出+日志文件记录】_第16张图片





(5)Insomnia专业API测试工具测试


B. 再测试异常的: http://localhost:8080/test?role=-1


1.为了演示最佳效果,先停掉当前项目,再清空log文件夹下面的所有日志


Spring-Boot--日志操作【全局异常捕获消息处理☞日志控制台输出+日志文件记录】_第17张图片


2.启动项目


日志记录文件立竿见影【牢记日志记录文件的级别是DEBUG】


Spring-Boot--日志操作【全局异常捕获消息处理☞日志控制台输出+日志文件记录】_第18张图片



3.测试API【显然role=-1的时候,对应的Controller抛出自定义异常】


Spring-Boot--日志操作【全局异常捕获消息处理☞日志控制台输出+日志文件记录】_第19张图片


4.观察下日志


Spring-Boot--日志操作【全局异常捕获消息处理☞日志控制台输出+日志文件记录】_第20张图片


按照级别,大于DEBUG的都会出现在日志记录文件里,所以,我们的ERROR出现了


Spring-Boot--日志操作【全局异常捕获消息处理☞日志控制台输出+日志文件记录】_第21张图片



5.多Send一下,观察日志文件变化


Spring-Boot--日志操作【全局异常捕获消息处理☞日志控制台输出+日志文件记录】_第22张图片


这个是今天的日志,假设我改下系统日期操作如下


6.本篇的创作时间是2017年12月5日13:37:35【周二】,改为2017年12月6日13:37:49【周三】




然后我们在多Send几次观察下日志文件的变化


Spring-Boot--日志操作【全局异常捕获消息处理☞日志控制台输出+日志文件记录】_第23张图片



Spring-Boot--日志操作【全局异常捕获消息处理☞日志控制台输出+日志文件记录】_第24张图片



演示完,记得把系统日期改过来,






你可能感兴趣的:(Spring-Boot)