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” ?>

logback

  1. <!-- 设置变量FILE_PATH,用于指定名为FILE的appender的目的文件存放的目录 -->
  2. <property name="FILE_PATH" value="D:/"></property>
  3. <!--
  4. **********************配置TurboFilter类型的过滤器**********************************
  5. TurboFilter类型过滤器有三种:这里使用的是DuplicateMessageFilter
  6. 子标签<cacheSize>:表示内部缓存对旧消息引用的个数上限
  7. 子标签<allowedRepetitions>:表示允许消息出现的重复次数上限,超过次数上限的记录请求将被丢弃
  8. -->
  9. <!-- 使用自定义的TurboFilter -->
  10. <turboFilter class="logback.SampleTurboFilter">
  11. </turboFilter>
  12. <!-- 使用DuplicateTurboFilter -->
  13. <turboFilter class="ch.qos.logback.classic.turbo.DuplicateMessageFilter">
  14. <allowedRepetitions>1</allowedRepetitions>
  15. <cacheSize>20</cacheSize>
  16. </turboFilter>
  17. <!-- ************************常用的Appender************************************** -->
  18. <!--
  19. <appender>标签包含2个属性:name、class
  20. name属性:指定appender名称;class属性:指定目的地类型 (比如ConsoleAppender、FileAppender等)
  21. class属性的值决定了<appender>标签包含的子标签的种类。
  22. -->
  23. <!-- 该appender的功能是将记录信息以特定格式写到控制台 -->
  24. <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
  25. <!--encoder:将事件转换为字符串
  26. 默认配置为PatternLayoutEncoder类
  27. encoder用于替代Layout,encoder扩展了Layout功能
  28. Layout功能:只负责把事件转换为字符串,但是不能指定何时将记录写入到指定目的地
  29. encoder功能:即负责把事件转换为字符串,也可以指定何时将记录写入到指定目的地
  30. -->
  31. <encoder>
  32. <!-- 指定输出格式
  33. %d{} :表示时间
  34. %thread:请求记录所在的线程名
  35. %-5level:用5位显示请求级别
  36. %logger{36}:输出logger名,{36}表示logger名最大占用的字符位数,{0}表示最简短logger名(不包含包名)。
  37. -->
  38. <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{0} -%msg%n</pattern>
  39. </encoder>
  40. </appender>
  41. <!-- 该appender的功能是将记录信息以特定格式写到文件 -->
  42. <appender name="FILE" class="ch.qos.logback.core.FileAppender">
  43. <!-- $使用变量FILE_PATH的格式,类似Linux中使用的格式:${FILE_PATH} -->
  44. <file>${FILE_PATH}/file.log</file>
  45. <encoder>
  46. <!-- 指定输出格式 -->
  47. <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{0} -%msg%n</pattern>
  48. </encoder>
  49. </appender>
  50. <!--
  51. ***********************以最小窗体为指定的滚动规则的appender*****************************
  52. RollingFileAppender类型的appender中必须包含4个子标签:<file>、<rollingPolicy>、<triggerPolicy>、<encoder>
  53. <rollingPolicy>标签用于指定滚动规则,该标签有一个属性class:用于指定实现具体的滚动规则的类。
  54. <triggerPolicy>标签用于指定发生滚动的条件,该标签有一个属性class:用于指定具体滚动条件的类。
  55. <rollingPolicy>和<triggerPolicy>中具体包含哪些子标签是由class属性指定的类来决定的,因为不同的类有不同的参数,从而需要不同的标签来传参
  56. -->
  57. <!-- 该appender的功能是将记录信息以特定格式写到文件,当文件达到20MB时,创建以特定规则新的 文件,之后的记录会写到新文件-->
  58. <appender name="rollingFile" class="ch.qos.logback.core.rolling.RollingFileAppender">
  59. <!-- 在第一次触发滚动之前记录将会写到该文件中 -->
  60. <file>${FILE_PATH}/rolling.log</file>
  61. <!--
  62. 前提条件:class的值为FixedWindowRollingPolicy,表示以最小窗体为指定的滚动规则
  63. RollingPolicy标签必须子标签:<fileNamePattern>、<minIndex>、<maxIndex>
  64. <fileNamePattern>:表示滚动条件达到后,创建文件名的规则,其中"%i"代表数字1~5。第一次触发条件,创建文件rolling1.log,并且记录开始写到这个文件中
  65. <minIndex>与<maxIndex>共同决定了文件的个数
  66. -->
  67. <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
  68. <fileNamePattern>${FILE_PATH}/rolling%i.log</fileNamePattern>
  69. <minIndex>1</minIndex>
  70. <maxIndex>5</maxIndex>
  71. </rollingPolicy>
  72. <!--
  73. <triggeringPolicy>功能:用于限制文件大小
  74. 前提条件:class的值为SizeBasedTriggeringPolicy,表示以文件大小为触发条件
  75. 只有一个子标签<maxFileSize>用于指定触发条件
  76. -->
  77. <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
  78. <maxFileSize>20MB</maxFileSize>
  79. </triggeringPolicy>
  80. <encoder>
  81. <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{0} -%msg%n</pattern>
  82. </encoder>
  83. </appender>
  84. <!--
  85. *****************************根据时间滚动 为滚动规则和条件的appender(最常用)***********************
  86. -->
  87. <!-- 该appender的功能:将记录信息以特定格式写到文件,当文件达到20MB时,创建以时间为特定规则新的 文件,之后的记录会写到新文件,
  88. 文件个数最多维持10个,文件达到10个 后删除旧的文件-->
  89. <appender name="time_file" class="ch.qos.logback.core.rolling.RollingFileAppender">
  90. <!-- TimeBasedRollingPolicy实现了RollingPolicy与TriggeringPolicy,
  91. 因此只需要<rollingPolicy>标签,不需要<TriggeringPolicy>标签
  92. <rollingPolicy>标签有两个子标签:<fileNamePattern>、<maxHistory>
  93. <fileNamePattern>:用于指定文件名命名规则
  94. <maxHistory>:保留文件的个数,超过了就删除创建时间最久的文件
  95. -->
  96. <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  97. <!-- 文件名 -->
  98. <fileNamePattern>${FILE_PATH}/java_log/test%d{yyyy-MM-dd_HH-mm}.log</fileNamePattern>
  99. <maxHistory>10</maxHistory>
  100. </rollingPolicy>
  101. <encoder>
  102. <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{0} -%msg%n</pattern>
  103. </encoder>
  104. </appender>
  105. <!--
  106. ***********************常规级别过滤器的使用****************************************
  107. 本配置功能:过滤并接受请求级别为debug的请求,对于其他级别请求一律丢弃。
  108. -->
  109. <appender name="level_console" class="ch.qos.logback.core.ConsoleAppender">
  110. <filter class="ch.qos.logback.classic.filter.LevelFilter">
  111. <level>debug</level>
  112. <onMatch>ACCEPT</onMatch>
  113. <onMismatch>DENY</onMismatch>
  114. </filter>
  115. <encoder>
  116. <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{0} -%msg%n</pattern>
  117. </encoder>
  118. </appender>
  119. <!--
  120. ***********************常规临界值滤器的使用****************************************
  121. 本配置功能:请求级别高于或等于info的请求响应NEUTRAL(进入下一个环节),低于info的级别请求响应DENY(表示丢弃)。
  122. -->
  123. <appender name="threshold_console" class="ch.qos.logback.core.ConsoleAppender">
  124. <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
  125. <level>info</level>
  126. </filter>
  127. <encoder>
  128. <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{0} -%msg%n</pattern>
  129. </encoder>
  130. </appender>
  131. <!-- appender的目的地为mysql数据库 -->
  132. <appender name="jdbc" class="ch.qos.logback.classic.db.DBAppender">
  133. <!-- 这里只使用jdbc中的DriverManager获得连接,不使用任何数据源 -->
  134. <connectionSource class="ch.qos.logback.core.db.DriverManagerConnectionSource">
  135. <driverClass>com.mysql.jdbc.Driver</driverClass>
  136. <url>jdbc:mysql://localhost:3306/logback?useUnicode=true&characterEncoding=utf8&serverTimezone=UTC</url>
  137. <user>root</user>
  138. <password>Zp970321</password>
  139. </connectionSource>
  140. </appender>
  141. <!-- ******以下DBAppender类型的appender的目的地为mysql数据库******** -->
  142. <appender name="c3p0_datasource" class="ch.qos.logback.classic.db.DBAppender">
  143. <!-- 这里使用DataSource获得连接-->
  144. <connectionSource class="ch.qos.logback.core.db.DataSourceConnectionSource">
  145. <!-- 实现DataSource的数据库连接池有很多,比如DBCP、c3p0、Druid等
  146. 这里使用的是c3p0
  147. -->
  148. <dataSource class="com.mchange.v2.c3p0.ComboPooledDataSource">
  149. <user>root</user>
  150. <password>Zp970321</password>
  151. <driverClass>com.mysql.jdbc.Driver</driverClass>
  152. <jdbcUrl>jdbc:mysql://localhost:3306/logback?useUnicode=true&characterEncoding=utf8</jdbcUrl>
  153. </dataSource>
  154. </connectionSource>
  155. </appender>
  156. <appender name="Druid_datasource" class="ch.qos.logback.classic.db.DBAppender">
  157. <!-- 这里使用DataSource获得连接-->
  158. <connectionSource class="ch.qos.logback.core.db.DataSourceConnectionSource">
  159. <!-- 实现DataSource的数据库连接池有很多,比如DBCP、c3p0、Druid等
  160. 这里使用的是Druid
  161. -->
  162. <dataSource class="com.alibaba.druid.pool.DruidDataSource">
  163. <username>root</username>
  164. <password>Zp970321</password>
  165. <driverClassName>com.mysql.jdbc.Driver</driverClassName>
  166. <url>jdbc:mysql://localhost:3306/logback?useUnicode=true&characterEncoding=utf8</url>
  167. </dataSource>
  168. </connectionSource>
  169. </appender>
  170. <appender name="dbcp_datasource" class="ch.qos.logback.classic.db.DBAppender">
  171. <!-- 这里使用DataSource获得连接-->
  172. <connectionSource class="ch.qos.logback.core.db.DataSourceConnectionSource">
  173. <!-- 实现DataSource的数据库连接池有很多,比如DBCP、c3p0、Druid等
  174. 这里使用的是dbcp
  175. -->
  176. <dataSource class="org.apache.commons.dbcp.BasicDataSource">
  177. <username>root</username>
  178. <password>Zp970321</password>
  179. <driverClassName>com.mysql.jdbc.Driver</driverClassName>
  180. <url>jdbc:mysql://localhost:3306/logback?useUnicode=true&characterEncoding=utf8</url>
  181. </dataSource>
  182. </connectionSource>
  183. </appender>
  184. <!-- level属性:指定根logger的分配级别 -->
  185. <root level="debug">
  186. <!-- ref属性:指定根logger关联的appender -->
  187. <appender-ref ref="STDOUT"></appender-ref>
  188. </root>
  189. <!-- name:指定logger名称;level:指定logger的分配级别;additivity(非必须,默认为true):设置appender叠加性 -->
  190. <logger name="demo" level="debug" additivity="false">
  191. <appender-ref ref="FILE"></appender-ref>
  192. </logger>
  193. <logger name="demo2" level="debug">
  194. <appender-ref ref="rollingFile"></appender-ref>
  195. </logger>
  196. <logger name="demo3" level="debug">
  197. <appender-ref ref="time_file"></appender-ref>
  198. </logger>
  199. <logger name="demo4" level="debug" additivity="false">
  200. <appender-ref ref="level_console"></appender-ref>
  201. </logger>
  202. <logger name="demo5" level="debug" additivity="false">
  203. <appender-ref ref="threshold_console"></appender-ref>
  204. </logger>
  205. <logger name="demo6" level="debug" additivity="false">
  206. <appender-ref ref="jdbc"></appender-ref>
  207. </logger>
  208. <logger name="demo7" level="debug" additivity="false">
  209. <appender-ref ref="c3p0_datasource"></appender-ref>
  210. </logger>
  211. <logger name="demo8" level="debug" additivity="false">
  212. <appender-ref ref="Druid_datasource"></appender-ref>
  213. </logger>
  214. <logger name="demo9" level="debug" additivity="false">
  215. <appender-ref ref="dbcp_datasource"></appender-ref>
  216. </logger>

```

参考

logback的xml配置文件模板(超详细)