Spring Boot (日志篇):集成默认日志logback

版权声明:本博客所有内容采用 知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议 进行许可 https://blog.csdn.net/Soinice/article/details/82424815

目录

说在前面

logback(Spring Boot 默认日志)

在pom.xml加入相关依赖

日志级别

控制台输出

lombok方式

日志文件输出

保存路径

级别控制

输出格式

自定义日志配置

根节点包含的属性

属性一: 设置上下文名称

属性二: 设置变量

子节点一:添加器

子节点二:根节点

子节点三:

总结

源码下载


说在前面

作为开发,日志是可以说是最重要,没有之一的东西。有代码就一定要有日志,日志写的越详细,处理器bug来越简单,解决问题也越容易,所以码代码之前务必先理解日志是怎么生成的。

Spring Boot在所有内部日志中使用Commons Logging,但是默认配置也提供了对常用日志的支持,

如:java.util.logging,Apache  log4j, log4j2,Logback,SLF4J即简单日志门面(Simple Logging Facade for Java),commons-logging, Spring框架使用的是Jakarta Commons Logging API (JCL)。

每种Logger都可以通过配置使用控制台或者文件输出日志内容。


logback(Spring Boot 默认日志)

Logback是log4j框架的作者开发的新一代日志框架,它效率更高、能够适应诸多的运行环境,同时天然支持SLF4J。

默认情况下,Spring Boot会用Logback来记录日志,并用INFO级别输出到控制台。在运行应用程序和其他例子时,你应该已经看到很多INFO级别的日志了。

从上图可以看到,日志输出内容元素具体如下:

  • 时间日期:精确到毫秒
  • 日志级别:ERROR, WARN, INFO, DEBUG or TRACE
  • 进程ID
  • 分隔符:— 标识实际日志的开始
  • 线程名:方括号括起来(可能会截断控制台输出)
  • Logger名:通常使用源代码的类名
  • 日志内容

在pom.xml加入相关依赖

spring-boot-starter-logging

打开之后:

可以明显看到我们需要的logback。

当然,在真正开发中,很多时候不需要特别去考虑引用,为了避免依赖冲突,可以先看一下工程中有没有已经在引用的。

比如:

spring-boot-starter-test 按住 CTRL 进去可以看到以下:

再继续点开spring-boot-starter:

当然这里面的version是父类引用的version。


日志级别

日志级别从低到高分为:

TRACE < DEBUG < INFO < WARN < ERROR < FATAL

如果设置为 WARN ,则低于 WARN 的信息都不会输出。 
Spring Boot中默认配置ERRORWARNINFO级别的日志输出到控制台。 



控制台输出


您还可以通过启动您的应用程序 --debug 标志来启用“调试”模式(开发的时候推荐开启),以下两种方式皆可:

  • 在运行命令后加入--debug标志,如:$ java -jar springTest.jar --debug
  • application.properties中配置debug=true,该属性置为true的时候,核心Logger(包含嵌入式容器、hibernate、spring)会输出更多内容,但是你自己应用的日志并不会输出为DEBUG级别

日志类名必须为当前类SpringBootDemoApplicationTests,否则将会显示其他类:

lombok方式

在pom.xml加入相关依赖:

安装 Lombok Plugin:

允许log注解:

这样就可以直接在对应的类上直接写 @Slf4j,然后log直接使用:


日志文件输出

默认情况下,Spring Boot将日志输出到控制台,不会写到日志文件。

使用Spring Boot喜欢在application.propertiesapplication.yml配置,这样只能配置简单的场景,保存路径、日志格式等,复杂的场景(区分 info 和 error 的日志、每天产生一个日志文件等)满足不了,只能自定义配置,下面会演示。

保存路径

如果要编写除控制台输出之外的日志文件,则需在application.properties中设置logging.filelogging.path属性。

  • logging.file,设置文件,可以是绝对路径,也可以是相对路径。如:logging.file=springBootLogBack.log(注意后缀,务必有)
  • logging.path,设置目录,会在该目录下创建spring.log文件,并写入日志内容,如:logging.path=/log 
    如果只配置 logging.file,会在项目的当前路径下生成一个 xxx.log 日志文件。 
    如果只配置 logging.path,在 /log文件夹生成一个日志文件为 spring.log

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

