Java日志框架--Log4j日志

红太狼 2023-07-05 10:25 42阅读 0赞

一、Log4j的简介

Log4J 是 Apache 的一个开源项目（官网 [http://jakarta.apache.org/log4j][http_jakarta.apache.org_log4j]），通过在项目中使用 Log4J，我们可以控制日志信息输出到控制台、文件、GUI 组件、甚至是数据库中。我们可以控制每一条日志的输出格式，通过定义日志的输出级别，可以更灵活的控制日志的输出过程。方便项目的调试。

1.**Log4j组件**：

Log4j主要由以下几个组件组成：

**Loggers（日志记录器）：**控制日志的输出级别与日志是否输出；

**Appenders(输出端)：**指定日志的输出格式（输出到控制台、文件等）；

**Layout（日志格式输出器）：**控制日志信息的输出格式。

Log4j中有一个特殊的logger叫做“root”,他是所有Logger的根，也就意味着其他所有的logger都会直接或者间接地继承自root.

root logger可以用Logger.getRootLogger（）方法获取。

2.Appenders:用来指定日志输出到哪个地方，可以同时指定日志地输出目的地，Log4j常用的输出目的地有一下几种：

<table style="width:500px;"> 
 <tbody> 
  <tr> 
   <td>输出端类型</td> 
   <td>作用</td> 
  </tr> 
  <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>

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

<table style="width:500px;"> 
 <tbody> 
  <tr> 
   <td>格式化类型</td> 
   <td>作用</td> 
  </tr> 
  <tr> 
   <td>HTMLLayout</td> 
   <td>格式化日志输出为HTML表格形式</td> 
  </tr> 
  <tr> 
   <td>SimpleLayout</td> 
   <td>简单的日志输出格式化，打印的日志格式为（info message）</td> 
  </tr> 
  <tr> 
   <td>PatternLayout</td> 
   <td>最强大的格式化期，可以根据自定义格式输出日志，如果没有指定的转化格式，就是用默认的转化格式</td> 
  </tr> 
  <tr> 
   <td>xml.XMLLayout</td> 
   <td>XML格式输出</td> 
  </tr> 
 </tbody> 
</table>

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

（1）Log4j采用类似C语言的printf函数的打印格式格式化日志信息，具体的占位符及其含义如下：

<table style="width:500px;"> 
 <tbody> 
  <tr> 
   <td>占位符</td> 
   <td>含义</td> 
  </tr> 
  <tr> 
   <td><strong>%m</strong></td> 
   <td><strong>输出代码中指定的日志信息</strong></td> 
  </tr> 
  <tr> 
   <td>%p&nbsp;</td> 
   <td>输出优先级、及DEBUG、INFO等</td> 
  </tr> 
  <tr> 
   <td><strong>%n</strong></td> 
   <td><strong>换行符</strong></td> 
  </tr> 
  <tr> 
   <td>%r</td> 
   <td>输出自应用启动到输出该log信息耗费的毫秒数</td> 
  </tr> 
  <tr> 
   <td>%c</td> 
   <td>输出打印语句所属的类的全名</td> 
  </tr> 
  <tr> 
   <td>%t</td> 
   <td>输出产生该日志的线程全名</td> 
  </tr> 
  <tr> 
   <td>%d</td> 
   <td>输出服务器当前时间，默认为ISO8601,也可以指定格式，如：%d{yyyy年MM月dd日 HH:mm:ss}</td> 
  </tr> 
  <tr> 
   <td>%l</td> 
   <td>输出日志时间发生的位置，包括类名、线程、及在代码中的行数</td> 
  </tr> 
  <tr> 
   <td>%F</td> 
   <td>输出日志消息产生时所在的文件名称</td> 
  </tr> 
  <tr> 
   <td>%L</td> 
   <td>输出代码中的行号</td> 
  </tr> 
  <tr> 
   <td>%%</td> 
   <td>输出一个“%”字符</td> 
  </tr> 
 </tbody> 
</table>

（2）可以在%与字符之间加上修饰符来控制最小宽度、最大宽度和文本的对其方式

<table style="width:500px;"> 
 <tbody> 
  <tr> 
   <td>占位符</td> 
   <td>含义</td> 
  </tr> 
  <tr> 
   <td>%5c</td> 
   <td>输出category名称，最小宽度是5，category&lt;5,默认的情况下右对齐</td> 
  </tr> 
  <tr> 
   <td>%-5c</td> 
   <td>输出category名称，最小宽度是5，category&lt;5,"_"是指定左对齐，会有空格</td> 
  </tr> 
  <tr> 
   <td>%.5c</td> 
   <td>输出category名称，最大宽度是5，category&gt;5.就会将左边多出的字符截掉，&lt;5不会有空格</td> 
  </tr> 
  <tr> 
   <td>%20.30c</td> 
   <td>输出category名称&lt;20补空格，并且右对齐；输出category名称&gt;30字符，就从左边较远输出的字符截掉</td> 
  </tr> 
 </tbody> 
</table>

二、快速入门

首先在 maven 中引入 log4j 的依赖:

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

创建 Log4jTest 类，测试 Log4j 的使用：

@Test
        public void testQuick() throws Exception{
    //        开启log4j内置日志记录
            LogLog.setInternalDebugging(true);
    
    
    //        初始化配置信息，在入门案例中暂不使用配置文件
            BasicConfigurator.configure();
    //        获取日志记录器对象
            Logger logger = Logger.getLogger(Log4jDemo.class);
    //        日志记录输出
            logger.info("hello log4j");
    
    //        日志级别
    
    
    
            //设置日志输出级别为WARN，这将覆盖配置文件中设置的级别，只有日志级别高于WARN的日志才输出
                logger.setLevel(Level.WARN);
                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");//追踪信息，记录程序所有的流程信息
    
        }

这里首先通过 Logger.getLogger(Log4Test.class) 创建 Logger 实例，然后调用 BasicConfigurator.configure() 方法指定该 Logger 使用默认的配置信息，接着调用 looger.setLevel(Level.WARN) 设置 Logger 的日志输出级别为 WARN 。运行 main 函数，控制台将会输出 warn 以上的错误信息。控制台输出如下：

0 [main] INFO LoggerDemo.Log4jDemo  - hello log4j
    5 [main] FATAL LoggerDemo.Log4jDemo  - fatal
    5 [main] ERROR LoggerDemo.Log4jDemo  - error
    5 [main] WARN LoggerDemo.Log4jDemo  - warn
    6 [main] FATAL org.apache.log4j.Logger  - fatal  logger1
    6 [main] ERROR org.apache.log4j.Logger  - error  logger1
    6 [main] WARN org.apache.log4j.Logger  - warn  logger1
    7 [main] INFO org.apache.log4j.Logger  - info  logger1
    7 [main] DEBUG org.apache.log4j.Logger  - debug  logger1
    7 [main] TRACE org.apache.log4j.Logger  - trace  logger1

注：如果没有调用 BasicConfigurator.configure() 方法，则运行 main 函数的时候则会报错，因为 Log4j 框架在运行的时候会加载项目路径下的 log4j.properties 配置文件（关于配置文件的使用，会在后面讲解）。而我们此时的项目中是没有该文件的。如果配置文件的名称不是 log4j.properties，则可以通过 PropertyConfigurator.configure(String configFilename) 指定配置文件的名称。

### 格式化器的使用 ###

修改 Log4JTest 中的代码：

public class Log4JTest {
     
        public static void main(String[] args) {
            Logger logger = Logger.getLogger(Log4JTest.class);
            BasicConfigurator.configure();
            HTMLLayout layout = new HTMLLayout();
            // SimpleLayout layout = new SimpleLayout();
            try {
                FileAppender appender = new FileAppender(layout, "D:\\out.html", false);
                logger.addAppender(appender);
                //设置日志输出级别为info，这将覆盖配置文件中设置的级别，只有日志级别高于WARN的日志才输出
                logger.setLevel(Level.WARN);
                logger.debug("这是debug");
                logger.info("这是info");
                logger.warn("这是warn");
                logger.error("这是error");
                logger.fatal("这是fatal");
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
     
    }

首先创建一个HTML格式的格式化器（HTMLLayout），然后创建文件输出端（FileAppender）指定输出端的格式为 HTML 格式，这里我指定输出路径为 D 盘下的 out.html 文件。然后通过 logger.addAppender(appender) 将文件输出端加载到 Logger 中。运行 main 函数，在 D 盘下会生成一个 out.html 文件，打开文件，里面的信息就是代码中输出的日志信息：  
![70][]

# log4j.properties 配置文件的使用 #

上面使用代码的方式设置 Logger 的输出格式，这样在我们每个要输出日志的类上都得设置一遍配置未免也太麻烦了吧。有一种更加方便的方法，我们只需要在项目路径下新建 log4j.properties 配置文件，并配置日志的输出格式等信息，Log4J 框架会自动的加载配置文件，并将配置信息设置到 Logger 中。最简单的配置文件如下：

#配置根  Loggers控制日志的输出级别与日志是否输出
    log4j.rootLogger=trace,console
    
    #自定义logger对象设置
    log4j.logger.LoggerDemo = info,file
    
    #配置输出到控制台  Appenders是指定日志的输出方式
    log4j.appender.console=org.apache.log4j.ConsoleAppender
    #指定输出控制台
    log4j.appender.console.Target = System.out
    #指定布局,输出日志的格式
    log4j.appender.console.layout=org.apache.log4j.PatternLayout
    #指定布局的参数
    log4j.appender.console.layout.ConversionPattern=[%-10p] %r %l %d{yyyy-MM-dd HH:mm:ss.SSS} %m%n
    
    
    #配置输出到控制台  Appenders是指定日志的输出方式
    log4j.appender.file=org.apache.log4j.FileAppender
    #指定布局,输出日志的格式
    log4j.appender.file.layout=org.apache.log4j.PatternLayout
    #指定布局的参数
    log4j.appender.file.layout.ConversionPattern=[%-10p] %r %l %d{yyyy-MM-dd HH:mm:ss.SSS} %m%n
    #指定日志文件保存路径
    log4j.appender.file.file = /logs/log4j.log
    #指定日志文件字符集
    log4j.appender.file.encoding = UTF-8
    
    #配置输出到控制台  Appenders是指定日志的输出方式
    log4j.appender.rollingFile=org.apache.log4j.RollingFileAppender
    #指定布局,输出日志的格式
    log4j.appender.rollingFile.layout=org.apache.log4j.PatternLayout
    #指定布局的参数
    log4j.appender.rollingFile.layout.ConversionPattern=[%-10p] %r %l %d{yyyy-MM-dd HH:mm:ss.SSS} %m%n
    #指定日志文件保存路径
    log4j.appender.rollingFile.file = /logs/log4j.log
    #指定日志文件字符集
    log4j.appender.rollingFile.encoding = UTF-8
    #指定日志文件内容的大小
    log4j.appender.rollingFile.maxFileSize = 1MB
    #指定日志文件的数量
    log4j.appender.rollingFile.maxBackupIndex = 10
    
    #配置输出到控制台  Appenders是指定日志的输出方式
    log4j.appender.dailyRollingFile=org.apache.log4j.DailyRollingFileAppender
    #指定布局,输出日志的格式
    log4j.appender.dailyRollingFile.layout=org.apache.log4j.PatternLayout
    #指定布局的参数
    log4j.appender.dailyRollingFile.layout.ConversionPattern=[%-10p] %r %l %d{yyyy-MM-dd HH:mm:ss.SSS} %m%n
    #指定日志文件保存路径
    log4j.appender.dailyRollingFile.file = /logs/log4j.log
    #指定日志文件字符集
    log4j.appender.dailyRollingFile.encoding = UTF-8
    #指定日志输出规则
    log4j.appender.dailyRollingFile.datePattern = '.'yyyy-MM-dd-HH-mm-ss
    
    
    #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/logs
    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')

使用JDBCAppender导出日志格式时，数据库设计如下：

DROP TABLE IF EXISTS `log`;
    CREATE TABLE `log` (
      `log_id` int(11) NOT NULL AUTO_INCREMENT,
      `project_name` varchar(255) COLLATE utf8_general_mysql500_ci DEFAULT NULL COMMENT '项目名',
      `create_date` varchar(255) COLLATE utf8_general_mysql500_ci DEFAULT NULL COMMENT '创建时间',
      `level` varchar(255) COLLATE utf8_general_mysql500_ci DEFAULT NULL COMMENT '优先级',
      `category` varchar(255) COLLATE utf8_general_mysql500_ci DEFAULT NULL COMMENT '所在类的全名',
      `file_name` varchar(255) COLLATE utf8_general_mysql500_ci DEFAULT NULL COMMENT '输出日志消息产生时所在的文件名称',
      `thread_name` varchar(255) COLLATE utf8_general_mysql500_ci DEFAULT NULL COMMENT '日志事件的线程名',
      `line` varchar(255) COLLATE utf8_general_mysql500_ci DEFAULT NULL COMMENT '行号',
      `all_category` varchar(255) COLLATE utf8_general_mysql500_ci DEFAULT NULL COMMENT '日志事件的发生位置',
      `message` varchar(4000) COLLATE utf8_general_mysql500_ci DEFAULT NULL COMMENT '输出代码中指定的消息',
      PRIMARY KEY (`log_id`)
    ) ENGINE=InnoDB AUTO_INCREMENT=30013 DEFAULT CHARSET=utf8 COLLATE=utf8_general_mysql500_ci;

[http_jakarta.apache.org_log4j]: http://jakarta.apache.org/log4j
[70]: https://img-blog.csdn.net/20180712151209742?watermark/2/text/aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Nzg3MTM4/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70