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

向右看齐 2022-06-01 06:37 313阅读 0赞

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

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

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

**logback当前分成三个模块：**

**logback-core**

**logback- classic**

**logback-access**

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

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

**![20171205110625853][]**

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

![20171205110926985][]

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

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

**![20171205111940097][]**

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

**（1）主要看注释**

**\[html\]**  [view plain][]   [copy][view plain]

1.  **<****configuration****>**      
2.            
3.        
4.        
5.      **<****appender** name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"**>**      
6.          **<****encoder****>**      
7.              **<****pattern****>**%d %p (%file:%line\\)- %m%n**</****pattern****>**    
8.                
9.              **<****charset****>**UTF-8**</****charset****>**     
10.         **</****encoder****>**      
11.     **</****appender****>**      
12.       
13.       
14.       
15.     **<****appender** name="syslog"      
16.         class="ch.qos.logback.core.rolling.RollingFileAppender"**>**      
17.         **<****File****>**log/sys.log**</****File****>**      
18.           
19.           
20.         **<****rollingPolicy** class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"**>**      
21.               
22.               
23.             **<****fileNamePattern****>**log/sys.%d.%i.log**</****fileNamePattern****>**   
24.                
25.             **<****maxHistory****>**30**</****maxHistory****>**     
26.             **<****timeBasedFileNamingAndTriggeringPolicy**  class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"**>**      
27.                     
28.                 **<****maxFileSize****>**1KB**</****maxFileSize****>**      
29.             **</****timeBasedFileNamingAndTriggeringPolicy****>**      
30.         **</****rollingPolicy****>**      
31.         **<****encoder****>**      
32.               
33.             **<****pattern****>**      
34.                 %d %p (%file:%line\\)- %m%n    
35.             **</****pattern****>**      
36.               
37.             **<****charset****>**UTF-8**</****charset****>**      
38.         **</****encoder****>**      
39.     **</****appender****>**      
40.       
41.     **<****root** level="info"**>**      
42.         **<****appender-ref** ref="STDOUT" **/>**      
43.     **</****root****>**      
44.       
45.       
46.       
47.     **<****logger** name="com.appleyk" level="DEBUG"**>**      
48.         **<****appender-ref** ref="syslog" **/>**      
49.     **</****logger****>**      
50. **</****configuration****>**

**（2）application.properties中初始化logback-boot.xml**

**\[plain\]**  [view plain][]   [copy][view plain]

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

**![20171205112947557][]**

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

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

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

（1）GlobalExceptionHandler.java

**\[java\]**  [view plain][]   [copy][view plain]

1.  **package** com.appleyk.exception;  
2.    
3.  **import** javax.servlet.http.HttpServletRequest;  
4.  **import** javax.servlet.http.HttpServletResponse;  
5.    
6.  **import** org.slf4j.Logger;  
7.  **import** org.slf4j.LoggerFactory;  
8.  **import** org.springframework.web.bind.MissingServletRequestParameterException;  
9.  **import** org.springframework.web.bind.annotation.CrossOrigin;  
10. **import** org.springframework.web.bind.annotation.ExceptionHandler;  
11. **import** org.springframework.web.bind.annotation.RestControllerAdvice;  
12.   
13. **import** com.appleyk.result.ResponseResult;  
14.   
15. @CrossOrigin  
16. @RestControllerAdvice  
17. **public** **class** GlobalExceptionHandler \{  
18.   
19.      **private** **static** Logger LOGGER = LoggerFactory.getLogger(GlobalExceptionHandler.**class**);  
20.       
21.     @ExceptionHandler  
22.     **public** ResponseResult processException(Exception ex, HttpServletRequest request, HttpServletResponse response)\{  
23.         ex.printStackTrace();  
24.           
25.         **if**(ex **instanceof** MissingServletRequestParameterException)\{  
26.             **return** **new** ResponseResult(400, ex);  
27.         \}  
28.         **if**(ex **instanceof** NoPermissions)\{  
29.                   
30.             LOGGER.error("======="\+ex.getMessage()+"=======");  
31.             **return** **new** ResponseResult(401, "sorry，无权限！");  
32.               
33.         \}  
34.           
35.         **return** **new** ResponseResult(500, ex.getMessage());  
36.           
37.     \}  
38.   
39. \}

（2）注意

![20171205113611873][]

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

![20171205113828154][]

（4）NoPermissions这个异常我们在哪里抛出呢？

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

**五、创建测试Controller**

(1)LogTestController.java

**\[java\]**  [view plain][]   [copy][view plain]

1.  **package** com.appleyk.controller;  
2.    
3.  **import** org.slf4j.Logger;  
4.  **import** org.slf4j.LoggerFactory;  
5.  **import** org.springframework.web.bind.annotation.RequestMapping;  
6.  **import** org.springframework.web.bind.annotation.RequestParam;  
7.  **import** org.springframework.web.bind.annotation.RestController;  
8.    
9.  **import** com.appleyk.exception.NoPermissions;  
10. **import** com.appleyk.result.ExceptionEnum;  
11. **import** com.appleyk.result.ResponseMessage;  
12. **import** com.appleyk.result.ResponseResult;  
13.   
14. @RestController  
15. **public** **class** LogTestController \{  
16.   
17.     **protected** **static** Logger logger=LoggerFactory.getLogger(HelloController.**class**);    
18.     @RequestMapping("/test")  
19.     **public** ResponseResult Test(@RequestParam(value="role") Integer role) **throws** Exception\{  
20.           
21.         logger.info("访问Controller");  
22.         **int** i = role;  
23.           
24.         **if**(i<0)\{  
25.             **throw** **new** NoPermissions(ExceptionEnum.WRONG\_PERMISSONS.toString());  
26.               
27.         \}  
28.         **else**\{  
29.            **return** **new** ResponseResult(ResponseMessage.OK);  
30.         \}  
31.           
32.           
33.     \}  
34.       
35. \}

![Image 1][]

（2）注意

![Image 1][]

![20171205114445386][]

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

![20171205114616072][]

**六、测试Controller，测试日志记录功能**

（1）测试前

![20171205114832174][]

（2）再看一下，logback-boot.xml中，配置的日志输出路径是什么

![20171205134902160][]

（3）启动Spring-boot项目

![20171205115212045][]

（4）浏览器中测试

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

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

![20171205120430928][]

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

![20171205120554130][]

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

![20171205120736595][]

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

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

![20171205131336054][]

5：注意

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

![20171205131817630][]

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

![20171205132107602][]

（5）Insomnia专业API测试工具测试

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

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

![20171205132615029][]

2.启动项目

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

![20171205132827016][]

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

![20171205132955846][]

4.观察下日志

![20171205133145791][]

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

![20171205133301603][]

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

![20171205133437440][]

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

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

![20171205133555943][]

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

![20171205133737953][]

![20171205134235287][]

演示完，记得把系统日期改过来，![偷笑][titter.gif]

[log4j]: http://baike.sogou.com/lemma/ShowInnerLink.htm?lemmaId=25530
[20171205110625853]: /images/20220601/96a285cc17f44129a8c1b09e95dad769.png
[20171205110926985]: /images/20220601/8ab3d4d787d7485f949d12d58043a847.png
[20171205111940097]: /images/20220601/1d47215cb5a140159c285f2a8d042fbc.png
[view plain]: http://blog.csdn.net/appleyk/article/details/78717388#
[20171205112947557]: /images/20220601/5c185ec06a6f4ea294754fdf872b21c4.png
[20171205113611873]: /images/20220601/24e984f466944e60bf4982ef13dd9ecd.png
[20171205113828154]: /images/20220601/2fc3301015e345939a601d5ded646e53.png
[Image 1]: 
[20171205114445386]: /images/20220601/c697b881dec5436d9a82beed63272d62.png
[20171205114616072]: /images/20220601/ea5c6f7167044d498bbd24bccd7bd23e.png
[20171205114832174]: /images/20220601/28bca71c3aa546cd867bae2d4e4b2d13.png
[20171205134902160]: /images/20220601/fa13310e4007445c8e86374bb4108a46.png
[20171205115212045]: /images/20220601/5e1ca465ecd0453c9e150feb6eec8ece.png
[20171205120430928]: /images/20220601/e8e6eca3c6b943f0b000e17459333dc1.png
[20171205120554130]: /images/20220601/6a0d7d8e188f4a30bed2801b3059297e.png
[20171205120736595]: /images/20220601/78181865221f4aed8438fab54b4fb514.png
[20171205131336054]: /images/20220601/a685359aa6f9414cb74e63e09c41db89.png
[20171205131817630]: /images/20220601/d007dbbb5b0f41478c3a4d08dd7b2588.png
[20171205132107602]: /images/20220601/1c02cdabe76046a280129f0732f248d9.png
[20171205132615029]: /images/20220601/9370e6a2089f4efaa798e44f2f8fcd2f.png
[20171205132827016]: /images/20220601/3c29fda5df3c49cab0b774066d567d77.png
[20171205132955846]: /images/20220601/beb4823e97574750a038883940b07c6d.png
[20171205133145791]: /images/20220601/4da4f8adc66f4c7985b068ce5d47c982.png
[20171205133301603]: /images/20220601/58255c0b56fe4a76816da9a2062d407e.png
[20171205133437440]: /images/20220601/13f4547b23bd41c28f0791f3063fb381.png
[20171205133555943]: /images/20220601/c63a7c25bcee4cd998e6a56c44144d64.png
[20171205133737953]: /images/20220601/07e4b74c7df34224a90a72df6e090227.png
[20171205134235287]: /images/20220601/7e0b5fb63cf44498ae8664177d935cab.png
[titter.gif]: /images/20220601/29846f3bf5344b1f92c2fa86245c7392.png