文章目录
视频链接 :
- 日志的作用和目的
- 日志的框架
- JUL的使用
- LOG4J的使用
- JCL的使用
1. 日志的概念
日志文件是用于记录系统操作事件的文件集合
调试日志
系统日志
如
Nginx
- access.log
- error.log
Tomcat
- catailina.log
ES
- elasticsearch.log
2. JAVA日志框架
问题:
- 控制日志输出的内容和格式
- 控制日志输出的位置
- 日志优化:异步日志,日志文件的归档和压缩
- 日志系统的维护
- 面向接口开发 – 日志的门面
日志门面
JCL、slf4j
日志实现
JUL、logback、log4j、log4j2
3. JUL (jdk自带)
3.1 JUL入门

Loggers:被称为记录器,调用其API来来发布日志信息。指定日志级别,日志内容
Handler:指定日志位置,格式化信息
package com.zs.blog;
import org.junit.jupiter.api.Test;
import java.util.logging.Level;
import java.util.logging.Logger;
public class JULTest {
@Test
public void testQuick() throws Exception {
// 1.创建日志记录器对象
Logger logger = Logger.getLogger("com.itheima.log.JULTest");
// 2.日志记录输出
logger.info("hello jul");
// 3. 通用方法进行记录
logger.log(Level.INFO, "info msg");
// 4. 日志内容占位符的使用
String name = "jack"; Integer age = 18; logger.log(Level.INFO, "用户信息:{0},{1}", new Object[]{name, age});
}
}
3.2. 日志级别
* java.util.logging.Level中定义了日志的级别:
SEVERE(最高值)
WARNING
INFO (默认级别)
CONFIG
FINE FINER
FINEST(最低值)
* 还有两个特殊的级别:
OFF,可用来关闭日志记录。
ALL,启用所有消息的日志记录。
虽然我们测试了7个日志级别但是默认只实现info以上的级别
@Test
public void testLogLevel() throws Exception {
// 1.获取日志对象
Logger logger = Logger.getLogger("com.itheima.log.QuickTest");
// 2.日志记录输出
logger.severe("severe");
logger.warning("warning");
logger.info("info");
logger.config("cofnig");
logger.fine("fine");
logger.finer("finer");
logger.finest("finest");
}
自定义日志级别配置
@Test
public void testLogConfig() throws Exception {
// 1.创建日志记录器对象
Logger logger = Logger.getLogger("com.itheima.log.JULTest");
// 一、自定义日志级别
// a.关闭系统默认配置
logger.setUseParentHandlers(false);
// b.创建handler对象
ConsoleHandler consoleHandler = new ConsoleHandler();
// c.创建formatter对象
SimpleFormatter simpleFormatter = new SimpleFormatter();
// d.进行关联
consoleHandler.setFormatter(simpleFormatter);
logger.addHandler(consoleHandler);
// e.设置日志级别
logger.setLevel(Level.ALL);
consoleHandler.setLevel(Level.ALL);
// 二、输出到日志文件
FileHandler fileHandler = new FileHandler("d:/logs/jul.log");
fileHandler.setFormatter(simpleFormatter);
logger.addHandler(fileHandler);
// 2.日志记录输出
logger.severe("severe");
logger.warning("warning");
logger.info("info");
logger.config("cofnig");
logger.fine("fine");
logger.finer("finer");
logger.finest("finest");
}
3.3 Logger之间的父子关系
JUL中Logger之间存在父子关系,这种父子关系通过树状结构存储,JUL在初始化时会创建一个顶层
RootLogger作为所有Logger父Logger,存储上作为树状结构的根节点。并父子关系通过路径来关联。
@Test
public void testLogParent() throws Exception {
//日志记录器对象父子关系
Logger logger1 = Logger.getLogger("com.itheima.log");
Logger logger2 = Logger.getLogger("com.itheima");
System.out.println(logger1.getParent() == logger2);//true
// 所有日志记录器对象的顶级父元素 class为java.util.logging.LogManager$RootLogger name为""
System.out.println("logger2 parent:" + logger2.getParent() + ",name:" + logger2.getParent().getName());
// 一、自定义日志级别
// a.关闭系统默认配置
logger2.setUseParentHandlers(false);
// b.创建handler对象
ConsoleHandler consoleHandler = new ConsoleHandler();
// c.创建formatter对象
SimpleFormatter simpleFormatter = new SimpleFormatter();
// d.进行关联
consoleHandler.setFormatter(simpleFormatter);
logger2.addHandler(consoleHandler);
// e.设置日志级别
logger2.setLevel(Level.ALL);
consoleHandler.setLevel(Level.ALL);
// 测试日志记录器对象父子关系
logger1.severe("severe");
logger1.warning("warning");
logger1.info("info");
logger1.config("config");
logger1.fine("fine");
logger1.finer("finer");
logger1.finest("finest");
}
3.4 配置文件
默认配置文件路径$JAVAHOME\jre\lib\logging.properties
@Test
public void testProperties() throws Exception {
// 读取自定义配置文件
InputStream in = JULTest.class.getClassLoader().getResourceAsStream("logging.properties");
// 获取日志管理器对象
LogManager logManager = LogManager.getLogManager();
// 通过日志管理器加载配置文件
logManager.readConfiguration(in);
Logger logger = Logger.getLogger("com.itheima.log.JULTest");
logger.severe("severe");
logger.warning("warning");
logger.info("info");
logger.config("config");
logger.fine("fine");
logger.finer("finer");
logger.finest("finest");
}
## RootLogger使用的处理器(获取时设置)
handlers= java.util.logging.ConsoleHandler
# RootLogger日志等级
.level= INFO
## 自定义Logger
com.itheima.handlers= java.util.logging.FileHandler
# 自定义Logger日志等级
com.itheima.level= INFO
# 忽略父日志设置
com.itheima.useParentHandlers=false
## 控制台处理器
# 输出日志级别
java.util.logging.ConsoleHandler.level = INFO
# 输出日志格式
java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter
# 指定handler对象的日志消息格式对象
java.util.logging.ConsoleHandler.encoding = UTF-8
# 指定日志输出的格式
java.util.logging.SimpleFormatter.format="%4$s: %5$s [%1$tc]%n"
## 文件处理器
# 输出日志级别
java.util.logging.FileHandler.level=INFO
# 输出日志格式
java.util.logging.FileHandler.formatter = java.util.logging.SimpleFormatter
# 输出日志文件路径
java.util.logging.FileHandler.pattern = /java%u.log
# 输出日志文件限制大小(50000字节)
java.util.logging.FileHandler.limit = 50000
# 输出日志文件限制个数
java.util.logging.FileHandler.count = 10
# 输出日志文件 是否是追加
java.util.logging.FileHandler.append=true
3.5 日志原理解析
- 初始化LogManager
- LogManager加载logging.properties配置
- 添加Logger到LogManager
- 从单例LogManager获取Logger
- 设置级别Level,并指定日志记录LogRecord
- Filter提供了日志级别之外更细粒度的控制
- Handler是用来处理日志输出位置
- Formatter是用来格式化LogRecord的

