登录
当前位置： 首页 > 工具软件 > Log4j JDBCAppender > 使用案例 >

log4j详解

景鸿晖
2023-12-01

log4j.properties配置详解

什么是log4j

Log4j是Apache的一个开源项目，通过使用Log4j，我们可以控制日志信息输送的目的地是控制台、文件、GUI组件，甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等；我们也可以控制每一条日志的输出格式；通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程。最令人感兴趣的就是，这些可以通过一个配置文件来灵活地进行配置，而不需要修改应用的代码。（摘自[百度百科][https://baike.baidu.com/item/log4j/480673?fr=aladdin]）

在强调bean开发的今天，除了从头到尾开发一个可重用的日志操作类外，Apache为我们提供了一个日志操作包-log4j。

配置

  1. 加入jar包
<dependency>
	<groupId>log4j</groupId>
	<artifactId>log4j</artifactId>
	<version>1.2.17</version>
</dependency>
  1. 在CLASSPATH下建立log4j.properties配置文件

该配置文件很重要，详见下文

  1. 在配置文件中修改对应的属性以便使用log4j
  2. 在要输出日志的类中加入相关的语句
// 定义属性
static Logger logger = Logger.getLogger(LogDemo.class);// LogDemo为相关的类

// 在对应的方法中
if(logger.isDebugEnabled()){
    logger.debug("System.....")
}

log4j组件介绍

在配置log4j前，我们需要了解一些有关log4j的相关知，以便对于配置文件有所了解

log4j有三个主要的组件：

  • Logger（记录器）：日志类别和级别；
  • Appenders（输出源）：日志要输出的地方；
  • Layouts（布局）：日志要以何种形式输出；

我们分步讲解这三个组件，可以说把这三个组件弄懂才了解了log4j

Loggers

Loggers记录器组件在系统中被分为五个级别：DEBUG、INFO、WARN、ERROR和FATAL。这五个级别是有顺序的，DEBUG < INFO < WARN < ERROR < FATAL，分别用来指定这条日志信息的重要程度。

与此同时Log4j有一个自定的规则：只输出级别不低于设定级别的日志信息，假设Loggers记录器级别设定为INFO，则级别大于等于INFO 的四个等级INFO,WARN,ERROR,FATAL级别的日志信息都会被输出，而级别比其低的DEBUG不会输出。

Appenders

禁用和使用日志请求只是log4j的基本功能，log4j日志系统还提供很多其他强大的功能，比如设置Appenders（输出源），将日志输出到不同的地方，如控制台（Console），文件（Files）等，可以根据天数或者文件大小产生新的文件，可以以流的形式将其发送到其他地方等等。

常使用的类如下：

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

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

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

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

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

log4j.appender.appenderName = className
log4j.appender.appenderName.Option1 = value1
…
log4j.appender.appenderName.OptionN = valueN

Layouts

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 =className
log4j.appender.appenderName.layout.Option1 = value1
...
log4j.appender.appenderName.layout.OptionN = valueN

配置详解

在实际应用中，要使Log4j在系统中运行须事先设定配置文件。配置文件事实上也就是对Logger、Appender及Layout进行相应设定。
Log4j支持两种配置文件格式:

  • 一种是XML格式的文件，
  • 一种是properties属性文件。

下面以properties属性文件为例介绍log4j.properties的配置。

配置组件

配置根Logger

log4j.rootLogger = [ level ] , appenderName1, appenderName2, …
log4j.additivity.org.apache=false：表示Logger不会在父Logger的appender里输出，默认为true。

  1. level：设定日志记录的最低级别，可设的值有OFF，FATAL,ERROR,WARN,INFO,DEBUG,ALL或者自定义的级别，log4j建议只使用中间四个级别。通过在这里设定级别，您可以控制应用程序中相应级别的日志信息的开关，比如这里设定了INFO级别，则应用程序中所有DEBUG级别的日志信息将不会被打印出来。

  2. appenderName：就是指定日志信息要输出到哪里。可以同时指定多个输出目的地，用逗号隔开即可。

    // 例如
log4j.rootLogger = INFO,A1,B2,C3

配置日志信息输出目的地（appender）：

log4j.appender.appenderName = className

appenderName:自定义appenderName，在log4j.rootLogger设置中使用className：可设值如下：

  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（将日志信息以流格式发送到任意指定的地方）
  • ConsoleAppender选项

Threshold=WARN：指定日志信息耳朵最低输出级别，默认为DEBUG。

immediateFlush=tru：表示所有信息都会被立即输出，设为false则不输出，默认值是true。

Target=System.err：默认值是System.out

  • FileAppender选项

Threshold=WARN：指定日志信息的最低输出级别，默认为DEBUG。

ImmediateFlush=true：表示所有消息都会被立即输出，设为false则不输出，默认值是true。

Append=false：true表示消息增加到指定文件中，false则将消息覆盖指定的文件内容，默认值是true。

File=D:/logs/logging.log4j：指定消息输出到logging.log4j文件中。

  • DailyRollingFileAppender选项

Threshold=WARN：指定日志信息的最低输出级别，默认为DEBUG。

ImmediateFlush=true：表示所有消息都会被立即输出，设为false则不输出，默认值是true。

Append=false：true表示消息增加到指定文件中，false则将消息覆盖指定的文件内容，默认值是true。

File=D:/logs/logging.log4j：指定当前消息输出到logging.log4j文件中。

DatePattern=’.'yyyy-MM：每月滚动一次日志文件，即每月产生一个新的日志文件。当前月的日志文件名为logging.log4j，前一个月的日志文件名为logging.log4j.yyyy-MM。
另外，也可以指定按周、天、时、分等来滚动日志文件，对应的格式如下：

  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：每分钟
  • RollingFileAppender选项

Threshold=WARN：指定日志信息的最低输出级别，默认为DEBUG。

ImmediateFlush=true：表示所有消息都会被立即输出，设为false则不输出，默认值是true。

Append=false：true表示消息增加到指定文件中，false则将消息覆盖指定的文件内容，默认值是true。

File=D:/logs/logging.log4j：指定消息输出到logging.log4j文件中。

MaxFileSize=100KB：后缀可以是KB, MB 或者GB。在日志文件到达该大小时，将会自动滚动，即将原来的内容移到logging.log4j.1文件中。

MaxBackupIndex=2：指定可以产生的滚动文件的最大数，例如，设为2则可以产生logging.log4j.1，logging.log4j.2两个滚动文件和一个logging.log4j文件。

  • 配置日志信息的输出格式（Layout）
log4j.appender.appenderName.layout=className

className：可设值如下：

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

LocationInfo=true：输出java文件名称和行号，默认值是false。

Title=My Logging： 默认值是Log4J Log Messages。

  • PatternLayout选项

ConversionPattern=%m%n：设定以怎样的格式显示消息。

格式化符号说明：

  • %p：输出日志信息的优先级，即DEBUG，INFO，WARN，ERROR，FATAL。
  • %d：输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，如：%d{yyyy/MM/dd HH:mm:ss,SSS}。
  • %r：输出自应用程序启动到输出该log信息耗费的毫秒数。
  • %t：输出产生该日志事件的线程名。
  • %l：输出日志事件的发生位置，相当于%c.%M(%F:%L)的组合，包括类全名、方法、文件名以及在代码中的行数。例如：test.TestLog4j.main(TestLog4j.java:10)。
  • %c：输出日志信息所属的类目，通常就是所在类的全名。
  • %M：输出产生日志信息的方法名。
  • %F：输出日志消息产生时所在的文件名称。
  • %L:：输出代码中的行号。
  • %m:：输出代码中指定的具体日志信息。
  • %n：输出一个回车换行符，Windows平台为"\r\n"，Unix平台为"\n"。
  • %x：输出和当前线程相关联的NDC(嵌套诊断环境)，尤其用到像java servlets这样的多客户多线程的应用中。
  • %%：输出一个"%"字符。

另外，还可以在%与格式字符之间加上修饰符来控制其最小长度、最大长度、和文本的对齐方式。如：

    1. c：指定输出category的名称，最小的长度是20，如果category的名称长度小于20的话，默认的情况下右对齐。
  • 2)%-20c："-"号表示左对齐。
  • 3)%.30c：指定输出category的名称，最大的长度是30，如果category的名称长度大于30的话，就会将左边多出的字符截掉，但小于30的话也不会补空格。

