Java之日志记录log4j

一、概要介绍
        log4j是Apache的一个开放源代码项目，通过使用log4j，我们可以控制日志信息输送的目的地是控制台、文件、GUI组件、甚至是socket服务器、NT的事件记录器、UNIX Syslog守护进程等；我们也可以控制每一条日志的输出格式；通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程。 
        log4j由三个重要的组件构成：日志信息的优先级，日志信息的输出目的地，日志信息的输出格式。日志信息的优先级从高到低有ERROR、WARN、 INFO、DEBUG，分别用来指定这条日志信息的重要程度；日志信息的输出目的地指定了日志将打印到控制台还是文件中；而输出格式则控制了日志信息的显示内容。 
        log4j对日志系统抽象出logger、logger工厂、appender、日志级别、日志格式等核心概念，这几个概念被广泛借鉴于其它日志系统的设计，经久不衰，其核心类图如下：

图1 log4j核心类图

二、配置文件 
        log4j支持两种配置文件格式，一种是XML格式的文件，一种是properties格式的文件。下面以使用properties格式做为配置文件为例说明之： 
        log4j.rootLogger=INFO, A1 
        log4j.appender.A1=org.apache.log4j.ConsoleAppender 
        log4j.appender.A1.layout=org.apache.log4j.PatternLayout 
        log4j.appender.A1.layout.ConversionPattern=%-4r %-5p [%t] %37c %3x - %m%n 
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
        其语法格式如下： 
        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（将日志信息以流格式发送到任意指定的地方） 
        （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}，输出类似：2014年04月13日 20:15: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字符，就从左边交远销出的字符截掉。 
