Log4j全面配置（经典）

来源：互联网发布：esb 数据交换平台编辑：程序博客网时间：2024/06/05 09:37

　　在实际编程时，要使Log4j真正在系统中运行事先还要对配置文件进行定义。定义步骤就是对Logger、Appender及Layout的分别使用。 Log4j支持两种配置文件格式，一种是XML格式的文件，一种是java properties（key=value）【Java特性文件（键=值）】。下面我们介绍使用Java特性文件做为配置文件的方法，具体如下：　　　　1、配置根Logger，其语法为：

　　log4j.rootLogger = [ level ] , appenderName1, appenderName2, …

　　level : 是日志记录的优先级，分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定义的级别。Log4j建议只使用四个级别，优先级从高到低分别是ERROR、WARN、INFO、DEBUG。

　　通过在这里定义的级别，您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定义了INFO级别，则应用程序中所有DEBUG级别的日志信息将不被打印出来。　　

　　appenderName:就是指定日志信息输出到哪个地方。您可以同时指定多个输出目的地。

例如：log4j.rootLogger＝info,A1,B2,C3 　　　　

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

　　log4j.appender.appenderName = fully.qualified.name.of.appender.class

　　"fully.qualified.name.of.appender.class" 可以指定下面五个目的地中的一个：

　　　　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文件。

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:指定可以产生的滚动文件的最大数。

实际应用：

log4j.appender.A1=org.apache.log4j.ConsoleAppender //这里指定了日志输出的第一个位置A1是控制台ConsoleAppender 　　　　

3、配置日志信息的格式，其语法为：

　　A.log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class

"fully.qualified.name.of.layout.class" 可以指定下面4个格式中的一个：

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

B. log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ssS} %c %m%n

这里需要说明的就是日志信息格式中几个符号所代表的含义：

　　－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"输出日志信息换行

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

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

根据上面的日志格式，某一个程序的输出结果如下：

0　　INFO　2003-06-13 13:23:46968 ClientWithLog4j Client socket: Socket[addr=localhost/127.0.0.1,port=8002,localport=2014]

16　 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j Server says: 'Java server with log4j, Fri Jun 13 13:23:46 CST 2003'

16　 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j GOOD

16　 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j Server responds: 'Command 'HELLO' not understood.'

16　 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j HELP

16　 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j Server responds: 'Vocabulary: HELP QUIT'

16　 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j QUIT

4. # 当输出信息于回滚文件时

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

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 　　

附：Log4j比较全面的配置

LOG4J的配置之简单使它遍及于越来越多的应用中了：Log4J配置文件实现了输出到控制台、文件、回滚文件、发送日志邮件、输出到数据库日志表、自定义标签等全套功能。择其一二使用就够用了.

log4j.rootLogger=DEBUG,CONSOLE#DEBUG,CONSOLE,FILE,ROLLING_FILE,MAIL,DATABASE#################### Console Appender###################log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppenderlog4j.appender.Threshold=DEBUGlog4j.appender.CONSOLE.Target=System.outlog4j.appender.CONSOLE.layout=org.apache.log4j.TTCCLayout#log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout#log4j.appender.CONSOLE.layout.ConversionPattern=%p:%d{yyy-MM-dd HH:mm:ss }[(%C:%L)] - %m%n#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###################### File Appender#####################log4j.appender.FILE=org.apache.log4j.FileAppenderlog4j.appender.FILE.File=file.loglog4j.appender.FILE.Append=falselog4j.appender.FILE.layout=org.apache.log4j.PatternLayoutlog4j.appender.FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n# Use this layout for LogFactor 5 analysis######################### Rolling File########################log4j.appender.ROLLING_FILE=org.apache.log4j.RollingFileAppenderlog4j.appender.ROLLING_FILE.Threshold=ERRORlog4j.appender.ROLLING_FILE.File=rolling.loglog4j.appender.ROLLING_FILE.Append=truelog4j.appender.ROLLING_FILE.MaxFileSize=10KBlog4j.appender.ROLLING_FILE.MaxBackupIndex=1log4j.appender.ROLLING_FILE.layout=org.apache.log4j.PatternLayoutlog4j.appender.ROLLING_FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n##################### Socket Appender####################log4j.appender.SOCKET=org.apache.log4j.RollingFileAppenderlog4j.appender.SOCKET.RemoteHost=localhostlog4j.appender.SOCKET.Port=5001log4j.appender.SOCKET.LocationInfo=true# Set up for Log Facter 5log4j.appender.SOCKET.layout=org.apache.log4j.PatternLayoutlog4j.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.LF5Appenderlog4j.appender.LF5_APPENDER.MaxNumberOfRecords=2000######################### SMTP Appender#######################log4j.appender.MAIL=org.apache.log4j.net.SMTPAppenderlog4j.appender.MAIL.Threshold=FATALlog4j.appender.MAIL.BufferSize=10log4j.appender.MAIL.From=chenyl@hollycrm.comlog4j.appender.MAIL.SMTPHost=mail.hollycrm.comlog4j.appender.MAIL.Subject=Log4J Messagelog4j.appender.MAIL.To=chenyl@hollycrm.comlog4j.appender.MAIL.layout=org.apache.log4j.PatternLayoutlog4j.appender.MAIL.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n######################### JDBC Appender#######################log4j.appender.DATABASE=org.apache.log4j.jdbc.JDBCAppenderlog4j.appender.DATABASE.URL=jdbc:mysql://localhost:3306/testlog4j.appender.DATABASE.driver=com.mysql.jdbc.Driverlog4j.appender.DATABASE.user=rootlog4j.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.PatternLayoutlog4j.appender.DATABASE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%nlog4j.appender.A1=org.apache.log4j.DailyRollingFileAppenderlog4j.appender.A1.File=SampleMessages.log4jlog4j.appender.A1.DatePattern=yyyyMMdd-HH'.log4j'log4j.appender.A1.layout=org.apache.log4j.xml.XMLLayout####################自定义Appender###################log4j.appender.im = net.cybercorlin.util.logger.appender.IMAppenderlog4j.appender.im.host = mail.cybercorlin.netlog4j.appender.im.username = usernamelog4j.appender.im.password = passwordlog4j.appender.im.recipient = corlin@cybercorlin.netlog4j.appender.im.layout=org.apache.log4j.PatternLayoutlog4j.appender.im.layout.ConversionPattern =[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n

