扫二维码与项目经理沟通
我们在微信上24小时期待你的声音
解答本文疑问/技术咨询/运营咨询/技术建议/互联网交流
日志文件是用于记录系统操作事件的文件集合
创新互联主营赫山网站建设的网络公司,主营网站建设方案,重庆APP开发公司,赫山h5小程序开发搭建,赫山网站营销推广欢迎赫山等地区企业咨询
系统日志是记录系统中硬件、软件和系统问题的信息，同时还可以监视系统中发生的事件。用户可以通过它来检查错误发生的原因，或者寻找受到攻击时攻击者留下的痕迹
当我们的系统变的更加复杂的时候，我们的日志就容易发生混乱。随着系统开发的进行，可能会更新不同的日志框架，造成当前系统中存在不同的日志依赖，让我们难以统一的管理和控制。所以我们需要借鉴 JDBC 的思想，为日志系统也提供一套门面，那么我们就可以面向这些接口规范来开发，避免了直接依赖具体的日志框架。这样我们的系统在日志中，就存在了日志的门面和日志的实现
常见的日志门面：JCL、Slf4j
常见的日志实现：JUL、log4j、logback、log4j2
日志门面和日志实现的关系：
使用日志门面的优势：
JUL（Java util Logging）是 Java 原生的日志实现框架，使用时不需要另外引用第三方类库，相对其他日志框架使用方便，学习简单，能够在小型应用中灵活使用
总结一下就是：
public class JULTest {
@Test
public void testQuick() throws Exception {
// 1.创建日志记录器对象
Logger logger = Logger.getLogger("com.itheima.log.JULTest");
// 2.日志记录输出
logger.info("hello jul");
logger.log(Level.INFO, "info msg");
String name = "jack";
Integer age = 18;
logger.log(Level.INFO, "用户信息：{0},{1}", new Object[]{name, age});
}
}
JUL 中定义的日志级别：SEVERE（最高值）、WARNING、INFO（默认级别）、CONFIG、FINE、FINER、FINEST（最低值）
还有两个特殊的级别：OFF，可用来关闭日志记录、ALL，启用所有消息的日志记录
@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");
}
虽然我们测试了 7 个日志级别，但是默认只实现 info 以上的级别，info 以下不会输出，我们可以自定义日志级别配置
@Test
public void testLogConfig() throws Exception {
// 创建日志记录器对象
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.severe("severe");
logger.warning("warning");
logger.info("info");
logger.config("config");
logger.fine("fine");
logger.finer("finer");
logger.finest("finest");
}
JUL 中 Logger 之间存在父子关系，这种父子关系通过树状结构存储，JUL 在初始化时会创建一个顶层 RootLogger 作为所有 Logger 父 Logger，存储上作为树状结构的根节点，父子关系通过包路径来关联
@Test
public void testLogParent() throws Exception {
// 日志记录器对象父子关系
Logger logger1 = Logger.getLogger("com.itheima");
Logger logger2 = Logger.getLogger("com");
// true
System.out.println(logger1.getParent() == logger2);
// 所有日志记录器对象的顶级父元素 class 为 java.util.logging.LogManager$RootLogger
// logger2 parent: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继承logger2的级别配置
logger1.severe("severe");
logger1.warning("warning");
logger1.info("info");
logger1.config("config");
logger1.fine("fine");
logger1.finer("finer");
logger1.finest("finest");
}
默认配置文件路径 $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 = ALL
# 输出日志格式
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
# 输出日志文件路径
# /logs/java0.log
java.util.logging.FileHandler.pattern = /logs/java%u.log
# 输出日志文件限制大小（50000字节）
java.util.logging.FileHandler.limit = 50000
# 输出日志文件限制个数
java.util.logging.FileHandler.count = 10
# 输出日志文件是否是追加
java.util.logging.FileHandler.append=true
Log4j 是Apache 下的一款开源的日志实现框架，通过在项目中使用 Log4J，我们可以控制日志信息输出到控制台、文件、甚至是数据库中。我们可以控制每一条日志的输出格式，通过定义日志的输出级别，可以更灵活的控制日志的输出过程，方便项目调试
log4j
log4j
1.2.17
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 都被定义了一个日志级别，用来控制日志信息的输出，日志级别从高到低分为：
还有两个特殊的级别：OFF 可用来关闭日志记录、ALL 启用所有消息的日志记录
日志记录器，负责收集处理日志记录，实例的命名就是类的全限定名
Logger 的名字大小写敏感，其命名有继承机制，例如：name 为 org.apache.commons 的 logger 会继承 name 为 org.apache 的 logger
Log4J 中有一个特殊的 logger 叫做 root，他是所有 logger 的根，可以用 Logger.getRootLogger() 方法获取，其他所有的 logger 都会直接或间接地继承自 root
Appender 用来指定日志输出到哪个地方，可以同时指定日志的输出目的地。Log4j 常用的输出目的地有以下几种：
布局器 Layouts 用于控制日志输出内容的格式，让我们可以使用各种需要的格式输出日志。Log4j 常用的 Layouts：
#指定日志的输出级别与输出端
log4j.rootLogger=INFO,Console
# 自定义Logger
# com.itheima包下的logger使用文件输出配置
log4j.logger.com.itheima = info,file
# apache包下的logger输出error级别日志
log4j.logger.org.apache = error
# 控制台输出配置
log4j.appender.Console=org.apache.log4j.ConsoleAppender
log4j.appender.Console.layout=org.apache.log4j.PatternLayout
# 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=%d [%t] %-5p [%c] - %m%n
# 文件输出配置
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
#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`)
);
全称为 Jakarta Commons Logging，是 Apache 提供的一个日志门面实现，为所有的 Java 日志实现提供一个统一的接口，它自身也提供一个日志的实现，但是功能较弱，它允许开发人员使用不同的具体日志实现工具，如：Log4J，JUL
JCL 有两个基本的抽象类：Log（基本记录器）和 LogFactory（负责创建 Log 实例）
commons-logging
commons-logging
1.2
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");
}
}
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);
}
classesToDiscover 数组是 JCL 支持的日志实现数组，对它进行遍历，尝试通过反射去实现
SLF4J（Simple Logging Facade For Java）主要是为了给 Java 日志访问提供一套标准、规范的 API 框架，其主要意义在于提供接口，具体的实现可以交由其他日志框架，例如 log4j 和 logback 等
SLF4J 也提供了功能较为简单的实现，但是一般很少用到。对于一般的 Java 项目而言，日志框架会选择 slf4j-api 作为门面，配上具体的实现框架（log4j、logback 等），中间使用桥接器完成桥接
SLF4J 的优势：
org.slf4j
slf4j-api
1.7.27
org.slf4j
slf4j-simple
1.7.27
public class Slf4jTest {
// 声明日志对象
public final static Logger LOGGER = LoggerFactory.getLogger(Slf4jTest.class);
@Test
public void testQuick() throws Exception {
// 打印日志信息
LOGGER.error("error");
LOGGER.warn("warn");
LOGGER.info("info");
LOGGER.debug("debug");
LOGGER.trace("trace");
// 使用占位符输出日志信息
String name = "jack";
Integer age = 18;
LOGGER.info("用户：{},{}", name, age);
// 将系统异常信息写入日志
try {
int i = 1 / 0;
} catch (Exception e) {
// e.printStackTrace();
LOGGER.info("出现异常：", e);
}
}
}
SLF4J 提供了用于绑定日志实现框架的 Jar 文件，每个绑定对应一个受支持的框架
使用 SLF4J 的日志绑定流程如下：
通过 maven 引入常见的日志实现框架：
org.slf4j
slf4j-api
1.7.27
org.slf4j
slf4j-log4j12
1.7.27
log4j
log4j
1.2.17
org.slf4j
slf4j-jdk14
1.7.27
ch.qos.logback
logback-classic
1.2.3
要切换日志框架，只需替换类路径上的 slf4j 绑定，例如，要从 java.util.logging 切换到 log4j，只需将 java.util.logging 的依赖替换为 log4j 的依赖即可
如果出现多个日志实现。默认加载第一个实现，也就是会使用 log4j
项目初期使用了一个简单的日志实现框架，如 Log4J，后续需要升级成 Slf4J + Logback，但又不想修改原有 Log4J 的代码，因此可以使用桥接器，将原本对 Log4J 的 API 调用重定向到 Slf4J 的实现
例如，最初的项目使用了 Log4J
log4j
log4j
1.2.17
public class Log4jTest {
// 声明日志对象
public final static Logger LOGGER = Logger.getLogger(Log4jTest.class);
@Test
public void test01() throws Exception {
// 打印日志信息
LOGGER.info("hello log4j");
}
}
如果我们要使用 SLF4J 的桥接器，替换原有的日志框架，那么我们需要做的第一件事情，就是删除掉原有项目中的日志框架的依赖，然后替换成 SLF4J 提供的桥接器
org.slf4j
log4j-over-slf4j
1.7.27
注意的问题：
Logback 是由 log4j 创始人设计的另一个开源日志组件，性能优于 log4j
Logback 主要分为三个模块：
org.slf4j
slf4j-api
1.7.25
ch.qos.logback
logback-classic
1.2.3
public class LogBackTest {
//定义日志对象
public final static Logger LOGGER = LoggerFactory.getLogger(LogBackTest.class);
@Test
public void testSlf4j(){
//打印日志信息
LOGGER.error("error");
LOGGER.warn("warn");
LOGGER.info("info");
LOGGER.debug("debug");
LOGGER.trace("trace");
}
}
Logback 会依次读取以下类型配置文件，如果均不存在会采用默认配置：
基本配置信息如下：
System.err
${pattern}
${pattern}
${log_dir}/logback.log
${pattern}
${log_dir}/logback.html
${pattern}
${log_dir}/roll_logback.log
${log_dir}/rolling.%d{yyyy-MMdd}.log%i.gz
1MB
error
ACCEPT
DENY
Log4j2 也是日志门面，因为它的日志实现功能非常强大，性能优越，所以一般还是将 Log4j2 看作是日志的实现
org.apache.logging.log4j
log4j-api
2.11.1
org.apache.logging.log4j
log4j-core
2.11.1
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 作为日志的实现
org.slf4j
slf4j-api
1.7.25
org.apache.logging.log4j
log4j-slf4j-impl
2.10.0
org.apache.logging.log4j
log4j-api
2.11.1
org.apache.logging.log4j
log4j-core
2.11.1
log4j2 默认加载 classpath 下的 log4j2.xml 文件中的配置
D:/logs
Log4j2 提供了两种实现日志的方式，一个是通过 AsyncAppender，一个是通过 AsyncLogger，分别对应前面的 Appender 组件和 Logger 组件
配置异步日志需要添加依赖
com.lmax
disruptor
3.3.4
使用 AsyncAppender 的方式
D:/logs
%d %p %c{1.} [%t] %m%n
AsyncLogger 是官方推荐的异步方式，它可以使得调用 Logger.log 返回得更快，并且有两种选择：全局异步和混合异步
全局异步：所有的日志都异步记录，配置文件上不用做任何改动，只需要在类路径添加一个名为 log4j2.component.properties 配置文件，并包含如下内容：
Log4jContextSelector=org.apache.logging.log4j.core.async.AsyncLoggerContextSelector
混合异步：可以在应用中同时使用同步日志和异步日志，这使得日志的配置方式更加灵活，如下配置： com.itheima 日志是异步的，root 日志是同步的
D:/logs
%d %p %c{1.} [%t] %m%n
垃圾收集暂停是延迟峰值的常见原因，并且对于许多系统而言，花费大量精力来控制这些暂停
许多日志库（包括以前版本的 Log4j）在稳态日志记录期间分配临时对象，如日志事件对象、字符串、字符数组、字节数组等。这会对垃圾收集器造成压力并增加 GC 暂停发生的频率
从 2.6 版本开始，默认情况下 Log4j 以无垃圾模式运行，重用对象和缓冲区，尽可能不分配临时对象
还有一个低垃圾模式，它不是完全无垃圾，但不使用 ThreadLocal 字段，Log4j 2.6 中的无垃圾日志记录部分通过重用 ThreadLocal 字段中的对象来实现，部分通过在将文本转换为字节时重用缓冲区来实现
有两个单独的系统属性可用于手动控制 Log4j 用于避免创建临时对象的机制：
log4j2.enableThreadlocals：如果为 true（默认），对象存储在 ThreadLocal 字段中并重新使用，否则将为每个日志事件创建新对象log4j2.enableDirectEncoders：如果为 true（默认），日志事件转换为文本，则将此文本转换为字节而不创建临时对象。注意：由于共享缓冲区上的同步，在此模式下多线程应用程序的同步日志记录性能可能更差，如果您的应用程序是多线程的并且日志记录性能很重要，请考虑使用异步记录器Springboot 默认使用 SLF4J 作为日志门面，logback 作为日志实现来记录日志
spring-boot-starter-logging
org.springframework.boot
依赖关系图：
在 springboot 中测试打印日志
@SpringBootTest
class SpringbootLogApplicationTests {
//记录器
public static final Logger LOGGER = LoggerFactory.getLogger(SpringbootLogApplicationTests.class);
@Test
public void contextLoads() {
// 打印日志信息
LOGGER.error("error");
LOGGER.warn("warn");
LOGGER.info("info"); // 默认日志级别
LOGGER.debug("debug");
LOGGER.trace("trace");
}
}
修改默认日志配置
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
logging.pattern.file=%d{yyyy-MM-dd} [%thread] %-5level %logger{50} - %msg%n
给类路径下放上每个日志框架自己的配置文件，SpringBoot 就不使用默认配置的了
使用 SpringBoot 可以切换不同环境的日志配置，如在 logback-spring.xml 添加如下内容：
...
${pattern}
%d{yyyyMMdd:HH:mm:ss.SSS} [%thread] %-5level %msg%n
...
application.properties 配置如下：
spring.profiles.active=dev
如果希望将日志切换为 log4j2
org.springframework.boot
spring-boot-starter-web
spring-boot-starter-logging
org.springframework.boot
org.springframework.boot
spring-boot-starter-log4j2
我们在微信上24小时期待你的声音
解答本文疑问/技术咨询/运营咨询/技术建议/互联网交流
微信二维码
移动版官网