Java Logback教程

今天仔细配置了一下Logback，之前都是直接从网上找一下，今天仔细研究了一下。首先简单配置如下：

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
  <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径-->
	<springProperty scope="context" name="logLevel" source="logBack.level"/>
	<springProperty scope="context" name="logPath" source="logBack.path"/>
	<springProperty scope="context" name="logName" source="logBack.name"/>

	<property name="COLOR_PATTERN" value="%black(%contextName-) %red(%d{yyyy-MM-dd HH:mm:ss}) %green([%thread]) %highlight(%-5level) %boldMagenta( %replace(%caller{1}){'\t|Caller.{1}0|\r\n', ''})- %gray(%msg%xEx%n)" />
	<!-- 控制台输出 -->
	<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}:%L - %msg%n</pattern>
		</encoder>
	</appender>

	<!-- 按照每天生成日志文件 -->
	<appender name="FILE"
		class="ch.qos.logback.core.rolling.RollingFileAppender">
		<rollingPolicy
			class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
			<!--日志文件输出的文件名 -->
			<FileNamePattern>${logPath}/${logName}.%d{yyyy-MM-dd}.%i.log
			</FileNamePattern>
			<!--日志文件保留天数 -->
			<MaxHistory>180</MaxHistory>
			<MaxFileSize>500MB</MaxFileSize>
			<!--重启清理日志文件-->
			<cleanHistoryOnStart>true</cleanHistoryOnStart>
		</rollingPolicy>
		<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}:%L - %msg%n</pattern>
		</encoder>
	</appender>

	<!-- 生成html格式日志结束 -->

	<!-- 每天生成一个html格式的日志开始 -->
	<appender name="FILE_HTML"
		class="ch.qos.logback.core.rolling.RollingFileAppender">
		<rollingPolicy
			class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
			<!--日志文件输出的文件名 -->
			<FileNamePattern>${logPath}/${logName}.%d{yyyy-MM-dd}.%i.html
			</FileNamePattern>
			<!--日志文件保留天数 -->
			<MaxHistory>180</MaxHistory>
			<MaxFileSize>500MB</MaxFileSize>
			<!--重启清理日志文件-->
			<cleanHistoryOnStart>true</cleanHistoryOnStart>
		</rollingPolicy>
		<encoder
			class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
			<layout class="ch.qos.logback.classic.html.HTMLLayout">
				<pattern>%p%d%msg%M%F{32}%L</pattern>
			</layout>
		</encoder>
	</appender>
	<!-- 每天生成一个html格式的日志结束 -->

	<!--myibatis log configure -->
	<logger name="com.apache.ibatis" level="DEBUG" />
	<logger name="java.sql.Connection" level="DEBUG" />
	<logger name="java.sql.Statement" level="DEBUG" />
	<logger name="java.sql.PreparedStatement" level="DEBUG" />


	<!-- 日志输出级别 -->
	<root level="${logLevel}">
		<appender-ref ref="STDOUT" />
		<appender-ref ref="FILE" />
		<appender-ref ref="FILE_HTML" />
	</root>

</configuration>

然后日志级别的区分如下：

fileNamePattern 值及其作用说明

然后今天主要测试了一下rollingPolicy节点下用ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy类和TimeBasedRollingPolicy类的MaxFileSize，MaxHistory的作用：

MaxFileSize：这个参数决定了单个log日志的大小，如果是ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy类，那就会在达到这个值得时候进行切分。但是如果用的是TimeBasedRollingPolicy类那么达到这个值之后，就不再写入日志，这点是比较坑的。

MaxHistory：这个值代表的是周期的概念，刚开始看各种文章有的说是代表保存日志的最多的天数，有的说是保存的文件个数，然后看了下官网，官网在SizeAndTimeBasedRollingPolicy和TimeBasedRollingPolicy类之下的时候的解释是Size and time based archiving supports deletion of old archive files. You need to specify the number of periods to preserve with the maxHistory property. When your application is stopped and restarted, logging will continue at the correct location, i.e. at the largest index number for the current period.然后经过我测试之后，发现这个表示的是周期。即在fileNamePattern 参数配置的如果是按照天进行分割，那这个的数量就表示是N天，如果fileNamePattern 配置的是分钟，那这个就表示N分钟。然后这个数量不能用类似3*30这种表达，必须直接用90表达。

参考：https://zhuanlan.zhihu.com/p/70595392

http://logback.qos.ch/manual/appenders.html#rfaRollingPolicy

https://blog.csdn.net/SIMBA1949/article/details/90718200

https://blog.csdn.net/u012723183/article/details/107685109