日志是应用软件中不可缺少的部分,Apache的开源项目log4j是一个功能强大的日志组件,提供方便的日志记录。本文结合几个简单实例总结log4j在开发中的应用。
普通java工程中使用Log4j
先来个入门示例,跑通了再介绍配置信息,新建一个maven项目,导入jar包依赖:
1
2
3
4
5
|
< dependency > < groupId >log4j</ groupId > < artifactId >log4j</ artifactId > < version >1.2.12</ version > </ dependency > |
系统目录结构如图:
其中,log4j.properties
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
|
# DEBUG,INFO,WARN,ERROR,FATAL LOG_LEVEL=DEBUG log4j.rootLogger = ${LOG_LEVEL},CONSOLE,COMMON,ERROR # ## 输出信息到控制台 ## # log4j.appender.CONSOLE = org.apache.log4j.ConsoleAppender log4j.appender.CONSOLE.Target = System.out log4j.appender.CONSOLE.Encoding=utf-8 log4j.appender.CONSOLE.layout = org.apache.log4j.PatternLayout log4j.appender.CONSOLE.layout.ConversionPattern = [%-5p] %d{yyyy-MM-dd HH:mm:ss,SSS} method:%l%n%m%n # ## 输出${LOG_LEVEL}级别以上的日志到=E://logs/log.log ## # log4j.appender.COMMON = org.apache.log4j.DailyRollingFileAppender log4j.appender.COMMON.File = E://logs/log.log # log4j.appender.COMMON.File = ${catalina.base}/logs/log.log #使用此表示存放在tomcat的logs文件夹下 log4j.appender.COMMON.Encoding=utf-8 log4j.appender.COMMON.Append = true log4j.appender.COMMON.Threshold = ${LOG_LEVEL} log4j.appender.COMMON.layout = org.apache.log4j.PatternLayout log4j.appender.COMMON.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [ %t:%r ] - [ %p ] %m%n # ## 输出ERROR 级别以上的日志到=E://logs/error.log ## # log4j.appender.ERROR = org.apache.log4j.DailyRollingFileAppender log4j.appender.ERROR.File =E://logs/error.log # log4j.appender.ERROR.File = ${catalina.base}/logs/error.log #使用此表示存放在tomcat的logs文件夹下 log4j.appender.ERROR.Encoding=utf-8 log4j.appender.ERROR.Append = true log4j.appender.ERROR.Threshold = ERROR log4j.appender.ERROR.layout = org.apache.log4j.PatternLayout log4j.appender.ERROR.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [ %t:%r ] - [ %p ] %m%n |
测试类:
1
2
3
4
5
6
7
8
9
10
11
12
|
import org.apache.log4j.Logger; <p>/** <em> Created by Hemi on 2017 / 5 / 30 . </em>/ public class LogTest { private static Logger logger = Logger.getLogger(LogTest. class ); public static void main(String[] args){ logger.debug( "this is debug.." ); logger.info( "this is info.." ); logger.error( "错误信息,something wrong!" ); } }</p> |
则控制台有
相应的 E://logs/下也会有相应的日志文件输出。
Log4j的基本使用方法
跑通了接下来详细介绍Log4j的组成。Log4j由三个重要的组件构成:日志信息的优先级,日志信息的输出目的地,日志信息的输出格式。日志信息的优先级从高到低有ERROR、WARN、 INFO、DEBUG,分别用来指定这条日志信息的重要程度;日志信息的输出目的地指定了日志将打印到控制台还是文件中;而输出格式则控制了日志信息的显示内容。
定义配置文件
-
配置根
1log4j.rootLogger = [ level ] , appenderName, appenderName, …
其中,level 是日志记录的优先级,分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定义的级别。Log4j建议只使用四个级别,优 先级从高到低分别是ERROR、WARN、INFO、DEBUG。通过在这里定义的级别,您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定 义了INFO级别,则应用程序中所有DEBUG级别的日志信息将不被打印出来。 appenderName就是指日志信息输出到哪个地方。您可以同时指定多个输出目的地。
-
配置日志信息输出目的地Appender,语法为:
1234log4j.appender.appenderName = fully.qualified.name.of.appender.
class
log4j.appender.appenderName.option1 = value1
…
log4j.appender.appenderName.option = valueN
Log4j提供的appender有以下几种:
12345org.apache.log4j.ConsoleAppender(控制台),
org.apache.log4j.FileAppender(文件),
org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件),
org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件),
org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)
-
配置日志信息的格式(布局),语法为:
1234log4j.appender.appenderName.layout = fully.qualified.name.of.layout.
class
log4j.appender.appenderName.layout.option1 = value1
…
log4j.appender.appenderName.layout.option = valueN
Log4j提供的layout有以下几种:
1234org.apache.log4j.HTMLLayout(以HTML表格形式布局),
org.apache.log4j.PatternLayout(可以灵活地指定布局模式),
org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串),
org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息)
HTMLLayout的使用例子:
1
2
3
4
5
6
7
8
9
|
# Define the file appender log4j.appender.FILE=org.apache.log4j.FileAppender log4j.appender.FILE.File=${catalina.base}/logs/htmlLayout.html log4j.appender.FILE.layout=org.apache.log4j.HTMLLayout # 设置为HTML文件的标题。默认值是Log4j的日志信息 log4j.appender.FILE.layout.Title=HTML Layout Example # 设置位置信息记录事件。默认为 false log4j.appender.FILE.layout.LocationInfo=true |
可以生成如下所示的日志页面
在PatternLayout中,关于输出格式,Log4j采用类似C语言中的printf函数的打印格式格式化日志信息,打印参数如下:
在代码中使用Log4j
-
得到记录器
1private
static
final
Logger logger = Logger.getLogger(LogTest.
class
);
-
读取配置文件
123BasicConfigurator.configure (): 自动快速地使用缺省Log4j环境。
PropertyConfigurator.configure ( String configFilename) :读取使用Java的特性文件编写的配置文件。
DOMConfigurator.configure ( String filename ) :读取XML形式的配置文件。
-
插入记录信息
1234logger.debug ( Object message ) ;
logger.info ( Object message ) ;
logger.warn ( Object message ) ;
logger.error ( Object message ) ;
Web项目中使用Log4j
在Web应用中使用Log4j,必须在启动服务时加载log4j的配置文件进行初始化,可以在web.xml中进行。步骤为:
1、新建一个servlet,这个servlet在init函数中为log4j执行配置。一般就是读入配置文件。所以需要在web.xml中为这个servlet配置,同时设定load-on-startup为1。
2、这个servlet配置log4j就是读出配置文件,然后调用configure函数。这里有两个问题:一、需要知道文件在哪里;二、需要正确的文件类型
3、配置文件位置在web.xml中配置一个param即可,路径一般是相对于web的root目录
4、文件类型一般有两种,一个是Java的property文件,另一种是xml文件
(1)创建Web工程,其最终目录结构如下:
(2)web.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
|
<? 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 >Log4jTest</ display-name > < servlet > < servlet-name >Log4jServlet</ servlet-name > < servlet-class >com.hemi.Log4jServlet</ servlet-class > < init-param > < param-name >log4jConfigLocation</ 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 >Log4jServlet</ servlet-name > < url-pattern >/</ url-pattern > </ servlet-mapping > < servlet > < servlet-name >Log4jTestServlet</ servlet-name > < servlet-class >com.hemi.Log4jTestServlet</ servlet-class > </ servlet > < servlet-mapping > < servlet-name >Log4jTestServlet</ servlet-name > < url-pattern >/test</ url-pattern > </ servlet-mapping > < welcome-file-list > < welcome-file >index.html</ welcome-file > </ welcome-file-list > </ web-app > |
(3)Log4jServlet.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
|
package com.hemi; import org.apache.log4j.BasicConfigurator; import org.apache.log4j.PropertyConfigurator; import javax.servlet.ServletConfig; import javax.servlet.ServletContext; import javax.servlet.ServletException; import javax.servlet.annotation.WebServlet; import javax.servlet.http.HttpServlet; import java.io.File; @WebServlet ( "/Log4jServlet" ) public class Log4jServlet extends HttpServlet { private static final long serialVersionUID = 1L; public Log4jServlet(){ super (); } @Override public void init(ServletConfig config) throws ServletException { System.out.println( "Log4jServlet 正在初始化 log4j日志设置信息" ); String log4jLocation = config.getInitParameter( "log4jConfigLocation" ); ServletContext sc = config.getServletContext(); if (log4jLocation == null ) { System.err.println( "*** 没有 log4jConfigLocation 初始化的文件, 所以使用 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(); } } |
(4)Log4jTestServlet.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
|
package com.hemi; import org.apache.log4j.Logger; import javax.servlet.ServletException; import javax.servlet.annotation.WebServlet; import javax.servlet.http.HttpServlet; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import java.io.IOException; @WebServlet ( "/Log4jTestServlet" ) public class Log4jTestServlet extends HttpServlet { private static final long serialVersionUID = 1L; private static Logger logger = Logger.getLogger(Log4jTestServlet. class ); @Override protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException { logger.debug( "this is debug.." ); logger.info( "this is info.." ); logger.error( "错误信息,something wrong!" ); } @Override protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException { doGet(req, resp); } } |
(5)启动Tomcat,在浏览器地址栏输入 http://localhost:8080/Log4jTest/test 查看控制台输出:
可以看到相应的结果。同时查看本地文件日志输出:
Spring中使用Log4j
在Spring中使用Log4j需要将log4j交给spring托管,在web.xml中做如下配置,此处略去spring的配置
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
|
<!-- 配置log4j配置文件路径 --> < context-param > < param-name >log4jConfigLocation</ param-name > < param-value >classpath:log4j.properties</ param-value > </ context-param > <!-- 60s 检测日志配置 文件变化 --> < context-param > < param-name >log4jRefreshInterval</ param-name > < param-value >60000</ param-value > </ context-param > <!-- 配置Log4j监听器 --> < listener > < listener-class >org.springframework.web.util.Log4jConfigListener</ listener-class > </ listener > |
之后在类中得到记录仪便可使用,不再需要创建Servlet
1
|
private static final Logger logger = Logger.getLogger(LogTest. class ); |