第02章 Spring-Boot 日志系统集成 logback 介绍
文章目录
- 第02章 Spring-Boot 日志系统集成 logback 介绍
- 参考
logback 常用配置详解（二）
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-5JodFgEp-1599827895669)(assets/appenderSyntax.png)]
：
是的子节点，是负责写日志的组件。
有两个必要属性name和class。name指定appender名称，class指定appender的全限定名。
1.ConsoleAppender:
把日志添加到控制台，有以下子节点：
：对日志进行格式化。（具体参数稍后讲解 ）
：字符串 System.out 或者 System.err ，默认 System.out ；
例如：
Xml代码
<configuration>
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%-4relative [%thread] %-5level %logger{35} - %msg %n</pattern>
</encoder>
</appender>
<root level="DEBUG">
<appender-ref ref="STDOUT" />
</root>
</configuration>2.FileAppender:
把日志添加到文件，有以下子节点：
：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。
：对记录事件进行格式化。（具体参数稍后讲解 ）
：如果是 true，日志会被安全的写入文件，即使其他的FileAppender也在向此文件做写入操作，效率低，默认是 false。
例如：
Xml代码
<configuration>
<appender name="FILE" class="ch.qos.logback.core.FileAppender">
<file>testFile.log</file>
<append>true</append>
<encoder>
<pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
</encoder>
</appender>
<root level="DEBUG">
<appender-ref ref="FILE" />
</root>
</configuration>3.RollingFileAppender:
滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件。有以下子节点：
：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。
：对记录事件进行格式化。（具体参数稍后讲解 ）
:当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名。
<triggeringPolicy >: 告知 RollingFileAppender 合适激活滚动。
：当为true时，不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy，但是有两个限制，1不支持也不允许文件压缩，2不能设置file属性，必须留空。
rollingPolicy：
TimeBasedRollingPolicy： 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。有以下子节点：
:
必要节点，包含文件名及“%d”转换符， “%d”可以包含一个java.text.SimpleDateFormat指定的时间格式，如：%d{yyyy-MM}。如果直接使用 %d，默认格式是 yyyy-MM-dd。RollingFileAppender 的file字节点可有可无，通过设置file，可以为活动文件和归档文件指定不同位置，当前日志总是记录到file指定的文件（活动文件），活动文件的名字不会改变；如果没设置file，活动文件的名字会根据fileNamePattern 的值，每隔一段时间改变一次。“/”或者“\”会被当做目录分隔符。
:
可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每个月滚动，且是6，则只保存最近6个月的文件，删除之前的旧文件。注意，删除旧文件是，那些为了归档而创建的目录也会被删除。
FixedWindowRollingPolicy： 根据固定窗口算法重命名文件的滚动策略。有以下子节点：
:窗口索引最小值
:窗口索引最大值，当用户指定的窗口过大时，会自动将窗口设置为12。
:
必须包含“%i”例如，假设最小值和最大值分别为1和2，命名模式为 mylog%i.log,会产生归档文件mylog1.log和mylog2.log。还可以指定文件压缩选项，例如，mylog%i.log.gz 或者 没有log%i.log.zip
triggeringPolicy:
SizeBasedTriggeringPolicy： 查看当前活动文件的大小，如果超过指定大小会告知RollingFileAppender 触发当前活动文件滚动。只有一个节点**😗*
:这是活动文件的大小，默认值是10MB。
例如：每天生成一个日志文件，保存30天的日志文件。
Xml代码
<configuration>
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>logFile.%d{yyyy-MM-dd}.log</fileNamePattern>
<maxHistory>30</maxHistory>
</rollingPolicy>
<encoder>
<pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
</encoder>
</appender>
<root level="DEBUG">
<appender-ref ref="FILE" />
</root>
</configuration>例如：按照固定窗口模式生成日志文件，当文件大于20MB时，生成新的日志文件。窗口大小是1到3，当保存了3个归档文件后，将覆盖最早的日志。
Xml代码
<configuration>
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>test.log</file>
<rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
<fileNamePattern>tests.%i.log.zip</fileNamePattern>
<minIndex>1</minIndex>
<maxIndex>3</maxIndex>
</rollingPolicy>
<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<maxFileSize>5MB</maxFileSize>
</triggeringPolicy>
<encoder>
<pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
</encoder>
</appender>
<root level="DEBUG">
<appender-ref ref="FILE" />
</root>
</configuration>4.另外还有SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender，并不常用，这些就不在这里讲解了，大家可以参考官方文档。当然大家可以编写自己的Appender。
：
负责两件事，一是把日志信息转换成字节数组，二是把字节数组写入到输出流。
目前PatternLayoutEncoder 是唯一有用的且默认的encoder ，有一个节点，用来设置日志的输入格式。使用“%”加“转换符”方式，如果要输出“%”，则必须用“\”对“%”进行转义。
例如：
Xml代码
<encoder>
<pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
</encoder里面的转换符说明：
转换符 | 作用 |
c {length } lo {length } logger {length } | 输出日志的logger名，可有一个整形参数，功能是缩短logger名，设置为0表示只输入logger最右边点符号之后的字符串。Conversion specifierLogger nameResult%loggermainPackage.sub.sample.BarmainPackage.sub.sample.Bar%logger{0}mainPackage.sub.sample.BarBar%logger{5}mainPackage.sub.sample.Barm.s.s.Bar%logger{10}mainPackage.sub.sample.Barm.s.s.Bar%logger{15}mainPackage.sub.sample.Barm.s.sample.Bar%logger{16}mainPackage.sub.sample.Barm.sub.sample.Bar%logger{26}mainPackage.sub.sample.BarmainPackage.sub.sample.Bar |
C {length } class {length } | 输出执行记录请求的调用者的全限定名。参数与上面的一样。尽量避免使用，除非执行速度不造成任何问题。 |
contextNamecn | 输出上下文名称。 |
d {pattern } date {pattern } | 输出日志的打印日志，模式语法与 |
F / file | 输出执行记录请求的java源文件名。尽量避免使用，除非执行速度不造成任何问题。 |
caller{depth}caller{depth, evaluator-1, … evaluator-n} | 输出生成日志的调用者的位置信息，整数选项表示输出信息深度。例如， %caller{2} 输出为： |
L / line | 输出执行日志请求的行号。尽量避免使用，除非执行速度不造成任何问题。 |
m / msg / message | 输出应用程序提供的信息。 |
M / method | 输出执行日志请求的方法名。尽量避免使用，除非执行速度不造成任何问题。 |
n | 输出平台先关的分行符“\n”或者“\r\n”。 |
p / le / level | 输出日志级别。 |
r / relative | 输出从程序启动到创建日志记录的时间，单位是毫秒 |
t / thread | 输出产生日志的线程名。 |
replace(p ){r, t} | p 为日志内容，r 是正则表达式，将p 中符合r 的内容替换为t 。例如， “%replace(%msg){’\s’, ‘’}” |
格式修饰符，与转换符共同使用：
可选的格式修饰符位于“%”和转换符之间。
第一个可选修饰符是左对齐 标志，符号是减号“-”；接着是可选的最小宽度 修饰符，用十进制数表示。如果字符小于最小宽度，则左填充或右填充，默认是左填充（即右对齐），填充符为空格。如果字符大于最小宽度，字符永远不会被截断。最大宽度 修饰符，符号是点号"."后面加十进制数。如果字符大于最大宽度，则从前面截断。点符号“.”后面加减号“-”在加数字，表示从尾部截断。
例如：%-4relative 表示，将输出从程序启动到创建日志记录的时间 进行左对齐 且最小宽度为4。
参考
官方文档:howto-configure-logback-for-logging
官方文档:profile_specific_configuration
为什么用Logback，这个建议大家上网搜一下，用log4j的建议更换了，此处的其实用的是sl4j日志，Logback只是他的实现，Logback性能比log4j高很多。
#Logback配置
SpringBoot本身就集成了日志记录组件，所以这节就没有日志依赖了。本来是要写Druid集成及监控的，突然发现前面没有写日志，就这样补上去。
#第一种方式，配置文件配置
SpringBoot默认就配置了配置文件，简单监控及日志输出配置也很简单，增加如下的配置就可以了，file指定日志记录地址及名称，level是监控级别，不是很重要的项目这样子就OK了。这写法无法显示sql，如果用jpa有单独配置可以显示，mybatis不能显示（企业级项目博主不推荐这写法）
logging:
file: ./application.log
level: debug#第二种方式，logback配置（推荐）
SpringBoot官方介绍，可以在resource下创建一个logback.xml文件，程序会自动加载，同时官方建议这个xml命名为logback-spring.xml。
当logback-spring.xml与配置文件中配置同时存在的时候，以.xml配置为准，配置文件无效。配置内容如下代码，博主写前logback的版本1.1.7，这个版本有个小bug在1.1.8才能修复，配置文件中写。
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<include resource="org/springframework/boot/logging/logback/defaults.xml" />
<logger name="org.springframework.web" level="INFO" />
<!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径-->
<property name="LOG_PATH" value="D://" />
<!-- 控制台输出 -->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
</encoder>
</appender>
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--日志文件输出的文件名-->
<FileNamePattern>${LOG_PATH}/TestWeb.log.%d{yyyy-MM-dd}.log</FileNamePattern>
<!--日志文件保留天数-->
<maxHistory>15</maxHistory>
<!-- 当前版本bug，需要1.1.8才修复 -->
<totalSizeCap>30GB</totalSizeCap>
</rollingPolicy>
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
</encoder>
<!--日志文件最大的大小-->
<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<MaxFileSize>10MB</MaxFileSize>
</triggeringPolicy>
</appender>
<!-- 异步记录文件 -->
<appender name="asyncFileAppender" class="ch.qos.logback.classic.AsyncAppender">
<discardingThreshold>0</discardingThreshold>
<queueSize>500</queueSize>
<appender-ref ref="FILE" />
</appender>
<root level="INFO">
<appender-ref ref="STDOUT" />
<appender-ref ref="asyncFileAppender" />
</root>
<!-- 打印sql -->
<logger name="com.dengzy.kuj.mybatis.dao" level="DEBUG"></logger>
</configuration>#多环境下的logback.xml配置
众所周知，SpringBoot可以在不同的配置环境下使用不同的配置文件，比如，你有application.yml,application-dev.yml,application-junit.yml,application-pro.yml，分别是公共配置，开发环境配置，单元测试环境配置，生产环境配置，切换环境只需要在application.yml中激活那个配置文件
，如下
spring:
profiles:
active: dev #切换不同环境的配置信息
output:
ansi:
enabled: detect #多彩输出日志，如果你的编辑器支持的话
datasource:
url: jdbc:mysxxxxx
username: xxx
。。。。在切换不同配置文件下我们需要使用不同的日志记录，比如开发的只需要打印控制台，生产的写文件和控制台，单元测试之写文件等等策略，那上面的配置文件就需要改一下，如下
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<include resource="org/springframework/boot/logging/logback/defaults.xml" />
<logger name="org.springframework.web" level="INFO" />
<appender name="consoleAppender" class="ch.qos.logback.core.ConsoleAppender">
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
</encoder>
</appender>
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--日志文件输出的文件名-->
<FileNamePattern>${LOG_PATH}/TestWeb.log.%d{yyyy-MM-dd}.log</FileNamePattern>
<!--日志文件保留天数-->
<maxHistory>15</maxHistory>
<!-- 当前版本bug，需要1.1.8才修复 -->
<totalSizeCap>30GB</totalSizeCap>
</rollingPolicy>
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
</encoder>
<!--日志文件最大的大小-->
<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<MaxFileSize>10MB</MaxFileSize>
</triggeringPolicy>
</appender>
<appender name="asyncFileAppender" class="ch.qos.logback.classic.AsyncAppender">
<discardingThreshold>0</discardingThreshold>
<queueSize>500</queueSize>
<appender-ref ref="FILE" />
</appender>
<springProfile name="dev">
<root level="INFO">
<appender-ref ref="consoleAppender" />
</root>
</springProfile>
<springProfile name="junit">
<root level="INFO">
<appender-ref ref="consoleAppender" />
<appender-ref ref="asyncFileAppender" />
</root>
</springProfile>
<springProfile name="test">
<root level="INFO">
<appender-ref ref="asyncFileAppender" />
</root>
</springProfile>
<springProfile name="pro">
<root level="INFO">
<appender-ref ref="asyncFileAppender" />
</root>
</springProfile>
<!--<root level="INFO">
<appender-ref ref="STDOUT" />
<appender-ref ref="asyncFileAppender" />
</root>-->
<!-- 打印sql -->
<logger name="com.dengzy.kuj.mybatis.dao" level="DEBUG"></logger>
</configuration>好了，至此配文件配置完毕。
2017-01-10 17:57:07.794 [http-nio-8080-exec-1] INFO com.dengzy.kuj.mybatis.controller.UserCtrl - 日志测试啦啦啦
2017-01-10 17:57:08.090 [http-nio-8080-exec-1] WARN org.apache.tomcat.jdbc.pool.ConnectionPool - maxIdle is larger than maxActive, setting maxIdle to: 20
2017-01-10 17:57:09.125 [http-nio-8080-exec-1] DEBUG c.d.kuj.mybatis.dao.UserMapper.queryUserInfoByName - ==> Preparing: select * from user WHERE name = ?
2017-01-10 17:57:09.231 [http-nio-8080-exec-1] DEBUG c.d.kuj.mybatis.dao.UserMapper.queryUserInfoByName - ==> Parameters: user(String)
2017-01-10 17:57:09.432 [http-nio-8080-exec-1] DEBUG c.d.kuj.mybatis.dao.UserMapper.queryUserInfoByName - <== Total: 4
setting maxIdle to: 20
2017-01-10 17:57:09.125 [http-nio-8080-exec-1] DEBUG c.d.kuj.mybatis.dao.UserMapper.queryUserInfoByName - ==> Preparing: select * from user WHERE name = ?
2017-01-10 17:57:09.231 [http-nio-8080-exec-1] DEBUG c.d.kuj.mybatis.dao.UserMapper.queryUserInfoByName - ==> Parameters: user(String)
2017-01-10 17:57:09.432 [http-nio-8080-exec-1] DEBUG c.d.kuj.mybatis.dao.UserMapper.queryUserInfoByName - <== Total: 4
