Spring Boot从入门到精通(八)日志管理实现和配置信息分析

Stella981
• 阅读 332

点击上方蓝色“Java精选”,选择“设为星标”

技术文章第一时间送达!

Spring Boot从入门到精通(八)日志管理实现和配置信息分析

Spring Boot对日志的处理,与平时我们处理日志的方式完全一致,它为Java Util Logging、Log4J2和Logback提供了默认配置。对于每种日志都预先配置使用控制台输出和可选的文件输出功能。

Spring Boot从入门到精通(八)日志管理实现和配置信息分析

如果使用Spring Boot Starters,那么默认使用的日志框架是Logback。Spring Boot底层对Java Util Logging、Commons Logging、Log4J及SLF4J日志框架也进行了适配,只需相关配置就可以实现日志框架的相互切换。

为了便捷,采用“**Spring Boot从入门到精通(七)集成Redis实现Session共享**”一章节使用的工程,【此章节来源自“Java精选”微信公众号,切换至后台->聚合->开源项目,分享了很多中间件比如Sring Boot系列文章从入门到精通等】,讲述一下Spring Boot中如何实现日志管理和相关配置信息的分析。

自定义日志配置

通过将相应的库添加到classpath可以激活各种日志系统,然后在classpath根目录下提供合适的配置文件可以进一步定制日志系统,配置文件也可以通过Spring Environment的logging.config属性指定。

根据不同的日志系统,可以按如下规则组织配置文件名,就能被正确加载:

Spring Boot从入门到精通(八)日志管理实现和配置信息分析

Spring Boot官方推荐优先使用带有-spring的文件名作为定义的日志配置(使用logback-spring.xml而不是logback.xml名称),若命名为logback-spring.xml的日志配置文件,Spring Boot可以为它添加一些Spring Boot特有的配置项;建议尽可能不使用Java Util Logging方式,因为Java Util Logging从可执行jar运行时会导致一些已知的类加载问题。

Spring Envrionment转换为System properties,一些有助于定制的配置属性和含义,参考如下所示:

Spring Boot从入门到精通(八)日志管理实现和配置信息分析

注:日志系统在解析配置文件时所有支持获取系统属性的值,具体参考spring-boot.jar中的默认配置。

Logging格式说明

Spring Boot 默认日志输出如下:

    2020-03-13 13:48:20.836  INFO 9632 --- [           main] trationDelegate$BeanPostProcessorChecker : Bean 'bootUserMapper' of type [org.mybatis.spring.mapper.MapperFactoryBean] is not eligible for getting processed by all BeanPostProcessors (for example: not eligible for auto-proxying)2020-03-13 13:48:20.868  INFO 9632 --- [           main] trationDelegate$BeanPostProcessorChecker : Bean 'org.springframework.transaction.annotation.ProxyTransactionManagementConfiguration' of type [org.springframework.transaction.annotation.ProxyTransactionManagementConfiguration] is not eligible for getting processed by all BeanPostProcessors (for example: not eligible for auto-proxying)2020-03-13 13:48:21.173  INFO 9632 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat initialized with port(s): 9090 (http)
    

   
   
   

上述输出的日志信息,从左往右含义解释如下:

日期时间:精确到毫秒

日志级别:ERROR,WARN,INFO,DEBUG or TRACE

进程:id

分割符:用于区分实际的日志记录

线程名:括在方括号中

日志名字:通常是源类名

日志信息说明

日志信息输出

首先,在Maven项目中pom.xml文件增加logging包引用,具体配置内容如下:

    <dependency>    <groupId>org.springframework.boot</groupId>    <artifactId>spring-boot-starter-logging</artifactId></dependency>
    

   
   
   

方式一:在控制台输出日志

日志级别从低到高依次:

TRACE < DEBUG < INFO< WARN < ERROR < FATAL

Logback 日志不提供FATAL级别,它被映射到ERROR级别。

Spring Boot只会输出比当前级别高的日志,默认的日志级别是INFO,因此低于INFO级别的日志记录都不输出。 默认级别(INFO),执行代码如下:

    package com.yoodb.study.demo04;import org.junit.Test;import org.slf4j.Logger;import org.slf4j.LoggerFactory;import org.springframework.boot.test.context.SpringBootTest;@SpringBootTestpublic class LoggerTest {    private static final Logger logger = LoggerFactory.getLogger(LoggerTest.class);    @Test    public void test() {        logger.trace("trace 级别的日志");        logger.debug("debug 级别的日志");        logger.info("info 级别的日志");        logger.warn("warn 级别的日志");        logger.error("error 级别的日志");    }}
    

   
   
   

