Log4j

基本使用方法

Log4j由三个重要的组件构成:

  • 日志信息的优先级。从高到低有ERROR、WARN、 INFO、DEBUG,分别用来指定这条日志信息的重要程度;
  • 日志信息的输出目的地。指定了日志将打印到控制台、文件或数据库;
  • 日志信息的输出格式。控制了日志信息的显示内容;

配置文件

Log4j支持两种配置文件格式,一种是XML格式的文件,一种是Java特性文件(键=值)。

Java特性文件

根Logger

语法为:

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

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

输出目的地Appender

语法为:

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

其中,Log4j提供的appender有以下几种:

  • org.apache.log4j.ConsoleAppender(控制台)
    • 选项:
    • Threshold=WARN:指定日志信息的最低输出级别,默认为DEBUG。
    • ImmediateFlush=true:表示所有消息都会被立即输出,设为false则不输出,默认值是true。
    • Target=System.err:默认值是System.out。
  • org.apache.log4j.FileAppender(文件)
    • 选项:
    • Threshold=WARN:指定日志信息的最低输出级别,默认为DEBUG。
    • ImmediateFlush=true:表示所有消息都会被立即输出,设为false则不输出,默认值是true。
    • Append=false:true表示消息增加到指定文件中,false则将消息覆盖指定的文件内容,默认值是true。
    • File=D:/logs/logging.log4j:指定消息输出到logging.log4j文件中。
  • org.apache.log4j.DailyRollingFileAppender(周期性产生一个日志文件)
    • 选项:
    • Threshold=WARN:指定日志信息的最低输出级别,默认为DEBUG。
    • ImmediateFlush=true:表示所有消息都会被立即输出,设为false则不输出,默认值是true。
    • Append=false:true表示消息增加到指定文件中,false则将消息覆盖指定的文件内容,默认值是true。
    • File=D:/logs/logging.log4j:指定当前消息输出到logging.log4j文件中。
    • DatePattern='.'yyyy-MM:每月滚动一次日志文件,即每月产生一个新的日志文件。当前月的日志文件名为logging.log4j,前一个月的日志文件名为logging.log4j.yyyy-MM。另外,也可以指定按周、天、时、分等来滚动日志文件,对应的格式如下:
      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:每分钟
  • org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件)
    • 选项:
    • Threshold=WARN:指定日志信息的最低输出级别,默认为DEBUG。
    • ImmediateFlush=true:表示所有消息都会被立即输出,设为false则不输出,默认值是true。
    • Append=false:true表示消息增加到指定文件中,false则将消息覆盖指定的文件内容,默认值是true。
    • File=D:/logs/logging.log4j:指定消息输出到logging.log4j文件中。
    • MaxFileSize=100KB:后缀可以是KB, MB 或者GB。在日志文件到达该大小时,将会自动滚动,即将原来的内容移到logging.log4j.1文件中。
    • MaxBackupIndex=2:指定可以产生的滚动文件的最大数,例如,设为2则可以产生logging.log4j.1,logging.log4j.2两个滚动文件和一个logging.log4j文件。
  • org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)
信息的格式(布局)

语法为:

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

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

  • org.apache.log4j.HTMLLayout(以HTML表格形式布局)
    • 选项:
    • LocationInfo=true:输出Java文件名称和行号,默认值是false。
    • Title=My Logging: 默认值是Log4J Log Messages。
  • org.apache.log4j.PatternLayout(可以灵活地指定布局模式)
    • 选项:
    • ConversionPattern=%m%n:设定以怎样的格式显示消息。
  • org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串)
  • org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息)

Log4j 采用类似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
  • %M: 输出产生日志信息的方法名。
  • %F: 输出日志消息产生时所在的文件名称。
  • %L: 输出代码中的行号。
  • %l: 输出日志事件的发生位置,相当于%c.%M(%F:%L)的组合,包括类全名、方法、文件名以及在代码中的行数。
  • %x: 输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像Java servlets这样的多客户多线程的应用中。
  • %%: 输出一个"%"字符。

另外,还可以在 % 与格式字符之间加上修饰符来控制其最小长度、最大长度、和文本的对齐方式。如:

  1. c: 指定输出category的名称,最小的长度是20,如果category的名称长度小于20的话,默认的情况下右对齐。
  2. %-20c: "-"号表示左对齐。
  3. %.30c: 指定输出category的名称,最大的长度是30,如果category的名称长度大于30的话,就会将左边多出的字符截掉,但小于30的话也不会补空格。

较完整的配置示例

Log4j配置文件实现了输出到控制台、文件、回滚文件、发送日志邮件、输出到数据库日志表、自定义标签等全套功能。

