Log4j使用详解(log4j.properties格式)

时间：2024-04-03 09:05:02

Log4j使用详解(log4j.properties格式)

1、Log4j 的引入

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

① 监视代码中变量的变化情况，周期性的记录到文件*其他应用进行统计分析工作；

② 跟踪代码运行时轨迹，作为日后审计的依据；

③ 担当集成开发环境中的调试器的作用，向文件或控制台打印代码的调试信息。

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

2、Log4j 简介

Log4j使用详解(log4j.properties格式)

[list=]Logger - 日志写出器，供程序员输出日志信息

Appender - 日志目的地，把格式化好的日志信息输出到指定的地方去

ConsoleAppender - 目的地为控制台的Appender

FileAppender - 目的地为文件的Appender

RollingFileAppender - 目的地为大小受限的文件的Appender

Layout - 日志格式化器，用来把程序员的logging request格式化成字符串

PatternLayout - 用指定的pattern格式化logging request的Layout [/list]

Log4j有三个主要的组件：Loggers(记录器)，Appenders (输出源)和Layouts(布局)，这里可简单理解为日志类别，日志要输出的地方和日志以何种形式输出。综合使用这三个组件可以轻松的记录信息的类型和级别，并可以在运行时控制日志输出的样式和位置。

3、 Loggers组件

Log4j中将要输出的Log信息定义了5种级别，依次为DEBUG、INFO、WARN、ERROR和FATAL， 分别用来指定这条日志信息的重要程度。当输出时，只有级别高过配置中规定的级别的信息才能真正的输出，否则屏蔽掉。这样就很方便的来配置不同情况下要输出的内容，而不需要更改代码，这点实在是方便啊。 假设你定义的级别是info，那么error和warn的日志可以显示而比他低的debug信息就不显示了。

ERROR 为严重错误 主要是程序的错误

WARN 为一般警告，比如session丢失

INFO 为一般要显示的信息，比如登录登出

DEBUG 为程序的调试信息

Logger类对象提供一系列方法供程序员输出日志信息：

Log4j使用详解(log4j.properties格式)
public void debug(Object msg);

public void debug(Object msg, Throwable t);

public void info(Object msg);

public void info(Object msg, Throwable t);

public void warn(Object msg);

public void warn(Object msg, Throwable t);

public void error(Object msg);

public void error(Object msg, Throwable t);

public void fatal(Object msg);

public void fatal(Object msg, Throwable t);
Log4j使用详解(log4j.properties格式)

① Logger的命名规则

Logger由一个String类的名字识别，logger的名字是大小写敏感的，且名字之间具有继承的关系，子名有父名作为前缀，用点号.分隔。如：x.y是x.y.z的父亲。

根logger (root logger)是所有logger的祖先，它具有如下属性：1) 它总是存在的；2) 它不可以通过名字获得。

通过调用public static Logger Logger.getRootLogger()获得root logger；通过调用public static Logger Logger.getLogger(String name)或者public static Logger Logger.getLogger(Class clazz)获得（或者创建）一个named logger。后者相当于调用Logger.getLogger(clazz.getName())。

在某对象中，用该对象所属的类为参数，调用Logger.getLogger(Class clazz)以获得logger被认为是目前所知的最理智的命名logger的方法。

Java程序举例来说：

Log4j使用详解(log4j.properties格式)
//建立Logger的一个实例，命名为“com.foo”

　　　Logger　logger = Logger.getLogger("com.foo"); //"com.foo"是实例进行命名，也可以任意

　　//设置logger的级别。通常不在程序中设置logger的级别。一般在配置文件中设置。

　　logger.setLevel(Level.INFO);

　　Logger barlogger = Logger.getLogger("com.foo.Bar");

　　//下面这个请求可用，因为WARN >= INFO

　　logger.warn("Low fuel level.");

　　//下面这个请求不可用，因为DEBUG < INFO

　　logger.debug("Starting search for nearest gas station.");

　　//命名为“com.foo.bar”的实例barlogger会继承实例“com.foo”的级别。因此，下面这个请求可用，因为INFO >= INFO

　　barlogger.info("Located nearest gas station.");

　　//下面这个请求不可用，因为DEBUG < INFO

　　barlogger.debug("Exiting gas station search");

　　/*这里“是否可用”的意思是能否输出Logger信息。*/
Log4j使用详解(log4j.properties格式)

