log4j 日志配置 -- properties 和 xml两种形式

1. Log4j简介

 在强调可重用组件开发的今天，除了自己从头到尾开发一个可重用的日志操作类外， Apache 为我们提供了一个强有力的日志操作包 ——Log4j 。　　 

　　 Log4j 是 Apache 的一个开放源代码项目，通过使用 Log4j ，我们可以控制日志信息输送的目的地是控制台、文件、 GUI 组件、甚至是套接口服 务器、 NT 的事件记录器、 UNIX Syslog 守护进程等；我们也可以控制每一条日志的输出格式；通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程。最令人感兴趣的就是，这些可以通过一个配置文件来灵活地进行配置，而不需要修改应用的代码。　　
　　此外，通过 Log4j 其他语言接口，您可以在 C 、 C+ + 、 .Net 、 PL/SQL 程序中使用 Log4j ，其语法和用法与在 Java 程序中一样，使得多语言分布式系统得到一个统一一致的日志组件模块。而且，通 过使用各种第三方扩展，您可以很方便地将 Log4j 集成到 J2EE 、 JINI 甚至是 SNMP 应用中。

1.1 添加日志的目的
在应用程序中添加日志记录总的来说基于三个目的：
1）监视代码中变量的变化情况，周期性的记录到文件中供其他应用进行统计分析工作；
2）跟踪代码运行时轨迹，作为日后审计的依据；
3）担当集成开发环境中的调试器的作用，向文件或控制台打印代码的调试信息。　　
　　最普通的做法就是在代码中嵌入许多的打印语句，这些打印语句可以输出到控制台或文件中，比较好的做法就是构造一个日志操作类 来封装此类操作，而不是让一系列的打印语句充斥了代码的主体。
http://logging.apache.org/log4j/ 官网地址

1.2 Log4j规则
Loggers组件在此系统中由低到高被分为七个级别：all < debug < info < warn < error < fatal < off。Log4j建议只使用四个级别，优先级从高到低分别是 ERROR、WARN、INFO、DEBUG。Log4j有一个规则：仅打印出大于等于当前级别的信息。假设你定义的级别是info，那么info、warn 和 error级别的信息可以打印出,而比info低的debug级别信息就不打印出来了。
输出级别的种类– ERROR、WARN、INFO、DEBUG
OFF是最高等级的，用于关闭所有日志记录。
FATAL指出每个严重的错误事件将会导致应用程序的退出。
ERROR 为严重错误 主要是程序的错误
WARN 为一般警告，比如session丢失
INFO 为一般要显示的信息，比如登录登出
DEBUG 为程序的调试信息
ALL是最低等级的，用于打开所有日志记录

2. Log4j 基本使用方法
　　 Log4j 由三个重要的组件构成：日志信息的优先级，日志信息的输出目的地，日志信息的输出格式 。日志信息的优先级用来指定这条日志信息的重要程度；日志信息的输出目的地指定了日志将打印到控制台还是文件中；而输出格式则控制了日志信息的显示内容。
Logger - 日志写出器 ，供程序员输出日志信息
Appender - 日志目的地 ，把格式化好的日志信息输出到指定的地方去
Layout - 日志格式化器 ，用来把程序员的 logging request 格式化成字符串

2.1 定义配置文件
　　 其实您也可以完全不使用配置文件，而是在代码中配置 Log4j 环境。但是，使用配置文件将使您的应用程序更加灵活。 Log4j 支持两种配置文件格式，一种是 XML 格式的文件，一种是 properties文件。下面我们介绍使用 properties文件做为配置文件的方法
　　
2.2.1 配置根 Logger
　　其语法为： log4j.rootLogger = [ level ] , appenderName, appenderName, …
　　其中， level 是日志记录的优先级，分为 OFF 、 FATAL 、 ERROR 、 WARN 、 INFO 、 DEBUG 、 ALL或者您定义的级别。 Log4j 建议只使用四个级别 ，优先级从高到低分别是 ERROR 、 WARN 、 INFO 、 DEBUG。通过在这里定义的级别，您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定义了 INFO 级别，则应用程序中所有 DEBUG 级别的日志信息将不被打印出来 。 appenderName 就是指 日志信息输出到哪个地方。您可以同时指定多个输出目的地。

