Java日志框架 -- LOG4J（Log4j入门案例日志级别Log4j组件（LoggersAppendersLayouts）配置文件内置日志记录自定义Logger）

Posted 2022-08-18 CodeJiao

1. LOG4J 学习

Log4j是Apache下的一款开源的日志框架，通过在项目中使用 Log4J，我们可以控制日志信息输出到控制台、文件、甚至是数据库中。我们可以控制每一条日志的输出格式，通过定义日志的输出级别，可以更灵活的控制日志的输出过程。方便项目的调试。

官方网站： http://logging.apache.org/log4j/1.2/

---

1.1 Log4j入门案例

1. 创建一个普通的Maven项目：

2. 导入log4j的依赖和单元测试junit的依赖：

    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
        </dependency>
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>
    </dependencies>

3. 编写测试代码：

Log4jTest.java

package com.tian.logs;


import org.apache.log4j.Logger;
import org.junit.Test;

public class Log4jTest 
    @Test
    public void testQuick() throws Exception 
        // 创建日志记录器对象
        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"); // 追踪信息，记录程序的所有流程信息
    

运行结果：

出现这个的原因是因为我们没有正确的初始化Log4j

解决办法：

        // 初始化系统配置
        BasicConfigurator.configure();

---

1.2 Log4j日志级别

一般只使用4个级别，优先级从高到低为 ERROR > WARN > INFO > DEBUG

---

1.3 Log4j组件

Log4J 主要由 Loggers (日志记录器)、Appenders（输出端）和 Layout（日志格式化器）组成。

• Loggers 控制日志的输出级别与日志是否输出
• Appenders 指定日志的输出方式（输出到控制台、文件、数据库等）
• Layout 控制日志信息的输出格式。

---

1.3.1 Loggers

日志记录器，负责收集处理日志记录，实例的命名就是类"XX"类的全限定名，Logger的名字大小写敏感，其命名有继承机制：例如：name为org.apache.commons的logger会继承name为org.apache的logger。

Log4J中有一个特殊的logger叫做"root"，他是所有logger的根，也就意味着其他所有的logger都会直接或者间接地继承自root。root logger可以用Logger.getRootLogger()方法获取。

---

1.3.2 Appenders

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

Appender类型	作用
ConsoleAppender	将日志输出到控制台
FileAppender	将日志输出到文件中
DailyRollingFileAppender	将日志输出到一个日志文件，并且每天输出到一个新的文件
RollingFileAppender	将日志信息输出到一个日志文件，并且指定文件的尺寸，当文件大小达到指定尺寸时，会自动把文件改名，同时产生一个新的文件
JDBCAppender	把日志信息保存到数据库中

---

1.3.3 Layouts

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

Layout类型	作用
htmlLayout	格式化日志输出为HTML表格形式
SimpleLayout	简单的日志输出格式化，打印的日志格式为（info - message）
PatternLayout	最强大的格式化期，可以根据自定义格式输出日志，如果没有指定转换格式，就是用默认的转换格式

---

1.4 使用配置文件

log4j.properties

# 指定 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

运行结果：

---

1.5 Log4j 的内置日志记录

Log4j 的内置日志记录可以看到Log4j是如何读取配置文件的：

示例：

运行结果：

---

1.6 Log4j的layouts配置（针对PatternLayout ）

在 log4j.properties 配置文件中，我们定义了日志输出级别与输出端，在输出端中分别配置日志的输出格式：

示例：

log4j.properties

# 指定 RootLogger 顶级父元素默认配置信息
# 指定日志级别=trace，使用的 appender 为=console
log4j.rootLogger=trace,console
# 指定控制台日志输出的 appender
log4j.appender.console=org.apache.log4j.ConsoleAppender
# 指定消息格式 layout
log4j.appender.console.layout=org.apache.log4j.PatternLayout
# 指定消息格式的内容
log4j.appender.console.layout.conversionPattern=[%-10p]%r  %l %dyyyy-MM-dd HH:mm:ss.SSS %m%n
# %m: 输出代码中指定的日志信息
# %p: 输出优先级，及 DEBUG、INFO 等
# %n: 换行符（Windows平台的换行符为 "\\n"，Unix 平台为 "\\n"）
# %r: 输出自应用启动到输出该 log 信息耗费的毫秒数
# %c: 输出打印语句所属的类的全名
# %t: 输出产生该日志的线程全名
# %d: 输出服务器当前时间，默认为 ISO8601，也可以指定格式，如：%dyyyy年MM月dd日 HH:mm:ss
# %l: 输出日志时间发生的位置，包括类名、线程、及在代码中的行数。如：Test.main(Test.java:10)
# %F: 输出日志消息产生时所在的文件名称
# %L: 输出代码中的行号
# %%: 输出一个 "%" 字符

