Log4J2用法

一、    关于Log4J

2015年5月，Apache宣布Log4J 1.x 停止更新。最新版为1.2.17。

如今，Log4J 2.x已更新至2.7。

官方网址：http://logging.apache.org/log4j/2.x/

二、    Log4J能做什么？

1.    将信息送到控制台，文件，GUI组件等。

2.    控制每条信息的输出格式。

3.    将信息分类，定义信息级别，细致地控制日志的输出。

三、    Log4J2的安装

1.    去官网下载log4j2，解压

2.    最基本的Jar包：

log4j-api-2.7.jar

log4j-core-2.7.jar

3. 将jar文件复制到Web项目的WEB-INF/lib目录下。

四、    配置文件介绍

1.    日志级别

trace：追踪，就是程序推进一下，可以写个trace输出

debug：调试，一般作为最低级别，trace基本不用。

info：输出重要的信息，使用较多

warn：警告，有些信息不是错误信息，但也要给程序员一些提示。

error：错误信息。用的也很多。

fatal：致命错误。级别较高，这种级别不用调试了，重写吧……

机制：如果一条日志信息的级别大于等于配置文件的级别，就记录。

2.    输出源

CONSOLE（输出到控制台）、FILE（输出到文件）等。

3.    布局方式

SimpleLayout：以简单的形式显示

HTMLLayout：以HTML表格显示

PatternLayout：自定义形式显示

在Log4J2中基本采用PatternLayout自定义日志布局。

自定义格式：

%t：线程名称

%p：日志级别

%c：日志消息所在类名

%m：消息内容

%M：输出执行方法

%d：发生时间，%d{yyyy-MM-dd HH:mm:ss,SSS}，输出类似：2011-10-18 22:10:28,921

%x: 输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像java servlets这样的多客户多线程的应用中。

%L：代码中的行数

%n：换行

<PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M -%msg%xEx%n"/>

c{precision}

logger{precision}

class{precision}àOutputs the name of the logger thatpublished the logging event.

Conversion Pattern	Logger Name	Result
%c{1}	org.apache.commons.Foo	Foo
%c{2}	org.apache.commons.Foo	commons.Foo
%c{10}	org.apache.commons.Foo	org.apache.commons.Foo
%c{-1}	org.apache.commons.Foo	apache.commons.Foo
%c{-2}	org.apache.commons.Foo	commons.Foo
%c{-10}	org.apache.commons.Foo	org.apache.commons.Foo
%c{1.}	org.apache.commons.Foo	o.a.c.Foo
%c{1.1.~.~}	org.apache.commons.test.Foo	o.a.~.~.Foo
%c{.}	org.apache.commons.test.Foo	....Foo

p|level{level=label,level=label, ...} p|level{length=n} p|level{lowerCase=true|false}à you can define the length of the levellabel:

m{nolookups}{ansi}|msg{nolookups}{ansi}|message{nolookups}{ansi}àsupplied message

xEx|xException|xThrowableàsuppress printing of the exception

五、    配置使用

1.    配置文件命名与存储位置（Log4J没有默认的配置文件）

系统选择configuration文件的优先级如下（放在src文件夹）：

classpath下名为 log4j-test.json 或者log4j-test.jsn文件

classpath下名为 log4j2-test.xml

classpath下名为 log4j.json 或者log4j.jsn文件

classpath下名为 log4j2.xml

很多人认为src就是classpath，java项目中Classpath路径到底指的是哪里？

1）   src不是classpath,而WEB-INF/classes,lib才是classpath，WEB-INF/是资源目录, 客户端不能直接访问。

2）   WEB-INF/classes目录存放src目录java文件编译之后的class文件，xml、properties等资源配置文件，这是一个定位资源的入口。

3）   lib和classes同属classpath，两者的访问优先级为: lib>classes。

配置主要是两方面内容：一是logger，二是appender；将两者关联起来

简单的配置文件

<?xml version="1.0" encoding="UTF-8"?>  
     <configuration status="OFF">  
       <appenders>
         <Console name="Console" target="SYSTEM_OUT">  
           <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>  
         </Console>
       </appenders>  
       <loggers>
         <root level="trace">  
           <appender-ref ref="Console"/>  
         </root>  
       </loggers>
     </configuration>