配置根
log4j.rootLogger=DEBUG,console,dailyFile,im
log4j.additivity.org.apache=true
控制台(console)
log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.Threshold=DEBUG
log4j.appender.console.ImmediateFlush=true
log4j.appender.console.Target=System.err
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
日志文件(logFile)
log4j.appender.logFile=org.apache.log4j.FileAppender
log4j.appender.logFile.Threshold=DEBUG
log4j.appender.logFile.ImmediateFlush=true
log4j.appender.logFile.Append=true
log4j.appender.logFile.File=D:/logs/log.log4j
log4j.appender.logFile.layout=org.apache.log4j.PatternLayout
log4j.appender.logFile.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
回滚文件(rollingFile)
log4j.appender.rollingFile=org.apache.log4j.RollingFileAppender
log4j.appender.rollingFile.Threshold=DEBUG
log4j.appender.rollingFile.ImmediateFlush=true
log4j.appender.rollingFile.Append=true
log4j.appender.rollingFile.File=D:/logs/log.log4j
log4j.appender.rollingFile.MaxFileSize=200KB
log4j.appender.rollingFile.MaxBackupIndex=50
log4j.appender.rollingFile.layout=org.apache.log4j.PatternLayout
log4j.appender.rollingFile.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
定期回滚日志文件(dailyFile)
log4j.appender.dailyFile=org.apache.log4j.DailyRollingFileAppender
log4j.appender.dailyFile.Threshold=DEBUG
log4j.appender.dailyFile.ImmediateFlush=true
log4j.appender.dailyFile.Append=true
log4j.appender.dailyFile.File=D:/logs/log.log4j
log4j.appender.dailyFile.DatePattern='.'yyyy-MM-dd
log4j.appender.dailyFile.layout=org.apache.log4j.PatternLayout
log4j.appender.dailyFile.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %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 Factor 5
log4j.appender.socket.layout=org.apache.log4j.PatternLayout
log4j.appender.socket.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %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 = [email protected]
log4j.appender.mail.SMTPHost=mail.com
log4j.appender.mail.Subject=Log4J Message
log4j.appender.mail.To= [email protected]
log4j.appender.mail.layout=org.apache.log4j.PatternLayout
log4j.appender.mail.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %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('=[%-5p] %d(%r) --> [%t] %l: %m %x %n')
log4j.appender.database.layout=org.apache.log4j.PatternLayout
log4j.appender.database.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
自定义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 = [email protected]
log4j.appender.im.layout=org.apache.log4j.PatternLayout
log4j.appender.im.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
不同类不同的日志
## java 以cn.com.Test为例,先要在Test.java中定义:
private static Log logger = LogFactory.getLog(Test.class);

## log4j.properties
log4j.logger.cn.com.Test= DEBUG, test
log4j.appender.test=org.apache.log4j.FileAppender
log4j.appender.test.File=${myweb.root}/WEB-INF/log/test.log
log4j.appender.test.layout=org.apache.log4j.PatternLayout
log4j.appender.test.layout.ConversionPattern=%d %p [%c] - %m%n
同一个类多个日志
## java 以cn.com.Test为例,先要在Test.java中定义:
private static Log logger1 = LogFactory.getLog("myTest1");
private static Log logger2 = LogFactory.getLog("myTest2");

## log4j.properties
log4j.logger.myTest1= DEBUG, test1
log4j.appender.test1=org.apache.log4j.FileAppender
log4j.appender.test1.File=${myweb.root}/WEB-INF/log/test1.log

log4j.logger.myTest2= DEBUG, test2
log4j.appender.test2=org.apache.log4j.FileAppender
log4j.appender.test2.File=${myweb.root}/WEB-INF/log/test2.log

还有一个问题,就是这些自定义的日志默认是同时输出到log4j.rootLogger所配置的日志中的,如何能只让它们输出到自己指定的日志中呢?这里有个开关:

og4j.additivity.myTest1 = false

它用来设置是否同时输出到log4j.rootLogger所配置的日志中,设为false就不会输出到其它地方啦!注意这里的"myTest1"是你在程序中给logger起的那个自定义的名字!

代码中使用 Log4j

得到记录器

使用 Log4j,第一步就是获取日志记录器,这个记录器将负责控制日志信息。其语法为:

public static Logger getLogger( String name )

通过指定的名字获得记录器,如果必要的话,则为这个名字创建一个新的记录器。Name一般取本类的名字,比如:

static Logger logger = Logger.getLogger ( ServerWithLog4j.class.getName () )

读取配置文件

当获得了日志记录器之后,第二步将配置 Log4j 环境,其语法为:

