JAVA - JAVA Log4j 专门用於 Java 语言的日志记录工具

参考资料

• 参考资料1：Log4j 简介
• 参考资料2：Log4j 日志级别
• 参考资料3：Log4j 日志输出控制文件
• 参考资料4：第一个 Log4j 日志文件
• Youtube 影片教学：千锋Java教程：36 框架入门 Log4j Log4j 简介

说明

会写这篇文章的主要原因，是因为原始的文章是大陆人撰写的文章，所以会有非常多的大陆用语，不是很喜欢看到大陆的用语，因此打算尽量都使用台湾的用语，使用正体中文再重新翻译过一遍，以方便使用肉眼阅读，这样下次再重新阅读的时候，就不用再重新转换一遍词汇的意思了XD，特此撰写本篇文章作为纪录以方便後续复查，虽然後面没有机会再用到，但也算是个不错的经验。

Log4j 简介

作为一个完整的软件，日志是必不可少的。

程序从开发、测试、维护、运行等环节，都需要向控制台或文件等地方输出大量讯息。
这些讯息的输出，在很多时候是使用 System.out.println() 无法完成的。

日志讯息根据用途与记录内容的不同，可分为：调试日志、运行日志、异常日志等。

Log4j 的全称为 Log for java，即专门用於 Java 语言的日志记录工具。

Log4j 日志级别

为了方便对於日志资料讯息的输出及显示，对日志内容进行了分级管理。日志级别由高到低，共分 6 个级别：

• fatal(致命的)
• error
• warn
• info
• debug
• trace(堆栈)

为什麽要对日志进行分级

无论是将日志输出到控制台，还是文件，其输出都会降低程序的执行效率。
但由於调试、运行维护的需要，客户的要求等原因，需要进行必要的日志输出。
这时候就必须要在程序码中加入日志输出语句。

这些输出语句若在程序运行时全部执行，则势必会降低程序的执行效率。
例如，使用 System.out.println() 将讯息输出到控制台，则所有的该输出语句均将被执行。会大大降低程序的执行效率。
而要使其不输出，唯一的办法就是将这些输出语句逐个全部删除。

这是个费时费力的过程。

将日志讯息进行分级管理，便可方便的控制讯息输出内容及输出位置：

哪些讯息需要输出，哪些讯息不需要输出，只需要在一个日志输出控制文件中稍加修改即可。

而程序码中的输出语句不用做任何修改。

从这个角度来说，程序码中的日志编写，其实就是写大量的输出语句。
只不过，这些输出语句比较特殊，它们具有级别，在程序运行期间不一定被执行。
它们的执行是由另一个控制文件控制。

Log4j 日志输出控制文件

日志输出简介

Log4j 的日志输出控制文件，主要由三个部分构成：

• 日志讯息的输出位置：控制日志讯息将要输出的位置，是控制台还是文件等。
• 日志讯息的输出格式：控制日志讯息的显示格式，即以怎样的字符串形式显示。
• 日志讯息的输出级别：控制日志讯息的显示内容，即显示哪些级别的日志讯息。

有了日志输出控制文件，程序码中只要设置好日志讯息内容及其级别即可，通过控制文件便可控制这些日志讯息的输出了。

日志属性配置文件

日志属性文件 log4j.properties 是专门用於控制日志输出的。其主要进行三方面控制：

• 输出位置：控制日志将要输出的位置，是控制台还是文件等。
• 输出布局：控制日志讯息的显示形式。
• 输出级别：控制要输出的日志级别。

日志属性文件由两个对象组成：日志附加器与根日志。

根日志，即为 Java 代码中的日志记录器，其主要由两个属性构成：日志输出级别与日志附加器。

日志附加器，则由日志输出位置定义，由其它很多属性进行修饰，如输出布局、文件位置、文件大小等。

什麽是日志附加器？

所谓日志附加器，就是为日志记录器附加上很多其它设置讯息。附加器的本质是一个接口，其定义语法为：log4j.appender.appenderName = 输出位置

常用的附加器实现类别

• org.apache.log4j.ConsoleAppender：日志输出到控制台
• org.apache.log4j.FileAppender：日志输出到文件
• org.apache.log4j.RollingFileAppender：当日志文件大小到达指定尺寸的时候将产生一个新的日志文件
• org.apache.log4j.DailyRollingFileAppender：每天产生一个日志文件

常用布局类型

• org.apache.log4j.HTMLLayout：网页布局，以 HTML 表格形式布局
• org.apache.log4j.SimpleLayout：简单布局，包含日志讯息的级别和讯息字符串
• org.apache.log4j.PatternLayout：匹配器布局，可以灵活地指定布局模式。其主要是通过设置 PatternLayout 的 ConversionPattern 属性值来控制具体输出格式的 。

