Java日志（slf4j+logback）及打印彩色日志

一、maven依赖

在pom文件增加slf4j+logback依赖

<!-- 版本配置 -->
<properties><slf4j.version>1.7.21</slf4j.version><logback.version>1.1.7</logback.version>
</properties><dependencies><!-- slf4j依赖包 --><dependency><groupId>org.slf4j</groupId><artifactId>slf4j-api</artifactId><version>${slf4j.version}</version></dependency><!-- logback-classic桥接器 --><dependency><groupId>ch.qos.logback</groupId><artifactId>logback-classic</artifactId><version>${logback.version}</version></dependency><!-- logback实现 --><dependency><groupId>ch.qos.logback</groupId><artifactId>logback-core</artifactId><version>${logback.version}</version></dependency>
</dependencies>

二、logback配置文件

在类路径下建logback.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false"><property name="APP_NAME" value="MY_APP_NAME" /><property name="LOG_DIR" value="logs" /><property name="FILE_LOG_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS}  %-5level [%thread] %logger{15} - %msg%n" /><!-- 彩色日志格式 --><property name="CONSOLE_LOG_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} %highlight(%-5level) %boldYellow([%thread])  %cyan(%logger{15}) %msg%n"/><contextName>${APP_NAME}</contextName><appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"><encoder><pattern>${CONSOLE_LOG_PATTERN}</pattern></encoder></appender><appender name="FILE" class="ch.qos.logback.core.FileAppender"><file>${LOG_DIR}/logFile.log</file><append>true</append><encoder><pattern>${FILE_LOG_PATTERN}</pattern></encoder></appender><appender name="RollingFile" class="ch.qos.logback.core.rolling.RollingFileAppender"><rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"><fileNamePattern>${LOG_DIR}/dayLogFile.%d{yyyy-MM-dd}.log</fileNamePattern><maxHistory>30</maxHistory></rollingPolicy><encoder><pattern>${FILE_LOG_PATTERN}</pattern></encoder></appender><!-- 使用root的appender-ref --><logger name="com.example.Logger1" level="DEBUG" additivity="true"></logger><!-- 不使用root的appender-ref --><logger name="com.example.Logger2" level="DEBUG" additivity="false"></logger><logger name="com.example.Logger3" level="DEBUG" additivity="false"><appender-ref ref="STDOUT"/></logger><root level="DEBUG"><appender-ref ref="STDOUT" /><appender-ref ref="FILE" /><appender-ref ref="RollingFile" /></root>
</configuration>

三、测试

1.java类

Loggor1.java

package com.example;import org.slf4j.Logger;
import org.slf4j.LoggerFactory;public class Logger1 {private static Logger LOGGER = LoggerFactory.getLogger(Logger1.class);static {LOGGER.info("This is logger1");}
}

Loggor2.java

package com.example;import org.slf4j.Logger;
import org.slf4j.LoggerFactory;public class Logger2 {private static Logger LOGGER = LoggerFactory.getLogger(Logger2.class);static {LOGGER.info("This is logger2");}
}

Loggor3.java

package com.example;import org.slf4j.Logger;
import org.slf4j.LoggerFactory;public class Logger3 {private static Logger LOGGER = LoggerFactory.getLogger(Logger3.class);static {LOGGER.info("This is logger3");}
}

Main.java

package com.example;import org.slf4j.Logger;
import org.slf4j.LoggerFactory;public class Main {private static Logger LOGGER = LoggerFactory.getLogger(Main.class);public static void main(String[] args) {new Logger1();new Logger2();new Logger3();LOGGER.debug("this is debug");LOGGER.info("this is info");LOGGER.warn("this is warn");LOGGER.error("this is error");}
}

2.结果

四、logback配置说明

1.<configuration>节点

属性有：

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

2.<contextName>节点

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

3.<property>节点

用来定义变量值的标签

4.<logger>节点

<logger> 用来设置某一个包或者具体的某一个类的日志打印级别、以及指定<appender>。

