log4j

  基本用法:  

  日志记录的重要性不多说,先给出依赖:

<!-- log begin -->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.6</version>
</dependency>
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-log4j12</artifactId>
    <version>1.7.6</version>
</dependency>
<!-- log end -->

接着是重要的log4j.properties中各个参数的含义和可以设置的值:

### define rootLogger ###
log4j.rootLogger = debug,stdout,D,haha

### output to console ###
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

### output log from level DEBUG to E://logs/log.html ###
log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
log4j.appender.D.File = E://logs/log.html
log4j.appender.D.Append = true
log4j.appender.D.Threshold = DEBUG
log4j.appender.D.layout = org.apache.log4j.HTMLLayout
log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

### output log from level ERROR to E://logs/error.log ###
log4j.appender.haha = org.apache.log4j.DailyRollingFileAppender
log4j.appender.haha.File =E://logs/error.log 
log4j.appender.haha.Append = true
log4j.appender.haha.Threshold = ERROR
log4j.appender.haha.layout = org.apache.log4j.PatternLayout
log4j.appender.haha.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

即便没有很清楚所有参数的含义,但根据配置文件的描述也不难理解,它的级别,输出日志的文件这两个信息。

那么有了配置文件,如何用java代码来进行日志的记录呢?

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Hello world!
 *
 */
public class App {

    private static Logger log = LoggerFactory.getLogger(App.class);

    public static void main(String[] args) {

        log.debug("This is debug message");
        log.error("This is error message");
        log.info("This is info message");
    }
}

看看输出效果:

== console ==
[DEBUG] 2016-08-29 14:17:38,615 method:com.changjiang.test.TestLog.App.main(App.java:16)
This is debug message
[ERROR] 2016-08-29 14:17:38,617 method:com.changjiang.test.TestLog.App.main(App.java:17)
This is error message
[INFO ] 2016-08-29 14:17:38,618 method:com.changjiang.test.TestLog.App.main(App.java:18)
This is info message

== E:logserror.log ==
2016-08-29 14:17:38  [ main:2 ] - [ ERROR ]  This is error message

== E:logslog.html ==
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>Log4J Log Messages</title>
<style type="text/css">
<!--
body, table {font-family: arial,sans-serif; font-size: x-small;}
th {background: #336699; color: #FFFFFF; text-align: left;}
-->
</style>
</head>
<body bgcolor="#FFFFFF" topmargin="6" leftmargin="6">
<hr size="1" noshade>
Log session start time Mon Aug 29 14:17:38 CST 2016<br>
<br>
<table cellspacing="0" cellpadding="4" border="1" bordercolor="#224466" width="100%">
<tr>
<th>Time</th>
<th>Thread</th>
<th>Level</th>
<th>Category</th>
<th>Message</th>
</tr>

<tr>
<td>0</td>
<td title="main thread">main</td>
<td title="Level"><font color="#339933">DEBUG</font></td>
<td title="com.changjiang.test.TestLog.App category">com.changjiang.test.TestLog.App</td>
<td title="Message">This is debug message</td>
</tr>

<tr>
<td>2</td>
<td title="main thread">main</td>
<td title="Level"><font color="#993300"><strong>ERROR</strong></font></td>
<td title="com.changjiang.test.TestLog.App category">com.changjiang.test.TestLog.App</td>
<td title="Message">This is error message</td>
</tr>

<tr>
<td>3</td>
<td title="main thread">main</td>
<td title="Level">INFO</td>
<td title="com.changjiang.test.TestLog.App category">com.changjiang.test.TestLog.App</td>
<td title="Message">This is info message</td>
</tr>

========================>

  接下来我们细细分解log4j.properties中每一项的具体含义以及它们可以取到的值。

  配置根logger:

example: log4j.rootLogger = debug,stdout,D,haha
<==> grammar: log4j.rootLogger
= [level],appenderName1,appenderName2,...

level : 是日志记录的优先级,分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定义的级别。Log4j建议只使用四个级别,优 先级从高到低分别是ERROR、WARN、INFO、DEBUG。通过在这里定义的级别,可以控制到应用程序中相应级别的日志信息的开关。比如在这里定 义了INFO级别,则应用程序中所有DEBUG级别的日志信息将不被打印出来。appenderName:就是指定日志信息输出到哪个地方。我们可以同时指定多个输出目的地。像在本实例中,我们指定了level=debug,也就是debug级别以下的日志就不会打印出来,而之后我们定义了三个输出地点,stdout,D,haha(只是取个名字到方便后面使用,实际上约定的stdout就是控制台标准输出,D指代DEBUG,E指代ERROR,这样的配置可读性较高)

接下来就要配置细节:

输出目的地Appender的详细信息,语法如下:

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

appender可选的值有:

org.apache.log4j.ConsoleAppender(控制台),  
org.apache.log4j.FileAppender(文件),  
org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件),  
org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件),  
org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)