4.LOG4J (Apache)
可以控制日志信息输出到控制台、文件、甚至是数据库中。我们可以控制每一条日志的输出格式,通过定义日志的输出级别,可以更灵活的控制日志的输出过程。
官方网站: http://logging.apache.org/log4j/1.2/
4.1 Log4j入门
添加依赖
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
</dependency>
java代码
package com.zs.blog;
import org.apache.log4j.BasicConfigurator;
import org.apache.log4j.Logger;
import org.junit.jupiter.api.Test;
public class Log4jTest {
@Test
public void testQuick() throws Exception {
// 初始化系统配置,不需要配置文件
BasicConfigurator.configure();
// 创建日志记录器对象
Logger logger = Logger.getLogger(Log4jTest.class);
// 日志记录输出
logger.info("hello log4j");
// 日志级别
logger.fatal("fatal"); // 严重错误,一般会造成系统崩溃和终止运行
logger.error("error"); //** 错误信息,但不会影响系统运行
logger.warn("warn"); //** 警告信息,可能会发生问题
logger.info("info"); //** 程序运行信息,数据库的连接、网络、IO操作等
logger.debug("debug"); //** 调试信息,一般在开发阶段使用,记录程序的变量、参 数等
logger.trace("trace"); // 追踪信息,记录程序的所有流程信息
}
}
日志的级别
* 每个Logger都被了一个日志级别(log level),用来控制日志信息的输出。日志级别从高到低分 为:
fatal 指出每个严重的错误事件将会导致应用程序的退出。
error 指出虽然发生错误事件,但仍然不影响系统的继续运行。
warn 表明会出现潜在的错误情形。
info 一般和在粗粒度级别上,强调应用程序的运行全程。
debug 一般用于细粒度级别上,对调试应用程序非常有帮助。
trace 是程序追踪,可以用于输出程序运行中的变量,显示执行的流程。
* 还有两个特殊的级别:
OFF,可用来关闭日志记录。
ALL,启用所有消息的日志记录。
注:一般只使用4个级别,优先级从高到低为 ERROR > WARN > INFO > DEBUG
4.2 Log4j组件
Log4J 主要由 Loggers (日志记录器)、Appenders(输出端)和 Layout(日志格式化器)组成。
其中
Loggers 控制日志的输出级别与日志是否输出;
Appenders 指定日志的输出方式(输出到控制台、文件等);
Layout 控制日志信息的输出格式。
4.2.1 Loggers
日志记录器,负责收集处理日志记录,实例的命名就是类“XX”的full quailied name(类的全限定名),
Logger的名字大小写敏感,其命名有继承机制:例如:name为org.apache.commons的logger会继承
name为org.apache的logger。
Log4J中有一个特殊的logger叫做“root”,他是所有logger的根,也就意味着其他所有的logger都会直接
或者间接地继承自root。root logger可以用Logger.getRootLogger()方法获取。
但是,自log4j 1.2版以来, Logger 类已经取代了 Category 类。对于熟悉早期版本的log4j的人来说,
Logger 类可以被视为 Category 类的别名。

4.2.2 Appenders
Appender 用来指定日志输出到哪个地方,可以同时指定日志的输出目的地。Log4j 常用的输出目的地
有以下几种:

4.2.3 Layouts
布局器 Layouts用于控制日志输出内容的格式,让我们可以使用各种需要的格式输出日志。Log4j常用
的Layouts:

Layout格式
%m 输出代码中指定的日志信息
%p 输出优先级,及 DEBUG、INFO等
%n 换行符(windows平台的转换符为"\n")
%r 输出自应用启动到输出该信息耗费的总毫秒数
%c 全类名
%t 线程名
%d 日期
%l 类名、线程、行数
%F 文件名
%L 代码行号
%% %
%5c 最小宽度 5, <5 右对齐
%-5c 最小宽度 5, <5 左对齐
%.5c 最大宽度 5, >5 左截断, <5 空格
%20.30c <20空格,右对齐, >30 左截断
4.3 配置文件
4.3.1 日志配置文件
- 配置文件名称

- 配置文件位置



使用ognl的方式读取配置文件
- 如何配置


配置文件log4j.rootLogger = trace,console log4j.appender.console = org.apache.log4j.ConsoleAppender log4j.appender.console.layout = org.apache.log4j.SimpleLayout
测试类
@Test
public void testQuick() throws Exception {
// 初始化系统配置,不需要配置文件
// BasicConfigurator.configure();
// 创建日志记录器对象
Logger logger = Logger.getLogger(Log4jTest.class);
// 日志记录输出
logger.info("hello log4j");
// 日志级别
logger.fatal("fatal"); // 严重错误,一般会造成系统崩溃和终止运行
logger.error("error"); // 错误信息,但不会影响系统运行
logger.warn("warn"); // 警告信息,可能会发生问题
logger.info("info"); // 程序运行信息,数据库的连接、网络、IO操作等
logger.debug("debug"); // 调试信息,一般在开发阶段使用,记录程序的变量、参 数等
logger.trace("trace"); // 追踪信息,记录程序的所有流程信息
}
4.3.2 内置日志开关
java
LogLog.setInternalDebugging(true);


4.3.3 layout配置

配置文件
# 指定 RootLogger 顶级元素默认配置信息(日志级别,输出位置)
# 指定日志级别=trace,使用的 appender 为=console
log4j.rootLogger = trace,console
# 指定控制台日志输出的 appender
log4j.appender.console = org.apache.log4j.ConsoleAppender
# 指定消息格式 layout
#log4j.appender.console.layout = org.apache.log4j.SimpleLayout
#log4j.appender.console.layout = org.apache.log4j.HTMLLayout
#log4j.appender.console.layout = org.apache.log4j.xml.XMLLayout
# 自定义layout
log4j.appender.console.layout = org.apache.log4j.PatternLayout
# 指定消息格式的内容
log4j.appender.console.layout.conversionPattern = %r [%t] %p %c %x - %m%n

