log4j使用教程_log4js

全栈程序员站长

发布于 2022-10-04 09:03:33

6220

发布于 2022-10-04 09:03:33

大家好，又见面了，我是你们的朋友全栈君。

简介

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

组成

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

日志级别

Log4J 在 org.apache.log4j.Level 类中定义了OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL七种日志级别：

OFF	最高日志级别，关闭左右日志
FATAL	将会导致应用程序退出的错误
ERROR	发生错误事件，但仍不影响系统的继续运行
WARN	警告，即潜在的错误情形
INFO	一般和在粗粒度级别上，强调应用程序的运行全程
DEBUG	一般用于细粒度级别上，对调试应用程序非常有帮助
ALL	最低等级，打开所有日志记录

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

Appender（输出端）

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

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

Layout（日志格式化器）

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

快速入门

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

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

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

public class Log4JTest {

    public static void main(String[] args) {   
        //获取Logger对象的实例         
        Logger logger = Logger.getLogger(Log4JTest.class);
        //使用默认的配置信息，不需要写log4j.properties
        BasicConfigurator.configure();
        //设置日志输出级别为WARN，这将覆盖配置文件中设置的级别，只有日志级别高于WARN的日志才输出
        logger.setLevel(Level.WARN);
        logger.debug("这是debug");
        logger.info("这是info");
        logger.warn("这是warn");
        logger.error("这是error");
        logger.fatal("这是fatal");
    }

}

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

0 [main] WARN com.huang.log4j.Log4JTest - 这是warn
0 [main] WARN com.huang.log4j.Log4JTest - 这是error
0 [main] WARN com.huang.log4j.Log4JTest - 这是fatal

注：如果没有调用 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 文件，打开文件，里面的信息就是代码中输出的日志信息：

log4j.properties 配置文件的使用

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

# 控制台输出配置
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.Threshold = DEBUG
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 #指定日志的文件编码

#指定日志的输出级别与输出端
log4j.rootLogger=DEBUG,Console,A

在 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 输出代码中的行号 %x 输出和当前线程相关的 NDC（嵌套诊断环境） %% 输出一个 “%” 字符可以在 % 与字符之间加上修饰符来控制最小宽度、最大宽度和文本的对其方式。如： %5c 输出category名称，最小宽度是5，category<5，默认的情况下右对齐 %-5c 输出category名称，最小宽度是5，category<5，”-“号指定左对齐,会有空格 %.5c 输出category名称，最大宽度是5，category>5，就会将左边多出的字符截掉，<5不会有空格 %20.30c category名称<20补空格，并且右对齐，>30字符，就从左边交远销出的字符截掉

然后编写测试类 Log4JTest.java ：

public class Log4JTest {

    public static void main(String[] args) {   
        //获取Logger对象的实例         
        Logger logger = Logger.getLogger(Log4JTest.class);
        logger.debug("这是debug");
        logger.info("这是info");
        logger.warn("这是warn");
        logger.error("这是error");
        logger.fatal("这是fatal");
    }

}

程序运行后控制台输出文本：

2018-07-12 14:36:36,114 [main] WARN  [com.huang.log4j.Log4JTest] - 这是warn
2018-07-12 14:36:36,114 [main] ERROR [com.huang.log4j.Log4JTest] - 这是error
2018-07-12 14:36:36,114 [main] FATAL [com.huang.log4j.Log4JTest] - 这是fatal

并会在 D 盘生成一份 log.txt 文件。文本内容如下：