1、日志门面SLF4J
因为存在各种各样的日志实现类,比如Log4j、Log4j2、Logback等,每个日志实现类提供的sdk又不一样,如果项目中的日志实现类由Log4j切换到Logback,则项目中日志打印的地方可能都要重新适配修改,这样做太缺乏灵活性和可拔插性了。Slf4j的引入就是为了解决这样的问题,Slf4j是一个日志门面工具,而不是具体的实现类,Slf4j后端兼容了常见的日志实现类,并对外提供统一的sdk,即代码中打印日志都使用Slf4j提供的接口,无论后端日志实现类换成哪个,都可以不用修改代码。拿Java中接口和实现类的概念类比,Slf4j相当于接口,Log4j、Log4j2、Logback相当于实现了这个接口的实现类。
使用时依赖包要引入SLF4J和某一个日志实现类的依赖,SpringBoot自带的日志实现类时logBack,如果非要使用Log4j在pom文件或者build.gradle文件中可以通过exclusion标签去除默认的日志实现类。以SpringBoot项目为例,引进依赖后,在项目的resource目录下新增日志实现类的配置文件,比如logback.xml,日志配置文件里可以定义日志滚动的策略(按天、按大小),日志输出的形式(控制台或者日志文件)、位置及日志打印的格式。
2、Logback配置文件
下面以一个配置项比较全的配置文件举例,实际开发中根据需要设置配置项,一般基本的配置项有:
- appender:一个相对整体的日志配置项的概念,比如打印到控制台的日志配置项集合对应一个appender,写到日志文件中的日志配置项集合对应一个appender;
- FILE_PATH:如果appender对应的日志文件的话,这个配置项就代表日志保存的目录;
- rollingPolicy:如果appender是RollingFileAppender,rollingPolicy就是指定日志滚动的策略,如果是按天滚动可以指定最多保留几天的日志,如果是按日志大小滚动可以指定日志分片的临界大小,同时也可以指定滚动产生的日志的文件名如何命名;
- pattern:日志中打印内容的具体格式,比如可以指定日期,日期也指定格式,打印线程id等;
- filter:在appender下的配置项,可以具体指定哪个logger的日志级别为某一个级别,细粒度控制;
- root:根logger,是所有logger的根logger,root对应的根logger可以设置日志级别,如果在配置文件中没有指定具体的logger对应的日志级别,默认会使用root logger对应的日志级别。 ```xml <?xml version=”1.0” encoding=”UTF-8” ?>
<!-- 设置变量FILE_PATH,用于指定名为FILE的appender的目的文件存放的目录 --><property name="FILE_PATH" value="D:/"></property><!--**********************配置TurboFilter类型的过滤器**********************************TurboFilter类型过滤器有三种:这里使用的是DuplicateMessageFilter子标签<cacheSize>:表示内部缓存对旧消息引用的个数上限子标签<allowedRepetitions>:表示允许消息出现的重复次数上限,超过次数上限的记录请求将被丢弃--><!-- 使用自定义的TurboFilter --><turboFilter class="logback.SampleTurboFilter"></turboFilter><!-- 使用DuplicateTurboFilter --><turboFilter class="ch.qos.logback.classic.turbo.DuplicateMessageFilter"><allowedRepetitions>1</allowedRepetitions><cacheSize>20</cacheSize></turboFilter><!-- ************************常用的Appender************************************** --><!--<appender>标签包含2个属性:name、classname属性:指定appender名称;class属性:指定目的地类型 (比如ConsoleAppender、FileAppender等)class属性的值决定了<appender>标签包含的子标签的种类。--><!-- 该appender的功能是将记录信息以特定格式写到控制台 --><appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"><!--encoder:将事件转换为字符串默认配置为PatternLayoutEncoder类encoder用于替代Layout,encoder扩展了Layout功能Layout功能:只负责把事件转换为字符串,但是不能指定何时将记录写入到指定目的地encoder功能:即负责把事件转换为字符串,也可以指定何时将记录写入到指定目的地--><encoder><!-- 指定输出格式%d{} :表示时间%thread:请求记录所在的线程名%-5level:用5位显示请求级别%logger{36}:输出logger名,{36}表示logger名最大占用的字符位数,{0}表示最简短logger名(不包含包名)。--><pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{0} -%msg%n</pattern></encoder></appender><!-- 该appender的功能是将记录信息以特定格式写到文件 --><appender name="FILE" class="ch.qos.logback.core.FileAppender"><!-- $使用变量FILE_PATH的格式,类似Linux中使用的格式:${FILE_PATH} --><file>${FILE_PATH}/file.log</file><encoder><!-- 指定输出格式 --><pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{0} -%msg%n</pattern></encoder></appender><!--***********************以最小窗体为指定的滚动规则的appender*****************************RollingFileAppender类型的appender中必须包含4个子标签:<file>、<rollingPolicy>、<triggerPolicy>、<encoder><rollingPolicy>标签用于指定滚动规则,该标签有一个属性class:用于指定实现具体的滚动规则的类。<triggerPolicy>标签用于指定发生滚动的条件,该标签有一个属性class:用于指定具体滚动条件的类。<rollingPolicy>和<triggerPolicy>中具体包含哪些子标签是由class属性指定的类来决定的,因为不同的类有不同的参数,从而需要不同的标签来传参--><!-- 该appender的功能是将记录信息以特定格式写到文件,当文件达到20MB时,创建以特定规则新的 文件,之后的记录会写到新文件--><appender name="rollingFile" class="ch.qos.logback.core.rolling.RollingFileAppender"><!-- 在第一次触发滚动之前记录将会写到该文件中 --><file>${FILE_PATH}/rolling.log</file><!--前提条件:class的值为FixedWindowRollingPolicy,表示以最小窗体为指定的滚动规则RollingPolicy标签必须子标签:<fileNamePattern>、<minIndex>、<maxIndex><fileNamePattern>:表示滚动条件达到后,创建文件名的规则,其中"%i"代表数字1~5。第一次触发条件,创建文件rolling1.log,并且记录开始写到这个文件中<minIndex>与<maxIndex>共同决定了文件的个数--><rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"><fileNamePattern>${FILE_PATH}/rolling%i.log</fileNamePattern><minIndex>1</minIndex><maxIndex>5</maxIndex></rollingPolicy><!--<triggeringPolicy>功能:用于限制文件大小前提条件:class的值为SizeBasedTriggeringPolicy,表示以文件大小为触发条件只有一个子标签<maxFileSize>用于指定触发条件--><triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"><maxFileSize>20MB</maxFileSize></triggeringPolicy><encoder><pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{0} -%msg%n</pattern></encoder></appender><!--*****************************根据时间滚动 为滚动规则和条件的appender(最常用)***********************--><!-- 该appender的功能:将记录信息以特定格式写到文件,当文件达到20MB时,创建以时间为特定规则新的 文件,之后的记录会写到新文件,文件个数最多维持10个,文件达到10个 后删除旧的文件--><appender name="time_file" class="ch.qos.logback.core.rolling.RollingFileAppender"><!-- TimeBasedRollingPolicy实现了RollingPolicy与TriggeringPolicy,因此只需要<rollingPolicy>标签,不需要<TriggeringPolicy>标签<rollingPolicy>标签有两个子标签:<fileNamePattern>、<maxHistory><fileNamePattern>:用于指定文件名命名规则<maxHistory>:保留文件的个数,超过了就删除创建时间最久的文件--><rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"><!-- 文件名 --><fileNamePattern>${FILE_PATH}/java_log/test%d{yyyy-MM-dd_HH-mm}.log</fileNamePattern><maxHistory>10</maxHistory></rollingPolicy><encoder><pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{0} -%msg%n</pattern></encoder></appender><!--***********************常规级别过滤器的使用****************************************本配置功能:过滤并接受请求级别为debug的请求,对于其他级别请求一律丢弃。--><appender name="level_console" class="ch.qos.logback.core.ConsoleAppender"><filter class="ch.qos.logback.classic.filter.LevelFilter"><level>debug</level><onMatch>ACCEPT</onMatch><onMismatch>DENY</onMismatch></filter><encoder><pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{0} -%msg%n</pattern></encoder></appender><!--***********************常规临界值滤器的使用****************************************本配置功能:请求级别高于或等于info的请求响应NEUTRAL(进入下一个环节),低于info的级别请求响应DENY(表示丢弃)。--><appender name="threshold_console" class="ch.qos.logback.core.ConsoleAppender"><filter class="ch.qos.logback.classic.filter.ThresholdFilter"><level>info</level></filter><encoder><pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{0} -%msg%n</pattern></encoder></appender><!-- appender的目的地为mysql数据库 --><appender name="jdbc" class="ch.qos.logback.classic.db.DBAppender"><!-- 这里只使用jdbc中的DriverManager获得连接,不使用任何数据源 --><connectionSource class="ch.qos.logback.core.db.DriverManagerConnectionSource"><driverClass>com.mysql.jdbc.Driver</driverClass><url>jdbc:mysql://localhost:3306/logback?useUnicode=true&characterEncoding=utf8&serverTimezone=UTC</url><user>root</user><password>Zp970321</password></connectionSource></appender><!-- ******以下DBAppender类型的appender的目的地为mysql数据库******** --><appender name="c3p0_datasource" class="ch.qos.logback.classic.db.DBAppender"><!-- 这里使用DataSource获得连接--><connectionSource class="ch.qos.logback.core.db.DataSourceConnectionSource"><!-- 实现DataSource的数据库连接池有很多,比如DBCP、c3p0、Druid等这里使用的是c3p0--><dataSource class="com.mchange.v2.c3p0.ComboPooledDataSource"><user>root</user><password>Zp970321</password><driverClass>com.mysql.jdbc.Driver</driverClass><jdbcUrl>jdbc:mysql://localhost:3306/logback?useUnicode=true&characterEncoding=utf8</jdbcUrl></dataSource></connectionSource></appender><appender name="Druid_datasource" class="ch.qos.logback.classic.db.DBAppender"><!-- 这里使用DataSource获得连接--><connectionSource class="ch.qos.logback.core.db.DataSourceConnectionSource"><!-- 实现DataSource的数据库连接池有很多,比如DBCP、c3p0、Druid等这里使用的是Druid--><dataSource class="com.alibaba.druid.pool.DruidDataSource"><username>root</username><password>Zp970321</password><driverClassName>com.mysql.jdbc.Driver</driverClassName><url>jdbc:mysql://localhost:3306/logback?useUnicode=true&characterEncoding=utf8</url></dataSource></connectionSource></appender><appender name="dbcp_datasource" class="ch.qos.logback.classic.db.DBAppender"><!-- 这里使用DataSource获得连接--><connectionSource class="ch.qos.logback.core.db.DataSourceConnectionSource"><!-- 实现DataSource的数据库连接池有很多,比如DBCP、c3p0、Druid等这里使用的是dbcp--><dataSource class="org.apache.commons.dbcp.BasicDataSource"><username>root</username><password>Zp970321</password><driverClassName>com.mysql.jdbc.Driver</driverClassName><url>jdbc:mysql://localhost:3306/logback?useUnicode=true&characterEncoding=utf8</url></dataSource></connectionSource></appender><!-- level属性:指定根logger的分配级别 --><root level="debug"><!-- ref属性:指定根logger关联的appender --><appender-ref ref="STDOUT"></appender-ref></root><!-- name:指定logger名称;level:指定logger的分配级别;additivity(非必须,默认为true):设置appender叠加性 --><logger name="demo" level="debug" additivity="false"><appender-ref ref="FILE"></appender-ref></logger><logger name="demo2" level="debug"><appender-ref ref="rollingFile"></appender-ref></logger><logger name="demo3" level="debug"><appender-ref ref="time_file"></appender-ref></logger><logger name="demo4" level="debug" additivity="false"><appender-ref ref="level_console"></appender-ref></logger><logger name="demo5" level="debug" additivity="false"><appender-ref ref="threshold_console"></appender-ref></logger><logger name="demo6" level="debug" additivity="false"><appender-ref ref="jdbc"></appender-ref></logger><logger name="demo7" level="debug" additivity="false"><appender-ref ref="c3p0_datasource"></appender-ref></logger><logger name="demo8" level="debug" additivity="false"><appender-ref ref="Druid_datasource"></appender-ref></logger><logger name="demo9" level="debug" additivity="false"><appender-ref ref="dbcp_datasource"></appender-ref></logger>