4.4 Layout的格式
在 log4j.properties 配置文件中,我们定义了日志输出级别与输出端,在输出端中分别配置日志的输出格式。
* log4j 采用类似 C 语言的 printf 函数的打印格式格式化日志信息,具体的占位符及其含义如下:
%m 输出代码中指定的日志信息
%p 输出优先级,及 DEBUG、INFO 等
%n 换行符(Windows平台的换行符为 "\n",Unix 平台为 "\n")
%r 输出自应用启动到输出该 log 信息耗费的毫秒数
%c 输出打印语句所属的类的全名
%t 输出产生该日志的线程全名
%d 输出服务器当前时间,默认为 ISO8601,也可以指定格式,如:%d{yyyy年MM月dd日 HH:mm:ss}
%l 输出日志时间发生的位置,包括类名、线程、及在代码中的行数。如: Test.main(Test.java:10)
%F 输出日志消息产生时所在的文件名称
%L 输出代码中的行号
%% 输出一个 "%" 字符
* 可以在 % 与字符之间加上修饰符来控制最小宽度、最大宽度和文本的对其方式。如:
%5c 输出category名称,最小宽度是5,category<5,默认的情况下右对齐
%-5c 输出category名称,最小宽度是5,category<5,"-"号指定左对齐,会有空格
%.5c 输出category名称,最大宽度是5,category>5,就会将左边多出的字符截掉,<5不 会有空格
%20.30c category名称<20补空格,并且右对齐,>30字符,就从左边交远销出的字符截掉
# 指定消息格式的内容
log4j.appender.console.layout.conversionPattern = [%%p]-->[%-6p] [%%p]-->[%6p] [%%p]-->[%.4p] [%%p]-->[%-6.5p] [%%r]-->[%r] [%%c]-->[%c] [%%t]-->[%t] [%%d]-->[%d{yyyy-MM-dd HH:mm:ss:SS}] [%%l]-->[%l] [%%F]-->[%F] [%%L]-->[%L] [%%%%]-->[%%] [%%m]==%m %n
[%p]-->[INFO ] [%p]-->[ INFO] [%p]-->[INFO] [%p]-->[INFO ] [%r]-->[0] [%c]-->[com.zs.blog.Log4jTest] [%t]-->[main] [%d]-->[2022-04-16 17:56:25:132] [%l]-->[com.zs.blog.Log4jTest.testQuick(Log4jTest.java:18)] [%F]-->[Log4jTest.java] [%L]-->[18] [%%]-->[%] [%m]==hello log4j 中文
[%p]-->[FATAL ] [%p]-->[ FATAL] [%p]-->[ATAL] [%p]-->[FATAL ] [%r]-->[3] [%c]-->[com.zs.blog.Log4jTest] [%t]-->[main] [%d]-->[2022-04-16 17:56:25:135] [%l]-->[com.zs.blog.Log4jTest.testQuick(Log4jTest.java:22)] [%F]-->[Log4jTest.java] [%L]-->[22] [%%]-->[%] [%m]==fatal 中文
[%p]-->[ERROR ] [%p]-->[ ERROR] [%p]-->[RROR] [%p]-->[ERROR ] [%r]-->[3] [%c]-->[com.zs.blog.Log4jTest] [%t]-->[main] [%d]-->[2022-04-16 17:56:25:135] [%l]-->[com.zs.blog.Log4jTest.testQuick(Log4jTest.java:23)] [%F]-->[Log4jTest.java] [%L]-->[23] [%%]-->[%] [%m]==error 中文
[%p]-->[WARN ] [%p]-->[ WARN] [%p]-->[WARN] [%p]-->[WARN ] [%r]-->[3] [%c]-->[com.zs.blog.Log4jTest] [%t]-->[main] [%d]-->[2022-04-16 17:56:25:135] [%l]-->[com.zs.blog.Log4jTest.testQuick(Log4jTest.java:24)] [%F]-->[Log4jTest.java] [%L]-->[24] [%%]-->[%] [%m]==warn 中文
[%p]-->[INFO ] [%p]-->[ INFO] [%p]-->[INFO] [%p]-->[INFO ] [%r]-->[4] [%c]-->[com.zs.blog.Log4jTest] [%t]-->[main] [%d]-->[2022-04-16 17:56:25:136] [%l]-->[com.zs.blog.Log4jTest.testQuick(Log4jTest.java:25)] [%F]-->[Log4jTest.java] [%L]-->[25] [%%]-->[%] [%m]==info 中文
[%p]-->[DEBUG ] [%p]-->[ DEBUG] [%p]-->[EBUG] [%p]-->[DEBUG ] [%r]-->[4] [%c]-->[com.zs.blog.Log4jTest] [%t]-->[main] [%d]-->[2022-04-16 17:56:25:136] [%l]-->[com.zs.blog.Log4jTest.testQuick(Log4jTest.java:26)] [%F]-->[Log4jTest.java] [%L]-->[26] [%%]-->[%] [%m]==debug 中文
[%p]-->[TRACE ] [%p]-->[ TRACE] [%p]-->[RACE] [%p]-->[TRACE ] [%r]-->[4] [%c]-->[com.zs.blog.Log4jTest] [%t]-->[main] [%d]-->[2022-04-16 17:56:25:136] [%l]-->[com.zs.blog.Log4jTest.testQuick(Log4jTest.java:27)] [%F]-->[Log4jTest.java] [%L]-->[27] [%%]-->[%] [%m]==trace 中文
4.5 Appender的输出
控制台,文件,数据库
#指定日志的输出级别与输出端
log4j.rootLogger=INFO,Console
# 控制台输出配置
log4j.appender.Console=org.apache.log4j.ConsoleAppender
log4j.appender.Console.layout=org.apache.log4j.PatternLayout
log4j.appender.Console.layout.ConversionPattern=%d [%t] %-5p [%c] - %m%n
# 文件输出配置
# 按时间拆分(默认为 .yyyy-MM-dd 以天为单位拆分)
log4j.appender.A = org.apache.log4j.DailyRollingFileAppender
#指定日志的输出路径
log4j.appender.A.File = D:/log.txt
log4j.appender.A.Append = true
#使用自定义日志格式化器
log4j.appender.A.layout = org.apache.log4j.PatternLayout
#指定日志的输出格式
log4j.appender.A.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [%t:%r] - [%p] %m%n
#指定日志的文件编码
log4j.appender.A.encoding=UTF-8
# 指定日期拆分的规则
log4j.appender.A.datePattern='.'yyyy-MM-dd-HH-mm-ss
# 文件输出配置
log4j.appender.B = org.apache.log4j.RollingFileAppender # 按文件大小拆分
#指定日志的输出路径
log4j.appender.B.File = D:/log.txt
log4j.appender.B.Append = true
#使用自定义日志格式化器
log4j.appender.B.layout = org.apache.log4j.PatternLayout
log4j.appender.B.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [%t:%r] - [%p] %m%n
log4j.appender.B.encoding=UTF-8
# 指定日志文件大小
log4j.appender.B.maxFileSize = 1MB
# 指定文件的数量默认是一个
log4j.appender.B.maxBackupIndex = 10
# 文件输出配置
log4j.appender.A = org.apache.log4j.FileAppender
log4j.appender.A.File = D:/log.txt
log4j.appender.A.Append = true
log4j.appender.A.layout = org.apache.log4j.PatternLayout
log4j.appender.A.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [%t:%r] - [%p] %m%n
log4j.appender.A.encoding=UTF-8
#mysql
log4j.appender.logDB=org.apache.log4j.jdbc.JDBCAppender
log4j.appender.logDB.layout=org.apache.log4j.PatternLayout
log4j.appender.logDB.Driver=com.mysql.jdbc.Driver
log4j.appender.logDB.URL=jdbc:mysql://localhost:3306/test
log4j.appender.logDB.User=root
log4j.appender.logDB.Password=root
log4j.appender.logDB.Sql=INSERT INTO log(project_name,create_date,level,category,file_name,thread_name,line,all_categ ory,message) values('itcast','%d{yyyy-MM-dd HH:mm:ss}','%p','%c','%F','%t','%L','%l','%m')
CREATE TABLE `log` (
`log_id` int(11) NOT NULL AUTO_INCREMENT,
`project_name` varchar(255) DEFAULT NULL COMMENT '目项名',
`create_date` varchar(255) DEFAULT NULL COMMENT '创建时间',
`level` varchar(255) DEFAULT NULL COMMENT '优先级',
`category` varchar(255) DEFAULT NULL COMMENT '所在类的全名',
`file_name` varchar(255) DEFAULT NULL COMMENT '输出日志消息产生时所在的文件名称 ',
`thread_name` varchar(255) DEFAULT NULL COMMENT '日志事件的线程名',
`line` varchar(255) DEFAULT NULL COMMENT '号行',
`all_category` varchar(255) DEFAULT NULL COMMENT '日志事件的发生位置',
`message` varchar(4000) DEFAULT NULL COMMENT '输出代码中指定的消息',
PRIMARY KEY (`log_id`)
);
4.5 自定义Logger
# RootLogger配置
log4j.rootLogger = trace,console
# 自定义Logger
log4j.logger.com.itheima = info,file
log4j.logger.org.apache = error

5. JCL 学习
全称为Jakarta Commons Logging,是Apache提供的一个通用日志API。
它是为 "所有的Java日志实现"提供一个统一的接口,它自身也提供一个日志的实现,但是功能非常常弱(SimpleLog)。所以一般不会单独使用它。他允许开发人员使用不同的具体日志实现工具: Log4j, Jdk
自带的日志(JUL)
JCL 有两个基本的抽象类:Log(基本记录器)和LogFactory(负责创建Log实例)。