log4j比较全面的配置

log4j配置文件实现了输出到控制台，文件，回滚文件，发送日志邮件，输出到数据库日志表，自定义标签等全套功能。

log4j.rootLogger=DEBUG,console,dailyFile,im
log4j.additivity.org.apache=true
# 控制台(console)
log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.Threshold=DEBUG
log4j.appender.console.ImmediateFlush=true
log4j.appender.console.Target=System.err
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
# 日志文件(logFile)
log4j.appender.logFile=org.apache.log4j.FileAppender
log4j.appender.logFile.Threshold=DEBUG
log4j.appender.logFile.ImmediateFlush=true
log4j.appender.logFile.Append=true
log4j.appender.logFile.File=D:/logs/log.log4j
log4j.appender.logFile.layout=org.apache.log4j.PatternLayout
log4j.appender.logFile.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
# 回滚文件(rollingFile)
log4j.appender.rollingFile=org.apache.log4j.RollingFileAppender
log4j.appender.rollingFile.Threshold=DEBUG
log4j.appender.rollingFile.ImmediateFlush=true
log4j.appender.rollingFile.Append=true
log4j.appender.rollingFile.File=D:/logs/log.log4j
log4j.appender.rollingFile.MaxFileSize=200KB
log4j.appender.rollingFile.MaxBackupIndex=50
log4j.appender.rollingFile.layout=org.apache.log4j.PatternLayout
log4j.appender.rollingFile.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
# 定期回滚日志文件(dailyFile)
log4j.appender.dailyFile=org.apache.log4j.DailyRollingFileAppender
log4j.appender.dailyFile.Threshold=DEBUG
log4j.appender.dailyFile.ImmediateFlush=true
log4j.appender.dailyFile.Append=true
log4j.appender.dailyFile.File=D:/logs/log.log4j
log4j.appender.dailyFile.DatePattern='.'yyyy-MM-dd
log4j.appender.dailyFile.layout=org.apache.log4j.PatternLayout
log4j.appender.dailyFile.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %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 Factor 5
log4j.appender.socket.layout=org.apache.log4j.PatternLayout
log4j.appender.socket.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %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
log4j.appender.mail.From = xxx@mail.com
log4j.appender.mail.SMTPHost=mail.com
log4j.appender.mail.Subject=Log4J Message
log4j.appender.mail.To= xxx@mail.com
log4j.appender.mail.layout=org.apache.log4j.PatternLayout
log4j.appender.mail.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %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('=[%-5p] %d(%r) --> [%t] %l: %m %x %n')
log4j.appender.database.layout=org.apache.log4j.PatternLayout
log4j.appender.database.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n