　　　　在对Logger实例进行命名时，没有限制，可以取任意自己感兴趣的名字。一般情况下建议以类的所在位置来命名Logger实例，这是目前来讲比较有效的Logger命名方式。这样可以使得每个类建立自己的日志信息，便于管理。比如：

　　　　static Logger logger = Logger.getLogger(ClientWithLog4j.class.getName());

　　

② Log level

每个logger都被分配了一个日志级别 (log level)，用来控制日志信息的输出。未被分配level的logger将继承它最近的父logger的level。

每条输出到logger的日志请求(logging request)也都有一个level，如果该request的level大于等于该logger的level，则该request将被处理（称为enabled）；否则该request将被忽略。故可得知：

logger的level越低，表示该logger越详细

logging request的level越高，表示该logging request越优先输出

关于logger的两点说明

用同名参数调用Logger.getLogger(String name)将返回同一个logger的引用。故可以在一个地方配置logger，在另外一个地方获得配置好的logger，而无须相互间传递logger的引用。

logger的创建可以按照任意的顺序，即，父logger可以后于子logger被创建。log4j将自动维护logger的继承树。

4、 Appenders组件

Log4j日志系统允许把日志输出到不同的地方，Appender则是用来指明将所有的log信息存放到什么地方，如控制台（Console）、文件（Files）、根据天数或者文件大小产生新的文件、以流的形式发送到其它地方等等。Log4j中支持多种appender，如 console、files、GUI components、NT Event Loggers等，一个Logger可以拥有多个 Appender，也就是你既可以将Log信息输出到屏幕，同时存储到一个文件中。

　　其语法表示为：　

org.apache.log4j.ConsoleAppender（控制台）

org.apache.log4j.FileAppender（文件）

org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件）

org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件）

org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）

　

　　配置时使用方式为：

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

log4j.appender.appenderName.option1 = value1

…

log4j.appender.appenderName.option = valueN

这样就为日志的输出提供了相当大的便利。

5、Layouts组件

Layout的作用是控制Log信息的输出方式，也就是格式化输出的信息。Log4j可以在Appenders的后面附加Layouts来完成这个功能。Layouts提供了四种日志输出样式，如根据HTML样式、*指定样式、包含日志级别与信息的样式和包含日志时间、线程、类别等信息的样式等等。

　　其语法表示为：

org.apache.log4j.HTMLLayout（以HTML表格形式布局），

org.apache.log4j.PatternLayout（可以灵活地指定布局模式），

org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），

org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

　　配置时使用方式为：

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

log4j.appender.appenderName.layout.option1 = value1

…

log4j.appender.appenderName.layout.option = valueN

　　Log4J采用类似C语言中的printf函数的打印格式格式化日志信息，打印参数如下： %m 输出代

码中指定的消息

　　%p 输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL

　　%r 输出自应用启动到输出该log信息耗费的毫秒数

　　%c 输出所属的类目，通常就是所在类的全名

　　%t 输出产生该日志事件的线程名

　　%n 输出一个回车换行符，Windows 平台为“\r\n”，Unix平台为“\n”

　　%d 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy

MMM dd HH：mm：ss，SSS}，输出类似： 2002年10月18 日 22：10：28，921

　　%l 输出日志事件的发生位置，包括类目名、发生的线程，以及在代码中的行数。举例：

Testlog4.main（TestLog4.java：10）

6、Log4j的使用

在Java编程使用Log4j可以参照以下示例：

①  建立Logger实例：

语法表示：public static Logger getLogger( String name)

实际使用：static Logger logger = Logger.getLogger(ServerWithLog4j.class.getName ()) ;

　　

②  读取配置文件：

获得了Logger的实例之后，接下来将配置Log4j使用环境：

语法表示：

　　BasicConfigurator.configure()：自动快速地使用缺省Log4j环境。

　　PropertyConfigurator.configure(String configFilename)：读取使用Java的特性文件编写的配置文件。

　　DOMConfigurator.configure(String filename)：读取XML形式的配置文件。

实际使用：

PropertyConfigurator.configure("ServerWithLog4j.properties");

　　

③  插入日志信息

完成了以上连个步骤以后，下面就可以按日志的不同级别插入到你要记录日志的任何地方了。

语法表示：

　　Logger.debug(Object message);//调试信息

　　Logger.info(Object message);//一般信息

　　Logger.warn(Object message);//警告信息

　　Logger.error(Object message);//错误信息

　　Logger.fatal(Object message);//致命错误信息

实际使用：logger.info("ServerSocket before accept: " + server);

　　

7、Log4j的配置

