学习链接
logback 配置详解（一、二）——logger、root
logback教程logback快速入门超实用详细教程收藏这一篇就够了(万字长文)
logback教程超实用项目实战收藏这一篇就够了(万字长文)
logback日志
概要
appender 可以理解为要输出的位置，可以是控制台，也可以是一个文件。- 输出位置
- 如果是控制台的话，就使用： ConsoleAppender
- 如果是输出到文件的话，就使用：RollingFileAppender滚动日志文件 或其他实现
- 编码器
- 可以使用 PatternLayoutEncoder 指定
日志的输出格式
- 可以使用 PatternLayoutEncoder 指定
- 输出位置
logger可以理解为日志记录器-
在java类中就是使用的日志记录器来输出日志，日志记录器
可以设置自己的日志级别。 -
当在java类中 使用日志记录器，通过
调用不同的方法 指定当前输出的日志 使用的日志级别，当使用此日志记录器输出当前日志时，所使用的日志级别，大于或等于日志记录器所指定的日志级别时，此日志器才会 将此日志内容输出到 该日志器所指定的appender中。 -
日志记录器是存在层级的
- 日志记录器的层级，是以
"."点号分割，最顶层的是root日志记录器。在项目中，可以使用<logger>标签定义日志记录器，比如：<logger name=“com.zzhua.blog.controller” level=“WARN”/> 和 <logger name=“com.zzhua.blog.controller.TestController” level=“INFO”>，这2个日志记录器就存在父子关系， com.zzhua.blog.controller是com.zzhua.blog.controller.TestController父日志记录器，而root则是所有日志记录器的顶级父级。 - 日志记录器的层级用法？如果使用某一个日志记录器的输出日志的方法，此方法指定的日志输出级别大于或等于当前日志记录器的日志级别，那么这个就会向这个日志记录器中所有使用<appender-ref>标签指定的appender中输出日志。并且找到当前日志记录器的父级日志记录器（如果有的话），将日志信息传递给父级日志记录器，而父级日志记录器指定的appender也会输出日志（注意，此时是已经忽略父级日志记录器的日志级别，只要子级日志记录器传过来了，就直接输出，而不管传过来的日志信息的日志级别），这样依次找到它们的父级，一直到root日志记录器。有的时候，我们并不向把当前的日志记录器的日志信息传递给父级日志记录器，那么可以设置
additivity="false"，来禁用日志消息向父级传递（这个additivity属性，可以在ch.qos.logback.core.joran.action.ActionConst这个类中找到）。
- 日志记录器的层级，是以
-
源码使用示例
在spring-boot-2.1.8.RELEASE.jar包中的logging包中可以找到logback配置文件的示例，我们可以参照这些设置，来创建我们自己的logback-spring.xml配置文件。
base.xml
<included>
<include resource="org/springframework/boot/logging/logback/defaults.xml" />
<property name="LOG_FILE" value="${LOG_FILE:-${LOG_PATH:-${LOG_TEMP:-${java.io.tmpdir:-/tmp}}}/spring.log}"/>
<include resource="org/springframework/boot/logging/logback/console-appender.xml" />
<include resource="org/springframework/boot/logging/logback/file-appender.xml" />
<root level="INFO">
<appender-ref ref="CONSOLE" />
<appender-ref ref="FILE" />
</root>
</included>
defaults.xml
<included>
<!-- 用于解析日志输出格式中指定的关键字，来做转换 -->
<conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" />
<conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" />
<conversionRule conversionWord="wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" />
<!-- 控制台打印日志格式 示例 -->
<property name="CONSOLE_LOG_PATTERN" value="${CONSOLE_LOG_PATTERN:-%clr(%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>
<!-- 日志文件打印日志格式 示例 -->
<property name="FILE_LOG_PATTERN" value="${FILE_LOG_PATTERN:-%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}} ${LOG_LEVEL_PATTERN:-%5p} ${PID:- } --- [%t] %-40.40logger{39} : %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>
<logger name="org.apache.catalina.startup.DigesterFactory" level="ERROR"/>
<logger name="org.apache.catalina.util.LifecycleBase" level="ERROR"/>
<logger name="org.apache.coyote.http11.Http11NioProtocol" level="WARN"/>
<logger name="org.apache.sshd.common.util.SecurityUtils" level="WARN"/>
<logger name="org.apache.tomcat.util.net.NioSelectorPool" level="WARN"/>
<logger name="org.eclipse.jetty.util.component.AbstractLifeCycle" level="ERROR"/>
<logger name="org.hibernate.validator.internal.util.Version" level="WARN"/>
</included>
console-appender.xml
打印到控制台上所使用的appender实现类 和 打印到控台台上 所使用的日志格式，来组成appender，后面可以引用此appender
<?xml version="1.0" encoding="UTF-8"?>
<!--
Console appender logback configuration provided for import, equivalent to the programmatic
initialization performed by Boot
-->
<included>
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>${CONSOLE_LOG_PATTERN}</pattern>
</encoder>
</appender>
</included>
file-appender.xml
将日志输出到日志文件中所使用的appender实现类 和 输出到日志文件中 所使用的日志格式，来组成appender，后面可以引用此appender
<?xml version="1.0" encoding="UTF-8"?>
<!--
File appender logback configuration provided for import, equivalent to the programmatic
initialization performed by Boot
-->
<included>
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<encoder>
<pattern>${FILE_LOG_PATTERN}</pattern>
</encoder>
<file>${LOG_FILE}</file>
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<fileNamePattern>${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz</fileNamePattern>
<maxFileSize>${LOG_FILE_MAX_SIZE:-10MB}</maxFileSize>
<maxHistory>${LOG_FILE_MAX_HISTORY:-0}</maxHistory>
</rollingPolicy>
</appender>
</included>
logback-release.xml示例
<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
<!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径-->
<property name="LOG_BASE_PATH" value="/data/logs/xxx-yyy-server" />
<property name="maxFileSize" value="5MB"/>
<property name="maxHistory" value="30"/>
<property name="commonPattern" value="%d{yyyy-MM-dd HH:mm:ss.SSS}-${PID}-[%X{X-B3-TraceId},%X{X-B3-SpanId},%X{X-B3-ParentSpanId}]-[%thread] %-5level %logger{30} [%file:%line] - %msg%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>${commonPattern}</pattern>
</encoder>
</appender>
<!--文件日志， 按照每天生成日志文件 -->
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${LOG_BASE_PATH}/ambientMonitor.log</file>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--日志文件输出的文件名-->
<FileNamePattern>${LOG_BASE_PATH}/%d/xxx.log.%d{yyyy-MM-dd}-%i.log</FileNamePattern>
<!--日志文件保留天数-->
<MaxHistory>${maxHistory}</MaxHistory>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>${maxFileSize}</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
<pattern>${commonPattern}</pattern>
</encoder>
</appender>
<appender name="SQL_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${LOG_BASE_PATH}/sql.log</file>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--日志文件输出的文件名-->
<FileNamePattern>${LOG_BASE_PATH}/%d/sql.log.%d{yyyy-MM-dd}-%i.log</FileNamePattern>
<!--日志文件保留天数-->
<MaxHistory>3</MaxHistory>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>10MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
<pattern>${commonPattern}</pattern>
</encoder>
</appender>
<!--该logger默认会继承自下面的root里面的appender和日志级别level，
当使用该logger时, 凡是大于该logger日志级别(如果未设置该logger日志级别，
则默认使用root的日志级别，如果设置了，则以设置的日志级别为准)的日志
都会输出到appender(包括root中的append-ref和自己下面的append-ref,
当然可以通过设置additivity属性(见类:ch.qos.logback.core.joran.action.ActionConst&RootLoggerAction)，
不继承root中配置的append-ref)中 -->
<logger name="com.xxx.yyy.mapper" level="DEBUG" additivity="false">
<appender-ref ref="STDOUT"/>
<appender-ref ref="SQL_FILE" />
</logger>
<!-- 日志输出级别 -->
<root level="INFO">
<appender-ref ref="STDOUT" />
<appender-ref ref="FILE"/>
</root>
</configuration>
摘自《logback-spring.xml配置简述》
什么是 Logback
logback继承自log4j，它建立在有十年工业经验的日志系统之上。它比其它所有的日志系统更快并且更小，包含了许多独特并且有用的特性。
Logback 的配置
Configruation
从上面的配置例子中我们可以看到根节点为<configuration>
在根节点的配置中包含了三个属性如下：
scan: 当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。scanPeriod: 设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。debug: 当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。
比如如下配置：
<configuration scan="true" scanPeriod="60 seconds" debug="false">
</configuration>
Property
<property>标签作为<configuration>标签的子标签主要用来定义变量的，它有name和value两个属性，他的值会进入logger的上下文中，使用${name}可以引用到。
- name: 变量的名称。
- value: 变量的值。
比如如下配置：
<property name="APP_NAME" value="DEMO"/>
Timestamp
<timestamp>标签作为<configuration>标签的子标签主要用来获取当前时间的字符串，它有key和dataPattern两个属性，它也同样会进入logger的上下文中，使用${key}可以引用到。
- key: 表示此标签的名字，类似上面property的name作用。
- dataPattern: 设置将当前时间(解析配置文件的时间)转换为字符串的模式，遵循java.txt.SimpleDateFormat的格式。
比如如下配置：
<timestamp key="FULL_DATE" dataPattern="yyyy-MM-dd HH:mm:ss"/>
感觉好像用的不多。
Appender
<appender>标签是写日志的组件，它主要有两个属性即name和class。
- name: 即指定该组件的名称。
- class: 为全限定名，他们必须实现自 ch.qos.logback.core.Appender接口。
常用的Appender有三种，他们分别是ConsoleAppender、FileAppender、RollingFileAppender。
选择每一个不同的Appender，所具有的子节点是不同的。在开始介绍不同的Appender之前，先介绍几个转换标记，因为在下面写文件名以及格式化日志的时候会用到：
-
%d: 输出日志时间点的日期或时间，指定格式的方式%d{yyyy-MM-dd HH:mm:ss} -
%i: 这是个一个自增索引，在分文件的时候，达到设的限制时，索引便会自增，从0开始，下面会用到 -
%p: 输出优先级，即DEBUG、INFO、WARN、ERROR、FATAL -
%r: 输出从应用启动到输出该日志所耗费的毫秒数 -
%t: 输出产生该日志的线程名 -
%f: 输出日志所属的类别名 -
%c: 输出日志类的全名 -
%l: 输出日志事件的发生位置，即输出日志语句在他所在类别的第几行。 -
%m: 输出代码中指定的信息，如log(message)中的message -
%n: 输出一个换行符号
ConsoleAppender
ConsoleAppender所对应的是将日志写到控制台的，它具有以下子节点：
-
<encoder>: 对日志进行格式化。例如：
<!-- 控制台输出 --> <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <pattern> [%-5level] [%date{yyyy-MM-dd HH:mm:ss}] %logger{96} [%line] - %msg%n</pattern> <charset>UTF-8</charset> </encoder> </appender>
FileAppender
FileAppender是将日志写入到文件中，它有以下子节点：
<file>: 被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。<append>: 如果是true，日志被追加到文件结尾，如果是false，清空现存文件，默认是true。<encoder>: 对日志进行格式化。<prudent>: 如果是true，日志会被安全的写入文件，即使其他的FileAppender也在向此文件做写入操作，效率低，默认是false。
例如：
<!-- 全量输出，用于 Admin 监控日志 -->
<appender name="MONITOR_FILE" class="ch.qos.logback.core.FileAppender">
<encoder>
<pattern>${PATTERN}</pattern>
<charset>UTF-8</charset>
</encoder>
<file>logs/${APP_NAME}.log</file>
<prudent>true</prudent>
</appender>
这里的${PATTERN}就是取的上文中提到的<property>标签，将[%-5level] [%date{yyyy-MM-dd HH:mm:ss}] %logger{96} [%line] - %msg%n定义在其中了
RollingFileAppender
RollingFileAppender是个滚动记录文件的组件，先将日志记录到指定文件，当符合指定的条件时，会将日志文件截断记录到其他文件。有以下子节点：
<file>: 被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。<encoder>: 对日志进行格式化。<append>: 如果是true，日志被追加到文件结尾，如果是false，清空现存文件，默认是true。<rollingPolicy>: 当发生滚动时，决定RollingFileAppender的行为，涉及文件移动和重命名。属性class定义具体的滚动策略类。这里有几种常见的策略，比如：TimeBasedRollingPolicy: 这是一种相对比较常用的策略，可以按天、按月等来分日志文件。SizeAndTimeBasedRollingPolicy: 这种策略是用来在比如按日期归档文件的时候，想要限制其大小，可以使用这种策略来实现。
例如：
<!-- 记录 INFO 日志 -->
<appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<encoder>
<pattern>${PATTERN}</pattern>
<charset>UTF-8</charset>
</encoder>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>INFO</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${LOG_DIR}/${APP_NAME}/info-${APP_NAME}-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>32 MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<prudent>true</prudent>
</appender>
Logger
该节点设置某一个包下或者某一个类的日志级别的，他有以下属性：
name: 用来指定受此logger作用的某一个包或者具体的某一个类。level: 用来设置当前指定包或类的日志级别，大小写不敏感，可以设置：TRACE、 DEBUG、 INFO、 WARN、ERROR 、ALL 和OFF，还有一个特殊的值INHERITED或者NULL，代表强制执行上级的级别，如果未设置此属性，那么当前logger将会继承上级的级别。addtivity: 是否向上级logger传递打印信息。默认是true。
例如：
<logger name="org.mybatis.spring" level="INFO" />
Root
<root>节点也是一个必选的节点，用来指定基础的日志输出级别，就是除了上面<logger>指定的，其他都是按此级别的，它只有一个level属性：
level: 也是用来指定日志级别的，但是这里不能设置特殊的值INHERITED或者NULL了，默认是DEBUG，其可以包含零个或者多个元素，标识使用哪些appender会在这里生效。
例如：
<root level="INFO">
<appender-ref ref="STDOUT" />
<appender-ref ref="INFO_FILE" />
<appender-ref ref="WARN_FILE" />
<appender-ref ref="DEBUG_FILE" />
<appender-ref ref="ERROR_FILE" />
</root>
完整示例
这个便是在学习这些配置的时候，结合自己要写的工程编写的logbakc-spring.xml文件，结合上面所说的配置，再加上少量注释，应该大致可以理解了：
<!-- Logback configuration. See http://logback.qos.ch/manual/index.html -->
<configuration scan="true" scanPeriod="10 seconds">
<property name="APP_NAME" value="queen-registry"/>
<property name="PATTERN" value="[%-5level] [%date{yyyy-MM-dd HH:mm:ss}] %logger{96} [%line] - %msg%n"/>
<!-- 控制台输出 -->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>${PATTERN}</pattern>
<charset>UTF-8</charset>
</encoder>
</appender>
<!-- 全量输出，用于 Admin 监控日志 -->
<appender name="MONITOR_FILE" class="ch.qos.logback.core.FileAppender">
<encoder>
<pattern>${PATTERN}</pattern>
<charset>UTF-8</charset>
</encoder>
<file>logs/${APP_NAME}.log</file>
<prudent>true</prudent>
</appender>
<!-- 记录 INFO 日志 -->
<appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<encoder>
<pattern>${PATTERN}</pattern>
<charset>UTF-8</charset>
</encoder>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>INFO</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${APP_NAME}/logs/info-${APP_NAME}-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>32 MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<prudent>true</prudent>
</appender>
<!-- 记录 WARN 日志 -->
<appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<encoder>
<pattern>${PATTERN}</pattern>
<charset>UTF-8</charset>
</encoder>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>WARN</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${APP_NAME}/logs/warn-${APP_NAME}-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>32 MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<prudent>true</prudent>
</appender>
<!-- 记录 DEBUG 日志 -->
<appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<encoder>
<pattern>${PATTERN}</pattern>
<charset>UTF-8</charset>
</encoder>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>DEBUG</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${APP_NAME}/logs/debug-${APP_NAME}-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>32 MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<prudent>true</prudent>
</appender>
<!-- 记录 ERROR 日志 -->
<appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<encoder>
<pattern>${PATTERN}</pattern>
<charset>UTF-8</charset>
</encoder>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>ERROR</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${APP_NAME}/logs/error-${APP_NAME}-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>32 MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<prudent>true</prudent>
</appender>
<!-- 这里的 springProfile 主要是用来区分环境的 -->
<!-- 开发、预发环境 -->
<springProfile name="dev, staging">
<root level="INFO">
<appender-ref ref="STDOUT" />
<appender-ref ref="MONITOR_FILE" />
</root>
<logger name="top.felixu.queen" level="DEBUG"/>
<logger name="org.mybatis.spring" level="INFO" />
<logger name="com.netflix.discovery" level="INFO" />
<logger name="org.springframework.amqp.rabbit" level="INFO" />
</springProfile>
<!-- 生产环境 -->
<springProfile name="prod">
<root level="INFO">
<appender-ref ref="STDOUT" />
<appender-ref ref="INFO_FILE" />
<appender-ref ref="WARN_FILE" />
<appender-ref ref="DEBUG_FILE" />
<appender-ref ref="ERROR_FILE" />
</root>
</springProfile>
</configuration>
摘自《logback输出彩色日志，每个请求一种颜色》
源自：logback输出彩色日志，每个请求一种颜色，请点击链接访问原文
Java项目，日志使用的时slf4j + logback，在服务器上查看日志时，都是黑白的，想要在服务器上输出的日志是彩色的，可以大大提高查看效率。
配合slf4j的MDC功能可以实现，可以实现一个请求链输出同一种颜色。
输出颜色的基本原理
linux是自带ANSI功能是支持彩色日志的，可以这样测试下,下面的代码会输出绿色的 日志两个字。
想知道的更多，可以自行搜索下ANSI关键词
echo -e "\033[32m 日志 \033[0m"
所以只要我们将要输出的日志字符串用\033[32m \033[0m]包起来,则查看就是绿色的，
同理除了绿色外还有其他颜色,只要切换数字即可，具体颜色如下。
String BLACK_FG = "30";
String RED_FG = "31";
String GREEN_FG = "32";
String YELLOW_FG = "33";
String BLUE_FG = "34";
String MAGENTA_FG = "35";
String CYAN_FG = "36";
String WHITE_FG = "37";
String DEFAULT_FG = "39";
简单颜色输出测试
创建Test.java,在linux下编译运行下面函数，输出确实变成了绿色。
public static void main(String[] args) {
String start = "\033[32m";
String end = "\033[0m";
System.out.println(start + "日志1" + end);
System.out.println(start + "日志2" + end);
}
logback对彩色日志的支持
一般logback的配置大概像下面这样，其中的encoder默认是PatternLayoutEncoder类，它包装了PatternLayout类对日志进行处理格式化。
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss} %-5p %C:%L-%m%n</pattern>
</encoder>
</appender>
PatternLayout内有多个converter，每个converter处理模式的一部分，如常用的%d，%p，%C都是已经注册好的，还有一些如%red %blue就是处理颜色的。
public class PatternLayout extends PatternLayoutBase<ILoggingEvent> {
public static final Map<String, String> defaultConverterMap = new HashMap<String, String>();
public static final String HEADER_PREFIX = "#logback.classic pattern: ";
static {
defaultConverterMap.putAll(Parser.DEFAULT_COMPOSITE_CONVERTER_MAP);
defaultConverterMap.put("d", DateConverter.class.getName());
defaultConverterMap.put("date", DateConverter.class.getName());
defaultConverterMap.put("r", RelativeTimeConverter.class.getName());
defaultConverterMap.put("relative", RelativeTimeConverter.class.getName());
defaultConverterMap.put("level", LevelConverter.class.getName());
defaultConverterMap.put("le", LevelConverter.class.getName());
defaultConverterMap.put("p", LevelConverter.class.getName());
defaultConverterMap.put("t", ThreadConverter.class.getName());
defaultConverterMap.put("thread", ThreadConverter.class.getName());
defaultConverterMap.put("lo", LoggerConverter.class.getName());
defaultConverterMap.put("logger", LoggerConverter.class.getName());
defaultConverterMap.put("c", LoggerConverter.class.getName());
defaultConverterMap.put("m", MessageConverter.class.getName());
defaultConverterMap.put("msg", MessageConverter.class.getName());
defaultConverterMap.put("message", MessageConverter.class.getName());
defaultConverterMap.put("C", ClassOfCallerConverter.class.getName());
defaultConverterMap.put("class", ClassOfCallerConverter.class.getName());
defaultConverterMap.put("M", MethodOfCallerConverter.class.getName());
defaultConverterMap.put("method", MethodOfCallerConverter.class.getName());
defaultConverterMap.put("L", LineOfCallerConverter.class.getName());
defaultConverterMap.put("line", LineOfCallerConverter.class.getName());
defaultConverterMap.put("F", FileOfCallerConverter.class.getName());
defaultConverterMap.put("file", FileOfCallerConverter.class.getName());
defaultConverterMap.put("X", MDCConverter.class.getName());
defaultConverterMap.put("mdc", MDCConverter.class.getName());
defaultConverterMap.put("ex", ThrowableProxyConverter.class.getName());
defaultConverterMap.put("exception", ThrowableProxyConverter.class.getName());
defaultConverterMap.put("rEx", RootCauseFirstThrowableProxyConverter.class.getName());
defaultConverterMap.put("rootException", RootCauseFirstThrowableProxyConverter.class.getName());
defaultConverterMap.put("throwable", ThrowableProxyConverter.class.getName());
defaultConverterMap.put("xEx", ExtendedThrowableProxyConverter.class.getName());
defaultConverterMap.put("xException", ExtendedThrowableProxyConverter.class.getName());
defaultConverterMap.put("xThrowable", ExtendedThrowableProxyConverter.class.getName());
defaultConverterMap.put("nopex", NopThrowableInformationConverter.class.getName());
defaultConverterMap.put("nopexception", NopThrowableInformationConverter.class.getName());
defaultConverterMap.put("cn", ContextNameConverter.class.getName());
defaultConverterMap.put("contextName", ContextNameConverter.class.getName());
defaultConverterMap.put("caller", CallerDataConverter.class.getName());
defaultConverterMap.put("marker", MarkerConverter.class.getName());
defaultConverterMap.put("property", PropertyConverter.class.getName());
defaultConverterMap.put("n", LineSeparatorConverter.class.getName());
defaultConverterMap.put("black", BlackCompositeConverter.class.getName());
defaultConverterMap.put("red", RedCompositeConverter.class.getName());
defaultConverterMap.put("green", GreenCompositeConverter.class.getName());
defaultConverterMap.put("yellow", YellowCompositeConverter.class.getName());
defaultConverterMap.put("blue", BlueCompositeConverter.class.getName());
defaultConverterMap.put("magenta", MagentaCompositeConverter.class.getName());
defaultConverterMap.put("cyan", CyanCompositeConverter.class.getName());
defaultConverterMap.put("white", WhiteCompositeConverter.class.getName());
defaultConverterMap.put("gray", GrayCompositeConverter.class.getName());
defaultConverterMap.put("boldRed", BoldRedCompositeConverter.class.getName());
defaultConverterMap.put("boldGreen", BoldGreenCompositeConverter.class.getName());
defaultConverterMap.put("boldYellow", BoldYellowCompositeConverter.class.getName());
defaultConverterMap.put("boldBlue", BoldBlueCompositeConverter.class.getName());
defaultConverterMap.put("boldMagenta", BoldMagentaCompositeConverter.class.getName());
defaultConverterMap.put("boldCyan", BoldCyanCompositeConverter.class.getName());
defaultConverterMap.put("boldWhite", BoldWhiteCompositeConverter.class.getName());
defaultConverterMap.put("highlight", HighlightingCompositeConverter.class.getName());
defaultConverterMap.put("lsn", LocalSequenceNumberConverter.class.getName());
}
public PatternLayout() {
this.postCompileProcessor = new EnsureExceptionHandling();
}
public Map<String, String> getDefaultConverterMap() {
return defaultConverterMap;
}
public String doLayout(ILoggingEvent event) {
if (!isStarted()) {
return CoreConstants.EMPTY_STRING;
}
return writeLoopOnConverters(event);
}
@Override
protected String getPresentationHeaderPrefix() {
return HEADER_PREFIX;
}
}
测试logback自带的颜色处理
上面的PatternLayout自带了一些颜色，我们测试下能否正常使用。
创建项目，添加logback依赖，配置文件和代码如下，可以看到输出的颜色被改变了。
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<!--使用%red()将要变色的模式包起来-->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<Pattern>%red(%d{yyyy-MM-dd HH:mm:ss}) %-5p %C:%L-%m%n</Pattern>
</encoder>
</appender>
<root level="debug">
<appender-ref ref="STDOUT"/>
</root>
</configuration>
public static void main(String[] args) {
Logger log = LoggerFactory.getLogger(Test.class);
log.info("日志");
}
可以看到，使用%red()将想变色的部分包起来，就会变色。这个颜色在idea的控制台，或者linux下能看到。
logback变色的实现原理
下面是ForegroundCompositeConverterBase的源码，可以看到它会在消息两端拼接上\033[xm这样的字符，和我们上面实例里手动拼接是一样的,所以才能展示不同的日志颜色。
public final static String ESC_START = "\033[";
public final static String ESC_END = "m";
String SET_DEFAULT_COLOR = ESC_START + "0;" + DEFAULT_FG + ESC_END;
@Override
protected String transform(E event, String in) {
StringBuilder sb = new StringBuilder();
sb.append(ESC_START);
sb.append(getForegroundColorCode(event));
sb.append(ESC_END);
sb.append(in);
sb.append(SET_DEFAULT_COLOR);
return sb.toString();
}
根据日志Level展示不同的颜色
SpringBoot是可以根据不同的日志级别展示不同颜色的，如error级别显示红色，info级别显示绿色。查看它的源码，发现它注册了自己写的Converter到logback里，名字叫clr。
<conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" />
配置Pattern是这样的,后面的{faint}是这个转换器的参数，通过getFirstOption()能获取到。
%clr(%d{${yyyy-MM-dd HH:mm:ss.SSS}}){faint}
这里逻辑很简单，她先调用getFirstOption()拿到配置的颜色，如果没有配置，则获取日志等级，从LEVELS里获取该等级对应的颜色，然后用该等级对应的颜色拼接在日志两端。
@Override
protected String transform(ILoggingEvent event, String in) {
//ELEMENTS是一个map
AnsiElement element = ELEMENTS.get(getFirstOption());
if (element == null) {
// LEVELS是一个map
element = LEVELS.get(event.getLevel().toInteger());
element = (element != null) ? element : AnsiColor.GREEN;
}
return toAnsiString(in, element);
}
MDC功能
servlet的线程模型是每个请求创建一个线程处理，如果我们在请求开始向ThreadLocal里存入一个值，则整个请求链都能拿到相同的值，利用这一点可以实现一个请求链显示同一种颜色的日志。
MDC就是slf4j提供的ThreadLocal，存入里面的值可以在配置中配置输出到日志里。我们可以在请求开始时存入颜色到MDC里，输出日志时根据我们配置的颜色输出。
实验MDC功能
在输出日志前将当前时间戳存入mdc，请求结束后移除mdc中对应的key。
public static void main(String[] args) {
//存入当前时间戳到MDC里，键为 mdc_key
MDC.put("mdc_key", String.valueOf(System.currentTimeMillis()));
Logger log = LoggerFactory.getLogger(Test.class);
log.info("日志");
MDC.remove("mdc_key");
}
logback里使用%X{}取出存入的值 。
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<Pattern>%X{mdc_key} %d{yyyy-MM-dd HH:mm:ss} %-5p %C:%L-%m%n</Pattern>
</encoder>
</appender>
使用MDC实现每个请求输出一种颜色
创建一个Converter 继承ForegroundCompositeConverterBase，并将此Converter配置到logback的配置文件里。
public class MdcColorConverter extends ForegroundCompositeConverterBase<ILoggingEvent> {
public static final String key = "MDCCOLORCONVERTER_KEY";
@Override
protected String getForegroundColorCode(ILoggingEvent event) {
//从event中获取MDCMap，再获取里面的key对应的值
String color = event.getMDCPropertyMap().get(key);
//如果没有返回默认颜色数值
if (color == null) {
return ANSIConstants.DEFAULT_FG;
}
//否则返回对应颜色的数值
return color;
}
}
创建一个filter，在请求进入servelt前，将随机颜色存入MDC内,并配置到spring里。
public class MdcColorFilter implements Filter {
private static List<String> list = new ArrayList<>();
private static AtomicInteger atm = new AtomicInteger();
{
list.add(ANSIConstants.MAGENTA_FG); //洋红/紫色
list.add(ANSIConstants.BLUE_FG); //蓝色
list.add(ANSIConstants.CYAN_FG); //青色
list.add(ANSIConstants.GREEN_FG); //绿色
list.add(ANSIConstants.YELLOW_FG); //黄色
list.add(ANSIConstants.RED_FG); //红色
}
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
try {
//循环调用list内的颜色
int index = atm.getAndIncrement() % list.size();
//将颜色对用的数值存入MDC
MDC.put(MdcColorConverter.key, list.get(Math.abs(index)));
chain.doFilter(request, response);
} finally {
//从MDC中删除键值
MDC.remove(MdcColorConverter.key);
}
}
}
创建一个servlet进行测试。
@RestController
public class TestController {
private static Logger logger = LoggerFactory.getLogger(TestController.class);
@RequestMapping("test")
public void test() {
logger.info("日志1");
logger.warn("日志1");
logger.error("日志1");
}
}
将Converter注册到logback上，配置如下,模式上使用我们注册的Converter将模式包起来。
<!-- 注册converter -->
<conversionRule conversionWord="mdcColor" converterClass="com.test.util.MdcColorConverter"/>
<property name="console_pattern" value="%mdcColor(%d{yyyy-MM-dd HH:mm:ss} %-5p %C:%L-%m%n)"/>
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>${console_pattern}</pattern>
</encoder>
</appender>
输出日志如下，每个请求一种颜色，非常便于人类查看。
总结
以上就是输出彩色日志的方法，除了输出到控制台，也可以输出到文件里，在linux下使用tail -f 查看文件，或者使用 less -r 查看就是彩色的，注意这里的less -r需要加-r参数才可以。
在本机调试时，因为只有自己访问，按照日志Level切换颜色看起来比较清晰，生产环境下，访问量大，多个请求日志之间的会交叉，使用MDC实现每个请求一种颜色比较便于人类观察。
1352
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