控制台输出结果如下:

    Connected to the target VM, address: '127.0.0.1:55595', transport: 'socket'14:05:13.957 [main] DEBUG com.yoodb.study.demo04.LoggerTest - debug 级别的日志14:05:13.962 [main] INFO com.yoodb.study.demo04.LoggerTest - info 级别的日志14:05:13.962 [main] WARN com.yoodb.study.demo04.LoggerTest - warn 级别的日志14:05:13.962 [main] ERROR com.yoodb.study.demo04.LoggerTest - error 级别的日志Disconnected from the target VM, address: '127.0.0.1:55595', transport: 'socket'Process finished with exit code 0
    

   
   
   

Spring Boot中默认配置ERROR、WARN和INFO级别的日志输出到控制台。您还可以通过启动您的应用程序—debug标志来启用“调试”模式(开发时推荐开启),以下两种方式皆可:

1)在运行命令后加入–debug标志,例如:

$ java -jar springTest.jar --debug

2)在application.properties中配置debug=true,该属性置为true的时候,核心Logger(包含嵌入式容器、hibernate、spring)会输出更多内容,但是你自己应用的日志并不会输出为DEBUG级别。

方式二:以文件的形式输出日志

默认情况下,Spring Boot将日志输出到控制台,不会写到日志文件。如果要编写除控制台输出之外的日志文件,则需在application.properties中设置logging.file.name或logging.file.path属性。

1)logging.file.name,设置文件,可以是绝对路径,也可以是相对路径。例如:

logging.file.name=info.log

2)logging.file.path,设置目录,会在该目录下创建spring.log文件,并写入日志内容,例如:

logging.file.path=/workspace/log

如果只配置logging.file.name,会在项目的当前路径下生成一个xxx.log日志文件。如果只配置logging.file.path,在/workspace/log文件夹生成一个为spring.log日志文件。

注:二者不能同时使用,如若同时使用,则只有logging.file.name生效。默认情况下,日志文件的大小达到10MB时会切分一次,产生新的日志文件,默认级别为:ERROR、WARN、INFO。

所有支持的日志记录系统都可以在Spring环境中设置记录级别,格式为: “logging.level.* = LEVEL ” 。

logging.level属性:

日志级别控制前缀,*为包名或Logger名。

LEVEL参数:

选项包括TRACE、DEBUG、INFO、WARN、ERROR、FATAL、OFF。

1、虽然Spring Boot中application.properties配置文件提供了日志的配置,但是个人更倾向于logback.xml的配置方式。

在src/main/resources目录中增加logback-spring.xml日志文件,文件内容如下(配置相对简单,个人请根据工程情况,进行相应的配置):

    <?xml version="1.0" encoding="UTF-8"?><configuration scan="true" scanPeriod="10 seconds">    <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">        <File>${LOG_PATH}/info.log</File>        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">            <fileNamePattern>${LOG_PATH}/info-%d{yyyyMMdd}.log.%i            </fileNamePattern>            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">                <maxFileSize>500MB</maxFileSize>            </timeBasedFileNamingAndTriggeringPolicy>            <maxHistory>2</maxHistory>        </rollingPolicy>        <layout class="ch.qos.logback.classic.PatternLayout">            <Pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} -%msg%n            </Pattern>        </layout>    </appender>    <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">            <level>ERROR</level>        </filter>        <File>${LOG_PATH}/error.log</File>        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">            <fileNamePattern>${LOG_PATH}/error-%d{yyyyMMdd}.log.%i            </fileNamePattern>            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">                <maxFileSize>500MB</maxFileSize>            </timeBasedFileNamingAndTriggeringPolicy>            <maxHistory>2</maxHistory>        </rollingPolicy>        <layout class="ch.qos.logback.classic.PatternLayout">            <Pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} -%msg%n            </Pattern>        </layout>    </appender>    <!--输出到控制台 ConsoleAppender-->    <appender name="CONSOLE_APPENDER" class="ch.qos.logback.core.ConsoleAppender">        <!--展示格式 layout-->        <layout class="ch.qos.logback.classic.PatternLayout">            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} -%msg%n</pattern>        </layout>    </appender>    <root level="INFO">        <appender-ref ref="INFO_FILE" />        <appender-ref ref="ERROR_FILE" />        <appender-ref ref="CONSOLE_APPENDER" />    </root></configuration>
    

   
   
   

注:1)控制台和日志文件的字符集;2)日志文件的存放位置,须要遵守Linux的命名规则。

根节点包含的属性

scan:当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。

scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。

debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。

1)子节点

root节点是必选节点,用来指定最基础的日志输出级别,只有一个level属性。

level: 用来设置打印级别,大小写无关,其值包含如下:

TRACE、DEBUG、INFO、WARN、ERROR、ALL和OFF

level不能设置为INHERITED或者同义词NULL, 默认是DEBUG。

