日志框架（二）Log4J

谁践踏了优雅 2023-01-05 05:03 234阅读 0赞

# 日志框架（二）Log4J #

> 上篇文章介绍了日志的作用，以及JDK自带的日志框架JUL，接下来我们继续学习Log4j框架

## 1. **Log4J** **学习** ##

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

### 1.1 **Log4j**入门 ###

1.  建立maven工程
2.  添加依赖
    
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.13.1</version>
        </dependency>
        
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.20</version>
        </dependency>
3.  入门案例
    
        /** * log4j入门案例 */
            @Test
            public void test() { 
                // 初始化系统配置，不需要配置文件
                BasicConfigurator.configure();
                // 创建日志记录器对象
                Logger logger = Logger.getLogger(Log4jTest.class);
                // 日志记录输出
                logger.info("hello log4j");
                // 日志级别
                // 严重错误，一般会造成系统崩溃和终止运行
                logger.fatal("fatal");
                // 错误信息，但不会影响系统运行
                logger.error("error");
                // 警告信息，可能会发生问题
                logger.warn("warn");
                // 程序运行信息，数据库的连接、网络、IO操作等
                logger.info("info");
                // 调试信息，一般在开发阶段使用，记录程序的变量、参 数等
                logger.debug("debug");
                // 追踪信息，记录程序的所有流程信息
                logger.trace("trace");
            }
4.  日志的级别
    
        * 每个Logger都被了一个日志级别（log level），用来控制日志信息的输出。日志级别从高到低分为：
            fatal 指出每个严重的错误事件将会导致应用程序的退出。
            error 指出虽然发生错误事件，但仍然不影响系统的继续运行。
            warn 表明会出现潜在的错误情形。
            info 一般和在粗粒度级别上，强调应用程序的运行全程。
            debug 一般用于细粒度级别上，对调试应用程序非常有帮助。
            trace 是程序追踪，可以用于输出程序运行中的变量，显示执行的流程。 
        * 还有两个特殊的级别： 
            OFF，可用来关闭日志记录。 
            ALL，启用所有消息的日志记录。
    
    > 注：一般只使用4个级别，优先级从高到低为 ERROR > WARN > INFO > DEBUG

### 1.2 Log4j组件 ###

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

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

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1phY2tfdHpo_size_16_color_FFFFFF_t_70_pic_center]

#### 1.2.2 Appenders ####

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

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

#### 1.2.3 Appenders ####

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

<table> 
 <thead> 
  <tr> 
   <th><strong>格式化器类型</strong></th> 
   <th><strong>作用</strong></th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>HTMLLayout</td> 
   <td>格式化日志输出为HTML表格形式</td> 
  </tr> 
  <tr> 
   <td>SimpleLayout</td> 
   <td>简单的日志输出格式化，打印的日志格式为（info - message）</td> 
  </tr> 
  <tr> 
   <td>PatternLayout</td> 
   <td>最强大的格式化期，可以根据自定义格式输出日志，如果没有指定转换格式，</td> 
  </tr> 
 </tbody> 
</table>

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

### 1.4 **Appender**的输出 ###

控制台，文件，数据库

# 指定日志的输出级别与输出端
    log4j.rootLogger=trace,console,logDB
    # 控制台输出配置
    log4j.appender.console=org.apache.log4j.ConsoleAppender
    # 指定消息格式 layout
    log4j.appender.console.layout=org.apache.log4j.PatternLayout
    # 指定消息格式类容
    log4j.appender.console.layout.conversionPattern=%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %l [%p] %m%n
    # 日志输出到文件中
    log4j.appender.file=org.apache.log4j.FileAppender
    # 指定消息格式 layout
    log4j.appender.file.layout=org.apache.log4j.PatternLayout
    # 指定消息格式类容
    log4j.appender.file.layout.conversionPattern=%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %l [%p] %m%n
    # 指定文件位置
    log4j.appender.file.file=./log/test.log
    # 指定文件编码
    log4j.appender.file.encoding=UTF-8
    # 日志输出到文件中--按照文件大小拆分的
    log4j.appender.rolling=org.apache.log4j.RollingFileAppender
    # 指定消息格式 layout
    log4j.appender.rolling.layout=org.apache.log4j.PatternLayout
    # 指定消息格式类容
    log4j.appender.rolling.layout.conversionPattern=%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %l [%p] %m%n
    # 指定文件位置
    log4j.appender.rolling.file=./log/test.log
    # 指定文件编码
    log4j.appender.rolling.encoding=UTF-8
    # 指定文件大小
    log4j.appender.rolling.maxFileSize=1MB
    # 指定日志数量
    log4j.appender.rolling.maxBackupIndex=10
    # 日志输出到文件中--按照时间拆分的
    log4j.appender.dailyFile=org.apache.log4j.DailyRollingFileAppender
    # 指定消息格式 layout
    log4j.appender.dailyFile.layout=org.apache.log4j.PatternLayout
    # 指定消息格式类容
    log4j.appender.dailyFile.layout.conversionPattern=%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %l [%p] %m%n
    # 指定文件位置
    log4j.appender.dailyFile.file=./log/test.log
    # 指定文件编码
    log4j.appender.dailyFile.encoding=UTF-8
    # 设置日期拆分规则
    log4j.appender.dailyFile.datePattern='.'yyyy-MM-dd
    #mysql
    log4j.appender.logDB=org.apache.log4j.jdbc.JDBCAppender
    log4j.appender.logDB.layout=org.apache.log4j.PatternLayout
    log4j.appender.logDB.Driver=com.mysql.cj.jdbc.Driver
    log4j.appender.logDB.URL=jdbc:mysql://127.0.0.1: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('log4j-demo','%d{yyyy-MM-dd HH:mm:ss}','%p','%c','%F','%t','%L','%l','%m')

