JAVA - 优雅的记录日志（log4j实战篇）

写在前面

项目开发中，记录错误日志有以下好处：

1. 方便调试
2. 便于发现系统运行过程中的错误
3. 存储业务数据，便于后期分析

在java中，记录日志有很多种方式：

• 自己实现

　　　　自己写类，将日志数据，以io操作方式，写数据到文本文件、数据库中。

• 使用log4j

　　　　log4j可以将日志输出到console窗口、文本文件、数据库等，功能强大！

• 使用slfj

　　　　slfj也是一个很强大的功能，slfj旨在一统天下，提供了logging.jar 和 log4j的接口，可以通过slfj来调用log4j，也可以调用jdk的logging。

• 使用jdk自带的logging.jar中的方法

log4j需要导入的包

一般使用log4j需要与logging配合使用：

• commons-logging-1.0.4.jar
• log4j-1.2.15.jar

添加配置文件

在src下，把log4j的配置文件添加进去log4j.properties。

建立类文件+主函数

修改配置文件，将日志输出到console

log4J配置文件为：

### 设置级别和目的地(这里多个目的地) ###
log4j.rootLogger = DEBUG,CONSOLE
### 这里的me是包，也就是在这个包记录日志时，是只记录debug及以上级别的日志
log4j.logger.me=DEBUG
### 输出到控制台 ###
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 =  %d{ABSOLUTE} %5p %c{}:%L - %m%n 

main主函数调用：

import org.apache.log4j.Logger;
 
public class Log4jTest {
   public static Logger logger1 = Logger.getLogger(Log4jTest.class);
   public static void main(String[] args) {
       //logger1
       logger1.trace("我是logger1，trace");
       logger1.debug("我是logger1，debug");
       logger1.info("我是logger1，info");
       logger1.warn("我是logger1，warn");
       logger1.error("我是logger1，error");
       logger1.fatal("我是logger1，fatal");
   }
}

可以看到console中输出内容：

::, DEBUG Log4jTest: [main:]- 我是logger1，debug
::,  INFO Log4jTest: [main:]- 我是logger1，info
::,  WARN Log4jTest: [main:]- 我是logger1，warn
::, ERROR Log4jTest: [main:]- 我是logger1，error
::, FATAL Log4jTest: [main:]- 我是logger1，fatal

设定输出的格式

在标题4中，看到console的输出内容，是按一定格式输出，格式的配置还是来自于配置文件log4j.properties

日志输出格式，所用到的参数如下，按需添加：

%p: 输出日志信息优先级，即DEBUG，INFO，WARN，ERROR，FATAL,
%d: 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss,SSS}，输出类似：2002年10月18日 ：：，
%r: 输出自应用启动到输出该log信息耗费的毫秒数
%c: 输出日志信息所属的类目，通常就是所在类的全名
%t: 输出产生该日志事件的线程名
%l: 输出日志事件的发生位置，相当于%C.%M(%F:%L)的组合,包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main(TestLog4.java:)
%x: 输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像java servlets这样的多客户多线程的应用中。
%%: 输出一个”%”字符
%F: 输出日志消息产生时所在的文件名称
%L: 输出代码中的行号
%m: 输出代码中指定的消息,产生的日志具体信息
%n: 输出一个回车换行符，Windows平台为”\r\n”，Unix平台为”\n”输出日志信息换行
可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如：
)%20c：指定输出category的名称，最小的宽度是20，如果category的名称小于20的话，默认的情况下右对齐。
)%-20c:指定输出category的名称，最小的宽度是20，如果category的名称小于20的话，”-”号指定左对齐。
)%.30c:指定输出category的名称，最大的宽度是30，如果category的名称大于30的话，就会将左边多出的字符截掉，但小于30的话也不会有空格。
)%.30c:如果category的名称小于20就补空格，并且右对齐，如果其名称长于30字符，就从左边交远销出的字符截掉。

将日志输出到文本文件

log4j配置文件：

### 设置级别和目的地(这里多个目的地) ###
log4j.rootLogger = trace,CONSOLE,zhangsanLog
log4j.logger.me=DEBUG
 
### 输出到控制台 ###
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 =  %d{ABSOLUTE} %5p %c{}:%L [%t:%r]- %m%n
 
