【log4j】log4j日志框架使用总结

一、log4j

Log4j是Apache的一个开放源代码项目，通过使用Log4j，我们可以控制日志信息输送的目的地是控制台、文件、GUI组件、甚至是套接口服务 器、NT的事件记录器、UNIX Syslog守护进程等；我们也可以控制每一条日志的输出格式；通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程

Log4j由三个重要的组件构成：日志信息的优先级，日志信息的输出目的地，日志信息的输出格式。日志信息的优先级从高到低有ERROR、WARN、 INFO、DEBUG，分别用来指定这条日志信息的重要程度；日志信息的输出目的地指定了日志将打印到控制台还是文件中；而输出格式则控制了日志信息的显示内容。 

二、基本用法

1.      下载并导入log4j的jar包  

我使用的是slf4j + log4j

所以这里需要几个基本的jar包 ：log4j-1.2.17.jar

                                                    commons-logging-1.2.jar

                                                    slf4j-api-1.7.25.jar

                                                    slf4j-log4j12-1.7.25.jar

当然这里也可以只使用log4j-1.2.17.jar，并不影响基本使用

ps:为什么同时使用commons-logging和Log4j,而不用其一

它自身的日志功能平常弱（只有一个简单的SimpleLog），所以一般不会单独使用它。
Log4j的功能非常全面强大，是目前的首选。几乎所有的Java开源项目都会用到Log4j，但，

所有用到Log4j的项目一般也同时会用到commons-loggin
 Commons-loggin的目的是为“所有的Java日志实现”提供一个统一的接口，避免项目与某个日志实现系统紧密a耦合

2.      在src目录下新建log4j.properties配置文件，(当然也不一定放置在这下面，但是如果是需要在web.xml额外进行配置）

这里简单的进行初步的配置，只为测试

# Root logger optionlog4j.rootLogger= INFO, stdout, R# Direct log messages to stdout 输出到控制台配置log4j.appender.stdout=org.apache.log4j.ConsoleAppenderlog4j.appender.stdout.Target=System.outlog4j.appender.stdout.layout=org.apache.log4j.PatternLayoutlog4j.appender.stdout.layout.ConversionPattern=[%-5p] %d{yyyy-MM-dd HH:mm:ss} %c %m%n#输出到文件配置log4j.appender.R=org.apache.log4j.DailyRollingFileAppenderlog4j.appender.R.File=D:\\logs.loglog4j.appender.R.layout=org.apache.log4j.PatternLayoutlog4j.appender.R.layout.ConversionPattern=%d-[TS] %p %t %c - %m%n

3.       日志输出类

/** * 日志框架测试 *  * @author xiazhang * @date   2017-6-10 */public class LogTest {private static org.apache.log4j.Logger logger1 = org.apache.log4j.Logger.getLogger(JunitTest.class);private static org.apache.commons.logging.Log logger2 = org.apache.commons.logging.LogFactory.getLog(JunitTest.class);private static org.slf4j.Logger logger3 = org.slf4j.LoggerFactory.getLogger(JunitTest.class);@Testpublic void test(){logger1.info("132456");logger2.info("123456");logger3.info("占位符1:{},占位符2:{}", "123456","789789");}}

4.      日志输出结果

(1) 控制台输出

[INFO ] 2017-06-10 12:06:56 my.test.junit.JunitTest 132456[INFO ] 2017-06-10 12:06:56 my.test.junit.JunitTest 123456[INFO ] 2017-06-10 12:06:56 my.test.junit.JunitTest 占位符1:123456,占位符2:789789

(2) 日志文件输出

三、log4j.properties 文件配置

1.       配置根logger

语法格式为

log4j.rootLogger = [ level ] , appenderName, appenderName, ...//appenderName输出目的地名称，可自己任意定义，并可同时指定多个

其中，level 是日志记录的优先级，分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定义的级别。Log4j建议只使用四个级别，优先级从高到低分别是ERROR、WARN、INFO、DEBUG。通过在这里定义的级别，您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定 义了INFO级别，则应用程序中所有DEBUG级别的日志信息将不被打印出来。

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（将日志信息以流格式发送到任意指定的地方）

例：

log4j.appender.stdout=org.apache.log4j.ConsoleAppender

log4j.appender.stdout.Target=System.out

option详解

(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:每周滚动一次文件，即每周产生一个新的文件。当然也可以指定按月、周、天、时和分。即对应的格式如下：   1)’.'yyyy-MM: 每月   2)’.'yyyy-ww: 每周   3)’.'yyyy-MM-dd: 每天   4)’.'yyyy-MM-dd-a: 每天两次   5)’.'yyyy-MM-dd-HH: 每小时   6)’.'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:指定可以产生的滚动文件的最大数。 

3.        配置日志信息的布局

语法为： 

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（包含日志产生的时间、线程、类别等等信息）

 

4.       输出格式配置

在配置文件中可以通过log4j.appender.A1.layout.ConversionPattern设置日志输出格式。 

参数： 
%p: 输出日志信息优先级，即DEBUG，INFO，WARN，ERROR，FATAL, 
%d: 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss,SSS}，输出类似：2002年10月18日 22：10：28，921 
%r: 输出自应用启动到输出该log信息耗费的毫秒数 
%c: 输出日志信息所属的类目，通常就是所在类的全名 
%t: 输出产生该日志事件的线程名 
%l: 输出日志事件的发生位置，相当于%C.%M(%F:%L)的组合,包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main(TestLog4.java:10) 
%x: 输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像java servlets这样的多客户多线程的应用中。 
%%: 输出一个”%”字符 
%F: 输出日志消息产生时所在的文件名称 
%L: 输出代码中的行号 
%m: 输出代码中指定的消息,产生的日志具体信息 
%n: 输出一个回车换行符，Windows平台为”\r\n”，Unix平台为”\n”输出日志信息换行 

可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如： 
1) %20c: 指定输出category的名称，最小的宽度是20，如果category的名称小于20的话，默认的情况下右对齐。 
2) %-20c: 指定输出category的名称，最小的宽度是20，如果category的名称小于20的话，”-”号指定左对齐。 
3) %.30c: 指定输出category的名称，最大的宽度是30，如果category的名称大于30的话，就会将左边多出的字符截掉，但小于30的话也不会有格。 
4) %20.30c: 如果category的名称小于20就补空格，并且右对齐，如果其名称长于30字符，就从左边交远销出的字符截掉。