在实际编程时，要使Log4j真正在系统中运行事先还要对配置文件进行定义。定义步骤就是对Logger、Appender及Layout的分别使用。

Log4j支持两种配置文件格式，一种是XML格式的文件，一种是java properties （key=value）【Java特性文件（键=值）】。下面我们介绍使用Java特性文件做为配置文件的方法

具体如下：

①  配置根Logger，其语法为：

log4j.rootLogger = [ level ] , appenderName1, appenderName2, …

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

appenderName:就是指定日志信息输出到哪个地方。您可以同时指定多个输出目的地。

例如：log4j.rootLogger＝info,A1,B2,C3

　　

②  配置日志信息输出目的地，其语法为：

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

"fully.qualified.name.of.appender.class" 可以指定下面五个目的地中的一个：

1.org.apache.log4j.ConsoleAppender（控制台）

2.org.apache.log4j.FileAppender（文件）

3.org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件）

4.org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件）

5.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:每周滚动一次文件，即每周产生一个新的文件。当然也可以指定按月、周、天、时和分。即对应的格式如下：

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: 每分钟

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:指定可以产生的滚动文件的最大数。

实际应用：

　log4j.appender.A1=org.apache.log4j.ConsoleAppender //这里指定了日志输出的第一个位置A1是控制台ConsoleAppender

　　

③  配置日志信息的格式，其语法为：

　A.

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

"fully.qualified.name.of.layout.class" 可以指定下面4个格式中的一个：

Log4j使用详解(log4j.properties格式)
1.org.apache.log4j.HTMLLayout（以HTML表格形式布局），

2.org.apache.log4j.PatternLayout（可以灵活地指定布局模式），

3.org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），

4.org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）
Log4j使用详解(log4j.properties格式)

a.HTMLLayout 选项

LocationInfo=true:默认值是false,输出java文件名称和行号

Title=my app file: 默认值是 Log4J Log Messages.

b.PatternLayout 选项

ConversionPattern=%m%n :指定怎样格式化指定的消息。

c.XMLLayout  选项

LocationInfo=true:默认值是false,输出java文件和行号

实际应用：

　　log4j.appender.A1.layout=org.apache.log4j.PatternLayout

B.

log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ssS} %c %m%n

这里需要说明的就是日志信息格式中几个符号所代表的含义：

Log4j使用详解(log4j.properties格式)
－X号: X信息输出时左对齐；

%p: 输出日志信息优先级，即DEBUG，INFO，WARN，ERROR，FATAL,

%d: 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss,SSS}，输出类似：2002年10月18日 22：10：28，921

%r: 输出自应用启动到输出该log信息耗费的毫秒数

%c: 输出日志信息所属的类目，通常就是所在类的全名

%t: 输出产生该日志事件的线程名

%l: 输出日志事件的发生位置，相当于%C.%M(%F:%L)的组合,包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main(TestLog4.java:10)

%x: 输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像java servlets这样的多客户多线程的应用中。

%%: 输出一个"%"字符

%F: 输出日志消息产生时所在的文件名称

%L: 输出代码中的行号

%m: 输出代码中指定的消息,产生的日志具体信息

%n: 输出一个回车换行符，Windows平台为"\r\n"，Unix平台为"\n"
Log4j使用详解(log4j.properties格式)

输出日志信息换行可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如：

1)%20c：指定输出category的名称，最小的宽度是20，如果category的名称小于20的话，默认的情况下右对齐。

2)%-20c:指定输出category的名称，最小的宽度是20，如果category的名称小于20的话，"-"号指定左对齐。

3)%.30c:指定输出category的名称，最大的宽度是30，如果category的名称大于30的话，就会将左边多出的字符截掉，但小于30的话也不会有空格。

4)%20.30c:如果category的名称小于20就补空格，并且右对齐，如果其名称长于30字符，就从左边交远销出的字符截掉。

这里上面三个步骤是对前面Log4j组件说明的一个简化；下面给出一个具体配置例子，在程序中可以参照执行：　

Log4j使用详解(log4j.properties格式)
log4j.rootLogger=INFO,A1，B2

log4j.appender.A1=org.apache.log4j.ConsoleAppender

log4j.appender.A1.layout=org.apache.log4j.PatternLayout

log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ssS} %c %m%n
Log4j使用详解(log4j.properties格式)

根据上面的日志格式，某一个程序的输出结果如下：

　　0　　INFO　2003-06-13 13:23:46968 ClientWithLog4j Client socket: Socket[addr=localhost/127.0.0.1,port=8002,localport=2014]