输出布局的格式,语法如下:

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

layout可选的值有:

org.apache.log4j.HTMLLayout(以HTML表格形式布局),  
org.apache.log4j.PatternLayout(可以灵活地指定布局模式),  
org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串),  
org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息)

日志内容详细参数:

%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日 221028921  
%l 输出日志事件的发生位置,包括类目名、发生的线程,以及在代码中的行数。举例:Testlog4.main(TestLog4.java:10)

========================>

  相比较于普通的java日志,web工程的日志记录要复杂一些。但原理实际上是一致的,需要的话,可以讲日志放进自己想放入的文件中,但是,在linux环境下,需要注意权限是否足够,避免因权限不足而导致新建日志文件失败的情况。

  另外,这部分日志如果想要与其它的日志放到一起,还必须对其进行初始化。

举个例子,用来启动log4jConfigLocation的servlet

    /**
     * @see Servlet#init(ServletConfig)
     */
    public void init(ServletConfig config) throws ServletException {
        log4jInit.info("Log4JInitServlet 正在初始化 log4j日志设置信息");
        String log4jLocation = config.getInitParameter("log4j-properties-location");
        ServletContext sc = config.getServletContext();
        if (log4jLocation == null) {
            log4jInit.error("*** 没有 log4j-properties-location 初始化的文件, 所以使用 BasicConfigurator初始化");
            BasicConfigurator.configure();
        } else {
            String webAppPath = sc.getRealPath("/");
            String log4jProp = webAppPath + log4jLocation;
            File yoMamaYesThisSaysYoMama = new File(log4jProp);
            if (yoMamaYesThisSaysYoMama.exists()) {
                log4jInit.info("使用: " + log4jProp + "初始化日志设置信息");
                PropertyConfigurator.configure(log4jProp);
            } else {
                log4jInit.error("*** " + log4jProp + " 文件没有找到, 所以使用 BasicConfigurator初始化");
                BasicConfigurator.configure();
            }
        }
        super.init(config);
    }

对应地,web.xml应如下设置,可以保证启动web容器时就对该servlet进行初始化(servlet生命周期):

    <servlet>
        <servlet-name>Log4JInitServlet</servlet-name>
        <servlet-class>com.changjiang.test.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>
        <servlet-name>Log4JTestServlet</servlet-name>
        <servlet-class>com.changjiang.test.Log4JTestServlet</servlet-class>
    </servlet>
    <servlet-mapping>
        <servlet-name>Log4JInitServlet</servlet-name>
        <url-pattern>/Log4JInitServlet</url-pattern>
    </servlet-mapping>
    <servlet-mapping>
        <servlet-name>Log4JTestServlet</servlet-name>
        <url-pattern>/Log4JTestServlet</url-pattern>
    </servlet-mapping>

调用到该方法时,可以在方法中设置日志,与普通Java没有区别:

    /**
     * @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse
     *      response)
     */
    protected void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        // TODO Auto-generated method stub
        log4jTest.debug("web debug");
        log4jTest.info("web info");
        log4jTest.error("web error");
    }

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

最终的输出文件或者目的地由log4j.properties中设置的信息决定。

========================>

接下来,再看spring-web中利用spring的容器加载对log进行启动:

先加载spring依赖,配置好applicationContext.xml与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>Archetype Created Web Application</display-name>
    <servlet>
        <servlet-name>test</servlet-name>
        <servlet-class>com.changjiang.test.Log4JTestServlet</servlet-class>
    </servlet>
    <servlet-mapping>
        <servlet-name>test</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>

这样就可以在war包加载时对日志进行初始化。

原文地址:https://www.cnblogs.com/bruceChan0018/p/5817976.html