root节点中可以包含零个或多个元素,标识这个appender将会添加到这个loger。

    <root level="INFO">    <appender-ref ref="INFO_FILE" />    <appender-ref ref="ERROR_FILE" />    <appender-ref ref="CONSOLE_APPENDER" /></root>
    

   
   
   

2)子节点设置上下文名称

每个logger都关联到logger上下文,默认上下文名称为“default”。但可以使用设置成其他名字,用于区分不同应用程序的记录。

设置后不能修改,通过%contextName设置来打印日志上下文名称,一般来说不用这个属性。

3)子节点

appender用来格式化日志输出节点,有两个属性name和class,class用来指定哪种输出策略,常用就是控制台输出策略和文件输出策略。

控制台输出使用ConsoleAppender类文件,具体参考配置如下:

    <appender name="CONSOLE_APPENDER" class="ch.qos.logback.core.ConsoleAppender">    <!--展示格式 layout-->    <layout class="ch.qos.logback.classic.PatternLayout">        <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} -%msg%n</pattern>    </layout></appender>
    

   
   
   

2、在application.properties中指定logback-spring.xml文件和日志生成的路径 ,配置内容如下:

    #com.yoodb.study.demo04包下所有class以DEBUG级别输出logging.level.com.yoodb.study=DEBUG#用来指定自己创建的日志文件logging.config=classpath:logback-spring.xml#指定输出文件位置logging.file.path=D://workspace/log
    

   
   
   

3、新建HelloWorldController类文件 ,具体内容如下:

    package com.yoodb.study.demo04;import org.slf4j.Logger;import org.slf4j.LoggerFactory;  import org.springframework.web.bind.annotation.PathVariable;  import org.springframework.web.bind.annotation.RequestMapping;  import org.springframework.web.bind.annotation.RestController;     @RestController  public class HelloWorldController {         protected static Logger logger=LoggerFactory.getLogger(HelloWorldController.class);             @RequestMapping("/")      public String helloworld(){          logger.debug("关注微信公众号“Java精选”,Spring Boot系列文章持续更新中,带你从入门到精通,玩转Spring Boot框架。");          return "Hello world!";      }             @RequestMapping("/hello/{name}")      public String helloName(@PathVariable String name){          logger.debug("访问 helloName,Name={}",name);          return "Hello "+name;      }  }
    

   
   
   

注:在添加引用时,日志的包一定是org.slf4j.Logger、org.slf4j.LoggerFactory类。

4、启动项目后,进行测试

1)运行主程序

2)在浏览器中依次输入

http://localhost:8080/

http://localhost:8080/hello/yoodb

3)由于我的工程在D盘所有log日志文件所在的目录找到D:/workspace/log文件夹下,日志文件的名称是在配置文件logback-spring.xml中设置。

控制台输出日志:

    2020-03-13 16:00:26.793 [http-nio-9090-exec-1] INFO  o.a.c.c.C.[Tomcat].[localhost].[/] -Initializing Spring DispatcherServlet 'dispatcherServlet'2020-03-13 16:00:26.794 [http-nio-9090-exec-1] INFO  o.s.web.servlet.DispatcherServlet -Initializing Servlet 'dispatcherServlet'2020-03-13 16:00:26.803 [http-nio-9090-exec-1] INFO  o.s.web.servlet.DispatcherServlet -Completed initialization in 9 ms2020-03-13 16:00:26.842 [http-nio-9090-exec-1] DEBUG c.y.s.demo04.HelloWorldController -访问 helloName,Name=yoodb2020-03-13 16:03:10.953 [http-nio-9090-exec-4] DEBUG c.y.s.demo04.HelloWorldController -关注微信公众号“Java精选”,Spring Boot系列文章持续更新中,带你从入门到精通,玩转Spring Boot框架。
    

   
   
   

日志文件内容如下图所示:

Spring Boot从入门到精通(八)日志管理实现和配置信息分析

本文“Spring Boot从入门到精通(八)日志管理实现和配置信息分析”文章的项目源码(springboot-study-demo04)地址:

https://github.com/yoodb/springboot

到此,关于Spring boot日志管理实现和相关配置信息的分析就讲完了,下面大家不妨试一试,但要注意使用的时候配置信息要求,有什么疑问欢迎下方留言,小编看到后立马回复!

关注我,回复“ Java ”免费领取视频教程和资料

回复“加群”加入专业技术讨论群^^

往期精选

Spring Boot从入门到精通(一)搭建第一个Spring Boot程序

Spring Boot从入门到精通(二)配置GitHub并上传Maven项目

Spring Boot从入门到精通(三)常用注解含义及用法分析总结

Spring Boot从入门到精通(四)连接MySQL数据库(附源码)