打印参数: Log4J 采用类似 C 语言中的 printf 函数的打印格式格式化日志讯息

• %m：输出代码中指定的消息
• %p：输出优先级，即 DEBUG，INFO，WARN，ERROR，FATAL
• %r：输出自应用启动到输出该 log 讯息耗费的毫秒数
• %c：输出所属的类目，通常就是所在类的全名
• %t：输出产生该日志事件的线程名
• %n：输出一个回车换行符，Windows 平台为 /r/n，Unix 平台为 /n
• %d：输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其後指定格式，比如：%d{yyy MMM dd HH:mm:ss , SSS}，输出类似：2002年10月18日22:10:28,921
• %l：输出日志事件的发生位置，包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main(TestLog4.java: 10 )

第一个 Log4j 日志文件

Slf4j 简介

slf4j 的全称是 Simple Loging Facade For Java，即它仅仅是一个为 Java 程序提供日志输出的统一接口，并不是一个具体的日志实现方案，就比如 JDBC 一样，只是一种规则而已。所以单独的 slf4j 是不能工作的，必须搭配其他具体的日志实现方案，比如 apache 的 org.apache.log4j.Logger，JDK 自带的 java.util.logging.Logger 以及 log4j 等。

我的 pom.xml 配置

参考原本的文章做修改後如下：

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>idv.ete</groupId>
  <artifactId>log4jTest</artifactId>
  <packaging>jar</packaging>
  <version>1.0-SNAPSHOT</version>
  <name>log4jTest</name>
  <url>http://maven.apache.org</url>
  <dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>3.8.1</version>
      <scope>test</scope>
    </dependency>
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-log4j12</artifactId>
      <version>1.7.25</version>
    </dependency>
  </dependencies>
  <build> 
    <plugins>   
      <plugin>    <!--plugins要写在build标签下，不然无法识别 -->
        <artifactId>maven-compiler-plugin</artifactId>   
        <version>3.1</version>    <!--maven-compiler-plugin版本写一个中央仓库有的版本，保存后它会自动下载 -->
        <configuration>   
          <source>10</source>    <!--我的jdk是10.0.1的，写成10.0.1不好用，所以就写成10了 -->
          <target>10</target>   
        </configuration>   
      </plugin> 
      <plugin>
          <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-shade-plugin</artifactId>
          <version>3.2.4</version>
          <executions>
            <execution>
              <phase>package</phase>
              <goals>
                <goal>shade</goal>
              </goals>
            </execution>
          </executions>
      </plugin>
    </plugins> 
  </build>
</project>

创建 log4j.properties 配置文件

注意：档案名字要是 log4j.properties 要一模一样。

在 src/main/resources 目录下创建名为 log4j.properties 的属性配置文件

log4j.rootLogger=INFO, console, file

log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=%d %p [%c] - %m%n

log4j.appender.file=org.apache.log4j.DailyRollingFileAppender
log4j.appender.file.File=logs/log.log
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.A3.MaxFileSize=1024KB
log4j.appender.A3.MaxBackupIndex=10
log4j.appender.file.layout.ConversionPattern=%d %p [%c] - %m%n

日志配置相关说明：

• log4j.rootLogger：根日志，配置了日志级别为 INFO，预定义了名称为 console、file 两种附加器
• log4j.appender.console：console 附加器，日志输出位置在控制台
• log4j.appender.console.layout：console 附加器，采用匹配器布局模式
• log4j.appender.console.layout.ConversionPattern：console 附加器，日志输出格式为：日期 日志级别 [类名] - 消息换行符
• log4j.appender.file：file 附加器，每天产生一个日志文件
• log4j.appender.file.File：file 附加器，日志文件输出位置 logs/log.log
• log4j.appender.file.layout：file 附加器，采用匹配器布局模式
• log4j.appender.A3.MaxFileSize：日志文件最大值
• log4j.appender.A3.MaxBackupIndex：最多纪录文件数
• log4j.appender.file.layout.ConversionPattern：file 附加器，日志输出格式为：日期 日志级别 [类名] - 消息换行符

测试日志输出

创建一个测试类别，并测试日志输出效果，参考原本文章的程序码修改後如下：

package idv.ete;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class App 
{

    public static final Logger logger = LoggerFactory.getLogger(App.class);

    public static void main( String[] args )
    {
        System.out.println( "Hello World!" );
        logger.info("slf4j for info");
        logger.debug("slf4j for debug");
        logger.error("slf4j for error");
        logger.warn("slf4j for warn");

        String message = "Hello SLF4J";
        logger.info("slf4j message is : {}", message);
    }
}

执行後 Console 显示如下：

项目根目录下也会多出 logs/log.log 目录及文件