5.1 JCL入门
- 建立maven工程
- 添加依赖
<dependency> <groupId>commons-logging</groupId> <artifactId>commons-logging</artifactId> <version>1.2</version> </dependency> - 入门代码
public class JULTest { @Test public void testQuick() throws Exception { // 创建日志对象 Log log = LogFactory.getLog(JULTest.class); // 日志记录输出 log.fatal("fatal"); log.error("error"); log.warn("warn"); log.info("info"); log.debug("debug"); } }
我们为什么要使用日志门面:
- 面向接口开发,不再依赖具体的实现类。减少代码的耦合
- 项目通过导入不同的日志实现类,可以灵活的切换日志框架
- 统一API,方便开发者学习和使用
- 统一配置便于项目日志的管理
5.2 JCL原理
-
通过LogFactory动态加载Log实现类

-
日志门面支持的日志实现数组
private static final String[] classesToDiscover = new String[]{"org.apache.commons.logging.impl.Log4JLogger", "org.apache.commons.logging.impl.Jdk14Logger", "org.apache.commons.logging.impl.Jdk13LumberjackLogger", "org.apache.commons.logging.impl.SimpleLog"}; -
获取具体的日志实现
for(int i = 0; i < classesToDiscover.length && result == null; ++i) { result = this.createLogFromClass(classesToDiscover[i], logCategory, true); }
1. 日志门面
- 日志门面和日志体系
- SLF4J
- logback的使用
- log4j2的使用
- SpringBoot中的日志使用
常见的日志门面 :
JCL、slf4j
常见的日志实现:
JUL、log4j、logback、log4j2

日志框架出现的历史顺序:
log4j -->JUL–>JCL–> slf4j --> logback --> log4j2
2. SLF4J的使用
简单日志门面(Simple Logging Facade For Java) SLF4J主要是为了给Java日志访问提供一套标准、规范
的API框架,其主要意义在于提供接口,具体的实现可以交由其他日志框架,例如log4j和logback等。
当然slf4j自己也提供了功能较为简单的实现,但是一般很少用到。对于一般的Java项目而言,日志框架
会选择slf4j-api作为门面,配上具体的实现框架(log4j、logback等),中间使用桥接器完成桥接。
官方网站: https://www.slf4j.org/

SLF4J是目前市面上最流行的日志门面。现在的项目中,基本上都是使用SLF4J作为我们的日志系统。
SLF4J日志门面主要提供两大功能:
1. 日志框架的绑定
2. 日志框架的桥接
2.1 SLF4J入门
- 添加依赖
<!--slf4j 门面-->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
</dependency>
<!--slf4j简单实现-->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-simple</artifactId>
</dependency>
- java代码
package com.zs.blog;
import org.junit.jupiter.api.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class Slf4jTest {
public static final Logger LOGGER = LoggerFactory.getLogger(Slf4jTest.class);
@Test
public void testQuick() throws Exception {
// 日志级别
LOGGER.error("error 中文"); // 错误信息,但不会影响系统运行
LOGGER.warn("warn 中文"); // 警告信息,可能会发生问题
LOGGER.info("info 中文"); // 程序运行信息,数据库的连接、网络、IO操作等
LOGGER.debug("debug 中文"); // 调试信息,一般在开发阶段使用,记录程序的变量、参 数等
LOGGER.trace("trace 中文"); // 追踪信息,记录程序的所有流程信息
LOGGER.info("用户:{},年龄 {}","zs",18);
//将系统异常信息输出
try {
int i =1/0;
} catch (Exception e) {
LOGGER.error("出现异常",e);
}
}
}
为什么要使用SLF4J作为日志门面?

2.2 绑定日志的实现(Binding)

logback
<!--slf4j 门面-->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
</dependency>
日志开关
<!--slf4j 门面-->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-nop</artifactId>
</dependency>
log4j
<!--slf4j 门面-->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
</dependency>
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
# 指定 RootLogger 顶级元素默认配置信息(日志级别,输出位置)
# 指定日志级别=trace,使用的 appender 为=console
log4j.rootLogger = trace,console
# 指定控制台日志输出的 appender
log4j.appender.console = org.apache.log4j.ConsoleAppender
log4j.appender.console.encoding=UTF-8
# 指定消息格式 layout
#log4j.appender.console.layout = org.apache.log4j.SimpleLayout
#log4j.appender.console.layout = org.apache.log4j.HTMLLayout
#log4j.appender.console.layout = org.apache.log4j.xml.XMLLayout
# 自定义layout
log4j.appender.console.layout = org.apache.log4j.PatternLayout
# 指定消息格式的内容
log4j.appender.console.layout.conversionPattern = [%%p]-->[%-6p] [%%p]-->[%6p] [%%p]-->[%.4p] [%%p]-->[%-6.5p] [%%r]-->[%r] [%%c]-->[%c] [%%t]-->[%t] [%%d]-->[%d{yyyy-MM-dd HH:mm:ss:SS}] [%%l]-->[%l] [%%F]-->[%F] [%%L]-->[%L] [%%%%]-->[%%] [%%m]==%m %n
jul
<!--slf4j 门面-->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-jdk14</artifactId>
</dependency>
如前所述,SLF4J支持各种日志框架。SLF4J发行版附带了几个称为“SLF4J绑定”的jar文件,每个绑定对应一个受支持的框架。
使用slf4j的日志绑定流程:
- 添加slf4j-api的依赖
- 使用slf4j的API在项目中进行统一的日志记录
- 绑定具体的日志实现框架
- 绑定已经实现了slf4j的日志框架,直接添加对应依赖
- 绑定没有实现slf4j的日志框架,先添加日志的适配器,再添加实现类的依赖
- slf4j有且仅有一个日志实现框架的绑定(如果出现多个默认使用第一个依赖日志实现)
要切换日志框架,只需替换类路径上的slf4j绑定。例如,要从java.util.logging切换到log4j,只需将
slf4j-jdk14-1.7.27.jar替换为slf4j-log4j12-1.7.27.jar即可。
SLF4J不依赖于任何特殊的类装载。实际上,每个SLF4J绑定在编译时都是硬连线的, 以使用一个且只有一个特定的日志记录框架。例如,slf4j-log4j12-1.7.27.jar绑定在编译时绑定以使用log4j。在您的代码
中,除了slf4j-api-1.7.27.jar之外,您只需将您选择的一个且只有一个绑定放到相应的类路径位置。不要
在类路径上放置多个绑定。以下是一般概念的图解说明。
2.3 桥接旧的日志框架(Bridging)
通常,您依赖的某些组件依赖于SLF4J以外的日志记录API。您也可以假设这些组件在不久的将来不会切
换到SLF4J。为了解决这种情况,SLF4J附带了几个桥接模块,这些模块将对log4j,JCL和
java.util.logging API的调用重定向,就好像它们是对SLF4J API一样。
桥接解决的是项目中日志的遗留问题,当系统中存在之前的日志API,可以通过桥接转换到slf4j的实现
- 先去除之前老的日志框架的依赖
- 添加SLF4J提供的桥接组件
- 为项目添加SLF4J的具体实现

迁移的方式:
如果我们要使用SLF4J的桥接器,替换原有的日志框架,那么我们需要做的第一件事情,就是删除掉原
有项目中的日志框架的依赖。然后替换成SLF4J提供的桥接器。
<!-- log4j-->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>log4j-over-slf4j</artifactId>
<version>1.7.27</version>
</dependency>
<!-- jul -->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>jul-to-slf4j</artifactId>
<version>1.7.27</version>
</dependency>
<!--jcl -->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>jcl-over-slf4j</artifactId>
<version>1.7.27</version>
</dependency>
注意问题:
- jcl-over-slf4j.jar和 slf4j-jcl.jar不能同时部署。前一个jar文件将导致JCL将日志系统的选择委托给
SLF4J,后一个jar文件将导致SLF4J将日志系统的选择委托给JCL,从而导致无限循环 - log4j-over-slf4j.jar和slf4j-log4j12.jar不能同时出现
- jul-to-slf4j.jar和slf4j-jdk14.jar不能同时出现
- 所有的桥接都只对Logger日志记录器对象有效,如果程序中调用了内部的配置类或者是
Appender,Filter等对象,将无法产生效果。
2.4 SLF4J原理解析
- SLF4J通过LoggerFactory加载日志具体的实现对象。
- LoggerFactory在初始化的过程中,会通过performInitialization()方法绑定具体的日志实现。
- 在绑定具体实现的时候,通过类加载器,加载org/slf4j/impl/StaticLoggerBinder.class
- 所以,只要是一个日志实现框架,在org.slf4j.impl包中提供一个自己的StaticLoggerBinder类,在
其中提供具体日志实现的LoggerFactory就可以被SLF4J所加载
3. Logback的使用
Logback是由log4j创始人设计的另一个开源日志组件,性能比log4j要好。
官方网站:https://logback.qos.ch/index.html
Logback主要分为三个模块:
- logback-core:其它两个模块的基础模块
- logback-classic:它是log4j的一个改良版本,同时它完整实现了slf4j API
- logback-access:访问模块与Servlet容器集成提供通过Http来访问日志的功能
后续的日志代码都是通过SLF4J日志门面搭建日志系统,所以在代码是没有区别,主要是通过修改配置
文件和pom.xml依赖
3.1 logback入门
- 添加依赖
<dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-api</artifactId> <version>1.7.25</version> </dependency> <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-classic</artifactId> <version>1.2.3</version> </dependency> - java代码
package com.zs.blog; import org.junit.jupiter.api.Test; import org.slf4j.Logger; import org.slf4j.LoggerFactory; public class LogbackTest { //定义日志对象 public final static Logger LOGGER = LoggerFactory.getLogger(LogbackTest.class); @Test public void testQuick() throws Exception { // 日志级别 LOGGER.error("error 中文"); // 错误信息,但不会影响系统运行 LOGGER.warn("warn 中文"); // 警告信息,可能会发生问题 LOGGER.info("info 中文"); // 程序运行信息,数据库的连接、网络、IO操作等 LOGGER.debug("debug 中文"); // 调试信息,一般在开发阶段使用,记录程序的变量、参 数等 LOGGER.trace("trace 中文"); // 追踪信息,记录程序的所有流程信息 LOGGER.info("用户:{},年龄 {}","zs",18); //将系统异常信息输出 try { int i =1/0; } catch (Exception e) { LOGGER.error("出现异常",e); } } }
3.2 logback配置
logback会依次读取以下类型配置文件:
- logback.groovy
- logback-test.xml
- logback.xml 如果均不存在会采用默认配置
-
logback组件之间的关系
- Logger:日志的记录器,把它关联到应用的对应的context上后,主要用于存放日志对象,也
可以定义日志类型、级别。 - Appender:用于指定日志输出的目的地,目的地可以是控制台、文件、数据库等等。
- Layout:负责把事件转换成字符串,格式化的日志信息的输出。在logback中Layout对象被封
装在encoder中。
- Logger:日志的记录器,把它关联到应用的对应的context上后,主要用于存放日志对象,也
-
基本配置信息
<?xml version="1.0" encoding="UTF-8"?> <configuration> <!--配置集中管理属性--> <!-- 日志输出格式: %-5level %d {yyyy-MM-dd HH:mm:ss.SSS}日期 %c 类的完整名称 %M 为method %L 为行号 %thread 线程名称 %m 或者 %msg 为信息 %n 换行 --> <!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度 %msg:日志消息,%n是换行符--> <property name="pattern" value="%d{yyyy-MM-dd HH:mm:ss.SSS} %c [%thread] %-5level %msg%n"/> <!--控制台日志输出appender--> <!-- Appender: 设置日志信息的去向,常用的有以下几个 ch.qos.logback.core.ConsoleAppender (控制台) ch.qos.logback.core.rolling.RollingFileAppender (文件大小到达指定尺 寸的时候产生一个新文件) ch.qos.logback.core.FileAppender (文件) --> <appender name="console" class="ch.qos.logback.core.ConsoleAppender"> <!--输出流对象 默认 System.out 改为 System.err--> <target>System.err</target> <!--日志格式配置--> <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"> <pattern>${pattern}</pattern> </encoder> </appender> <!--日志记录器对象--> <!-- 用来设置某一个包或者具体的某一个类的日志打印级别、以及指定<appender>。 <loger>仅有一个name属性,一个可选的level和一个可选的addtivity属性 name: 用来指定受此logger约束的某一个包或者具体的某一个类。 level: 用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,如果未设置此属性,那么当前logger将会继承上级的级别。 additivity: 是否向上级loger传递打印信息。默认是true。 <logger>可以包含零个或多个<appender-ref>元素,标识这个appender将会添加到这个 logger --> <!-- 也是<logger>元素,但是它是根logger。默认debug level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF, <root>可以包含零个或多个<appender-ref>元素,标识这个appender将会添加到这个 logger。 --> <root level="ALL"> <appender-ref ref="console"/> </root> </configuration> -
FileAppender配置
<?xml version="1.0" encoding="UTF-8"?> <configuration> <!--配置集中管理属性--> <!-- 日志输出格式: %-5level %d {yyyy-MM-dd HH:mm:ss.SSS}日期 %c 类的完整名称 %M 为method %L 为行号 %thread 线程名称 %m 或者 %msg 为信息 %n 换行 --> <!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度 %msg:日志消息,%n是换行符--> <property name="pattern" value="%d{yyyy-MM-dd HH:mm:ss.SSS} %c [%thread] %-5level %msg%n"/> <!-- 日志文件存放目录 value="/logs" : 绝对路径 value="logs" : 项目根路径 --> <property name="log_dir" value="logs"></property> <!--控制台日志输出appender--> <!-- Appender: 设置日志信息的去向,常用的有以下几个 ch.qos.logback.core.ConsoleAppender (控制台) ch.qos.logback.core.rolling.RollingFileAppender (文件大小到达指定尺 寸的时候产生一个新文件) ch.qos.logback.core.FileAppender (文件) --> <appender name="console" class="ch.qos.logback.core.ConsoleAppender"> <!--输出流对象 默认 System.out 改为 System.err--> <target>System.err</target> <!--日志格式配置--> <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"> <pattern>${pattern}</pattern> </encoder> </appender> <!--fileappender--> <appender name="file" class="ch.qos.logback.core.FileAppender"> <!--日志格式配置--> <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"> <pattern>${pattern}</pattern> </encoder> <!--日志输出路径--> <file>${log_dir}/logback.log</file> </appender> <!-- 生成html格式appender对象 --> <appender name="htmlfile" class="ch.qos.logback.core.FileAppender"> <!--日志格式配置--> <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder"> <layout class="ch.qos.logback.classic.html.HTMLLayout"> <pattern>%level%d{yyyy-MM-dd HH:mm:ss}%c%M%L%thread%m</pattern> <!-- <pattern>${pattern}</pattern>--> </layout> <!--日志输出路径--> <file>${log_dir}/logback.html</file> </encoder> </appender> <!--日志记录器对象--> <!-- 用来设置某一个包或者具体的某一个类的日志打印级别、以及指定<appender>。 <loger>仅有一个name属性,一个可选的level和一个可选的addtivity属性 name: 用来指定受此logger约束的某一个包或者具体的某一个类。 level: 用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,如果未设置此属性,那么当前logger将会继承上级的级别。 additivity: 是否向上级loger传递打印信息。默认是true。 <logger>可以包含零个或多个<appender-ref>元素,标识这个appender将会添加到这个 logger --> <!-- 也是<logger>元素,但是它是根logger。默认debug level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF, <root>可以包含零个或多个<appender-ref>元素,标识这个appender将会添加到这个 logger。 --> <root level="ALL"> <appender-ref ref="console"/> <appender-ref ref="file"/> <!-- <appender-ref ref="htmlfile"/>--> </root> </configuration> -
RollingFileAppender配置
<?xml version="1.0" encoding="UTF-8"?> <configuration> <!--配置集中管理属性--> <!-- 日志输出格式: %-5level %d {yyyy-MM-dd HH:mm:ss.SSS}日期 %c 类的完整名称 %M 为method %L 为行号 %thread 线程名称 %m 或者 %msg 为信息 %n 换行 --> <!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度 %msg:日志消息,%n是换行符--> <property name="pattern" value="%d{yyyy-MM-dd HH:mm:ss.SSS} %c [%thread] %-5level %msg%n"/> <!-- 日志文件存放目录 value="/logs" : 绝对路径 value="logs" : 项目根路径 --> <property name="log_dir" value="logs"></property> <!--控制台日志输出appender--> <!-- Appender: 设置日志信息的去向,常用的有以下几个 ch.qos.logback.core.ConsoleAppender (控制台) ch.qos.logback.core.rolling.RollingFileAppender (文件大小到达指定尺 寸的时候产生一个新文件) ch.qos.logback.core.FileAppender (文件) --> <appender name="console" class="ch.qos.logback.core.ConsoleAppender"> <!--输出流对象 默认 System.out 改为 System.err--> <target>System.err</target> <!--日志格式配置--> <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"> <pattern>${pattern}</pattern> </encoder> </appender> <!--fileappender--> <appender name="file" class="ch.qos.logback.core.FileAppender"> <!--日志格式配置--> <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"> <pattern>${pattern}</pattern> </encoder> <!--日志输出路径--> <file>${log_dir}/logback.log</file> </appender> <!-- 生成html格式appender对象 --> <appender name="htmlfile" class="ch.qos.logback.core.FileAppender"> <!--日志格式配置--> <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder"> <layout class="ch.qos.logback.classic.html.HTMLLayout"> <pattern>%level%d{yyyy-MM-dd HH:mm:ss}%c%M%L%thread%m</pattern> <!-- <pattern>${pattern}</pattern>--> </layout> <!--日志输出路径--> <file>${log_dir}/logback.html</file> </encoder> </appender> <!-- 日志文件拆分和归档的appender对象--> <appender name="rollFile" class="ch.qos.logback.core.rolling.RollingFileAppender"> <!--日志格式配置--> <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"> <pattern>${pattern}</pattern> </encoder> <!--日志输出路径--> <file>${log_dir}/roll_logback.log</file> <!--指定日志文件拆分和压缩规则--> <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy"> <!--通过指定压缩文件名称,来确定分割文件方式--> <!-- <fileNamePattern>${log_dir}/rolling.%d{yyyy-MM-dd-HH-mm-ss}.log%i.gz</fileNamePattern>--> <fileNamePattern>${log_dir}/rolling.%d{yyyy-MM-dd}.log%i</fileNamePattern> <!--文件拆分大小--> <maxFileSize>1MB</maxFileSize> </rollingPolicy> </appender> <!--日志记录器对象--> <!-- 用来设置某一个包或者具体的某一个类的日志打印级别、以及指定<appender>。 <loger>仅有一个name属性,一个可选的level和一个可选的addtivity属性 name: 用来指定受此logger约束的某一个包或者具体的某一个类。 level: 用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,如果未设置此属性,那么当前logger将会继承上级的级别。 additivity: 是否向上级loger传递打印信息。默认是true。 <logger>可以包含零个或多个<appender-ref>元素,标识这个appender将会添加到这个 logger --> <!-- 也是<logger>元素,但是它是根logger。默认debug level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF, <root>可以包含零个或多个<appender-ref>元素,标识这个appender将会添加到这个 logger。 --> <root level="ALL"> <appender-ref ref="console"/> <!-- <appender-ref ref="file"/>--> <!-- <appender-ref ref="htmlfile"/>--> <appender-ref ref="rollFile"/> </root> </configuration> -
Filter和异步日志配置
<?xml version="1.0" encoding="UTF-8"?> <configuration> <!--配置集中管理属性--> <!-- 日志输出格式: %-5level %d {yyyy-MM-dd HH:mm:ss.SSS}日期 %c 类的完整名称 %M 为method %L 为行号 %thread 线程名称 %m 或者 %msg 为信息 %n 换行 --> <!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度 %msg:日志消息,%n是换行符--> <property name="pattern" value="%d{yyyy-MM-dd HH:mm:ss.SSS} %c [%thread] %-5level %msg%n"/> <!-- 日志文件存放目录 value="/logs" : 绝对路径 value="logs" : 项目根路径 --> <property name="log_dir" value="logs"></property> <!--控制台日志输出appender--> <!-- Appender: 设置日志信息的去向,常用的有以下几个 ch.qos.logback.core.ConsoleAppender (控制台) ch.qos.logback.core.rolling.RollingFileAppender (文件大小到达指定尺 寸的时候产生一个新文件) ch.qos.logback.core.FileAppender (文件) --> <appender name="console" class="ch.qos.logback.core.ConsoleAppender"> <!--输出流对象 默认 System.out 改为 System.err--> <target>System.err</target> <!--日志格式配置--> <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"> <pattern>${pattern}</pattern> </encoder> </appender> <!--fileappender--> <appender name="file" class="ch.qos.logback.core.FileAppender"> <!--日志格式配置--> <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"> <pattern>${pattern}</pattern> </encoder> <!--日志输出路径--> <file>${log_dir}/logback.log</file> </appender> <!-- 生成html格式appender对象 --> <appender name="htmlfile" class="ch.qos.logback.core.FileAppender"> <!--日志格式配置--> <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder"> <layout class="ch.qos.logback.classic.html.HTMLLayout"> <pattern>%level%d{yyyy-MM-dd HH:mm:ss}%c%M%L%thread%m</pattern> <!-- <pattern>${pattern}</pattern>--> </layout> <!--日志输出路径--> <file>${log_dir}/logback.html</file> </encoder> </appender> <!-- 日志文件拆分和归档的appender对象--> <appender name="rollFile" class="ch.qos.logback.core.rolling.RollingFileAppender"> <!--日志格式配置--> <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"> <pattern>${pattern}</pattern> </encoder> <!--日志输出路径--> <file>${log_dir}/roll_logback.log</file> <!--指定日志文件拆分和压缩规则--> <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy"> <!--通过指定压缩文件名称,来确定分割文件方式--> <!-- <fileNamePattern>${log_dir}/rolling.%d{yyyy-MM-dd-HH-mm-ss}.log%i.gz</fileNamePattern>--> <fileNamePattern>${log_dir}/rolling.%d{yyyy-MM-dd}.log%i</fileNamePattern> <!--文件拆分大小--> <maxFileSize>1MB</maxFileSize> </rollingPolicy> <filter class="ch.qos.logback.classic.filter.LevelFilter"> <!--设置拦截日志级别--> <level>info</level> <!--error级别输出--> <onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter> </appender> <!--异步日志--> <appender name="async" class="ch.qos.logback.classic.AsyncAppender"> <appender-ref ref="rollFile"/> </appender> <!--日志记录器对象--> <root level="ALL"> <appender-ref ref="console"/> <!-- <appender-ref ref="file"/>--> <!-- <appender-ref ref="htmlfile"/>--> <!-- <appender-ref ref="rollFile"/>--> <appender-ref ref="async"/> </root> <!--自定义logger additivity表示是否从 rootLogger继承配置 --> <logger name="com.zs.blog" level="warn" additivity="false"> <appender-ref ref="console"/> </logger> </configuration> -
官方提供的log4j.properties转换成logback.xml
https://logback.qos.ch/translator/
生成后的logback的内容中 的格式信息需要修改即可

3.3 logback-access的使用
logback-access模块与Servlet容器(如Tomcat和Jetty)集成,以提供HTTP访问日志功能。我们可以使
用logback-access模块来替换tomcat的访问日志。
- 将logback-access.jar与logback-core.jar复制到$TOMCAT_HOME/lib/目录下
- 修改$TOMCAT_HOME/conf/server.xml中的Host元素中添加:
<Valve className="ch.qos.logback.access.tomcat.LogbackValve" /> - logback默认会在$TOMCAT_HOME/conf下查找文件 logback-access.xml
<?xml version="1.0" encoding="UTF-8"?> <configuration> <!-- always a good activate OnConsoleStatusListener --> <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.log</file> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <fileNamePattern>access.%d{yyyy-MM-dd}.log.zip</fileNamePattern> </rollingPolicy> <encoder> <!-- 访问日志的格式 --> <pattern>combined</pattern> </encoder> </appender> <appender-ref ref="FILE"/> </configuration> - 官方配置: https://logback.qos.ch/access.html#configuration
4. log4j2的使用
Apache Log4j 2是对Log4j的升级版,参考了logback的一些优秀的设计,并且修复了一些问题,因此带
来了一些重大的提升,主要有:
- 异常处理,在logback中,Appender中的异常不会被应用感知到,但是在log4j2中,提供了一些异
常处理机制。 - 性能提升, log4j2相较于log4j 和logback都具有很明显的性能提升,后面会有官方测试的数据。
- 自动重载配置,参考了logback的设计,当然会提供自动刷新参数配置,最实用的就是我们在生产
上可以动态的修改日志的级别而不需要重启应用。 - 无垃圾机制,log4j2在大部分情况下,都可以使用其设计的一套无垃圾机制,避免频繁的日志收集
导致的jvm gc。
官网: https://logging.apache.org/log4j/2.x/
4.1 Log4j2入门
目前市面上最主流的日志门面就是SLF4J,虽然Log4j2也是日志门面,因为它的日志实现功能非常强
大,性能优越。所以大家一般还是将Log4j2看作是日志的实现,Slf4j + Log4j2应该是未来的大势所趋。
- 添加依赖
<!-- Log4j2 门面API--> <dependency> <groupId>org.apache.logging.log4j</groupId> <artifactId>log4j-api</artifactId> <version>2.11.1</version> </dependency> <!-- Log4j2 日志实现 --> <dependency> <groupId>org.apache.logging.log4j</groupId> <artifactId>log4j-core</artifactId> <version>2.11.1</version> </dependency> - JAVA代码
public class Log4j2Test { // 定义日志记录器对象 public static final Logger LOGGER = LogManager.getLogger(Log4j2Test.class); @Test public void testQuick() throws Exception { LOGGER.fatal("fatal"); LOGGER.error("error"); LOGGER.warn("warn"); LOGGER.info("info"); LOGGER.debug("debug"); LOGGER.trace("trace"); } } - 使用slf4j作为日志的门面,使用log4j2作为日志的实现
<!-- Log4j2 门面API--> <dependency> <groupId>org.apache.logging.log4j</groupId> <artifactId>log4j-api</artifactId> <version>2.11.1</version> </dependency> <!-- Log4j2 日志实现 --> <dependency> <groupId>org.apache.logging.log4j</groupId> <artifactId>log4j-core</artifactId> <version>2.11.1</version> </dependency> <!--使用slf4j作为日志的门面,使用log4j2来记录日志 --> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-api</artifactId> <version>1.7.25</version> </dependency> <!--为slf4j绑定日志实现 log4j2的适配器 --> <dependency> <groupId>org.apache.logging.log4j</groupId> <artifactId>log4j-slf4j-impl</artifactId> <version>2.10.0</version> </dependency>
4.2 Log4j2配置
log4j2默认加载classpath下的 log4j2.xml 文件中的配置。
<?xml version="1.0" encoding="UTF-8"?>
<!--
status="warn": 日志框架本身的日志级别
monitorInterval="5" : 自动加载配置文件的间隔时间不低于5秒中,配置文件修改后无需重启应用
-->
<Configuration status="warn" monitorInterval="5">
<!--集中配置属性管理
使用时通过el表达式
-->
<properties>
<property name="LOG_HOME">logs</property>
</properties>
<!--日志处理器-->
<Appenders>
<!--控制台输出appender
SYSTEM_OUT:黑色
SYSTEM_ERR:红色
-->
<Console name="Console" target="SYSTEM_OUT">
<PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] [%-5level] %c{36}:%L - -- %m%n"/>
</Console>
<!--日志文件输出appender-->
<File name="file" fileName="${LOG_HOME}/myfile.log">
<PatternLayout pattern="[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%-5level] %l %c{36} - %m%n"/>
</File>
<!--日志文件输出appender:随机读写流的输出appender,性能提高-->
<RandomAccessFile name="accessFile" fileName="${LOG_HOME}/myAcclog.log">
<PatternLayout pattern="[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%-5level] %l %c{36} - %m%n"/>
</RandomAccessFile>
<!--安照一定规则拆分的日志文件的 appender-->
<!--拆分后的文件的命名
以天为单位生成一个日志文件夹,在当天内分钟为单位生成日志文件,进行拆分
-->
<RollingFile name="rollingFile" fileName="${LOG_HOME}/myrollog.log"
filePattern="${LOG_HOME}/$${date:yyyy-MM-dd}/myrollog-%d{yyyy- MM-dd-HH-mm}-%i.log">
<!--日志级别过滤器-->
<ThresholdFilter level="debug" onMatch="ACCEPT" onMismatch="DENY"/>
<!--日志消息格式-->
<PatternLayout pattern="[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%-5level] %l %c{36} - %msg%n"/>
<!--拆分规则-->
<Policies>
<!--系统启动时,生成新的日志文件进行记录-->
<OnStartupTriggeringPolicy/>
<!--按照文件大小拆分-->
<SizeBasedTriggeringPolicy size="10 MB"/>
<!--按照时间节点拆分-->
<TimeBasedTriggeringPolicy/>
</Policies>
<!--指定同一个目录下文件的个数限定为30个,超过会进行覆盖-->
<DefaultRolloverStrategy max="30"/>
</RollingFile>
</Appenders>
<!--logger 定义-->
<Loggers>
<!--使用 rootLogger 配置 日志级别
level="trace"
-->
<Root level="trace">
<!--指定日志输出位置-->
<AppenderRef ref="Console"/>
</Root>
</Loggers>
</Configuration>
4.3 Log4j2异步日志
异步日志
log4j2最大的特点就是异步日志,其性能的提升主要也是从异步日志中受益,我们来看看如何使用
log4j2的异步日志。
- 同步日志

- 异步日志

Log4j2提供了两种实现日志的方式,一个是通过AsyncAppender,一个是通过AsyncLogger,分别对应
前面我们说的Appender组件和Logger组件。
注意:配置异步日志需要添加依赖
<!--异步日志依赖-->
<dependency>
<groupId>com.lmax</groupId>
<artifactId>disruptor</artifactId>
<version>3.3.4</version>
</dependency>
- AsyncAppender方式,(性能同logback差不多)
<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="warn">
<properties>
<property name="LOG_HOME">D:/logs</property>
</properties>
<Appenders>
<File name="file" fileName="${LOG_HOME}/myfile.log">
<PatternLayout>
<Pattern>%d %p %c{1.} [%t] %m%n</Pattern>
</PatternLayout>
</File>
<Async name="Async">
<AppenderRef ref="file"/>
</Async>
</Appenders>
<Loggers>
<Root level="error">
<AppenderRef ref="Async"/>
</Root>
</Loggers>
</Configuration>
- AsyncLogger方式(推荐使用)
AsyncLogger才是log4j2 的重头戏,也是官方推荐的异步方式。它可以使得调用Logger.log返回的
更快。你可以有两种选择:全局异步和混合异步。
-
全局异步就是,所有的日志都异步的记录,在配置文件上不用做任何改动,只需要添加一个
log4j2.component.properties 配置;Log4jContextSelector=org.apache.logging.log4j.core.async.AsyncLoggerCon textSelector -
混合异步就是,你可以在应用中同时使用同步日志和异步日志,这使得日志的配置方式更加
灵活。<?xml version="1.0" encoding="UTF-8"?> <Configuration status="WARN"> <properties> <property name="LOG_HOME">D:/logs</property> </properties> <Appenders> <File name="file" fileName="${LOG_HOME}/myfile.log"> <PatternLayout> <Pattern>%d %p %c{1.} [%t] %m%n</Pattern> </PatternLayout> </File> <!--<Async name="Async"> <AppenderRef ref="file"/> </Async>--> </Appenders> <Loggers> <!-- includeLocation 关闭日志信息的行号功能,可能会影响到日志的性能 additivity:不再继承rootloger对象 --> <AsyncLogger name="com.itheima" level="trace" includeLocation="false" additivity="false"> <AppenderRef ref="file"/> </AsyncLogger> <Root level="info" includeLocation="true"> <AppenderRef ref="file"/> </Root> </Loggers> </Configuration>如上配置: com.itheima 日志是异步的,root日志是同步的。
使用异步日志需要注意的问题:
- 如果使用异步日志,AsyncAppender、AsyncLogger和全局日志,不要同时出现。性能会和AsyncAppender一致,降至最低。
- 设置includeLocation=false ,打印位置信息会急剧降低异步日志的性能,比同步日志还要
慢。
4.4 Log4j2的性能

无垃圾记录
垃圾收集暂停是延迟峰值的常见原因,并且对于许多系统而言,花费大量精力来控制这些暂停。
许多日志库(包括以前版本的Log4j)在稳态日志记录期间分配临时对象,如日志事件对象,字符串,
字符数组,字节数组等。这会对垃圾收集器造成压力并增加GC暂停发生的频率。
从版本2.6开始,默认情况下Log4j以“无垃圾”模式运行,其中重用对象和缓冲区,并且尽可能不分配临
时对象。还有一个“低垃圾”模式,它不是完全无垃圾,但不使用ThreadLocal字段。
Log4j 2.6中的无垃圾日志记录部分通过重用ThreadLocal字段中的对象来实现,部分通过在将文本转换
为字节时重用缓冲区来实现。
使用Log4j 2.5:内存分配速率809 MB /秒,141个无效集合。

Log4j 2.6没有分配临时对象:0(零)垃圾回收。

有两个单独的系统属性可用于手动控制Log4j用于避免创建临时对象的机制:
log4j2.enableThreadlocals- 如果“true”(非Web应用程序的默认值)对象存储在
ThreadLocal字段中并重新使用,否则将为每个日志事件创建新对象。log4j2.enableDirectEncoders- 如果将“true”(默认)日志事件转换为文本,则将此文本转换
为字节而不创建临时对象。注意: 由于共享缓冲区上的同步,在此模式下多线程应用程序的同步
日志记录性能可能更差。如果您的应用程序是多线程的并且日志记录性能很重要,请考虑使用异步
记录器。
5. SpringBoot中的日志使用
springboot框架在企业中的使用越来越普遍,springboot日志也是开发中常用的日志系统。springboot
默认就是使用SLF4J作为日志门面,logback作为日志实现来记录日志。
5.1 SpringBoot中的日志设计
springboot中的日志
<dependency>
<artifactId>spring-boot-starter-logging</artifactId>
<groupId>org.springframework.boot</groupId>
</dependency>

总结:
- springboot 底层默认使用logback作为日志实现。
- 使用了SLF4J作为日志门面
- 将JUL也转换成slf4j
- 也可以使用log4j2作为日志门面,但是最终也是通过slf4j调用logback
5.2 SpringBoot日志使用
-
在springboot中测试打印日志
@Component @ConfigurationProperties(prefix = "test") @PropertySource(value = "classpath:/application.properties", encoding = "UTF-8") public class springTest { //记录器 public static final Logger LOGGER = LoggerFactory.getLogger(springTest.class); @Test public void contextLoads() { // 打印日志信息 LOGGER.error("error"); LOGGER.warn("warn"); LOGGER.info("info");// 默认日志级别 LOGGER.debug("debug"); LOGGER.trace("trace"); } } -
修改默认日志配置
# 指定自定义 logger 对象日志级别 logging.level.com.itheima=trace # 在控制台输出的日志的格式 同logback logging.pattern.console=%d{yyyy-MM-dd} [%thread] [%-5level] %logger{50} - %msg%n # 指定文件中日志输出的格式 # logging.file=D:/logs/springboot.log # 指定日志存放的目录,默认的文件名 spring.log logging.file.path=/logs/springboot/ # 指定文件输出格式 logging.pattern.file=%d{yyyy-MM-dd} [%thread] %-5level %logger{50} - %msg%n -
指定配置
给类路径下放上每个日志框架自己的配置文件;SpringBoot就不使用默认配置的了

logback.xml:直接就被日志框架识别了 -
使用SpringBoot解析日志配置
logback-spring.xml:由SpringBoot解析日志配置
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<springProfile name="dev">
<pattern>${pattern}</pattern>
</springProfile>
<springProfile name="pro">
<pattern>%d{yyyyMMdd:HH:mm:ss.SSS} [%thread] %-5level %msg%n</pattern>
</springProfile>
</encoder>
application.properties
spring.profiles.active=dev
- 将日志切换为log4j2
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<exclusions>
<!--排除logback-->
<exclusion>
<artifactId>spring-boot-starter-logging</artifactId>
<groupId>org.springframework.boot</groupId>
</exclusion>
</exclusions>
</dependency>
<!-- 添加log4j2 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>
记录一个配置
<?xml version="1.0" encoding="UTF-8"?>
<!--
status: 框架日志级别
-->
<Configuration status="WARN">
<!--
集中配置属性管理
-->
<Properties>
<Property name="PID">mylog</Property>
<Property name="LOG_EXCEPTION_CONVERSION_WORD">%xwEx</Property>
<Property name="LOG_LEVEL_PATTERN">%5p</Property>
<!--<Property name="LOG_PATTERN">%d{yyyy-MM-dd HH:mm:ss} %-5level [%thread][%file:%line] - %msg%n</Property>-->
<!--参考文档 https://logging.apache.org/log4j/2.x/manual/layouts.html#PatternLayout -->
<Property name="LOG_PATTERN">%highlight{%d{yyyy-MM-dd HH:mm:ss} %-5level [%thread] %logger{1.} - %msg%n%}
</Property>
<!--日志路径-->
<Property name="baseDir">./apps/logs</Property>
</Properties>
<!--用于入库日志表对应级别-->
<CustomLevels>
<CustomLevel name="DIAG" intLevel="350"/>
</CustomLevels>
<Appenders>
<!--控制台输出-->
<Console name="Console" target="SYSTEM_OUT" follow="true">
<PatternLayout pattern="${LOG_PATTERN}"/>
</Console>
<!--RollingFile代替file,按时间输出所有info日志-->
<RollingFile name="InfoFile" fileName="${baseDir}/iplat.app.log"
filePattern="${baseDir}/$${date:yyyyMMdd}/iplat-%d{yyyy-MM-dd-HH}.log">
<!--日志格式-->
<PatternLayout pattern="[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%-5level] %l %logger{36} - %msg%n"/>
<!--日志拆分规则-->
<Policies>
<!--系统启动时,生成新的日志文件进行记录-->
<OnStartupTriggeringPolicy/>
<!--按照时间节点拆分-->
<TimeBasedTriggeringPolicy interval="1"/>
<!--文件大小超过200m新生成一个-->
<!-- <SizeBasedTriggeringPolicy size="100 MB"/>-->
<!--同一个文件夹下最多-->
<!-- <DefaultRolloverStrategy max="32" />-->
</Policies>
<!--文件最大配置,超出则删除历史日志-->
<DefaultRolloverStrategy max="100">
<Delete basePath="${baseDir}" maxDepth="2">
<IfFileName glob="*/iplat-*.log">
<IfLastModified age="10d">
<IfAny>
<IfAccumulatedFileSize exceeds="10 GB"/>
<IfAccumulatedFileCount exceeds="240"/>
</IfAny>
</IfLastModified>
</IfFileName>
</Delete>
</DefaultRolloverStrategy>
</RollingFile>
<!--按日期输出错误日志,方便项目定位错误-->
<RollingFile name="ErrorFile" fileName="${baseDir}/iplat.error.log"
filePattern="${baseDir}/$${date:yyyyMMdd}/iplat-error-%d{yyyy-MM-dd-HH}.log">
<PatternLayout pattern="[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%-5level] %l %logger{36} - %msg%n"/>
<Policies>
<!--默认1小时滚动一次-->
<TimeBasedTriggeringPolicy interval="1"/>
</Policies>
</RollingFile>
<TextArea name="platLogAppender">
<PatternLayout pattern="%m%n"/>
</TextArea>
<Async name="Async">
<AppenderRef ref="InfoFile"/>
<AppenderRef ref="platLogAppender"/>
</Async>
<Async name="AsyncError">
<AppenderRef ref="ErrorFile"/>
</Async>
<!--用于入库自定日志表对应级别,注意表名及表空间,初始化类-->
<!--JDBC name="databaseAppender" tableName="wxcw.operate_log">
<ConnectionFactory class="com.baosight.wxplat.common.utils.log4j.PoolManager" method="getConnection"/>
<Column name="log_date" isEventTimestamp="true"/>
<Column name="log_file" pattern="%file"/>
<Column name="log_line" pattern="%line"/>
<Column name="log_thread" pattern="%thread"/>
<Column name="log_level" pattern="%level"/>
<Column name="log_message" pattern="%message"/>
<Column name="log_user" pattern="%X{user}"/>
</JDBC-->
</Appenders>
<Loggers>
<!--用来增加sql的日志,无论下面root logger级别是什么都输出sql log-->
<logger name="com.baosight.iplat4j.core.data.ibatis.dao.SqlMapDaoLogProxy" level="info"/>
<logger name="com.baosight.iplat4j.core.security.sso" level="debug"/>
<!--过滤掉spring的一些无用的debug信息-->
<logger name="org.springframework" level="error"/>
<logger name="org.thymeleaf" level="error"/>
<!--输出到数据库-->
<!--<logger name="com.baosight.iplat4j.core.log.xeye.PlatEye" level="diag">-->
<!--<appender-ref ref="databaseAppender"/>-->
<!--</logger>-->
<!--警告日志输出文件,可修改-->
<!--默认info及以上级别在控制台输出-->
<Root level="info">
<AppenderRef ref="Async" level="info"/>
<AppenderRef ref="AsyncError" level="error"/>
<AppenderRef ref="Console" level="info"/>
</Root>
<Root level="error">
<AppenderRef ref="Async" level="error"/>
<AppenderRef ref="AsyncError" level="error"/>
<AppenderRef ref="Console" level="error"/>
</Root>
</Loggers>
</Configuration>
593

被折叠的 条评论
为什么被折叠?



