【日志技术】LOG4J / LOG4J2

2024-01-18 126

版权

本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。

本文涉及的产品

日志服务 SLS，月写入数据量 50GB 1个月

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

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

官方网站：

https://logging.apache.org/log4j/2.x/

一、Log4j 日志框架：

https://logging.apache.org/log4j/1.2/

1.简单使用Log4j：

1.1 导入Maven依赖：

<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>

1.2 简单使用Log4j：

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

2.日志级别：

* 每个Logger都被了一个日志级别（log level），用来控制日志信息的输出。日志级别从高到低分
为：
  fatal 指出每个严重的错误事件将会导致应用程序的退出。
  error 指出虽然发生错误事件，但仍然不影响系统的继续运行。
  warn 表明会出现潜在的错误情形。
  info 一般和在粗粒度级别上，强调应用程序的运行全程。
  debug 一般用于细粒度级别上，对调试应用程序非常有帮助。
  trace 是程序追踪，可以用于输出程序运行中的变量，显示执行的流程。
* 还有两个特殊的级别：
  OFF，可用来关闭日志记录。
  ALL，启用所有消息的日志记录。

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

3.Log4j 组件：

Log4J 主要由 Loggers (日志记录器)、Appenders（输出端）和 Layout（日志格式化器）组成。其中 Loggers 控制日志的输出级别与日志是否输出；Appenders 指定日志的输出方式（输出到控制台、文件等）；Layout 控制日志信息的输出格式。

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 类的别名。

Appenders（输出端）：

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

Layouts（日志格式化器）：

在 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字符，就从左边交远销出的字符截掉

4.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
# 文件输出配置
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_category,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`)
);

5.自定义Logger：

# RootLogger配置
log4j.rootLogger = trace,console
# 自定义Logger
log4j.logger.com.itheima = info,file
log4j.logger.org.apache = error

@Test
public void testCustomLogger() throws Exception {
    // 自定义 com.itheima
    Logger logger1 = Logger.getLogger(Log4jTest.class);
  logger1.fatal("fatal"); // 严重错误，一般会造成系统崩溃和终止运行
  logger1.error("error"); // 错误信息，但不会影响系统运行
  logger1.warn("warn"); // 警告信息，可能会发生问题
  logger1.info("info"); // 程序运行信息，数据库的连接、网络、IO操作等
  logger1.debug("debug"); // 调试信息，一般在开发阶段使用，记录程序的变量、参数等
  logger1.trace("trace"); // 追踪信息，记录程序的所有流程信息
  // 自定义 org.apache
  Logger logger2 = Logger.getLogger(Logger.class);
  logger2.fatal("fatal logger2"); // 严重错误，一般会造成系统崩溃和终止运行
  logger2.error("error logger2"); // 错误信息，但不会影响系统运行
  logger2.warn("warn logger2"); // 警告信息，可能会发生问题
  logger2.info("info logger2"); // 程序运行信息，数据库的连接、网络、IO操作等
  logger2.debug("debug logger2"); // 调试信息，一般在开发阶段使用，记录程序的变量、参数等
  logger2.trace("trace logger2"); // 追踪信息，记录程序的所有流程信息
}

二、LOG4J2 日志框架：

Log4j2 配置：

log4j2默认加载classpath下的 log4j2.xml 文件中的配置。

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="warn" monitorInterval="5">
    <properties>
        <property name="LOG_HOME">D:/logs</property>
    </properties>
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] [%-5level] %c{36}:%L --- %m%n"/>
        </Console>
        <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>
        <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>
        <RollingFile name="rollingFile" fileName="${LOG_HOME}/myrollog.log"
                     filePattern="D:/logs/$${date:yyyy-MM-dd}/myrollog-%d{yyyyMM-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>
            <DefaultRolloverStrategy max="30"/>
        </RollingFile>
    </Appenders>
    <Loggers>
        <Root level="trace">
            <AppenderRef ref="Console"/>
        </Root>
    </Loggers>
</Configuration>