2.2.2 配置日志信息输出目的地 Appender
其语法为： log4j.appender.appenderName = fully.qualified.name.of.appender.class.
其中， 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 （将日志信息以流格式发送到任意指定的地方）
1）ConsoleAppender 选项
Threshold=WARN: 指定日志消息的输出最低层次。
ImmediateFlush=true: 默认值是 true, 意谓着所有的消息都会被立即输出。
Target=System.err ：默认情况下是： System.out, 指定输出控制台
2）FileAppender 选项
Threshold=WARN: 指定日志消息的输出最低层次。
ImmediateFlush=true: 默认值是 true, 意谓着所有的消息都会被立即输出。
File=mylog.txt: 指定消息输出到 mylog.txt 文件。
3）DailyRollingFileAppender 选项
Threshold=WARN: 指定日志消息的输出最低层次。
ImmediateFlush=true: 默认值是 true, 意谓着所有的消息都会被立即输出。
File=mylog.txt: 指定消息输出到 mylog.txt 文件。
Append=false: 默认值是 true, 即将消息增加到指定文件中， false 指将消息覆盖指定的文件内容。
DatePattern=’.’yyyy-ww: 每周滚动一次文件 ，即每周产生一个新的文件。当然也可以指定按月、周、天、时和分。即对应的格式如下：
a. yyyy-MM: 每月
b. yyyy-ww: 每周
c. yyyy-MM-dd: 每天
d. yyyy-MM-dd-a: 每天两次
e. yyyy-MM-dd-HH: 每小时
f. 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: 指定可以产生的滚动文件的最大数。
实际应用：
　　 log4j.appender.A1=org.apache.log4j.ConsoleAppender // 这里指定了日志输出的第一个位置 A1 是控制台ConsoleAppender 　

2.2.3 配置日志信息的格式（布局）
　　其语法为： log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
　　其中， Log4j 提供的 layout 有以 e 几种：
　　 1) org.apache.log4j.HTMLLayout （以 HTML 表格形式布局），
　　 2) org.apache.log4j.PatternLayout （可以灵活地指定布局模式），
　　 3) org.apache.log4j.SimpleLayout （包含日志信息的级别和信息字符串），
　　 4) org.apache.log4j.TTCCLayout （包含日志产生的时间、线程、类别等等信息）
　　 1) HTMLLayout 选项
　　 LocationInfo=true: 默认值是 false, 输出 java 文件名称和行号
　　 Title=my app file: 默认值是 Log4J Log Messages.
　　 2) PatternLayout 选项
　　 ConversionPattern=%m%n : 指定怎样格式化指定的消息。
　　 3) XMLLayout 选项
　　 LocationInfo=true: 默认值是 false, 输出 java 文件和行号
　　 实际应用：
　　 log4j.appender.A1.layout=org.apache.log4j.PatternLayout
　　 log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ssS} %c %m%n

参照1：日志信息的格式
Log4J 采用类似 C 语言中的 printf 函数的打印格式格式化日志信息，这里需要说明的就是日志信息格式中几个符号所代表的含义：
-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)的组合,包括类目名、发生的线程，以及在代码中的行数。
%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字符，就从左边交远销出的字符截掉。
这里上面三个步骤是对前面 Log4j 组件说明的一个简化；下面给出一个具体配置例子，在程序中可以参照执行：
　　 log4j.rootLogger=INFO,A1 ， B2
　　 log4j.appender.A1=org.apache.log4j.ConsoleAppender
　　 log4j.appender.A1.layout=org.apache.log4j.PatternLayout
　　 log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ssS} %c %m%n

参照2：log4j.properties 形式日志

log4j的配置之简单使它遍及于越来越多的应用中了,

