log4j日志处理学习

log4j学习

本次学习Log4j日志框架的主要目的是为了实现对大数据平台的日志管理，因为现在的平台日志信息实在是太过庞大了，所占的硬盘空间也会越来越多，为了对日志信息文件做相应的管理，从而可以使用Log4j实现这些功能。

什么是Log4j

Log4j是Apache的一个开放源代码项目，通过使用Log4j，我们可以控制日志信息输送的目的地是控制台、文件、GUI组件、甚至是套接口服务 器、NT的事件记录器、UNIXSyslog守护进程等;我们也可以控制每一条日志的输出格式;通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程。最令人感兴趣的就是，这些可以通过一个配置文件来灵活地进行配置，而不需要修改应用的代码。

log4j原理

Log4j设计实现为分层结构，每一层都提供了不同的类，实现不同功能的对象执行不同的任务，在实际的使用中可以根据自己的具体需求灵活的进行扩展。不同组件的框架图如下： 

由图可以看出，log4j框架核心对象主要有三种：

• Logger 对象，在程序使用中往往只会接触到这一对象，Logger对象负责获取不同级别日志信息；
• Layout对象，该层提供用于格式化不同风格的日志信息的对象； 
  Appender对象，负责发布日志信息，可以指定将日志信息输出的目的地，可以是控制台终端、文件、数据库、Unix syslog等； 
  还有四种辅助对象：
• Level对象：用于定义日志的级别，这个想必大家都不会陌生，Linux系统中是非常常用的（比如开发内核程序，常常用printk打印日志以此调试程序）。主要有以下几种 
  
  1. off 最高等级，用于关闭所有日志记录。
  2. fatal 指出每个严重的错误事件将会导致应用程序的退出。
  3. error 指出虽然发生错误事件，但仍然不影响系统的继续运行。
  4. warm 表明会出现潜在的错误情形。
  5. info 一般和在粗粒度级别上，强调应用程序的运行全程。
  6. debug 一般用于细粒度级别上，对调试应用程序非常有帮助。
  7. all 最低等级，用于打开所有日志记录。 
     Log4j建议只使用四个级别，优先级从高到低分别是ERROR、WARN、INFO、DEBUG，定义一个较低级别的话，会将比其级别高的日志信息全部打印出来；
• Filter对象：主要用于分析过滤日志信息，判断是否应该记录；
• ObjectRenderer对象：用于提供不同对象的toString方法；
• LogManager对象：主要负责Log4j的初始化配置。

Log4j的简单使用

1. 配置文件

主要有两个步骤，首先定义Log4j的配置文件，在代码中获取Log4j日志记录器。 
配置文件主要支持两种文件格式，XML格式和Java 键-值格式的配置文件。这里主要说下第二种格式的使用。

a.配置根Logger：

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

level 指定日志的级别，appenderName指定相应级别日志的输出目的地及一些属性；如：

 
 
log4j.rootLogger = error,stdout,E //指定级别为error，高于等于error级别的日志信息都会输出

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

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

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

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

使用org.apache.log4j.PatternLayout布局时需要指定输出的格式，定义为：

 
 
log4j.appender.E.layout.ConversionPattern = value

ConversionPattern参数的格式含义类似C语言中的printf函数的打印格式格式化日志信息，打印参数如下：

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

接下来看一个配置实例：

 
 
//配置stdout，日志输出到控制台，采用PatternLayout格式
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
//配置E，以文件形式输出，指定DailyRollingFileAppender根据时间对日志进行切割
log4j.appender.E = org.apache.log4j.DailyRollingFileAppender
log4j.appender.E.File =F://logs/error.log 
log4j.appender.E.Append = true
log4j.appender.E.Threshold = ERROR 
log4j.appender.T.DatePattern='.'yyyy-MM-dd-HH   //以小时分隔日志文件，即就是一个小时产生一个日志文件
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

2.使用log4j

根据上一步的配置实例写一个测试代码如下：

 
 
package test;
import org.apache.log4j.Logger;
public class Log4j_test {
    static Logger LOG = Logger.getLogger(Log4j_test.class); //获取日志记录器
    public static void main(String[] args) {
        LOG.debug("hello");  //指定日志信息
        LOG.error("hello");
        LOG.fatal("fatal");
        LOG.warn("warn");
    }
}

因为指定的日志级别是error，所以只有error和fatal级别日志会输出 
程序输出如下

 
 
[ERROR] 2016-10-22 19:13:31,860 method:test.Log4j_test.main(Log4j_test.java:10)
hello
[FATAL] 2016-10-22 19:13:31,868 method:test.Log4j_test.main(Log4j_test.java:11)
fatal

因为指定了输出文件，所以可以在F://logs/目录中发现文件error.log。