https://blog.csdn.net/liuweixiao520/article/details/78900779

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

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

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

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

logback当前分成三个模块:

logback-core

logback- classic

logback-access

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

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

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

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

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

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

(1)主要看注释

[html] view plain copy

  1. <configuration>
  2. <!-- %m输出的信息,%p日志级别,%t线程名,%d日期,%c类的全名,%i索引【从数字0开始递增】,,, -->
  3. <!-- appender是configuration的子节点,是负责写日志的组件。 -->
  4. <!-- ConsoleAppender:把日志输出到控制台 -->
  5. <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
  6. <encoder>
  7. <pattern>%d %p (%file:%line\)- %m%n</pattern>
  8. <!-- 控制台也要使用UTF-8,不要使用GBK,否则会中文乱码 -->
  9. <charset>UTF-8</charset>
  10. </encoder>
  11. </appender>
  12. <!-- RollingFileAppender:滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件 -->
  13. <!-- 以下的大概意思是:1.先按日期存日志,日期变了,将前一天的日志文件名重命名为XXX%日期%索引,新的日志仍然是sys.log -->
  14. <!--             2.如果日期没有发生变化,但是当前日志的文件大小超过1KB时,对当前日志进行分割 重命名-->
  15. <appender name="syslog"
  16. class="ch.qos.logback.core.rolling.RollingFileAppender">
  17. <File>log/sys.log</File>
  18. <!-- rollingPolicy:当发生滚动时,决定 RollingFileAppender 的行为,涉及文件移动和重命名。 -->
  19. <!-- TimeBasedRollingPolicy: 最常用的滚动策略,它根据时间来制定滚动策略,既负责滚动也负责出发滚动 -->
  20. <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  21. <!-- 活动文件的名字会根据fileNamePattern的值,每隔一段时间改变一次 -->
  22. <!-- 文件名:log/sys.2017-12-05.0.log -->
  23. <fileNamePattern>log/sys.%d.%i.log</fileNamePattern>
  24. <!-- 每产生一个日志文件,该日志文件的保存期限为30天 -->
  25. <maxHistory>30</maxHistory>
  26. <timeBasedFileNamingAndTriggeringPolicy  class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
  27. <!-- maxFileSize:这是活动文件的大小,默认值是10MB,本篇设置为1KB,只是为了演示 -->
  28. <maxFileSize>1KB</maxFileSize>
  29. </timeBasedFileNamingAndTriggeringPolicy>
  30. </rollingPolicy>
  31. <encoder>
  32. <!-- pattern节点,用来设置日志的输入格式 -->
  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. <!-- com.appley为根包,也就是只要是发生在这个根包下面的所有日志操作行为的权限都是DEBUG -->
  46. <!-- 级别依次为【从高到低】:FATAL > ERROR > WARN > INFO > DEBUG > TRACE  -->
  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

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

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

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

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

(1)GlobalExceptionHandler.java

[java] view plain copy

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

(2)注意

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

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

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

五、创建测试Controller

(1)LogTestController.java

[java] view plain copy

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

(2)注意

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

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

(1)测试前

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

(3)启动Spring-boot项目

(4)浏览器中测试

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

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

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

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

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

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

5:注意

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

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

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

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

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

2.启动项目

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

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

4.观察下日志

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

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

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

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

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

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