案例 :

# 设置级别和目的地   log4j.rootLogger=debug,appender1    # 输出到控制台   log4j.appender.appender1=org.apache.log4j.ConsoleAppender  # 设置输出样式   log4j.appender.appender1.layout=org.apache.log4j.PatternLayout  # 自定义样式   log4j.appender.appender1.layout.ConversionPattern =%r [%t] [%p] - %c -%l -%m%n  

log4j.properties文件
Log4J 配置文件实现了输出到控制台、文件、回滚文件、发送日志邮件、输出到数据库日志表、自定义标签等全套功能。择其一二使用就够用了.

######################## set log levels  设置级别和目的地   ######################log4j.rootLogger=DEBUG,CONSOLE,FILEOUT#DEBUG,CONSOLE,FILE,ROLLING_FILE,MAIL,DATABASElog4j.addivity.org.apache=true######################## CONSOLE Appender  输出到控制台  ######################log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppenderlog4j.appender.Threshold=DEBUGlog4j.appender.CONSOLE.Target=System.outlog4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayoutlog4j.appender.CONSOLE.layout.ConversionPattern=[%-5p][%d{yyyy-MM-dd HH\:mm\:ss,SSS}][%c] \:%m%n#log4j.appender.CONSOLE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n\u00A0#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######################## Rolling File Appender######################log4j.appender.FILEOUT=org.apache.log4j.RollingFileAppenderlog4j.appender.FILEOUT.File=${catalina.home}/mybatisDemo.rollfile.log#log4j.appender.FILEOUT.Threshold=ALLlog4j.appender.FILEOUT.Threshold=ERRORlog4j.appender.FILEOUT.Append=truelog4j.appender.FILEOUT.MaxFileSize=1000KB#log4j.appender.ROLLING_FILE.MaxBackupIndex=1log4j.appender.FILEOUT.layout=org.apache.log4j.PatternLayoutlog4j.appender.FILEOUT.layout.ConversionPattern=[%-5p][%d{yyyy-MM-dd HH\:mm\:ss,SSS}][%c] \:%m%n#log4j.appender.CONSOLE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n\u00A0########################## File Appender########################log4j.appender.FILE=org.apache.log4j.FileAppender#log4j.appender.FILE.File=${catalina.home}/mybatisDemo.file.log#log4j.appender.FILE.Append=false#log4j.appender.FILE.layout=org.apache.log4j.PatternLayout#log4j.appender.CONSOLE.layout.ConversionPattern=[%-5p][%d{yyyy-MM-dd HH\:mm\:ss,SSS}][%c] \:%m%n##log4j.appender.CONSOLE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n\u00A0##################### ## Socket Appender ##################### #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########################## SMTP Appender #########################log4j.appender.MAIL=org.apache.log4j.net.SMTPAppender#log4j.appender.MAIL.Threshold=FATAL#log4j.appender.MAIL.BufferSize=10#log4j.appender.MAIL.From=[e-mail]#log4j.appender.MAIL.SMTPHost=mail.openwolf.com#log4j.appender.MAIL.Subject=Log4J Message#log4j.appender.MAIL.To=[e-mail]#log4j.appender.MAIL.layout=org.apache.log4j.PatternLayout#log4j.appender.MAIL.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n######################### ## JDBC Appender ######################## #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#################### ### myself 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

参照3：log4j.xml形式的日志

