Log4j新手快速入门教程
- 格式：pdf
- 大小：118.79 KB
- 文档页数：3
Log4j新⼿快速⼊门教程
简介
组成
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 常⽤的输出⽬的地有以下⼏种：
Layout（⽇志格式化器）
快速⼊门
⾸先在 maven 中引⼊ log4j 的依赖:
log4j
log4j
1.2.17
创建 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 ⽂件。⽂本内容如下：
总结
以上就是这篇⽂章的全部内容了，希望本⽂的内容对⼤家的学习或者⼯作具有⼀定的参考学习价值，谢谢⼤家对的⽀持。
