Java 日志框架 logback
文章目录
-
- logback概述
- 日志等级(五个)
- 相关组件
- Logback配置文件(XML)
- RootLogger设置
- Appender
-
- ConsoleAppender
- FileAppender(自定义格式与HTML)
- RollingFileAppender
- Filter
-
- LevelFilter
- 异步日志配置
- 自定义Logger
- 简单使用logback(无配置文件)
- 配合配置文件使用logback
- log4j.properties转logback.xml
- Logback的access模块
- 认识access模块
- 使用access模块
- 总结
原文链接： https://changlu.blog.csdn.net/article/details/114860566
logback概述
官方网站：https://logback.qos.ch/index.html
Logback：同样是log4j创始人离开Apache之后设计的开源日志组件，其性能比Log4j要好。
logback分为三个模块：logback-core，logback-classic和logback-access
logback-core：为其他两个模块奠定基础
logback-classic：它是log4j的一个改良版本，同时它完整实现了slf4j API。
logback-access：访问模块与Servlet容器集成提供通过Http来访问日志的功能。
现如今日志框架都是通过slf4j日志门面来搭建日志系统的，在大多引入日志实现框架中都包含了slf4j-api的依赖，之后主要通过修改配置文件以及pom.xml。
日志等级(五个)
package ch.qos.logback.classic;
public final class Level implements Serializable {
public static final Level OFF = new Level(2147483647, "OFF");
public static final Level ERROR = new Level(40000, "ERROR");
public static final Level WARN = new Level(30000, "WARN");
public static final Level INFO = new Level(20000, "INFO");
public static final Level DEBUG = new Level(10000, "DEBUG");
public static final Level TRACE = new Level(5000, "TRACE");
public static final Level ALL = new Level(-2147483648, "ALL");
...
}
日志级别排序为：TRACE< DEBUG<INFO< WARN< ERROR。默认日志等级为Debug，其中OFF与ALL作为日志开关。
相关组件
在logback中也包含三个组件Logger、Appender以及Layout，与Log4j大同小异：
Logger：日志记录器，把它关联到应用的对应的context上后，主要用于存放日志对象，也可以定义日志类型、级别。
Appender：用于指定日志输出的目的地，目的地可以是控制台、文件、数据库等等。
Layout：负责把事件转换成字符串，格式化的日志信息的输出，在Logback中Layout对象被封装在encoder中。
Logback配置文件(XML)
在使用logback日志框架会默认读取以下类型的配置文件：
logback.groovylogback-test.xmllogback.xml
若是均不存在会采用默认配置，日志等级为DEBUG，默认输出到console。
一般创建logback.xml(Maven项目放置到resource下)
<configuration>
configuration>
RootLogger设置
root基本設置
<root level="ALL">
<appender-ref ref="console"/>
root>
配置键值对以及进行获取对应键的值
<property name="pattern" value="%-5level %d{yyyy-MM-dd HH:mm:ss.SSS} %c %M %L [%thread] %m%n"/>
<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>${pattern}pattern>
encoder>
appender>
- 注意看①②，在②中引用预先配置的
property，使用${}获取其中的value值
日志输出格式
<property name="pattern" value="%-5level %d{yyyy-MM-dd HH:mm:ss.SSS} %c %M %L [%thread] %m%n"/>
Appender
ConsoleAppender：输出到屏幕。FileAppender：输出到指定文件。RollingFileAppender：可定时创建文件以及按文件大小进行切割。
ConsoleAppender
目的：输出到屏幕上。
配置logback.xml：
实例演示
<configuration>
<property name="pattern" value="%-5level %d{yyyy-MM-dd HH:mm:ss.SSS} %c %M %L [%thread] %m%n"/>
<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
<target>System.errtarget>
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>${pattern}pattern>
encoder>
appender>
<root level="ALL">
<appender-ref ref="console"/>
<appender-ref ref="file"/>
root>
configuration>
运行程序：
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class LogTest {
//获取Logger实例
public static final Logger LOGGER = LoggerFactory.getLogger(LogTest.class);
public static void main(String[] args) {
//为了效果明显循环10000次
for (int i = 0; i < 10000; i++) {
LOGGER.error("error");
LOGGER.warn("warn");
LOGGER.info("info");
LOGGER.debug("debug");
LOGGER.trace("trace");
}
}
}
FileAppender(自定义格式与HTML)
目的：日志输出到文件中。
针对于FileAppender其中append = true(可追加)、FileSize bufferSize = new FileSize(8192);(缓冲大小)。
- FileAppender本身类中包含
setFile()，其父类OutputStreamAppender包含setEncoder。
输出到文件其格式为自定义格式(
PatternLayoutEncoder)
<property name="log_dir" value="d:/logs"/>
<property name="pattern" value="%-5level %d{yyyy-MM-dd HH:mm:ss.SSS} %c %M %L [%thread] %m%n"/>
<appender name="file" class="ch.qos.logback.core.FileAppender">
<file>${log_dir}/logback.logfile>
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>${pattern}pattern>
encoder>
appender>
<root level="ALL">
<appender-ref ref="console"/>
<appender-ref ref="file"/>
root>
- 输出程序可见下面的3.2，对应的键值对设置无非对应指定类或其父类的相关set方法可见源码。
输出到文件其格式为HTML格式(
LayoutWrappingEncoder中包含Layout为HTMLLayout)
<property name="log_dir" value="d:/logs"/>
<property name="pattern" value="%-5level %d{yyyy-MM-dd HH:mm:ss.SSS} %c %M %L [%thread] %m%n"/>
<appender name="htmlFile" class="ch.qos.logback.core.FileAppender">
<file>${log_dir}/logback.htmlfile>
<encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
<layout class="ch.qos.logback.classic.html.HTMLLayout">
<pattern>%-5level%d{yyyy-MM-dd HH:mm:ss.SSS}%c%M%L%thread%mpattern>
layout>
encoder>
appender>
<root level="ALL">
<appender-ref ref="console"/>
<appender-ref ref="htmlFile"/>
root>
- 测试程序见3.2，对应标签设置无非就是对应set方法。
- 在
ch.qos.logback.core.encoder.LayoutWrappingEncoder中包含layout可设置对应的htmllayout。
RollingFileAppender
目的：可定时创建文件以及按文件大小进行切割。
RollingFileAppender类实现了FileAppender，即具有FileAppender可设置的属性内容如Encoder、file(输出路径)
<property name="log_dir" value="d:/logs"/>
<appender name="rollingFile" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${log_dir}/roll_logback.logfile>
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>${pattern}pattern>
encoder>
<RollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<fileNamePattern>${log_dir}/rolling.%d{yyyy-MM-dd-hh-mm-ss}.log%i.gzfileNamePattern>
<maxFileSize>1MBmaxFileSize>
RollingPolicy>
appender>
<root level="ALL">
<appender-ref ref="rollingFile"/>
root>
- 第13行：设置的日志文件拆分与压缩规则类，其包含两个属性
fileNamePattern可确定分割文件的名称以及分割的时间(分割上面file文件)，maxFileSize可设置单个文件的大小，这里最大为1MB。
测试程序：
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class LogTest {
//获取Logger实例
public static final Logger LOGGER = LoggerFactory.getLogger(LogTest.class);
public static void main(String[] args) {
//为了效果明显循环10000次
for (int i = 0; i < 10000; i++) {
LOGGER.error("error");
LOGGER.warn("warn");
LOGGER.info("info");
LOGGER.debug("debug");
LOGGER.trace("trace");
}
}
}
Filter
目的：用来进行过滤指定日志等级的日志记录。
Filter可设置在任意的appender中，如下：
EvaluatorFilter：临界过滤器，滤掉低于指定临界值的日志。LevelFilter：级别过滤器，对特定某个级别的日志进行过滤。
LevelFilter
配置说明
配置LevelFilter的三个属性介绍：
level：设置过滤的日志等级。
onMatch：匹配日志等级时执行操作。
onMismatch：不匹配日志等级时执行操作。
其中onMatch、onMismatch对应表示使用的是指定的枚举值(三个)：
DENY：日志将立即被抛弃不再经过其他过滤器。(否定含义)
NEUTRAL：有序列表里的下个过滤器过接着处理日志；（该级别既不处理，也不抛弃，相当于没有任何处理，日志会被保存下来并在本appender被执行）(中立的)
ACCEPT：日志会被立即处理，不再经过剩余过滤器。(通过含义)
实例使用
要求：只将error日志等级输出到文件中。
logback.xml配置如下：
<configuration>
<appender name="file" class="ch.qos.logback.core.FileAppender">
<file>${log_dir}/logback.logfile>
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>${pattern}pattern>
encoder>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>errorlevel>
<onMatch>ACCEPTonMatch>
<onMismatch>DENYonMismatch>
filter>
appender>
<root level="ALL">
<appender-ref ref="file"/>
root>
configuration>
测试程序：
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class LogTest {
//获取Logger实例
public static final Logger LOGGER = LoggerFactory.getLogger(LogTest.class);
public static void main(String[] args) {
for (int i = 0; i < 10000; i++) {
LOGGER.error("error");
LOGGER.warn("warn");
LOGGER.info("info");
LOGGER.debug("debug");
LOGGER.trace("trace");
}
}
}
原理分析
上面配置的是LevelFilter类，我们看下该类包含的属性：
- 可以看到
LevelFilter类中包含level属性及set方法。
LevelFilter父类AbstractMatcherFilter包含了onMatch、onMismatch属性及set方法。
可以看到其默认值为FilterReply.NEUTRAL对应的是枚举类，我们再去看下枚举类：
- 对应着三个实例，对应含义见上。
异步日志配置
介绍
我们之前打印日志使用的都是同步日志，而对于高并发低延迟要求的系统中我们可以设置异步。
异步：打印日志时候是把打印任务放入内存队列后就直接返回了，而不像同步日志一样会每次直接进行写磁盘。
实例使用
对FileAppender使用异步日志，logback.xml配置如下：
<configuration>
<appender name="file" class="ch.qos.logback.core.FileAppender">
<file>${log_dir}/logback.logfile>
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>${pattern}pattern>
encoder>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>errorlevel>
<onMatch>ACCEPTonMatch>
<onMismatch>DENYonMismatch>
filter>
appender>
<appender name="async" class="ch.qos.logback.classic.AsyncAppender">
<discardingThreshold>0discardingThreshold>
<queueSize>1024queueSize>
<neverBlock>trueneverBlock>
<appender-ref ref="file"/>
appender>
<root level="ALL">
<appender-ref ref="file"/>
root>
configuration>
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class LogTest {
//获取Logger实例
public static final Logger LOGGER = LoggerFactory.getLogger(LogTest.class);
public static void main(String[] args) {
for (int i = 0; i < 10000; i++) {
LOGGER.error("error");
LOGGER.warn("warn");
LOGGER.info("info");
LOGGER.debug("debug");
LOGGER.trace("trace");
}
}
}
说明：通常对于在进行高并发情况下使用异步日志！
源码初探
通过使用appender为AsyncAppender来引用配置文件中定义的appender来达到异步效果，首先看下AsyncAppender的继承关系：
AsyncAppender类中包含一个配置属性：
AsyncAppender的父类AsyncAppenderBase包含的配置属性：
- 对应属性描述如下：
<queueSize>512queueSize>
<discardingThreshold>0discardingThreshold>
<maxFlushTime>1000maxFlushTime>
<neverBlock>trueneverBlock>
<includeCallerData>trueincludeCallerData>
<appender-ref ref="file"/>
其中需要知道的是在异步日志器中属性包含了BlockingQueue接口即队列，该接口有多个实现类：
在AsyncAppenderBase的start()方法，默认获取了ArrayBlockingQueue这个实现类：
许多配置信息其实间接的与这个队列实现类有关！！！这里暂时了解即可，不再进行深入探究。
自定义Logger
介绍
目的：根据不同的业务需求时可进行自定义Logger，例如自己定义的消息使用自定义输出到控制台，对于系统的消息可输出到日志文件。可通过使用LoggerFactory.getLogger(指定类或包名);来获取指定配置的logger实例。
使用方式
<logger name="xyz.changlu" level="debug" additivity="false">
<appender-ref ref="console"/>
logger>
- 这里使用
additivity：设置一个布尔值表示是否要继承RootLogger。
简单使用logback(无配置文件)
首先引入依赖slf4j-api(方便统一API)，接着引入logback-classic模块：
<dependencies>
<dependency>
<groupId>org.slf4jgroupId>
<artifactId>slf4j-apiartifactId>
<version>1.7.30version>
dependency>
<dependency>
<groupId>ch.qos.logbackgroupId>
<artifactId>logback-classicartifactId>
<version>1.2.3version>
dependency>
dependencies>
- 其实
slf4j-classic中包含了slf4j-api的依赖，但是为了进行日志API的统一管理才单独引入slf4j-api的依赖。(这样想，若是你不导入单独的slf4j-api的依赖，之后更换日志框架也随着对应不同的slf4j-api的依赖引入出现问题)
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class LogTest {
//获取Logger实例
public static final Logger LOGGER = LoggerFactory.getLogger(LogTest.class);
public static void main(String[] args) {
LOGGER.error("error");
LOGGER.warn("warn");
LOGGER.info("info");
LOGGER.debug("debug");
LOGGER.trace("trace");
}
}
日志等级默认为debug。
配合配置文件使用logback
新建logback.xml放置在resource目录下：
<configuration>
<property name="pattern" value="%-5level %d{yyyy-MM-dd HH:mm:ss.SSS} %c %M %L [%thread] %m%n"/>
<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
<target>System.errtarget>
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>${pattern}pattern>
encoder>
appender>
<root level="ALL">
<appender-ref ref="console"/>
root>
configuration>
- 设置了
root的日志等级为ALL，appender引用的是consoleappender，该appender设置了输出流对象以及日志格式配置(自定义日志格式布局，格式也是进行的引用)。
测试程序
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class LogTest {
//获取Logger实例
public static final Logger LOGGER = LoggerFactory.getLogger(LogTest.class);
public static void main(String[] args) {
LOGGER.error("error");
LOGGER.warn("warn");
LOGGER.info("info");
LOGGER.debug("debug");
LOGGER.trace("trace");
}
}
运行的内容显示与配置文件中的相同，配置成功。
log4j.properties转logback.xml
针对于一些老项目原本使用log4j现在想要使用logback，那么对应的配置文件必然也需要进行重写，不过我们也有简便的方法通过官网提供的转换功能来实现：logback转换页面
我们将想要转换的log4j.propertoes复制到指定的输入栏即可：
转换内容如下：
log4j.properties
log4j.rootLogger = trace,file
# FileAppender
# file为名称 其中属性file：文件路径 encoding：编码
log4j.appender.file = org.apache.log4j.FileAppender
log4j.appender.file.file = C:/Users/93997/Desktop/projectexers/logs/log.txt
log4j.appender.file.encoding = UTF-8
# 设置自定义布局(自定义输出格式)
log4j.appender.file.layout = org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern= [%-5p]%r %l %d{yyyy-MM-dd HH:mm:ss:SSS} %m%n
logback.xml
<configuration>
<appender name="file" class="ch.qos.logback.core.FileAppender">
<file>C:/Users/93997/Desktop/projectexers/logs/log.txtfile>
<encoding>UTF-8encoding>
<encoder>
<pattern>[%-5p]%r %l %d{yyyy-MM-dd HH:mm:ss:SSS} %m%npattern>
encoder>
appender>
<root level="trace">
<appender-ref ref="file"/>
root>
configuration>
注意点：唯一需要注意的是其中设置的pattern格式，在logback中是没有%l的，所以我们对于转换后的配置文件的输出格式pattern进行修改即可。
Logback的access模块
认识access模块
介绍：Logback-access模块与Servlet容器(如Tomcat、Jetty)继承，并提供了HTTP访问日志的功能，我们可以使用logback-access模块来替换tomcat的访问日志。
目的：当想对Tomcat日志进行同一管理的时候可使用这个模块，进行自定义日志输出等。
使用access模块
本次内容在
Tomcat8.5.63中使用(10.0.2不行)，对于Tomcat可去Tomcat官网下载获取。
当我们启动tomcat并访问localhost:8080网址下页面，点击访问几个页面时就会在logs目录下创建日志文件：
实际使用
logback的access模块
第一步：将logback-access.jar与logback-core.jar复制到$TOMCAT_HOME/lib/目录下。
即tomcat解压目录的lib目录下放置两个jar包(都是1.17版本)
- 可去中央仓库下载或者到我的百度网盘中获取（链接：https://pan.baidu.com/s/1T5CJx1vR1621TDrCRsKr9Q 提取码：njy4 ）
第二步： 修改$TOMCAT_HOME/conf/server.xml中的Host元素中添加value标签
<Valve className="ch.qos.logback.access.tomcat.LogbackValve" />
第三步：将准备好的logback-access.xml复制到$TOMCAT_HOME/conf/目录下
logback-access.xml内容如下：
<configuration>
<statusListener class="ch.qos.logback.core.status.OnConsoleStatusListener"/>
<property name="LOG_DIR" value="${catalina.base}/logs"/>
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${LOG_DIR}/access.logfile>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>access.%d{yyyy-MM-dd}.log.zipfileNamePattern>
rollingPolicy>
<encoder>
<pattern>combinedpattern>
encoder>
appender>
<appender-ref ref="FILE"/>
configuration>
- 其中
pattern指定的名称可见官网(多个名称定义)：https://logback.qos.ch/access.html#configuration
我们接着启动tomcat，并点击访问几个页面，之后来查看logs中生成的access.log文件：
对于输出的格式内容我们也可以进行更改调整。
总结
1、Logback有5个日志等级，默认日志等级为debug。组件同样有Logger、Appender、Encoder(封装了Layout)。—见第一章节
2、自定义配置文件通常使用logback.xml，其中常使用的Appender是RollingFileAppender(按时新增日志文件以及按文件大小拆分)，LevelFilter可以设置过滤日志等级。—见第二章节Appender、Filter部分
3、logback中能够配置异步日志，大大提高性能。—见第二章节异步日志配置
4、在logback官网能够将log4j.properties转为logback.xml，不过需要注意的是log4j.properteis中的格式配置字符%l在logback中无效，需要更改。—见第4部分
5、Loback中的access模块能够替换serlvet容器(如Tomcat、Jetty)的访问日志，并且能够进行自定义格式。—见第5部分