spring boot slf4j日记记录配置详解相关推荐

  1. Spring Boot 2.0 的配置详解(图文教程)

    本文来自作者 泥瓦匠 @ bysocket.com 在 GitChat 上分享 「Spring Boot 2.0 的配置详解(图文教程)」 编辑 | 哈比 Spring Boot 配置,包括自动配置和 ...

  2. Spring Boot 使用 Druid 连接池详解

    Spring Boot 使用 Druid 连接池详解 Alibaba Druid 是一个 JDBC 组件库,包含数据库连接池.SQL Parser 等组件,被大量业务和技术产品使用或集成,经历过严苛的 ...

  3. spring boot模板引擎thymleaf用法详解

    spring boot模板引擎thymleaf用法详解 Spring-boot支持FreeMarker.Thymeleaf.jsp.veocity 但是对freemarker和thymeleaf的支持 ...

  4. Spring Boot的每个模块包详解

    Spring Boot的每个模块包详解,具体如下: 1.spring-boot-starter 这是Spring Boot的核心启动器,包含了自动配置.日志和YAML. 2.spring-boot-s ...

  5. java图片填充父容器_java相关:spring的父子容器及配置详解

    java相关:spring的父子容器及配置详解 发布于 2020-5-26| 复制链接 本篇文章主要介绍了spring的父子容器及配置详解,详细的介绍了spring父子容器的概念.使用场景和用法,有兴 ...

  6. spring boot(四):thymeleaf使用详解

    spring boot(四):thymeleaf使用详解 在上篇文章springboot(二):web综合开发中简单介绍了一下thymeleaf,这篇文章将更加全面详细的介绍thymeleaf的使用. ...

  7. java logback策略输出无效,如何修改覆盖spring boot默认日志策略logback详解

    背景 Spring Boot在所有内部日志中使用Commons Logging,但是默认配置也提供了对常用日志的支持,如:Java Util Logging,Log4J, Log4J2和Logback ...

  8. 精通Spring Boot——第三篇:详解WebMvcConfigurer接口

    2019独角兽企业重金招聘Python工程师标准>>> SpringBoot 确实为我们做了很多事情, 但有时候我们想要自己定义一些Handler,Interceptor,ViewR ...

  9. spring boot 源码解析43-JmxMetricWriter详解

    前言 本文我们来介绍JmxMetricWriter, JmxMetricWriter是依赖于spring jmx 来实现的. 因此本文的开头先介绍一下spring boot 与jmx的集成,然后分析J ...

最新文章

  1. Go 分布式学习利器(9)-- Go语言 结构体的行为定义和实现
  2. MVC - 17.OA项目
  3. 软件实施或技术支持技能必备提炼
  4. HTTP basic auth
  5. 优良中差五个等级英文表达_谈谈英文医学论文的文体特征和翻译技巧
  6. 地铁关门提示音,可使用倒计时
  7. Atitit 知识聚合的方法大总结 目录 1. 什么是聚合 汇聚 1 2. 聚合化应用场景 2 2.1. 一站式 2 3. 知识聚合的历史与趋势
  8. 漏洞复现|Microsoft Office数学公式编辑器内存损坏漏洞(CVE-2017-11882 )
  9. 金戈铁马 Android NDK 实战篇:男人之间的那些事
  10. [AHK]按文件的年份归档到不同年份目录里
  11. 删除launchpad中无法正常移除的图标
  12. 微信加密某一个人私聊?微信私密聊天
  13. 摄像头P2P软件提供,完美解决打洞及音视频、用户码传输问题。
  14. 25岁,我明白了这些道理
  15. python中base64 decode_python2解码base64中文乱码怎么解决?
  16. NodeJS的模块机制
  17. 小米手机刷机和Xposed安装流程
  18. 博途(TIA)软件安装教程;博途软件安装常见问题解决办法
  19. Unity动画暂停的方法
  20. Python数据采集与处理之网页爬取

热门文章

  1. 第 4 章 Glance - 022 - 如何使用 OpenStack CLI
  2. .NET (C#) Internals: ASP.NET 应用程序与页面生命周期——吴秦(Tyler)
  3. 测试1111111111111111111
  4. linux基础-延时命令:sleep
  5. 数据库查询的数据导出到xls表,集合数据导出到xls表
  6. “习惯测试”三步法,打造完美用户体验
  7. 关于web.config中customErrors
  8. Linux下tomcat安装及优化
  9. 听研二师兄师姐报告收获
  10. linux Makefile中 make -C和M=的作用