级别控制

所有支持的日志记录系统都可以在Spring环境中设置记录级别(例如在application.properties中) 
格式为:'logging.level.* = LEVEL'

logging.level:日志级别控制前缀,*为包名或Logger名 
LEVEL:选项TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF

举例:

logging.level.com.example.demo.controller.LogController=info:LogController类中所有class以info级别输出
logging.level.root=WARN:root日志以WARN级别输出

输出格式


自定义日志配置

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

  • Logback:logback-spring.xml, logback-spring.groovy, logback.xml, logback.groovy
  • Log4j:log4j-spring.properties, log4j-spring.xml, log4j.properties, log4j.xml
  • Log4j2:log4j2-spring.xml, log4j2.xml
  • JDK (Java Util Logging):logging.properties

Spring Boot官方推荐优先使用带有-spring的文件名作为你的日志配置(如使用logback-spring.xml,而不是logback.xml),命名为logback-spring.xml的日志配置文件,spring boot可以为它添加一些spring boot特有的配置项(下面会提到)。 
默认的命名规则,并且放在 src/main/resources 下面即可

如果你即想完全掌控日志配置,但又不想用logback.xml作为Logback配置的名字,application.yml可以通过logging.config属性指定自定义的名字:logging.config=classpath:logging-config.xml

虽然一般并不需要改变配置文件的名字,但是如果你想针对不同运行时Profile使用不同的日志配置,这个功能会很有用。 

一般不需要这个属性,而是直接在logback-spring.xml中使用springProfile配置,不需要logging.config指定不同环境使用不同配置文件。springProfile配置在下面介绍。

根节点包含的属性

  • scan:当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true
  • scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scantrue时,此属性生效。默认的时间间隔为1分钟。
  • debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false

根节点<configuration>有2个属性值,3个子节点,下面一一会详细介绍。


属性一:<contextName> 设置上下文名称

每个logger都关联到logger上下文,默认上下文名称为“default”。但可以使用设置成其他名字,用于区分不同应用程序的记录。一旦设置,不能修改,可以通过%contextName来打印日志上下文名称,一般来说我们不用这个属性,可有可无。

<contextName>logback-lvy</contextName>

属性二:<property> 设置变量

用来定义变量值的标签, 有两个属性,name和value;其中name的值是变量的名称,value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后,可以使“${}”来使用变量。


子节点一:<appender>添加器

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

控制台输出ConsoleAppender

  • 示例一:

Console显示:

可以看到layoutencoder,都可以将事件转换为格式化后的日志记录,但是控制台输出使用layout,文件输出使用encoder。

  • 示例二:

Console显示:

<encoder>表示对日志进行编码:

  • %contextName:上下文名称
  • %d{"yyyy-MM-dd HH:mm:ss,SSS"}:日志输出时间
  • %thread:输出日志的进程名字,这在Web应用以及异步任务处理中很有用
  • %-5level 或者 %-5p:日志级别,并且使用5个字符靠左对齐
  • %logger{36}:日志输出者的名字(从右边数,长度为36),由于太长这里引用的 %c{0}-%M
  • %c{0}:日志输出者的名字,从右边数,第一个(类名)
  • %M:方法名
  • %msg 或者%m:日志消息
  • %n:换行符 

当然也可以使用layout:

<!--输出到控制台 ConsoleAppender-->
<appender name="consoleLog1" class="ch.qos.logback.core.ConsoleAppender">
    <!--展示格式 layout-->
    <layout class="ch.qos.logback.classic.PatternLayout">
      <pattern>%contextName %d{"yyyy-MM-dd HH:mm:ss,SSS"} [%thread] [%-5p] [%c{0}-%M] - %m%n</pattern>
    </layout>
</appender>

如果不想输出某级别日志,可以选择ThresholdFilter为系统定义的拦截器,例如我们用ThresholdFilter来过滤掉ERROR级别以下的日志不输出到文件中。如果不用记得注释掉,不然你控制台会发现没日志~

