Java日志模块

1.简介

1.1.背景

在应用程序中添加日志记录总的来说基于三个目的

  1. 12bet,监视代码中变量的变化情况,周期性的记录到文件中供其他应用进行统计分析工作;
  2. 跟踪代码运行时轨迹,作为日后审计的依据;
  3. 12bet,担当集成开发环境中的调试器的作用,12bet,向文件或控制台打印代码的调试信息。

12bet,最普通的做法就是在代码中嵌入许多的打印语句,这些打印语句可以输出到控制台或文件中,比较好的做法就是构造一个日志操作类 来封装此类操作,12bet,而不是让一系列的打印语句充斥了代码的主体。

1.2.log4j介绍

类图:

  • Logger – 日志写出器,供程序员输出日志信息
  • Appender – 日志目的地,把格式化好的日志信息输出到指定的地方去
    • ConsoleAppender – 目的地为控制台的Appender
    • FileAppender – 目的地为文件的Appender
    • RollingFileAppender – 目的地为大小受限的文件的Appender
  • Layout – 日志格式化器,用来把程序员的logging request格式化成字符串
    • PatternLayout – 用指定的pattern格式化logging request的Layout

1.3.slf4j介绍

slf4j是java的简单日志外观,它提供我们一个一致的API来使用不同的日志框架,比如: java.util.logging,logback,log4j等。

12博网址,使用slf4j,只有一个强制性的依赖,就是slf4j-api-x.x.x.jar,我们在编写代码的时候,只会使用这个jar包里的API,应用程序在运行时去类路径下查找绑定的具体日志框架,12博网址,并使用该绑定的日志框架进行实际的日志操作,如果在应用程序的类路径下面没有找到合适的绑定的话,slf4j默认使用一个没有任何操作的实现。

1.4.在maven中使用slf4j+log4j

<dependency>  
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-log4j12</artifactId>
    <version>1.7.7</version>
</dependency>  

实际用到的包有:

slf4j-api.jar
slf4j-log4j12.jar
log4j.jar

2.配置log4j.properties

2.1.新增配置文件

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

下面我们介绍Maven工程下使用 Java 特性文件做为配置文件的方法(src/main/resources下新建log4j.properties文件)。

2.2.配置根logger

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

其中, level 是日志记录的优先级,分为 OFFFATALERRORWARNINFODEBUGALL 或者您定义的级别。

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

2.3.配置日志输出appender

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

其中fully.qualified.name.of.appender.class可以是以下几种:

  • org.apache.log4j.ConsoleAppender(控制台),
  • org.apache.log4j.FileAppender(文件)
  • org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件)
  • org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件)
  • 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: 每周滚动一次文件 ,即每周产生一个新的文件。当然也可以指定按月、周、天、时和分。即对应的格式如下:
    • ‘.’yyyy-MM: 每月
    • ‘.’yyyy-ww: 每周
    • ‘.’yyyy-MM-dd: 每天
    • ‘.’yyyy-MM-dd-a: 每天两次
    • ‘.’yyyy-MM-dd-HH: 每小时
    • ‘.’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: 指定可以产生的滚动文件的最大数。

2.4.配置日志信息格式

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

其中fully.qualified.name.of.layout.class 可以是以下几种:

  • org.apache.log4j.HTMLLayout(以 HTML 表格形式布局)
  • org.apache.log4j.PatternLayout(可以灵活地指定布局模式)
  • org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串)
  • 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 采用类似 C 语言中的 printf 函数的打印格式格式化日志信息,打印参数如下:

  • %m 输出代码中指定的消息
  • %p 输出优先级,即 DEBUGINFOWARNERRORFATAL
  • %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
  • %l 输出日志事件的发生位置,包括类目名、发生的线程,以及在代码中的行数。

2.5.配置日志的相对路径

例如:

log4j.appender.logfile.File=${ProjectRoot}/logs/app.log  

其中${ProjectRoot}是变量,会被System Property中的ProjectRoot的值代替。这样我们可以在log4j加载配置文件之前,先使用System.setProperty ("ProjectRoot", ProjectRoot);设置好根路径,此操作可以在初始化servlet时进行。

具体方法如下:

1.新建初始化类:

package sys.init;
import https://www.liuwanlin.info/files/javax.servlet.http.httpservlet;
/**
 * 初始化系统变量
 */
