浅谈如何使用Log4j记录日志

时间:2022-06-09 20:28:58

一.什么是log4j

Log4J是Apache的一个开放源代码的项目。通过使用Log4J,程序员可以控制日志信息输送的目的地,包括控制台,文件,GUI组件和NT事件记录器,也可以控制每一条日志的输出格式,或通过定义每一条日志信息的级别,更加细致地控制日志的生成过程。

二.日志及分类

软件的运行过程中离不开日志,日志主要用来记录系统运行过程中的一些重要的操作信息,便于监视系统运行时的情况,帮助用户提前发现和避开可能出现的问题,或者出现问题后根据日志找到发生的原因。

日志根据记录的不同,主要分为三类:

1.SQL日志:记录系统执行的sql语句。

2.异常日志:记录系统运行中发生的异常事件。

3.业务日志:记录系统运行过程,如用户的登录,操作记录。

三.配置文件说明

1、定义配置文件
Log4j支持两种配置文件格式,一种是XML格式的文件,一种是Java特性文件log4j.properties(键=值)。下面将介绍使用log4j.properties文件作为配置文件的方法:
①配置根Logger
Logger 负责处理日志记录的大部分操作。
其语法为:
log4j.rootLogger = [ level ] , appenderName, appenderName, …
其中,level 是日志记录的优先级,分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定义的级别。Log4j建议只使用四个级别,优 先级从高到低分别是ERROR、WARN、INFO、DEBUG。通过在这里定义的级别,您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定 义了INFO级别,只有等于及高于这个级别的才进行处理,则应用程序中所有DEBUG级别的日志信息将不被打印出来。ALL:打印所有的日志,OFF:关 闭所有的日志输出。 appenderName就是指定日志信息输出到哪个地方。可同时指定多个输出目的地。
②配置日志信息输出目的地 Appender
Appender 负责控制日志记录操作的输出。
其语法为:
log4j.appender.appenderName = fully.qualified.name.of.appender.class
log4j.appender.appenderName.option1 = value1
log4j.appender.appenderName.optionN = valueN
这里的appenderName为在①里定义的,可任意起名。
其中,Log4j提供的appender有以下几种:
org.apache.log4j.ConsoleAppender(控制台),
org.apache.log4j.FileAppender(文件),
org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件),
org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件),可通过 log4j.appender.R.MaxFileSize=100KB设置文件大小,还可通过 log4j.appender.R.MaxBackupIndex=1设置为保存一个备份文件。
org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)
例如:log4j.appender.stdout=org.apache.log4j.ConsoleAppender
定义一个名为stdout的输出目的地,ConsoleAppender为控制台。
③配置日志信息的格式(布局)Layout
Layout 负责格式化Appender的输出。
其语法为:
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表格形式布局),
org.apache.log4j.PatternLayout(可以灵活地指定布局模式),
org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串),
org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息)
2、格式化日志信息
Log4J采用类似C语言中的printf函数的打印格式格式化日志信息,打印参数如下:
%m 输出代码中指定的消息
%p 输出优先级,即DEBUG,INFO,WARN,ERROR,FATAL
%r 输出自应用启动到输出该log信息耗费的毫秒数
%c 输出所属的类目,通常就是所在类的全名
%t 输出产生该日志事件的线程名
%n 输出一个回车换行符,Windows平台为“rn”,Unix平台为“n”
%d 输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式,比如:%d{yyyy MMM dd HH:mm:ss,SSS},输出类似:2002年10月18日 22:10:28,921
%l 输出日志事件的发生位置,包括类目名、发生的线程,以及在代码中的行数。

四.如何使用log4j记录日志

要使用log4j记录日志,首先要下载log4j的jar文件,官方网站是http://logging.apache.org/log4j。当前下载地址是:http://logging.apache.org/log4j/1.2/dowload.html.下载好该文件,解压后有一个apache-log4j-1.2.17\log4j-1.2.17.jar文件.

第一步:在项目中加入log4j所使用的jar文件

首先在项目中创建一个lib文件夹,把该文件复制该文件中。然后对已经复制过来的jar包鼠标点击右键,选中BuildPath  --------》Add to Build Path 然后你会在项目中看到多了一个引入外包的项目:Library

浅谈如何使用Log4j记录日志

第二步:创建log4j.properties文件

选择要使用的log4j项目,点击src,依次选择New————》File---------New File--------》输入文件名,单击Finish按钮,结束创建。‘

第三步:编写log4j.properties文件,配置日志信息。

log4j.rootLogger=Info,file, stdout

### direct log messages to stdout ###
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=%d{ABSOLUTE} %5p %c{1}:%L - %m%n

### direct messages to file mylog.log ###
log4j.appender.file=org.apache.log4j.FileAppender
log4j.appender.file.File=D\:mylog.log
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L - %m%n

### set log levels - for more verbose logging change 'info' to 'debug' ###

五.日志及级别

每个Logger都被了一个日志级别(log level),用来控制日志信息的输出。日志级别从高到低分为:
01.off         最高等级,用于关闭所有日志记录。
02.fatal       指出每个严重的错误事件将会导致应用程序的退出。
03.error      指出虽然发生错误事件,但仍然不影响系统的继续运行。
04.warm     表明会出现潜在的错误情形。
05.info         一般和在粗粒度级别上,强调应用程序的运行全程。
06.debug     一般用于细粒度级别上,对调试应用程序非常有帮助。
07.all           最低等级,用于打开所有日志记录。

六.在程序中使用lpg4j记录日志

package cn.hyj.one;
import org.apache.log4j.Logger;
public class Test {

    //通过Logger的getLogger获取一个Loogger实例
    public static Logger lo=Logger.getLogger(Test.class);
    public static void main(String[] args) {
        try {
            int result=5/0;//出现异常
        } catch (Exception e) {
            System.out.println("除数不能为零!");
            lo.info("除数不能为0");//保存日志
        }

    }
}