<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
    <level>ERROR</level>
</filter>

输出到文件 RollingFileAppender:

另一种常见的日志输出到文件,随着应用的运行时间越来越长,日志也会增长的越来越多,将他们输出到同一个文件并非一个好办法。RollingFileAppender用于切分文件日志:

一些配置:

infoLogFile:

errorLogFile:

最后,root节点无比引用,否则写的都无效了:

如果同时有<File><FileNamePattern>,根据日期分割日志,代码注释写的很清楚了。

如果没有<File>,那么指挥使用<FileNamePattern>的文件路径规则。

如果要区分 Info 和 Error 级别的日志,那么需要使用过滤规则的策略。

子节点二:<root>根节点

level:用来设置打印级别,大小写无关。

TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,不能设置为INHERITED或者同义词NULL。 默认是DEBUG。 
可以包含零个或多个元素,标识这个appender将会添加到这个logger。

子节点三:<loger>

<loger>用来设置某一个包或者具体的某一个类的日志打印级别、以及指定<appender><loger>仅有一个name属性,一个可选的level和一个可选的addtivity属性。

  • name:用来指定受此loger约束的某一个包或者具体的某一个类。
  • level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,还有一个特俗值INHERITED或者同义词NULL,代表强制执行上级的级别。如果未设置此属性,那么当前loger将会继承上级的级别。
  • addtivity:是否向上级loger传递打印信息。默认是true。

loger在实际使用的时候有两种情况 
先来看一看代码中如何使用

这是一个登录的判断的方法,我们引入日志,并且打印不同级别的日志,然后根据logback-spring.xml中的配置来看看打印了哪几种级别日志。

第一种:带有loger的配置,不指定级别,不指定appender

logback-spring.xml增加 loger 配置如下:

<logger name="com.example.demo.controller.LogController" />将控制controller包下的所有类的日志的打印,但是并没用设置打印级别,所以继承他的上级的日志级别“info”; 
没有设置addtivity,默认为true,将此loger的打印信息向上级传递; 
没有设置appender,此loger本身不打印任何信息。 
<root level="info">root的打印级别设置为“info”,指定了名字为“console”appender

当执行com.example.demo.controller.LogController类的login方法时,LogController在包com.example.demo.controller中,所以首先执行<logger name="com.example.demo.controller.LogController"/>,将级别为“info”及大于“info”的日志信息传递给root,本身并不打印; 
root接到下级传递的信息,交给已经配置好的名为“console”的appender处理,“console” appender 将信息打印到控制台;

打印结果如下:

第二种:带有多个loger的配置,指定级别,指定appender

logback-spring.xml增加 loger 配置如下:

控制com.example.demo.controller.LogController类的日志打印,打印级别为“WARN”; 
additivity属性为false,表示此loger的打印信息不再向上级传递; 
指定了名字为“console”的appender;

这时候执行com.example.demo.controller.LogController类的login方法时,先执行<logger name="com.example.demo.controller.LogController" level="WARN" additivity="false">,将级别为“WARN”及大于“WARN”的日志信息交给此loger指定的名为“console”的appender处理,在控制台中打出日志,不再向上级root传递打印信息。

打印结果如下:

当然如果你把additivity="false"改成additivity="true"的话,就会打印两次,因为打印信息向上级传递,logger本身打印一次,root接到后又打印一次。

当然如果你把additivity="false"改成additivity="true"的话,就会打印两次,因为打印信息向上级传递,logger本身打印一次,root接到后又打印一次。

注意:

范围有重叠的话,范围小的,有效。

总结

到此为止终于介绍完日志框架了,平时使用的时候推荐用自定义logback-spring.xml来配置,代码中使用日志也很简单,类里面添加private final Logger logger = LoggerFactory.getLogger(Logger.class);即可。

当然也可以使用lombok方式。

源码下载

[相关示例完整代码]请获取 相关分支哦:feature-20180906-logBack 

猜你喜欢

转载自blog.csdn.net/Soinice/article/details/82424815