### 输出到日志文件 ###
log4j.appender.zhangsanLog = org.apache.log4j.DailyRollingFileAppender
log4j.appender.zhangsanLog.File =G\:\\var\\alldata\\zhenduan\\debug.log
#log4j.appender.zhangsanLog.File =/var/alldata/zhenduan/debug.log
log4j.appender.zhangsanLog.Append = true
## 只输出DEBUG级别以上的日志
log4j.appender.zhangsanLog.Threshold = DEBUG
#'.'yyyy-MM-dd: 每天产生一个新的文件
log4j.appender.zhangsanLog.DatePattern = '.'yyyy-MM-dd
log4j.appender.zhangsanLog.layout = org.apache.log4j.PatternLayout
log4j.appender.zhangsanLog.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [%t:%r] - [%p] [%c{}:%L] [%M] %m%n
log4j.additivity.zhangsanLog = false

main函数调用：

public static Logger logger1 = Logger.getLogger(Log4jTest.class);
public static void main(String[] args) {
   //logger1
   logger1.trace("我是logger1，trace");
   logger1.debug("我是logger1，debug");
   logger1.info("我是logger1，info");
   logger1.warn("我是logger1，warn");
   logger1.error("我是logger1，error");
   logger1.fatal("我是logger1，fatal");
} 

每一小时、每天、每半天生成一个文件

继续使用标题6的配置，但是需要修改几个地方。

在标题6中，有这句话

log4j.appender.zhangsanLog = org.apache.log4j.DailyRollingFileAppender

这句话的意思：将日志追加到文件，问题是多久生成一个文件？

需要修改

log4j.appender.zhangsanLog.DatePattern = '.'yyyy-MM-dd

DatePattern=’.’yyyy-ww:每周滚动一次文件，即每周产生一个新的文件。当然也可以指定按月、周、天、时和分，即对应的格式如下：

• ’.’yyyy-MM: 每月
• ’.’yyyy-ww: 每周
• ’.’yyyy-MM-dd: 每天
• ’.’yyyy-MM-dd-a: 每天两次
• ’.’yyyy-MM-dd-HH: 每小时
• ’.’yyyy-MM-dd-HH-mm: 每分钟

当文本文件为3KB大时新建一个文件

同样使用标题6的代码：

log4j.appender.zhangsanLog = org.apache.log4j.RollingFileAppender
log4j.appender.zhangsanLog.File =G\:\\var\\alldata\\zhenduan\\debug.log
#log4j.appender.zhangsanLog.File =/var/alldata/zhenduan/debug.log
log4j.appender.zhangsanLog.Append = true
## 输出DEBUG级别以上的日志
log4j.appender.zhangsanLog.Threshold = DEBUG
#'.'yyyy-MM-dd: 每天产生一个新的文件
log4j.appender.zhangsanLog.MaxFileSize = 2KB
log4j.appender.zhangsanLog.MaxBackupIndex =
log4j.appender.zhangsanLog.layout = org.apache.log4j.PatternLayout
log4j.appender.zhangsanLog.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [%t:%r] - [%p] [%c{}:%L] [%M] %m%n
log4j.additivity.zhangsanLog = false

这里修改的是

log4j.appender.zhangsanLog = org.apache.log4j.RollingFileAppender

MaxFileSize，当文件达到多大存储空间时，就新建一个文件MaxBackupIndex.

Log4j的日志级别

由低到高，可以联想到windows或unix的错误级别：

trace： 是追踪，就是程序推进以下，你就可以写个trace输出，所以trace应该会特别多，不过没关系，我们可以设置最低日志级别不让他输出。

debug： 调试么，我一般就只用这个作为最低级别，trace压根不用。是在没办法就用eclipse或者idea的debug功能就好了么。

info： 输出一下你感兴趣的或者重要的信息，这个用的最多了。

warn： 有些信息不是错误信息，但是也要给程序员的一些提示，类似于eclipse中代码的验证不是有error 和warn（不算错误但是也请注意，比如以下depressed的方法）。

error： 错误信息。用的也比较多。

fatal： 级别比较高了。重大错误，这种级别你可以直接停止程序了，是不应该出现的错误么！不用那么紧张，其实就是一个程度的问题。

log4j的配置说明

Log4j支持两种配置文件格式，一种是XML格式的文件，一种是properties格式的文件。一般我常用的是properties文件

1、log4j.rootLogger = [ level ] , appenderName, appenderName, …

level：是log4j的日志级别，优先级从高到低分别是ERROR、WARN、INFO、DEBUG。

appenderName：就是指定日志信息输出到哪个地方。可同时指定多个输出目的地。

2、 配置日志信息输出目的地Appender，其语法为：

log4j.appender.appenderName = fully.qualified.name.of.appender.class
 