### 1.5 **自定义Logger** ###

# RootLogger配置 
    log4j.rootLogger = trace,console 
    # 自定义Logger 
    log4j.logger.com.tzh = info,file 
    log4j.logger.org.apache = error
    
    # 日志输出到文件中
    log4j.appender.file=org.apache.log4j.FileAppender
    # 指定消息格式 layout
    log4j.appender.file.layout=org.apache.log4j.PatternLayout
    # 指定消息格式类容
    log4j.appender.file.layout.conversionPattern=%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %l [%p] %m%n
    # 指定文件位置
    log4j.appender.file.file=./log/test.log
    # 指定文件编码
    log4j.appender.file.encoding=UTF-8

/** * 自定义logger */
        @Test
        public void test4() { 
            Logger logger = Logger.getLogger(Log4jTest.class);
            logger.fatal("fatal");
            logger.error("error");
            logger.warn("warn");
            logger.info("info");
            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");
            logger1.debug("debug logger1");
            logger1.trace("trace logger1");
        }

![在这里插入图片描述][20210111163907306.jpg_pic_center]

## 2. **JCL** 学习 ##

全称为Jakarta Commons Logging，是Apache提供的一个通用日志API。

它是为 "所有的Java日志实现"提供一个统一的接口，它自身也提供一个日志的实现，但是功能非常常（SimpleLog）。所以一般不会单独使用它。他允许开发人员使用不同的具体日志实现工具: Log4j, Jdk自带的日志（JUL)

JCL 有两个基本的抽象类：Log(基本记录器)和LogFactory(负责创建Log实例)

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1phY2tfdHpo_size_16_color_FFFFFF_t_70_pic_center 1]

### 2.1 JCL入门 ###

1.  建立maven工程
2.  添加依赖
    
        <dependency>
             <groupId>commons-logging</groupId>
             <artifactId>commons-logging</artifactId>
             <version>1.2</version>
        </dependency>
3.  快速入门
    
        /** * 快速入门 */
        @Test
        public void test() { 
            Log log = LogFactory.getLog(JCLTest.class);
            log.fatal("fatal");
            log.error("error");
            log.warn("warn");
            log.info("info");
            log.debug("debug");
        }

**我们为什么要使用日志门面：**

1.  面向接口开发，不再依赖具体的实现类。减少代码的耦合
2.  项目通过导入不同的日志实现类，可以灵活的切换日志框架
3.  统一API，方便开发者学习和使用
4.  统一配置便于项目日志的管理

### 2.2 JCL原理 ###

1.  通过LogFactory动态加载Log实现类

![在这里插入图片描述][20210111174952314.jpg_pic_center]

1.  日志门面支持的日志实现数组
    
        private static final String[] classesToDiscover = { 
                    "org.apache.commons.logging.impl.Log4JLogger",
                    "org.apache.commons.logging.impl.Jdk14Logger",
                    "org.apache.commons.logging.impl.Jdk13LumberjackLogger",
                    "org.apache.commons.logging.impl.SimpleLog"
            };
2.  获取具体的日志实现
    
        for(int i=0; i<classesToDiscover.length && result == null; ++i) { 
            result = createLogFromClass(classesToDiscover[i], logCategory, true);
        }

\--------------最后感谢大家的阅读，愿大家技术越来越流弊！--------------

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1phY2tfdHpo_size_16_color_FFFFFF_t_70]

\--------------也希望大家给我点支持，谢谢各位大佬了！！！--------------

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1phY2tfdHpo_size_16_color_FFFFFF_t_70_pic_center]: /images/20221119/613e0850aa57445daf23630fdffc4f58.png
[20210111163907306.jpg_pic_center]: /images/20221119/b0e4df8c12c64928aff2ce87f6653d2c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1phY2tfdHpo_size_16_color_FFFFFF_t_70_pic_center 1]: https://img-blog.csdnimg.cn/20210111175002244.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1phY2tfdHpo,size_16,color_FFFFFF,t_70#pic_center
[20210111174952314.jpg_pic_center]: https://img-blog.csdnimg.cn/20210111174952314.jpg#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1phY2tfdHpo_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200721144257696.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1phY2tfdHpo,size_16,color_FFFFFF,t_70