运行结果：

---

1.7 Log4j的FileAppender配置

---

1.7.1 输出到文件的配置

log4j.properties

# 指定 RootLogger 顶级父元素默认配置信息
# 指定日志级别=trace，使用的 appender 为=console
log4j.rootLogger=trace,console,file
# 指定控制台日志输出的 appender
log4j.appender.console=org.apache.log4j.ConsoleAppender
# 指定消息格式 layout
log4j.appender.console.layout=org.apache.log4j.PatternLayout
# 指定消息格式的内容
log4j.appender.console.layout.conversionPattern=[%-10p]%r  %l %dyyyy-MM-dd HH:mm:ss.SSS %m%n
# 日志文件输出的 appender 对象
log4j.appender.file=org.apache.log4j.FileAppender
# 指定消息格式 layout
log4j.appender.file.layout=org.apache.log4j.PatternLayout
# 指定消息格式的内容
log4j.appender.file.layout.conversionPattern=[%-10p]%r  %l %dyyyy-MM-dd HH:mm:ss.SSS %m%n
# 指定日志文件保存路径
log4j.appender.file.file=C:/logs/log4j.log
# 指定日志文件的字符集
log4j.appender.file.encoding=UTF-8

运行结果：

---

1.7.2 按照文件大小拆分日志文件

log4j.properties

# 指定 RootLogger 顶级父元素默认配置信息
# 指定日志级别=trace，使用的 appender 为=console
log4j.rootLogger=trace,console,rollingFile
# 指定控制台日志输出的 appender
log4j.appender.console=org.apache.log4j.ConsoleAppender
# 指定消息格式 layout
log4j.appender.console.layout=org.apache.log4j.PatternLayout
# 指定消息格式的内容
log4j.appender.console.layout.conversionPattern=[%-10p]%r  %l %dyyyy-MM-dd HH:mm:ss.SSS %m%n
# 按照文件大小拆分的 appender 对象
# 日志文件输出的 appender 对象
log4j.appender.rollingFile=org.apache.log4j.RollingFileAppender
# 指定消息格式 layout
log4j.appender.rollingFile.layout=org.apache.log4j.PatternLayout
# 指定消息格式的内容
log4j.appender.rollingFile.layout.conversionPattern=[%-10p]%r  %l %dyyyy-MM-dd HH:mm:ss.SSS %m%n
# 指定日志文件保存路径
log4j.appender.rollingFile.file=C:/logs/log4j.log
# 指定日志文件的字符集
log4j.appender.rollingFile.encoding=UTF-8
# 指定日志文件内容的大小
log4j.appender.rollingFile.maxFileSize=10KB
# 指定日志文件的数量
log4j.appender.rollingFile.maxBackupIndex=10

说明：指定日志文件内容的大小

测试：

我们去改下测试代码，然日志文件的内容稍微多点。

运行结果：

---

1.7.3 按照时间顺序拆分日志文件

log4j.properties

# 指定 RootLogger 顶级父元素默认配置信息
# 指定日志级别=trace，使用的 appender 为=console
log4j.rootLogger=trace,console,dailyRole
# 指定控制台日志输出的 appender
log4j.appender.console=org.apache.log4j.ConsoleAppender
# 指定消息格式 layout
log4j.appender.console.layout=org.apache.log4j.PatternLayout
# 指定消息格式的内容
log4j.appender.console.layout.conversionPattern=[%-10p]%r  %l %dyyyy-MM-dd HH:mm:ss.SSS %m%n
# 按照文件日期拆分的 appender 对象
# 日志文件输出的 appender 对象
log4j.appender.dailyRole=org.apache.log4j.DailyRollingFileAppender
# 指定消息格式 layout
log4j.appender.dailyRole.layout=org.apache.log4j.PatternLayout
# 指定消息格式的内容
log4j.appender.dailyRole.layout.conversionPattern=[%-10p]%r  %l %dyyyy-MM-dd HH:mm:ss.SSS %m%n
# 指定日志文件保存路径
log4j.appender.dailyRole.file=C:/logs/log4j.log
# 指定日志文件的字符集
log4j.appender.dailyRole.encoding=UTF-8