log4j.appender.appenderName.option1 = value1
…
log4j.appender.appenderName.option = valueN
其中，Log4j提供的appender有以下几种：
org.apache.log4j.ConsoleAppender（控制台），
org.apache.log4j.FileAppender（文件），
org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件），
org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件），
org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）

3、设置好appender后，针对appender的配置

也就是设置好要输出到什么地方后，其它配置选项

(1).ConsoleAppender选项

Threshold=WARN:指定日志消息的输出最低层次。

ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。

Target=System.err：默认情况下是：System.out,指定输出控制台

(2).FileAppender 选项

Threshold=WARN:指定日志消息的输出最低层次。

ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。

File=mylog.txt:指定消息输出到mylog.txt文件。

Append=false:默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。

(3).DailyRollingFileAppender 选项

Threshold=WARN:指定日志消息的输出最低层次。

ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。

File=mylog.txt:指定消息输出到mylog.txt文件。

Append=false:默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。

DatePattern=’.’yyyy-ww:每周滚动一次文件，即每周产生一个新的文件。当然也可以指定按月、周、天、时和分。即对应的格式如下：

• ’.’yyyy-MM: 每月
• ’.’yyyy-ww: 每周
• ’.’yyyy-MM-dd: 每天
• ’.’yyyy-MM-dd-a: 每天两次
• ’.’yyyy-MM-dd-HH: 每小时
• ’.’yyyy-MM-dd-HH-mm: 每分钟

(4).RollingFileAppender 选项

Threshold=WARN:指定日志消息的输出最低层次。

ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。

File=mylog.txt:指定消息输出到mylog.txt文件。

Append=false:默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。

MaxFileSize=100KB: 后缀可以是KB, MB 或者是 GB. 在日志文件到达该大小时，将会自动滚动，即将原来的内容移到mylog.log.1文件

MaxBackupIndex=2:指定可以产生的滚动文件的最大数。

4. 配置日志信息的布局，其语法为：

log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
log4j.appender.appenderName.layout.option1 = value1
…
log4j.appender.appenderName.layout.option = valueN

其中，Log4j提供的layout有以下几种：

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

关于additivity

log4j.additivity.zhangsanLog = false

这个additivity也是很有意思的选项。

它是 子Logger 是否继承 父Logger 的 输出源（appender） 的标志位。具体说，默认情况下子Logger会继承父Logger的appender，也就是说子Logger会在父Logger的appender里输出。若是additivity设为false，则子Logger只会在自己的appender里输出，而不会在父Logger的appender里输出。
效果如下：

log4j.rootLogger=WARN,A2,A3
log4j.logger.test=DEBUG 
 
log4j.appender.A2=org.apache.log4j.RollingFileAppender
log4j.appender.A2.File=../logs/test.log
log4j.appender.A2.Encoding=UTF-8
log4j.appender.A2.Append=true
log4j.appender.A2.MaxFileSize=2MB
log4j.appender.A2.MaxBackupIndex=5
log4j.appender.A2.layout=org.apache.log4j.PatternLayout
log4j.appender.A2.layout.ConversionPattern=%-5p %d [%t] %c{3}.%M - %m%n 
 
log4j.additivity.test.xml=false
log4j.logger.test.xml=DEBUG,A3 
 
log4j.appender.A3=org.apache.log4j.RollingFileAppender
log4j.appender.A3.File=../logs/test-xml.log
log4j.appender.A3.Encoding=UTF-8
log4j.appender.A3.Append=true
log4j.appender.A3.MaxFileSize=2MB
log4j.appender.A3.MaxBackupIndex=5
log4j.appender.A3.layout=org.apache.log4j.PatternLayout
log4j.appender.A3.layout.ConversionPattern=%-5p %d [%t] %c{3}.%M - %m%n

配置文件中有

log4j.logger.test=DEBUG
log4j.additivity.test.xml=false
log4j.logger.test.xml=DEBUG,A3

这个实例中，通过log4j.additivity.test.xml=false这一句取消了继承关系，这样XML的log就只会在A3中输出.

另：不考虑日志级别，a.java, b.java, c.java 分别调用自己的logger，将日志分别写入到不同的文件中。

这个需求主要是在配置文件中，给appender取个名字

然后在调用时，使用名称的方式调用

public static Logger loggerA = Logger.getLogger(“Alog”);
public static Logger loggerB = Logger.getLogger(“Blog”);
public static Logger loggerC = Logger.getLogger(“Clog”);