@SuppressWarnings("serial")
public class SysPropsServlet extends HttpServlet {
    public void init() {
        //系统根目录
        System.setProperty("ProjectRoot", this.getServletContext().getRealPath("/"));
    }
}

设置的ProjectRoot为项目根目录。

2.配置web.xml

<!-- 初始化系统变量 -->  
<servlet>  
    <servlet-name>System Properties Initial</servlet-name>
    <servlet-class>sys.init.SysPropsServlet</servlet-class>
    <load-on-startup>0</load-on-startup><!-- 0表示启动时立即加载 -->
</servlet>  

3.使用变量:
如本小节开头所示。

3.代码中使用Log4j

3.1.得到记录器

Logger logger = LoggerFactory.getLogger(HelloWorld.class);  

以上方法通过当前类名获取logger

Logger logger = LoggerFactory.getLogger("accessLog");  

以上方法通过appender的名称获取记录器。

第一种方法不指定特定的记录器,一般可以在调试时使用,实际开发过程中有必要的话可以在每个类中都使定义private static logger

第二种方法只是将记录插入到特定的记录器,此方法更适合于记录一些有用的信息,例如web工程中用户的访问信息的记录。

3.2.插入记录信息

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

3.3.示例

输出为文本文件或 HTML 文件

# 设置级别:   
log4j.rootLogger=debug,appender1  
log4j.appender.appender1=org.apache.log4j.FileAppender  
# 设置文件输出路径   
log4j.appender.appender1.File=c:/Log4JDemo02.html  
# 设置文件输出样式   
log4j.appender.appender1.layout=org.apac he.log4j.HTMLLayout  

输出为文本文件或HTML 文件

# 设置级别和多个目的地   
log4j.rootLogger=debug,appender1,appender2  
# 输出到控制台   
log4j.appender.appender1=org.apache.log4j.ConsoleAppender  
log4j.appender.appender1.layout=org.apache.log4j.TTCCLayout  
# 输出到文件 ( 这里默认为追加方式 )  
log4j.appender.appender2=org.apache.log4j.FileAppender  
log4j.appender.appender2.File=c:/Log4JDemo02.html  
log4j.appender.appender2.layout=org.apache.log4j.HTMLLayout  

使用样式

# 设置级别和目的地   
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.rootLogger=debug,appender1,appender2  
# 输出到控制台   
log4j.appender.appender1=org.apache.log4j.ConsoleAppender  
# 设置输出样式   
log4j.appender.appender1.layout=org.apache.log4j.PatternLayout  
log4j.appender.appender1.layout.ConversionPattern=[%d{yy/MM/dd HH:mm:ss:SSS}][%C-%M] %m%n  
# 输出到文件 ( 这里默认为追加方式 )  
log4j.appender.appender2=org.apache.log4j.FileAppender  
# 设置文件输出路径   
log4j.appender.appender2.File=c:/Log4JDemo06.log  
# 设置文件输出样式   
log4j.appender.appender2.layout=org.apache.log4j.PatternLayout  
log4j.appender.appender2.layout.ConversionPattern=[%d{HH:mm:ss:SSS}][%C-%M] -%m%n  

特定包的级别和目的地

log4j.logger.com.coderdream.log4j =debug,appender1  
log4j.logger.com.coderdream.log4jDao =info,appender1,appender2  
# 输出到控制台   
log4j.appender.appender1=org.apache.log4j.ConsoleAppender  
log4j.appender.appender1.layout=org.apache.log4j.PatternLayout  
log4j.appender.appender1.layout.ConversionPattern =[%d{yy/MM/dd HH:mm:ss:SSS}][%C-%M] %m%n  
# 输出到文件 ( 这里默认为追加方式 )  
log4j.appender.appender2=org.apache.log4j.FileAppender  
log4j.appender.appender2.File=c:/Log4JDemo07_Dao.log  
 log4j.appender.appender2.layout=org.apache.log4j.PatternLayout  
log4j.appender.appender2.layout.ConversionPattern=[%d{HH:mm:ss:SSS}][%C-%M] -%m%n  
Author image
关于 superlin
Beijing, CN 主页
The reason why a great man is great is that he resolves to be a great man.
 
 
默认颜色 边栏居左 边栏居右