稍微复杂的配置

<?xml version="1.0" encoding="UTF-8"?>  
<configuration status="error">
<!--     先定义所有的appender -->
    <appenders>
<!--         这个输出控制台的配置 -->
        <Console name="Console" target="SYSTEM_OUT">
<!--             控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch） -->
            <ThresholdFilter level="trace" onMatch="ACCEPT" onMismatch="DENY"/>
<!--             这个都知道是输出日志的格式 -->
            <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>
        </Console>
        
<!--         文件会打印出所有信息，这个log每次运行程序会自动清空，由append属性决定，这个也挺有用的，适合临时测试用 -->
<!--         append为TRUE表示消息增加到指定文件中，false表示消息覆盖指定的文件内容，默认值是true -->
        <File name="log" fileName="log/test.log" append="false">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>
        </File>
        
<!--          添加过滤器ThresholdFilter,可以有选择的输出某个级别以上的类别  onMatch="ACCEPT" onMismatch="DENY"意思是匹配就接受,否则直接拒绝  -->
        <File name="ERROR" fileName="logs/error.log">
            <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="%d{yyyy.MM.dd 'at' HH:mm:ss z} %-5level %class{36} %L %M - %msg%xEx%n"/>
        </File>

<!--         这个会打印出所有的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档 -->
        <RollingFile name="RollingFile" fileName="logs/web.log"
                     filePattern="logs/$${date:yyyy-MM}/web-%d{MM-dd-yyyy}-%i.log.gz">
            <PatternLayout pattern="%d{yyyy-MM-dd 'at' HH:mm:ss z} %-5level %class{36} %L %M - %msg%xEx%n"/>
            <SizeBasedTriggeringPolicy size="2MB"/>
        </RollingFile>
    </appenders>
    
<!--     然后定义logger，只有定义了logger并引入的appender，appender才会生效 -->
    <loggers>
<!--         建立一个默认的root的logger,ref指向上面appender的名称 -->
        <root level="info">
            <appender-ref ref="RollingFile"/>
            <appender-ref ref="Console"/>
            <appender-ref ref="ERROR" />
            <appender-ref ref="log"/>
        </root>

    </loggers>
</configuration>

最后说明，

使用Console类型的appender，日志会输出到控制台，windows为控制台，linux为catalina.out文件

使用File,RollingFile为文件类型的appender，日志会输出到指定位置的文件中

如果logger包含控制台和文件类型的appender,且程序中记录日志的logger的级别大于等于配置文件中logger的级别，则日志会在各个类型的文件中记录。

如果logger只包含控制台的appender,且程序中记录日志的logger的级别大于等于配置文件中logger的级别，则日志只会记录在控制台类型的文件中记录。

如果logger只包含文件类型的appender,且程序中记录日志的logger的级别大于等于配置文件中logger的级别，则日志只会在文件类型的文件中记录。

也就是说logger引用了多少个append配置，记录日志时，引用的append都会起作用。

当然，如果程序中的logger调用方法的级别小于配置文件中logger配置的level，则不会记录日志。

        下面Java类中使用了slf4j的接口来实现日志记录。这将会使用我们配置文件中Root根节点指定的Appender，如果我们没有自己配置Logger，则会使用Root根节点的默认配置。

        private static final Logger logger=LoggerFactory.getLogger(My.class);

        下面使用自定义的Logger作为日志记录器,为此加一个自定义Logger，name为myLearningLog

          private static final Logger logger = LoggerFactory.getLogger("myLearningLog");

       

        记录日志

　　  public static void main(String[] args) {
         logger.trace("learning1 log4j trace");  //如果配置文件中logger的level为info，则trace,和debug不会记录
         logger.debug("learning1 log4j debug");
         logger.info("learning1 log4j info");
         logger.warn("learning1 log4j warn");
         logger.error("learning1 log4j error");
       }

 

扩展

Log4j用法

Log4j的配置文件分类
Log4j支持两种配置文件格式，一种是XML格式的文件，一种是properties（key=value）文件，其中properties格式的配置文件最为常用，其有一个固定的文件名log4j.properties，下面我们介绍使用properties文件做为配置文件的方法：

log4j.properties配置文件详解