BasicConfigurator.configure ():自动快速地使用缺省 Log4j 环境。  
PropertyConfigurator.configure ( String configFilename) :读取使用Java的特性文件编写的配置文件。  
DOMConfigurator.configure ( String filename ) :读取XML形式的配置文件。

插入记录信息(格式化日志信息)

当上两个必要步骤执行完毕,您就可以轻松地使用不同优先级别的日志记录语句插入到您想记录日志的任何地方,其语法如下:

Logger.debug ( Object message ) ;  
Logger.info ( Object message ) ;  
Logger.warn ( Object message ) ;  
Logger.error ( Object message ) ;

日志级别

每个Logger都有一个日志级别(log level),用来控制日志信息的输出。日志级别从高到低分为:

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

上面这些级别是定义在 org.apache.log4j.Level 类中。Log4j 只建议使用4个级别,优先级从高到低分别是error,warn,info和debug。通过使用日志级别,可以控制应用程序中相应级别日志信息的输出。例如,如果使用了 info 级别,则应用程序中所有低于 info 级别的日志信息(如debug)将不会被打印出来。

Web项目中使用Log4j

在J2EE应用使用 Log4j,必须先在启动服务时加载 Log4j 的配置文件进行初始化,可以在web.xml中进行。

  1. web应用的log4j使用基本上都采用:新建一个 servlet ,这个 servletinit 函数中为 log4j 执行配置。一般就是读入配置文件。所以需要在 web.xml 中为这个 servlet 配置,同时设定 load-on-startup 为 1 ;
  2. 这个 servlet 配置 log4j 就是读出配置文件,然后调用 configure 函数。这里有两个问题:
    1. 需要知道文件在哪里:配置文件位置在 web.xml 中配置一个 param 即可,路径一般是相对于 web 的 root 目录;
    2. 需要正确的文件类型:文件类型一般有两种,一个是 Java 的 property 文件,另一种是 xml 文件;

配置文件的大致内容:log4j 可以指定输出的log级别的最低等级,以及log的输出配置格式,每个log可以指定多个输出方式;

web.xml配置

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://java.sun.com/xml/ns/javaee"
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
    id="WebApp_ID" version="3.0">
    <display-name>LogLearning</display-name>

    <servlet>
        <servlet-name>Log4JTestServlet</servlet-name>
        <servlet-class>com.mucfc.Log4JTestServlet</servlet-class>
    </servlet>

    <!--用来启动 log4jConfigLocation的servlet -->
    <servlet>
        <servlet-name>Log4JInitServlet</servlet-name>
        <servlet-class>com.mucfc.Log4JInitServlet</servlet-class>
        <init-param>
            <param-name>log4j-properties-location</param-name>
            <param-value>/WEB-INF/classes/log4j.properties</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>

    <servlet-mapping>
        <servlet-name>Log4JTestServlet</servlet-name>
        <url-pattern>/test</url-pattern>
    </servlet-mapping>
</web-app>

配置文件log4j.properties

### set log levels ###  
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  

log4j.appender.D = org.apache.log4j.DailyRollingFileAppender  
log4j.appender.D.File = logs/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  

log4j.appender.E = org.apache.log4j.DailyRollingFileAppender  
log4j.appender.E.File = logs/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

初始化的servlet - Log4JInitServlet.java

/** 
 * Servlet implementation class Log4JInitServlet 
 */  
@WebServlet("/Log4JInitServlet")  
public class Log4JInitServlet extends HttpServlet {  
    private static final long serialVersionUID = 1L;  

    /** 
     * @see HttpServlet#HttpServlet() 
     */  
    public Log4JInitServlet() {  
        super();  
        // TODO Auto-generated constructor stub  
    }  