5、log4j比较全面的配置
        log4j配置文件实现了输出到控制台、文件、回滚文件、发送日志邮件、输出到数据库日志表、自定义标签等全套功能，下面列出常用配置，择其一二使用就可以了：
        log4j.rootLogger=DEBUG,CONSOLE,A1,im
        log4j.addivity.org.apache=true
        # 应用于控制台
        log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
        log4j.appender.Threshold=DEBUG
        log4j.appender.CONSOLE.Target=System.out
        log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
        log4j.appender.CONSOLE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n
        #log4j.appender.CONSOLE.layout.ConversionPattern=[start]%d{DATE[DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[thread] n%c[CATEGORY]%n%m[MESSAGE]%n%n
        #应用于文件
        log4j.appender.FILE=org.apache.log4j.FileAppender
        log4j.appender.FILE.File=file.log
        log4j.appender.FILE.Append=false
        log4j.appender.FILE.layout=org.apache.log4j.PatternLayout
        log4j.appender.FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n
        # Use this layout for LogFactor 5 analysis
        # 应用于文件回滚
        log4j.appender.ROLLING_FILE=org.apache.log4j.RollingFileAppender
        log4j.appender.ROLLING_FILE.Threshold=ERROR
        log4j.appender.ROLLING_FILE.File=rolling.log //文件位置,也可以用变量${java.home}、rolling.log
        log4j.appender.ROLLING_FILE.Append=true //true:添加 false:覆盖
        log4j.appender.ROLLING_FILE.MaxFileSize=10KB //文件最大尺寸
        log4j.appender.ROLLING_FILE.MaxBackupIndex=1 //备份数
        log4j.appender.ROLLING_FILE.layout=org.apache.log4j.PatternLayout
        log4j.appender.ROLLING_FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n
        #应用于socket
        log4j.appender.SOCKET=org.apache.log4j.RollingFileAppender
        log4j.appender.SOCKET.RemoteHost=localhost
        log4j.appender.SOCKET.Port=5001
        log4j.appender.SOCKET.LocationInfo=true
        # Set up for Log Facter 5
        log4j.appender.SOCKET.layout=org.apache.log4j.PatternLayout
        log4j.appender.SOCET.layout.ConversionPattern=[start]%d{DATE[DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[thread]%n%c[CATEGORY]%n%m[MESSAGE]%n%n
        # Log Factor 5 Appender
        log4j.appender.LF5_APPENDER=org.apache.log4j.lf5.LF5Appender
        log4j.appender.LF5_APPENDER.MaxNumberOfRecords=2000
        # 发送日志给邮件
        log4j.appender.MAIL=org.apache.log4j.net.SMTPAppender
        log4j.appender.MAIL.Threshold=FATAL
        log4j.appender.MAIL.BufferSize=10
        log4j.appender.MAIL.From=web@
        log4j.appender.MAIL.SMTPHost=
        log4j.appender.MAIL.Subject=Log4J Message
        log4j.appender.MAIL.To=web@
        log4j.appender.MAIL.layout=org.apache.log4j.PatternLayout
        log4j.appender.MAIL.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n
        # 用于数据库
        log4j.appender.DATABASE=org.apache.log4j.jdbc.JDBCAppender
        log4j.appender.DATABASE.URL=jdbc:mysql://localhost:3306/test
        log4j.appender.DATABASE.driver=com.mysql.jdbc.Driver
        log4j.appender.DATABASE.user=root
        log4j.appender.DATABASE.password=
        log4j.appender.DATABASE.sql=INSERT INTO LOG4J (Message) VALUES (’[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n’)
        log4j.appender.DATABASE.layout=org.apache.log4j.PatternLayout
        log4j.appender.DATABASE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n 
        log4j.appender.A1=org.apache.log4j.DailyRollingFileAppender
        log4j.appender.A1.File=SampleMessages.log4j
        log4j.appender.A1.DatePattern=yyyyMMdd-HH’.log4j’
        log4j.appender.A1.layout=org.apache.log4j.xml.XMLLayout
        #自定义Appender
        log4j.appender.im = net.cybercorlin.util.logger.appender.IMAppender
        log4j.appender.im.host = mail.cybercorlin.net
        log4j.appender.im.username = username
        log4j.appender.im.password = password
        log4j.appender.im.recipient = [e-mail]
        log4j.appender.im.layout=org.apache.log4j.PatternLayout
        log4j.appender.im.layout.ConversionPattern =[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n

三、简单实例
        一般将commons-logging和log4j结合在一起进行日志记录，点击下载commons-logging，点击下载log4j。这里只用log4j，解压后将log4j-1.2.17.jar导入classpath中，如果用tomcat的话，需要将其拷贝到WEB-INF/lib目录下。
1、配置文件
        在你希望的目录下新建配置文件log4j.properties，比如：
        #vi tomcat/webapp/ROOT/log4j.properties
        --------------------------------------------------------------------------------------
        # 定义 DEBUG 优先级， R 为日志输出目的的
        log4j.rootLogger= DEBUG, R
        # 设置日志输出类型 , 为文件类型
        log4j.appender.R= org.apache.log4j.FileAppender
        # 设置日志文件名 logRecord.log, 输出到 tomcat 服务器的 logs 目录下 
        log4j.appender.R.file= ../logs/logRecord.log 
        # 每次在文件尾写入新的日志信息 
        log4j.appender.R.Append= true 
        # 日志输出信息格式类型 
        log4j.appender.R.layout= org.apache.log4j.PatternLayout 
        # 日志输出信息格式为 日期、优先级、 [ 全类名 ] 、日志信息、换行       
        log4j.appender.R.layout.ConversionPattern= %d%p [%l] %m%n   
2、实例代码
         日志配置文件准备好后，下面开始编写测试例程：
        #vi Log4J.java
        import org.apache.log4j.Logger;
        import org.apache.log4j.PropertyConfigurator;

        public class Log4J {
            public static Logger logger = Logger.getLogger(Log4J.class.getName());

            public static void main(String[] args) {
                PropertyConfigurator.configure(args[0]);
                logger.debug("Test log4j. debug");
                logger.info("Test log4j. info");
                logger.warn("Test log4j. warn");
                logger.error("Test log4j. error");
                System.out.println("success");
            }
        }
        保存后，执行如下命令编译Log4J.java源码成字节码Log4J.class：
        #javac -cp WEB-INF/lib/commons-logging-1.1.3.jar:WEB-INF/lib/log4j-1.2.17.jar -d ./ Log4J.java
        注意：如果源码依赖第三方jar包的话，需要像上面一样用-cp来引用第三方jar包，否则直接编译即可。
        编译完后就能看到字节码文件Log4J.class了，执行如下命令就能在Java虚拟机上执行字节码Log4J.class：
        #java -cp .:WEB-INF/lib/commons-logging-1.1.3.jar:WEB-INF/lib/log4j-1.2.17.jar Log4J log4j.properties
        注意：
        （1）如果源码依赖第三方jar包的话，需要像上面一样用-cp来引用第三方jar包，否则直接执行即可；
        （2）-cp目录中需要包含表示当前路径的.；
        （3）字节码文件Log4J.class在执行时不需要带上扩展名.class而仅仅指定名称Log4J即可。
        这三点需要准确无误，否则会出现类似如下的错误：
        java.lang.NoClassDefFoundError
        执行完后，如果能看到屏幕输出success，说明成功了，可以查看日志文件../logs/logRecord.log中内容如下：
        2014-04-30 21:19:27,354DEBUG [Log4J.main(Log4J.java:11)] Test log4j. debug
        2014-04-30 21:19:27,356INFO [Log4J.main(Log4J.java:12)] Test log4j. info
        2014-04-30 21:19:27,356WARN [Log4J.main(Log4J.java:13)] Test log4j. warn
        2014-04-30 21:19:27,356ERROR [Log4J.main(Log4J.java:14)] Test log4j. error