<logger>可以包含零个或多个<appender-ref>元素，标识这个appender将会添加到这个logger。

属性有：

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

5.<root>节点

root节点和logger节点其实都是表示Logger组件，root是最顶层的logger。root节点只有一个level属性。

<root>可以包含零个或多个<appender-ref>元素，标识这个appender将会添加到这个logger。

属性有：

level: 用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，不能设置为INHERITED或者同义词NULL。默认是DEBUG。

6.<appender>节点

<appender> 是负责写日志的组件。<appender>有两个必要属性name和class。

属性有：

name: appender名称
class: appender的全限定名。

class取值有：

ch.qos.logback.core.ConsoleAppender
ch.qos.logback.core.FileAppender
ch.qos.logback.core.rolling.RollingFileAppender

7.ch.qos.logback.core.ConsoleAppender

节点有：

<encoder>：对日志进行格式化
<target>：字符串 System.out 或者 System.err ，默认 System.out

8.ch.qos.logback.core.FileAppender

FileAppender 把日志添加到文件

节点有：

<file>：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值
<append>：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true
<encoder>：对记录事件进行格式化
<prudent>：如果是 true，日志会被安全的写入文件，即使其他的FileAppender也在向此文件做写入操作，效率低，默认是 false

9.ch.qos.logback.core.rolling.RollingFileAppender

RollingFileAppender 滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件

节点有：

<file>：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
<append>：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。
<encoder>：对记录事件进行格式化。（具体参数稍后讲解）
<rollingPolicy>:当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名。
<triggeringPolicy >: 告知 RollingFileAppender 合适激活滚动。
<prudent>：当为true时，不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy，但是有两个限制，1不支持也不允许文件压缩，2不能设置file属性，必须留空。

<rollingPolicy>节点的class可取值：ch.qos.logback.core.rolling.TimeBasedRollingPolicy
TimeBasedRollingPolicy：最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。

TimeBasedRollingPolicy有子节点：

<fileNamePattern>: 必要节点，包含文件名及“%d”转换符， “%d”可以包含一个java.text.SimpleDateFormat指定的时间格式，如：%d{yyyy-MM}。如果直接使用 %d，默认格式是 yyyy-MM-dd。RollingFileAppender 的file字节点可有可无，通过设置file，可以为活动文件和归档文件指定不同位置，当前日志总是记录到file指定的文件（活动文件），活动文件的名字不会改变；如果没设置file，活动文件的名字会根据fileNamePattern的值，每隔一段时间改变一次。“/”或者“\”会被当做目录分隔符。
<maxHistory>: 可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件

10.<encoder>下<pattern>节点

<pattern>: 设置日志的输入格式。使用“%”加“转换符”方式，如果要输出“%”，则必须用“\”对“\%”进行转义。

logger：输出日志的logger名，可有一个整形参数，功能是缩短logger名
logger	c {length} lo {length} logger {length}	logger	com.example.Logger1 com.example.Main
		logger{0}	Logger1 Main
		logger{1}	c.e.Logger1 c.e.Main
		logger{14}	c.e.Logger1 c.example.Main
		logger{16}	c.e.Logger3 com.example.Main
		logger{17}	c.example.Logger1 com.example.Main
date：输出日志的时间
date	d {pattern } date {pattern }	%date	2020-10-15 19:36:17.491
date	d {pattern } date {pattern }	%date{yyyy-MM-dd HH:mm:ss.SSS}	2020-10-15 19:36:17.491
level：输出日志级别
level	p le level
thread：输出产生日志的线程名
thread	t thread
message：输出应用程序提供的信息
message	m msg message
n：输出平台相关的分行符“\n”或者“\r\n”
n	n
制表对齐
		%n	如果长度不够会在左边加空格
		%-n	如果长度不够会在右边加空格
		%.n	如果长度超过会从开头开始截取直到长度对应
		%.-n	如果长度超过会从结尾开始截取直到长度对应
		%n.m	第一种情况和第三种情况结合，1、2和3、4可以任意结合