运行结果：

以秒为单位去拆分日志文件：

运行结果：

---

1.7.4 输出到数据库的配置

我们先用mysql数据库建立一张表：

CREATE TABLE `log`
(
    `log_id`       int 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`)
) ENGINE = InnoDB
  DEFAULT CHARSET = utf8mb3;

然后在pom.xml文件中导入MySQL的依赖：

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.25</version>
        </dependency>

编写配置文件代码：

log4j.properties

# 指定 RootLogger 顶级父元素默认配置信息
# 指定日志级别=trace，使用的 appender 为=console
log4j.rootLogger=trace,console,logDB
# 指定控制台日志输出的 appender
log4j.appender.console=org.apache.log4j.ConsoleAppender
# 指定消息格式 layout
log4j.appender.console.layout=org.apache.log4j.PatternLayout
# 指定消息格式的内容
log4j.appender.console.layout.conversionPattern=[%-10p]%r  %l %dyyyy-MM-dd HH:mm:ss.SSS %m%n
#mysql
log4j.appender.logDB=org.apache.log4j.jdbc.JDBCAppender
# sql驱动
log4j.appender.logDB.Driver=com.mysql.cj.jdbc.Driver
# sql连接
log4j.appender.logDB.URL=jdbc:mysql://localhost:3306/codejiao
# 用户名
log4j.appender.logDB.User=root
# 用户密码
log4j.appender.logDB.Password=317525
# 插入语句
log4j.appender.logDB.Sql=INSERT INTO log(project_name,create_date,level,category,file_name,thread_name,line,all_category,message) values('codejiao','%dyyyy-MM-dd HH:mm:ss','%p','%c','%F','%t','%L','%l','%m')

运行结果：

---

1.8 自定义Logger

---

1.8.1 自定义Logger

log4j.properties

# 指定 RootLogger 顶级父元素默认配置信息
log4j.rootLogger=trace,console
# 自定义 logger 对象设置
log4j.logger.com.tian.logs=info,file
# 指定控制台日志输出的 appender
log4j.appender.console=org.apache.log4j.ConsoleAppender
# 指定消息格式 layout
log4j.appender.console.layout=org.apache.log4j.PatternLayout
# 指定消息格式的内容
log4j.appender.console.layout.conversionPattern=[%-10p]%r  %l %dyyyy-MM-dd HH:mm:ss.SSS %m%n
# 日志文件输出的 appender 对象
log4j.appender.file=org.apache.log4j.FileAppender
# 指定消息格式 layout
log4j.appender.file.layout=org.apache.log4j.PatternLayout
# 指定消息格式的内容
log4j.appender.file.layout.conversionPattern=[%-10p]%r  %l %dyyyy-MM-dd HH:mm:ss.SSS %m%n
# 指定日志文件保存路径
log4j.appender.file.file=c:/logs/log4j.log

---

1.8.2 测试

package com.tian.logs;


import org.apache.log4j.Logger;
import org.apache.log4j.helpers.LogLog;
import org.junit.Test;

public class Log4jTest 
    @Test
    public void testQuick() throws Exception 
        // 开启 log4j 内置日志记录
        LogLog.setInternalDebugging(true);
        // 创建日志记录器对象
        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"); // 追踪信息，记录程序的所有流程信息
    

运行结果：

---

1.8.3 我们去拓展org.apache.log4j.Logger

编写测试代码：

package com.tian.logs;


import org.apache.log4j.Logger;
import org.apache.log4j.helpers.LogLog;
import org.junit.Test;

public class Log4jTest 
    @Test
    public void testQuick() throws Exception 
        // 开启 log4j 内置日志记录
        LogLog.setInternalDebugging(true);
        // 创建日志记录器对象
        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 logger1 = Logger.getLogger(Logger.class);
        logger1.fatal("fatal logger1"); // 严重错误，一般会造成系统崩溃并终止运行
        logger1.error("error logger1"); // 错误信息，不会影响系统运行
        logger1.warn("warn logger1");   // 警告信息，可能会发生问题
        logger1.info("info logger1");   // 运行信息，数据连接、网络连接、IO 操作等等
        logger1.debug("debug logger1"); // 调试信息，一般在开发中使用，记录程序变量参数传递信息等等
        logger1.trace("trace logger1"); // 追踪信息，记录程序所有的流程信息
    

运行结果：

---

---