# 自定义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=[%-5p] %d(%r) --> [%t] %l: %m %x %n

输出独立日志文件

log4j的强大功能无可置疑，但实际应用中免不了遇到某个功能需要输出独立的日志文件的情况，怎样才能把所需的内容从原有日志中分离，形成单独的日志文件呢？其实只要在现有的log4j基础上稍加配置即可轻松实现这一功能。

常见

# 在控制台和myweb.log文件中记录日志

log4j.rootLogger=DEBUG, stdout, logfile
 
log4j.category.org.springframework=ERROR
log4j.category.org.apache=INFO
 
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d %p [%c] - %m%n
 
log4j.appender.logfile=org.apache.log4j.RollingFileAppender
log4j.appender.logfile.File=${myweb.root}/WEB-INF/log/myweb.log
log4j.appender.logfile.MaxFileSize=512KB
log4j.appender.logfile.MaxBackupIndex=5
log4j.appender.logfile.layout=org.apache.log4j.PatternLayout
log4j.appender.logfile.layout.ConversionPattern=%d %p [%c] - %m%n

不同类输出不同文件

如果想要对不同的类输出不同的文件（以cn.com.Test为例），先要在Test.java中定义：

private static Log logger = LogFactory.getLog(Test.class);
　　//然后在log4j.properties中加入:
log4j.logger.cn.com.Test= DEBUG, test
log4j.appender.test=org.apache.log4j.FileAppender
log4j.appender.test.File=${myweb.root}/WEB-INF/log/test.log
log4j.appender.test.layout=org.apache.log4j.PatternLayout
log4j.appender.test.layout.ConversionPattern=%d %p [%c] - %m%n
　　//也就是让cn.com.Test中的logger使用log4j.appender.test所做的配置。