16　 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j Server says: 'Java server with log4j, Fri Jun 13 13:23:46 CST 2003'

　　16　 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j GOOD

　　16　 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j Server responds: 'Command 'HELLO' not understood.'

　　16　 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j HELP

　　16　 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j Server responds: 'Vocabulary: HELP QUIT'

　　16　 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j QUIT

④   当输出信息于回滚文件时

Log4j使用详解(log4j.properties格式)
log4j.appender.ROLLING_FILE=org.apache.log4j.RollingFileAppender   //指定以文件的方式输出日志

log4j.appender.ROLLING_FILE.Threshold=ERROR 

log4j.appender.ROLLING_FILE.File=rolling.log  //文件位置,也可以用变量${java.home}、rolling.log

log4j.appender.ROLLING_FILE.Append=true 

log4j.appender.ROLLING_FILE.MaxFileSize=10KB  //文件最大尺寸

log4j.appender.ROLLING_FILE.MaxBackupIndex=1  //备份数

log4j.appender.ROLLING_FILE.layout=org.apache.log4j.PatternLayout 

log4j.appender.ROLLING_FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n
Log4j使用详解(log4j.properties格式)

8、Log4j常用配置实例

LOG4J的配置之简单使它遍及于越来越多的应用中了：Log4J配置文件实现了输出到控制台、文件、回滚文件、发送日志邮件、输出到数据库日志表、自定义标签等全套功能。择其一二使用就够用了，

Log4j使用详解(log4j.properties格式)
log4j.rootLogger=DEBUG,CONSOLE,A1,im

 log4j.addivity.org.apache=true

 # 应用于控制台

 log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender

 log4j.appender.Threshold=DEBUG

 log4j.appender.CONSOLE.Target=System.out

 log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout

 log4j.appender.CONSOLE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n

 #log4j.appender.CONSOLE.layout.ConversionPattern=[start]%d{DATE}[DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[THREAD] n%c[CATEGORY]%n%m[MESSAGE]%n%n

 #应用于文件

 log4j.appender.FILE=org.apache.log4j.FileAppender

 log4j.appender.FILE.File=file.log

 log4j.appender.FILE.Append=false

 log4j.appender.FILE.layout=org.apache.log4j.PatternLayout

 log4j.appender.FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n

 # Use this layout for LogFactor 5 analysis

 # 应用于文件回滚

 log4j.appender.ROLLING_FILE=org.apache.log4j.RollingFileAppender

 log4j.appender.ROLLING_FILE.Threshold=ERROR

 log4j.appender.ROLLING_FILE.File=rolling.log  //文件位置,也可以用变量${java.home}、rolling.log

 log4j.appender.ROLLING_FILE.Append=true       //true:添加  false:覆盖

 log4j.appender.ROLLING_FILE.MaxFileSize=10KB   //文件最大尺寸

 log4j.appender.ROLLING_FILE.MaxBackupIndex=1  //备份数

 log4j.appender.ROLLING_FILE.layout=org.apache.log4j.PatternLayout

 log4j.appender.ROLLING_FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%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 Facter 5

 log4j.appender.SOCKET.layout=org.apache.log4j.PatternLayout

 log4j.appender.SOCET.layout.ConversionPattern=[start]%d{DATE}[DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[THREAD]%n%c[CATEGORY]%n%m[MESSAGE]%n%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

 www.wuset.com">log4j.appender.MAIL.From=web@www.wuset.com

 log4j.appender.MAIL.SMTPHost=www.wusetu.com

 log4j.appender.MAIL.Subject=Log4J Message

 www.wusetu.com">log4j.appender.MAIL.To=web@www.wusetu.com

 log4j.appender.MAIL.layout=org.apache.log4j.PatternLayout

 log4j.appender.MAIL.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%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 ('[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n')

 log4j.appender.DATABASE.layout=org.apache.log4j.PatternLayout

 log4j.appender.DATABASE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n

 log4j.appender.A1=org.apache.log4j.DailyRollingFileAppender

 log4j.appender.A1.File=SampleMessages.log4j

 log4j.appender.A1.DatePattern=yyyyMMdd-HH'.log4j'

 log4j.appender.A1.layout=org.apache.log4j.xml.XMLLayout

 #自定义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 = corlin@cybercorlin.net

 log4j.appender.im.layout=org.apache.log4j.PatternLayout

 log4j.appender.im.layout.ConversionPattern =[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n

相关文章