<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE log4j:configuration PUBLIC "-//APACHE//DTD LOG4J 1.2//EN"     "http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/xml/doc-files/log4j.dtd" ><log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/"    threshold="debug" debug="true">    <!-- 控制台 -->    <appender name="console.CONSOLE" class="org.apache.log4j.ConsoleAppender">        <param name="threshold" value="debug" />        <layout class="org.apache.log4j.PatternLayout">            <param name="ConversionPattern" value="[%-5p][%d{yyyy-MM-dd HH:mm:ss,SSS}][%c] :%m%n" />        </layout>    </appender>    <!-- 系统应用级别日志 -->    <appender name="file.text.SYS.APP.FILE" class="org.apache.log4j.RollingFileAppender">        <param name="threshold" value="error" />        <param name="file" value="${catalina.home}/mybatislogs/mybatis_demo.sys.log" />        <param name="maxFileSize" value="1M" />        <param name="maxBackupIndex" value="5" />        <param name="append" value="true" />        <layout class="org.apache.log4j.PatternLayout">            <param name="ConversionPattern" value="[%-5p][%d{yyyy-MM-dd HH:mm:ss,SSS}][%c] :%m%n" />        </layout>    </appender>    <!-- 每天的日志 -->    <appender name="file.text.DATE.FILE" class="org.apache.log4j.DailyRollingFileAppender">        <param name="threshold" value="debug" />        <param name="file" value="${catalina.home}/mybatislogs/mybatis_demo.date.log" />        <param name="append" value="true" />        <param name="datePattern" value="'.'yyy-MM-dd" />        <!-- <param name="datePattern" value="'.'yyy-MM-dd-HH"/> -->        <layout class="org.apache.log4j.PatternLayout">            <param name="ConversionPattern" value="[%-5p][%d{yyyy-MM-dd HH:mm:ss,SSS}][%c] :%m%n" />        </layout>    </appender>    <!-- HTML形式的错误日志 -->    <appender name="file.html.HTML" class="org.apache.log4j.RollingFileAppender">        <param name="threshold" value="error" />        <param name="file" value="${catalina.home}/mybatislogs/mybatis_demo.log.html" />        <param name="maxFileSize" value="1M" />        <param name="maxBackupIndex" value="5" />        <param name="append" value="true" />        <layout class="org.apache.log4j.HTMLLayout" />    </appender>    <!-- XML形式错误日志 -->    <appender name="file.xml.XML" class="org.apache.log4j.RollingFileAppender">        <param name="threshold" value="error" />        <param name="file" value="${catalina.home}/mybatislogs/mybatis_demo.log.xml" />        <param name="maxFileSize" value="1M" />        <param name="maxBackupIndex" value="5" />        <param name="append" value="true" />        <layout class="org.apache.log4j.xml.XMLLayout" />    </appender>    <!-- 邮件日志 -->    <appender name="mail.MAIL" class="org.apache.log4j.net.SMTPAppender">        <param name="threshold" value="debug" />        <param name="BufferSize" value="10" />        <param name="From" value="[e-mail]" />        <param name="SMTPHost" value="www.baidu.com" />        <param name="Subject" value="openwolf-log4j-Message" />        <param name="To" value="[e-mail]" />        <layout class="org.apache.log4j.PatternLayout">            <param name="ConversionPattern" value="[%-5p][%d{yyyy-MM-dd HH:mm:ss,SSS}][%c] :%m%n" />        </layout>    </appender>    <!-- SOCKET日志 -->    <appender name="remote.CHAINSAW" class="org.apache.log4j.net.SocketAppender">        <param name="threshold" value="fatal" />        <param name="remoteHost" value="localhost" />        <param name="port" value="18845" />        <param name="locationInfo" value="true" />    </appender>    <category name="com.chess" additivity="true">        <priority value="info" />        <appender-ref ref="console.CONSOLE" />    </category>    <category name="com.co" additivity="true">        <priority value="debug" />        <appender-ref ref="console.CONSOLE" />        <appender-ref ref="file.text.DATE.FILE" />    </category>    <category name="org" additivity="true">        <priority value="warn" />        <appender-ref ref="console.CONSOLE" />        <!-- <appender-ref ref="file.text.DATE_FILE"/> -->    </category>    <root>        <!-- <level value="trace" /> <level value="debug" /> <level value="info"             /> <level value="warn" /> <level value="error" /> <level value="fatal" /> -->        <appender-ref ref="console.CONSOLE" />        <appender-ref ref="file.text.DATE.FILE" />    </root></log4j:configuration>