自己补充一下log4j的加载方式:

方式一:通过Listener加载

import java.io.IOException;import java.io.InputStream;import java.util.Properties;import javax.servlet.ServletContext;import javax.servlet.ServletContextEvent;import javax.servlet.ServletContextListener;import org.apache.log4j.PropertyConfigurator;public class ApplicationListener implements ServletContextListener {public void contextDestroyed(ServletContextEvent arg0) {}public void contextInitialized(ServletContextEvent event) {ServletContext servletContext = event.getServletContext();// 获得Log4j的配置文件路径,propertiesUtilsLocation需在web.xml中配制String propertiesUtilsLocation = servletContext.getInitParameter("propertiesUtilsLocation");// PropertiesUtils.configuration(servletContext.getRealPath(propertiesUtilsLocation));InputStream is = servletContext.getResourceAsStream(propertiesUtilsLocation);Properties props = new Properties();try {props.load(is);System.out.println("Start Load log4j configuration ... ");} catch (IOException e) {System.err.println("Load log4j configuration failed");}PropertyConfigurator.configure(props);}}

方式二:通过servlet加载

import java.io.IOException;import java.io.InputStream;import java.util.Properties;import javax.servlet.ServletConfig;import javax.servlet.ServletContext;import javax.servlet.ServletException;import javax.servlet.http.HttpServlet;public class LoadLog4jServlet extends HttpServlet {private static final long serialVersionUID = 1L;@Overridepublic void init(ServletConfig config) throws ServletException {ServletContext sc = config.getServletContext();String properties_file_path = sc.getInitParameter("propertiesUtilsLocation");Properties pro=new Properties();try {InputStream is=sc.getResourceAsStream(properties_file_path);pro.load(is);System.out.println("startting loading log4j.properties config file...");} catch (IOException e) {System.out.println("loading log4j.properties config file throw a exception!");e.printStackTrace();}org.apache.log4j.PropertyConfigurator.configure(pro);}}

web.xml配置

<?xml version="1.0" encoding="UTF-8"?><web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"><context-param><param-name>propertiesUtilsLocation</param-name><param-value>/WEB-INF/log4j.properties</param-value></context-param><!-- 用于加载log4j 的监听器 --><!--<listener>--><!--<listener-class>--><!--listener.ApplicationListener--><!--</listener-class>--><!--</listener>--><!-- 用于加载log4j 的servlet --><servlet><servlet-name>load-log4j</servlet-name><servlet-class>servlet.LoadLog4jServlet</servlet-class><load-on-startup>1</load-on-startup></servlet> </web-app>

现在我们可以在JAVA源码中使用Log4j了

import org.apache.log4j.Logger;public class Service {static Logger log = Logger.getLogger(helloworld.Service.class);public String sayHello(String yourName) {log.debug("测试log4j");return "Hello World " + yourName;}}