002-log-log4j

一、概述

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

1.1、POM依赖

        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>

1.2、配置log4j.properties

一般放置在resource目录下即可

### 设置###
log4j.rootLogger = debug,stdout,D,E

### 输出信息到控制抬 ###
log4j.appender.stdout = org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target = System.out
log4j.appender.stdout.layout = org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern = [%-5p] %d{yyyy-MM-dd HH:mm:ss,SSS} method:%l%n%m%n

### 输出DEBUG 级别以上的日志到 ###
log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
log4j.appender.D.File = log.log
log4j.appender.D.Append = true
log4j.appender.D.Threshold = DEBUG 
log4j.appender.D.layout = org.apache.log4j.PatternLayout
log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

### 输出ERROR 级别以上的日志到error.log ###
log4j.appender.E = org.apache.log4j.DailyRollingFileAppender
log4j.appender.E.File =error.log 
log4j.appender.E.Append = true
log4j.appender.E.Threshold = ERROR 
log4j.appender.E.layout = org.apache.log4j.PatternLayout
log4j.appender.E.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

1.3、java代码

    private static Logger logger = Logger.getLogger(ApplicationMain.class);

    public static void main(String[] args) {
        // 记录debug级别的信息  
        logger.debug("This is debug message.");
        // 记录info级别的信息  
        logger.info("This is info message.");
        // 记录error级别的信息  
        logger.error("This is error message.");
    } 

控制台输出

[DEBUG] 2019-06-20 19:07:08,388 method:com.github.bjlhx15.common.study.log.ApplicationMain.main(ApplicationMain.java:10)
This is debug message.
[INFO ] 2019-06-20 19:07:08,390 method:com.github.bjlhx15.common.study.log.ApplicationMain.main(ApplicationMain.java:12)
This is info message.
[ERROR] 2019-06-20 19:07:08,390 method:com.github.bjlhx15.common.study.log.ApplicationMain.main(ApplicationMain.java:14)
This is error message.

  同时查看文件级别输出

二、配置详解

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

2.1、定义配置文件

  其实您也可以完全不使用配置文件,而是在代码中配置Log4j环境。但是,使用配置文件将使您的应用程序更加灵活。Log4j支持两种配置文件格式,一种是XML格式的文件,一种是Java特性文件(键=值)。下面我们介绍使用Java特性文件做为配置文件的方法:

  1.配置根Logger,其语法为:

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

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

  每个Logger都被了一个日志级别(log level),用来控制日志信息的输出。日志级别从高到低分为:
    A:off 最高等级,用于关闭所有日志记录。
    B:fatal 指出每个严重的错误事件将会导致应用程序的退出。
    C:error 指出虽然发生错误事件,但仍然不影响系统的继续运行。
    D:warm 表明会出现潜在的错误情形。
    E:info 一般和在粗粒度级别上,强调应用程序的运行全程。
    F:debug 一般用于细粒度级别上,对调试应用程序非常有帮助。
    G:all 最低等级,用于打开所有日志记录。

  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.配置日志信息的格式(布局),其语法为:

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

  其中,Log4j提供的layout有以e几种:

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

2.2、PatternLayout

  Log4J采用类似C语言中的printf函数的打印格式格式化日志信息,打印参数如下: %m 输出代码中指定的消息

 -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平台为"/r/n",Unix平台为"/n"输出日志信息换行

最常用的格式化器,用户可以自定义:日期、时间、所在的线程、类名、文件名、方法名、信息级别、文件行数

  Log4j能输出形形色色的参数,这些参数内容的长度可能是不同的。

  例如,%C输出类名,有的类名很长,有的类名很短,会导致日志比较凌乱。

  为解决该问题,Log4j允许设置输出内容的长度等,不够长会用空格补齐,使输出内容变得整齐。

  设置方法是在%与参数符号间添加数字,例如%20P、%-20P等。

  正数表示右对齐,负数表示左对齐,数字表示最小宽度,不足时用空格补齐。还可以设置最大宽度,如果超出,则截取,方法是用小数点+数字设置,例如%.30P。

格式

对齐方式

最小宽度

最大宽度

描述

示例

[%10p]

右对齐

10

 

正数右对齐,最小宽度

[          ERROR]

[%-10P]

左对齐

10

 

负数左对齐,最小宽度

[ERROR          ]

[%.4P]

 

 

4

最大宽度

[RROR]

[%10.20]

右对齐

10

20

正数右对齐,最大最小宽度

[          ERROR]

[%-10.20]

左对齐

10

20

负数左对齐,最大最小宽度

[ERROR          ]

常用参数描述

参数

描述

示例

小c

输出Logger所在的类别(即Logger的名字)。

允许使用%c{数字}输出部分的名称(从右边往左边数)

%c:将输出a.b.Clazz

%c{1}:将输出Clazz

%c{2}:将输出b.Clazz

%c{3}:将输出a.b.Clazz

大C

输出Logger所在类的名称。

有时候Logger的名称不同于类,例如Hibernate中用org.hibernate.SQL

作为所有输出DML语句的Logger的名称,便于控制。

允许使用%C{数字}输出部分的名称(从右边往左数)

%c:将输出a.b.Clazz

%c{1}:将输出Clazz

%c{2}:将输出b.Clazz

%c{3}:将输出a.b.Clazz

d

输出日期。允许使用%d{yyyy-MM-dd HH:mm:ss}格式化日期。

%d不仅支持JDK SimpleDateFormat的日期格式,

还支持log4j自己的日期格式,例如ABSOLUTE、DATE、ISO8601等

%d:将输出2013-06-01 23:42:34,343

%d{yyyy-MM-dd}:将输出2013-06-01

%d{ABSOLUTE}:将输出23:42:34,343

%d{DATE}:将输出01 六月 2013 23:42:34,343

F|file

输出所在的类文件名称

%F:将输出Log4jConfigTest.java

l

输出语句所在的行数,包括类名、方法名、文件名、行数等

%l:将输出bar.foo.Log4jConfigTest.test(Log4jConfigTest.java:34)

L

输出语句所在的行数,只输出数字

%L:将输出 34

m

输出消息

输出消息,即log.info(“”)、log.debug(“”)中的参数

M

输出方法名

%M:将输出test

N

换行。Windows下输出\r\n,Linux下输出\n

换行

p

输出日志级别(priority)

DEBUG、INFO、ERROR、FITAL等。

r

输出从程序启动到输出该日志之间的时间间隔,单位:毫秒

%r:将输出 3000

t

输出当前的线程名称

%t:将输出main、Thread-0、Thread-1等

%

%%用来输出百分号

 

 示例配置:

  PatternLayout pattern="[%d{yyyy-MM-dd HH:mm:ss:SSS}][%5p][%t] - %l - %m%n"

  输出:[2019-08-17 11:17:24:414][ INFO][] - com.lhx.doStart(ClusterManager.java:92) - try to update cluster.

 

 

 

 

 

 

 

 

发送到

posted @ 2019-06-21 11:16  bjlhx15  阅读(233)  评论(0编辑  收藏  举报
Copyright ©2011~2020 JD-李宏旭