[Log4j] 配置Log4j

旧城等待， 2022-08-14 01:43 317阅读 0赞

Log4J的配置文件(Configuration File)就是用来设置记录器的级别、存放器和布局的，它可接key=value格式的设置或xml格式的设置信息。通过配置，可以创建出Log4J的运行环境。  
  
**1. 配置文件**  
Log4J配置文件的基本格式如下：

![None.gif][] \#配置根Logger  
![None.gif][]log4j.rootLogger = **\[** level **\]** , appenderName1 , appenderName2 ,   …  
![None.gif][]  
![None.gif][]\#配置日志信息输出目的地Appender  
![None.gif][]log4j.appender.appenderName =   fully.qualified.name.of.appender.class  
![None.gif][]　　log4j.appender.appenderName.option1 =   value1  
![None.gif][]　　…  
![None.gif][]　　log4j.appender.appenderName.optionN =   valueN  
![None.gif][]  
![None.gif][]\#配置日志信息的格式（布局）  
![None.gif][]log4j.appender.appenderName.layout =   fully.qualified.name.of.layout.class  
![None.gif][]　　log4j.appender.appenderName.layout.option1 =   value1  
![None.gif][]　　…  
![None.gif][]　　log4j.appender.appenderName.layout.optionN = valueN

其中 **\[level\]** 是日志输出级别，共有5级：

![None.gif][] FATAL 0    
![None.gif][]ERROR 3    
![None.gif][]WARN 4    
![None.gif][]INFO 6    
![None.gif][]DEBUG 7   
![None.gif][]

Appender  为日志输出目的地，Log4j提供的appender有以下几种：

![None.gif][] org.apache.log4j.ConsoleAppender（控制台），  
![None.gif][]org.apache.log4j.FileAppender（文件），  
![None.gif][]org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件），  
![None.gif][]org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件），  
![None.gif][]org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）

**Layout**：日志输出格式，Log4j提供的layout有以下几种：

![None.gif][] org.apache.log4j.HTMLLayout（以HTML表格形式布局），  
![None.gif][]org.apache.log4j.PatternLayout（可以灵活地指定布局模式），  
![None.gif][]org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），  
![None.gif][]org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

**打印参数:** Log4J采用类似C语言中的printf函数的打印格式格式化日志信息，如下:

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

**2. 在代码中初始化Logger:**  
1）在程序中调用**BasicConfigurator.configure()**方法：给根记录器增加一个ConsoleAppender，输出格式通过PatternLayout设为**"%-4r \[%t\] %-5p %c %x - %m%n"**，还有根记录器的默认级别是**Level.DEBUG**.  
2）配置放在文件里，通过命令行参数传递文件名字，通过**PropertyConfigurator.configure(args\[x\])**解析并配置；  
3）配置放在文件里，通过环境变量传递文件名等信息，利用log4j默认的初始化过程解析并配置；  
4）配置放在文件里，通过应用服务器配置传递文件名等信息，利用一个特殊的servlet来完成配置。  
  
**3. 为不同的 Appender 设置日志输出级别：**  
当调试系统时，我们往往注意的只是异常级别的日志输出，但是通常所有级别的输出都是放在一个文件里的，如果日志输出的级别是BUG！？那就慢慢去找吧。  
这时我们也许会想要是能把异常信息单独输出到一个文件里该多好啊。当然可以，Log4j已经提供了这样的功能，我们只需要在配置中修改**Appender**的**Threshold**  就能实现,比如下面的例子：  
  
**\[配置文件\]**

![None.gif][] \#\#\# set log levels \#\#\#  
![None.gif][]log4j.rootLogger = debug , stdout , D ,   E  
![None.gif][]  
![None.gif][]\#\#\# 输出到控制台 \#\#\#  
![None.gif][]log4j.appender.stdout =  org.apache.log4j.ConsoleAppender  
![None.gif][]log4j.appender.stdout.Target =  System.out  
![None.gif][]log4j.appender.stdout.layout =  org.apache.log4j.PatternLayout  
![None.gif][]log4j.appender.stdout.layout.ConversionPattern = %d\{ABSOLUTE\} %5p %c\{ 1  \}:%L - %m%n  
![None.gif][]  
![None.gif][]\#\#\# 输出到日志文件 \#\#\#  
![None.gif][]log4j.appender.D =  org.apache.log4j.DailyRollingFileAppender  
![None.gif][]log4j.appender.D.File =  logs/log.log  
![None.gif][]log4j.appender.D.Append =  true  
![None.gif][]log4j.appender.D.**Threshold** =  DEBUG **\#\# 输出DEBUG级别以上的日志**  
![None.gif][]log4j.appender.D.layout =  org.apache.log4j.PatternLayout  
![None.gif][]log4j.appender.D.layout.ConversionPattern = %-d\{yyyy-MM-dd HH:mm:ss\} **\[** %t:%r **\]** \- **\[** %p **\]**  %m%n  
![None.gif][]  
![None.gif][]\#\#\# 保存异常信息到单独文件 \#\#\#  
![None.gif][]log4j.appender.D =  org.apache.log4j.DailyRollingFileAppender  
![None.gif][]log4j.appender.D.File =  logs/error.log \#\# 异常日志文件名  
![None.gif][]log4j.appender.D.Append =  true  
![None.gif][]log4j.appender.D.**Threshold** =  ERROR **\#\# 只输出ERROR级别以上的日志!!!**  
![None.gif][]log4j.appender.D.layout =  org.apache.log4j.PatternLayout  
![None.gif][]log4j.appender.D.layout.ConversionPattern = %-d\{yyyy-MM-dd HH:mm:ss\} **\[** %t:%r **\]** \- **\[** %p **\]** %m%n

**\[代码中使用\]**

![ExpandedBlockStart.gif][] public class TestLog4j  \{  
![ExpandedSubBlockStart.gif][] public static void main(String\[\] args) \{  
![InBlock.gif][] PropertyConfigurator.configure( " D:/Code/conf/log4j.properties " );  
![InBlock.gif][] Logger logger = Logger.getLogger(TestLog4j. class);  
![InBlock.gif][] logger.debug( " debug " );  
![InBlock.gif][] logger.error( " error " );  
![ExpandedSubBlockEnd.gif][] \}  
![ExpandedBlockEnd.gif][]\}

运行一下，看看异常信息是不是保存在了一个单独的文件error.log中。

[None.gif]: /images/20220810/2791f893eaf04340b80beecdb95efa5e.png
[ExpandedBlockStart.gif]: /images/20220810/e6eeb0896b9744d9ada67cfe14a39f8e.png
[ExpandedSubBlockStart.gif]: /images/20220810/faf04de1c5d047f388a86949d560c75b.png
[InBlock.gif]: /images/20220810/9f1ab867daa64376b89b34415cd140b2.png
[ExpandedSubBlockEnd.gif]: /images/20220810/a211736e4cb9490c9b0aff83b8e687b8.png
[ExpandedBlockEnd.gif]: /images/20220810/5cce321922874ecd9e0d8e16943bf931.png