同一类输出多个日志文件

但是，如果在同一个类中需要输出多个日志文件，其实道理是一样的，先要在Test.java中定义：

private static Log logger1 = LogFactory.getLog("myTest1");
private static Log logger2 = LogFactory.getLog("myTest2");

然后在配置文件加入:

log4j.logger.myTest1= DEBUG, test1
log4j.appender.test1=org.apache.log4j.FileAppender
log4j.appender.test1.File=${myweb.root}/WEB-INF/log/test1.log
log4j.appender.test1.layout=org.apache.log4j.PatternLayout
log4j.appender.test1.layout.ConversionPattern=%d %p [%c] - %m%n
　　
log4j.logger.myTest2= DEBUG, test2
log4j.appender.test2=org.apache.log4j.FileAppender
log4j.appender.test2.File=${myweb.root}/WEB-INF/log/test2.log
log4j.appender.test2.layout=org.apache.log4j.PatternLayout
log4j.appender.test2.layout.ConversionPattern=%d %p [%c] - %m%n
​```　
  #也就是在用logger时给它一个自定义的名字(如这里的"myTest1")，然后在log4j.properties中做出相应配置即可。别忘了不同日志要使用不同的logger(如输出到test1.log的要用logger1.info("abc"))。

　　还有一个问题，就是这些自定义的**日志默认是同时输出到log4j.rootLogger所配置的日志中的**，如何能只让它们输出到自己指定的日志中呢？别急，这里有个开关：
　　log4j.additivity.myTest1 = false
　　#它用来设置是否同时输出到log4j.rootLogger所配置的日志中，设为false就不会输出到其它地方啦！注意这里的"myTest1"是你在程序中给logger起的那个自定义的名字！
	#如果你说，我只是不想同时输出这个日志到log4j.rootLogger所配置的logfile中，stdout里我还想同时输出呢！那也好办，把你的log4j.logger.myTest1 = DEBUG, test1改为下式就OK啦！

log4j.logger.myTest1=DEBUG, test1
 类似资料：

相关阅读

log4j性能Log4j详细使用教程_动力节点Java学院整理Android中的LOG4Jslf4j与log4j全面了解压缩Log4j文件

相关文章

Log4j HTMLLayout格式Log4j XML配置Log4j Properties配置Struts2+Log4j集成Log4j 日志级别

相关问答

grailsgroovy配置Log4jTomEE和Log4j RollingFileAppenderLog4j 2不支持Log4j。属性文件了吗？将log4j 1.2配置转换为log4j 2配置使用log4j-core-2.4.1时是否需要log4j-core

相关文档

log4j 中文教程Log4j 入门教程Laravel 源码详解HAProxy 用法详解Android Animation 动画详解
快捷导航： 新手教程 算法原理 架构设计 Java进阶 数据库进阶 大厂专栏 面试经验 编程笔记 编程问答 所有专题 文档资料 工具软件 电子书籍 小牛导航
在线工具： 房贷计算器 个税计算器 Linux命令查询 Json格式化 正则表达式 颜色转换 AES加解密 SHA1加密 MD5加密 毒鸡汤 字数统计 随机密码生成 进制转换 Base64编解码 励志句子
Copyright © 2019-2024 小牛知识库@xnip.cn. All Rights Reserved.