    /** 
     * @see Servlet#init(ServletConfig) 
     */  
    public void init(ServletConfig config) 
        throws ServletException {

        System.out.println("Log4JInitServlet正在初始化log4j日志设置信息");  
        String log4jLocation = config.getInitParameter(
            "log4j-properties-location");  

        ServletContext sc = config.getServletContext();  

        if (log4jLocation == null) {  
            System.err.println("*** 没有log4j-properties-location 
                初始化的文件, 所以使用 BasicConfigurator 初始化");  
            BasicConfigurator.configure();  
        } else {  
            String webAppPath = sc.getRealPath("/");  
            String log4jProp = webAppPath + log4jLocation;  
            File yoMamaYesThisSaysYoMama = new File(log4jProp);  
            if (yoMamaYesThisSaysYoMama.exists()) {  
                System.out.println("使用: " + log4jProp + "初始化日志设置信息");  
                PropertyConfigurator.configure(log4jProp);  
            } else {  
                System.err.println("*** " + log4jProp + " 文件没有找到, 
                    所以使用 BasicConfigurator初始化");  
                BasicConfigurator.configure();  
            }  
        }  
        super.init(config);  
    }  

    /** 
     * @see HttpServlet#doGet(HttpServletRequest request, 
     *    HttpServletResponse response) 
     */  
    protected void doGet(HttpServletRequest request, 
        HttpServletResponse response) 
        throws ServletException, IOException {  
        // TODO Auto-generated method stub  
    }  

    /** 
     * @see HttpServlet#doPost(HttpServletRequest request, 
     *    HttpServletResponse response) 
     */  
    protected void doPost(HttpServletRequest request, 
        HttpServletResponse response) 
        throws ServletException, IOException {  
        // TODO Auto-generated method stub  
    }  

}

调用日志servlet - Log4JTestServlet.java

/** 
 * Servlet implementation class Log4JTestServlet 
 */  
@WebServlet("/Log4JTestServlet")  
public class Log4JTestServlet extends HttpServlet {

    private static final long serialVersionUID = 1L;  
    private static Logger logger = Logger.getLogger(
        Log4JTestServlet.class);    

    /** 
     * @see HttpServlet#HttpServlet() 
     */  
    public Log4JTestServlet() {  
        super();  
        // TODO Auto-generated constructor stub  
    }  

    /** 
     * @see Servlet#init(ServletConfig) 
     */  
    public void init(ServletConfig config) 
        throws ServletException {  
        // TODO Auto-generated method stub  
    }  

    /** 
     * @see HttpServlet#doGet(HttpServletRequest request, 
     *    HttpServletResponse response) 
     */  
    protected void doGet(HttpServletRequest request, 
        HttpServletResponse response) 
        throws ServletException, IOException {  

        // 记录debug级别的信息    
        logger.debug("This is debug message.");    
        // 记录info级别的信息    
        logger.info("This is info message.");    
        // 记录error级别的信息    
        logger.error("This is error message.");    
    }  

    /** 
     * @see HttpServlet#doPost(HttpServletRequest request, 
     *    HttpServletResponse response) 
     */  
    protected void doPost(HttpServletRequest request, 
        HttpServletResponse response) 
        throws ServletException, IOException {  

        doGet(request,response);  
    }  

}

Spring中使用Log4j

web.xml

修改上述项目的 web.xml 文件

<?xml version="1.0" encoding="UTF-8"?>  
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
    xmlns="http://java.sun.com/xml/ns/javaee"  
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"  
    id="WebApp_ID" version="3.0">

    <display-name>LogLearning</display-name>  

    <servlet>  
        <servlet-name>Log4JTestServlet</servlet-name>  
        <servlet-class>com.mucfc.Log4JTestServlet</servlet-class>  
    </servlet>

    <servlet-mapping>  
        <servlet-name>Log4JTestServlet</servlet-name>  
        <url-pattern>/test</url-pattern>  
    </servlet-mapping>   

    <!-- Spring 容器加载 -->  
    <listener>  
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>  
    </listener>  
    <context-param>  
        <param-name>contextConfigLocation</param-name>  
        <param-value>classpath:applicationContext.xml</param-value>  
    </context-param>   

    <!-- 设置根目录 -->  
    <context-param>    
        <param-name>webAppRootKey</param-name>    
        <param-value>webapp.root</param-value>    
    </context-param>    

    <context-param>  
        <param-name>log4jConfigLocation</param-name>  
        <param-value>/WEB-INF/classes/log4j.properties</param-value>  
    </context-param> 

    <!-- 3000表示开一条watchdog线程每60秒扫描一下配置文件的变化;这样便于日志存放位置的改变 -->
    <context-param>    
         <param-name>log4jRefreshInterval</param-name>    
         <param-value>3000</param-value>    
    </context-param>   
    <listener>  
        <listener-class>org.springframework.web.util.Log4jConfigListener</listener-class>  
    </listener>   

</web-app>

applicationContext.xml

文件中不需要配置其他内容

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:context="http://www.springframework.org/schema/context"
    xmlns:aop="http://www.springframework.org/schema/aop"
    xsi:schemaLocation="http://www.springframework.org/schema/beans
    http://www.springframework.org/schema/beans/spring-beans-3.2.xsd
    http://www.springframework.org/schema/aop
    http://www.springframework.org/schema/aop/spring-aop-3.2.xsd
    http://www.springframework.org/schema/context
    http://www.springframework.org/schema/context/spring-context-3.2.xsd">
</beans>

results matching ""

    No results matching ""