Spring Boot从入门到精通(五)多数据源配置实现及源码分析

Spring Boot从入门到精通(六)集成Redis实现缓存机制

Spring Boot从入门到精通(七)集成Redis实现Session共享

搞不定MyBatis面试,速看全面MyBatis面试题及答案整理总结

搞不定Redis面试,速看全面Redis面试题及答案整理总结

搞不定Zookeeper面试,速看全面Zookeeper面试题及答案整理总结

Spring Boot从入门到精通(八)日志管理实现和配置信息分析

我就知道你“在看”!

本文分享自微信公众号 - Java精选(w_z90110)。
如有侵权,请联系 support@oschina.cn 删除。
本文参与“OSC源创计划”,欢迎正在阅读的你也加入,一起分享。

点赞
收藏
评论区
推荐文章
浅梦一笑 浅梦一笑
2个月前
初学 Python 需要安装哪些软件?超级实用,小白必看!
编程这个东西是真的奇妙。对于懂得的人来说,会觉得这个工具是多么的好用、有趣,而对于小白来说,就如同大山一样。其实这个都可以理解,大家都是这样过来的。那么接下来就说一下python相关的东西吧,并说一下我对编程的理解。本人也是小白一名,如有不对的地方,还请各位大神指出01名词解释:如果在编程方面接触的比较少,那么对于软件这一块,有几个名词一定要了解,比如开发环
刚刚好 刚刚好
2个月前
css问题
1、在IOS中图片不显示(给图片加了圆角或者img没有父级)<div<imgsrc""/</divdiv{width:20px;height:20px;borderradius:20px;overflow:h
blmius blmius
1年前
MySQL:[Err] 1292 - Incorrect datetime value: ‘0000-00-00 00:00:00‘ for column ‘CREATE_TIME‘ at row 1
文章目录问题用navicat导入数据时,报错:原因这是因为当前的MySQL不支持datetime为0的情况。解决修改sql\mode:sql\mode:SQLMode定义了MySQL应支持的SQL语法、数据校验等,这样可以更容易地在不同的环境中使用MySQL。全局s
小森森 小森森
2个月前
校园表白墙微信小程序V1.0 SayLove -基于微信云开发-一键快速搭建,开箱即用
后续会继续更新,敬请期待2.0全新版本欢迎添加左边的微信一起探讨!项目地址:(https://www.aliyun.com/activity/daily/bestoffer?userCodesskuuw5n)\2.Bug修复更新日历2.情侣脸功能大家不要使用了,现在阿里云的接口已经要收费了(土豪请随意),\\和注意
晴空闲云 晴空闲云
2个月前
css中box-sizing解放盒子实际宽高计算
我们知道传统的盒子模型,如果增加内边距padding和边框border,那么会撑大整个盒子,造成盒子的宽度不好计算,在实务中特别不方便。boxsizing可以设置盒模型的方式,可以很好的设置固定宽高的盒模型。盒子宽高计算假如我们设置如下盒子:宽度和高度均为200px,那么这会这个盒子实际的宽高就都是200px。但是当我们设置这个盒子的边框和内间距的时候,那
艾木酱 艾木酱
1个月前
快速入门|使用MemFire Cloud构建React Native应用程序
MemFireCloud是一款提供云数据库,用户可以创建云数据库,并对数据库进行管理,还可以对数据库进行备份操作。它还提供后端即服务,用户可以在1分钟内新建一个应用,使用自动生成的API和SDK,访问云数据库、对象存储、用户认证与授权等功能,可专
Stella981 Stella981
1年前
Spring Boot日志集成
!(https://oscimg.oschina.net/oscnet/1bde8e8d00e848be8b84e9d1d44c9e5c.jpg)SpringBoot日志框架SpringBoot支持JavaUtilLogging,Log4j2,Lockback作为日志框架,如果你使用star
Wesley13 Wesley13
1年前
MySQL查询按照指定规则排序
1.按照指定(单个)字段排序selectfromtable_nameorderiddesc;2.按照指定(多个)字段排序selectfromtable_nameorderiddesc,statusdesc;3.按照指定字段和规则排序selec
Stella981 Stella981
1年前
Docker 部署SpringBoot项目不香吗?
  公众号改版后文章乱序推荐,希望你可以点击上方“Java进阶架构师”,点击右上角,将我们设为★“星标”!这样才不会错过每日进阶架构文章呀。  !(http://dingyue.ws.126.net/2020/0920/b00fbfc7j00qgy5xy002kd200qo00hsg00it00cj.jpg)  2
helloworld_28799839 helloworld_28799839
2个月前
常用知识整理
Javascript判断对象是否为空jsObject.keys(myObject).length0经常使用的三元运算我们经常遇到处理表格列状态字段如status的时候可以用到vue