配置主要是两方面内容：一是logger，二是appender；将两者关联起来

1.配置根Logger，其语法为：

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

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

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

1. log4j.appender.appenderName = fully.qualified.name.of.appender.class
2. log4j.appender.appenderName.option1 = value1
3. …
4. log4j.appender.appenderName.option = valueN

2.1配置Appender类型，Log4j提供的appender有以下几种：

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

ConsoleAppender
Threshold=WARN：指定日志消息的输出最低层次。
ImmediateFlush=true：默认值是true,意谓着所有的消息都会被立即输出。
Target=System.err：默认情况下是：System.out,指定输出控制台，linux就是输出到catalina.out文件中。

FileAppender
Threshold=WARN：指定日志消息的输出最低层次。
ImmediateFlush=true：默认值是true,意谓着所有的消息都会被立即输出。
File=mylog.txt：指定消息输出到mylog.txt文件。
Append=false：默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。

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: 每分钟

RollingFileAppender
Threshold=WARN：指定日志消息的输出最低层次。
ImmediateFlush=true：默认值是true,意谓着所有的消息都会被立即输出。
File=mylog.txt：指定消息输出到mylog.txt文件。
Append=false：默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。
MaxFileSize=100KB：后缀可以是KB, MB 或者是 GB. 在日志文件到达该大小时，将会自动滚动，即将原来的内容移到mylog.log.1文件。
MaxBackupIndex=5：指定可以产生的滚动文件的最大数。

2.2.配置appender的日志信息的格式（布局），其语法为：

1. log4j.appender.appenderName.layout = 例如org.apache.log4j.PatternLayout
2. log4j.appender.appenderName.layout.option1 = value1
3. …
4. 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（包含日志产生的时间、线程、类别等等信息

 

　　其中指定PatternLayout时，需要配合设置日志格式ConversionPattern才行，下面详解。

2.3配置具体的自定义格式

日志信息格式中几个符号所代表的含义：

-X号: X信息输出时左对齐；
%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平台为” ”，Unix平台为” ”输出日志信息换行

可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如：

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字符，就从左边交远销出的字符截掉

 log4j.properties配置文件 实战

//配置Logger,这里配置的是跟rootLogger,指定日志级别及用的的Appender

log4j.rootLogger = INFO, stdout  , D , R  //指定输出级别为INFO,Appender有stdout  , D , R 

//下面具体配置三个Appender：stdout  , D , R

//输出到控制台，即catalina.out文件
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss,SSS} [%c]-[%p] %m%n

 　　产生文件如图：

//每天产生一个日志文件catalinacustomer，且每小时分隔出一个文件catalinacustomer.yyyy-MM-dd-HH.log，

log4j.appender.D=org.apache.log4j.DailyRollingFileAppender
log4j.appender.D.File=${catalina.base}/logs/catalinacustomer
log4j.appender.D.DatePattern ='.'yyyy-MM-dd-HH'.log'
log4j.appender.D.layout = org.apache.log4j.PatternLayout //自定义布局PatternLayout
log4j.appender.D.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss,SSS} [%c]-[%p] %m%n  //定义布局格式
log4j.appender.D.Append=true //默认为true

产生文件如图：

 //按照指定的文件大小尺寸产生文件机制

log4j.appender.R=org.apache.log4j.RollingFileAppender
log4j.appender.R.File=${catalina.base}/logs/catalinacustomerfile //文件名
log4j.appender.R.MaxFileSize=10KB  //后缀可以是KB, MB 或者是 GB. 在日志文件到达该大小时，将会自动滚动，即将原来的内容移到catalinacustomerfile .1文件,依次类推，数字越小内容越新。
log4j.appender.R.MaxBackupIndex=10 //指定可以产生的滚动文件的最大数
log4j.appender.R.layout=org.apache.log4j.PatternLayout
log4j.appender.R.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss,SSS} [%c]-[%p] %m%n

产生文件如图：

如上配置，则会产生这些文件，分别是catalina.out，catalinacustomer，catalinacustomer.yyyy-MM-dd-HH.log，catalinacustomerfile ，catalinacustomerfile.1 ，……

 之所以是catalina.2019-10-10.log而非catalina.out，是因为用了cronolog做日志分隔。