Log4j 使用方法和输出格式控制--log4j的PatternLayout参数含义

于 2020-06-12 15:47:05 发布
阅读量3.2k 收藏 5
点赞数
分类专栏： # MyBatis 文章标签： log4j
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/mk1843109092/article/details/106714530
版权
本文详细介绍了Log4j的功能和使用，包括日志级别、输出目的地的配置，如控制台和文件Appender，以及PatternLayout的参数含义，用于定制日志输出格式。Log4j提供多种Appender选项，如滚动文件Appender，以及各种Layout，如HTML和PatternLayout，后者允许灵活的格式设置。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

Log4j

  • 由 Apache 推出的开源免费日志处理的类库
  • 可以控制日志信息输送的目的地是控制台、文件…等
  • 可以控制每一条日志的输出格式
  • 使用时导入 log4j 的 jar 包，并在 src 中 配置 log4j.properties 。（该文件名固定）
  • Logger组件分为五个级别：DEBUG、INFO、WARN、ERROR和FATAL。
    • FATAL 致命错误，不能解决
    • ERROR 为严重错误 主要是程序的错误
    • WARN 为警告
    • INFO 为普通信息
    • DEBUG 为程序的调试信息
    • 分别用来指定这条日志信息的重要程度
    • 五个级别顺序：DEBUG < INFO < WARN < ERROR < FATAL
  • 只输出级别不低于设定级别的日志信息，假设Logger级别设定为INFO，则INFO、WARN、ERROR和FATAL级别的日志信息都会输出，而级别比INFO低的DEBUG则不会输出
log4j.rootCategory=INFO, CONSOLE, LOGFILE, ...

设置 Logger 输出级别，只输出该级别及以上级别内容
设置输出目的地，CONSOLE表示控制台，LOGFILE表示日志文件，…

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

日志输出位置的命名及一些配置
后面可以有以下几种值

  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=true：表示所有消息都会被立即输出，设为false则不输出，默认值是true。
    • Target=System.err：默认值是System.out。

  • FileAppender选项配置项

    • Threshold=WARN
    • ImmediateFlush=true
    • Append=false：true表示消息追加到指定文件中，false消息覆盖指定文件内容，默认值是true。
    • File=axis.log：指定消息输出到axis.log文件中。（可以自行修改文件地址）

  • DailyRollingFileAppender选项配置项

    • Threshold=WARN
    • ImmediateFlush=true
    • Append=false
    • File=axis.log
    • DatePattern=’.'yyyy-MM：每月滚动一次日志文件，即每月产生一个新的日志文件。当前月的日志文件名为logging.log4j，前一个月的日志文件名为logging.log4j.yyyy-MM

  • RollingFileAppender选项配置项

    • Threshold=WARN
    • ImmediateFlush=true
    • Append=false
    • File=axis.log
    • MaxFileSize=100KB：后缀可以是KB, MB 或者GB。在日志文件到达该大小时，将会自动滚动，即将原来的内容移到axis.log文件中。
    • MaxBackupIndex=2：指定可以产生的滚动文件的最大数
log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout

日志输出样式
可以有一下几种

  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选项配置

log4j.appender.CONSOLE.layout.ConversionPattern=%C %d{YYYY-MM-dd hh:mm:ss} %m %n

设置日志格式（下表转载自）

参数说明例子
%c
列出logger名字空间的全称，如果加上{<层数>}表示列出从最内层算起的指定层数的名字空间
log4j配置文件参数举例
输出显示媒介
假设当前logger名字空间是"a.b.c"
%ca.b.c
%c{2}b.c
%20c（若名字空间长度小于20，则左边用空格填充）
%-20c（若名字空间长度小于20，则右边用空格填充）
%.30c（若名字空间长度超过30，截去多余字符）
%20.30c（若名字空间长度小于20，则左边用空格填充；若名字空间长度超过30，截去多余字符）
%-20.30c（若名字空间长度小于20，则右边用空格填充；若名字空间长度超过30，截去多余字符）
%C
列出调用logger的类的全名（包含包路径）假设当前类是"org.apache.xyz.SomeClass"
%Corg.apache.xyz.SomeClass
%C{1}SomeClass
%d
显示日志记录时间，{<日期格式>}使用ISO8601定义的日期格式%d{yyyy/MM/dd HH:mm:ss,SSS}2005/10/12 22:23:30,117
%d{ABSOLUTE}22:23:30,117
%d{DATE}12 Oct 2005 22:23:30,117
%d{ISO8601}2005-10-12 22:23:30,117
%F
显示调用logger的源文件名%FMyClass.java
%l
输出日志事件的发生位置，包括类目名、发生的线程，以及在代码中的行数%lMyClass.main(MyClass.java:129)
%L
显示调用logger的代码行%L129
%m
显示输出消息%mThis is a message for debug.
%M
显示调用logger的方法名%Mmain
%n
当前平台下的换行符%nWindows平台下表示rn
UNIX平台下表示n
%p
显示该条日志的优先级%pINFO
%r
显示从程序启动时到记录该条日志时已经经过的毫秒数%r1215
%t
输出产生该日志事件的线程名%tMyClass
%x
按NDC（Nested Diagnostic Context，线程堆栈）顺序输出日志假设某程序调用顺序是MyApp调用com.foo.Bar
%c %x - %m%nMyApp - Call com.foo.Bar.
com.foo.Bar - Log in Bar
MyApp - Return to MyApp.
%X
按MDC（Mapped Diagnostic Context，线程映射表）输出日志。通常用于多个客户端连接同一台服务器，方便服务器区分是那个客户端访问留下来的日志。%X{5}（记录代号为5的客户端的日志）
%%
显示一个百分号%%%

使用

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

log4j.appender.socket.layout=org.apache.log4j.PatternLayout
log4j.appender.socket.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n

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

		Logger logger = Logger.getLogger(Test.class);
		logger.debug("这是一个调试信息");
		logger.info("这是一个普通信息");

log4j2

<?xml version="1.0" encoding="UTF-8"?>
<!-- 控制日志的日志输出级别 -->
<configuration status="OFF">
    <!--先定义所有的appender -->
    <appenders>
        <!--这个输出控制台的配置 -->
        <Console name="Console" target="SYSTEM_OUT" >
            <!--             控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch） -->
            <!-- <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/> -->
            <!--             这个都知道是输出日志的格式 -->
            <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>
        </Console>
 
        <!--文件会打印出所有信息，这个log每次运行程序会自动清空，由append属性决定，这个也挺有用的，适合临时测试用 -->
        <!--append为TRUE表示消息增加到指定文件中，false表示消息覆盖指定的文件内容，默认值是true -->
        <File name="log" fileName="D:/logs/log4j2.log" append="true">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>
        </File>
 
        <!--添加过滤器ThresholdFilter,可以有选择的输出某个级别以上的类别  onMatch="ACCEPT" onMismatch="DENY"意思是匹配就接受,否则直接拒绝  -->
        <File name="ERROR" fileName="D:/logs/error.log">
            <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="%d{yyyy.MM.dd 'at' HH:mm:ss z} %-5level %class{36} %L %M - %msg%xEx%n"/>
        </File>
 
        <!--这个会打印出所有的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档 -->
        <RollingFile name="RollingFile" fileName="D:/logs/web.log"
                     filePattern="logs/$${date:yyyy-MM}/web-%d{MM-dd-yyyy}-%i.log.gz">
            <PatternLayout pattern="%d{yyyy-MM-dd 'at' HH:mm:ss z} %-5level %class{36} %L %M - %msg%xEx%n"/>
            <SizeBasedTriggeringPolicy size="2MB"/>
        </RollingFile>
    </appenders>
 
 
    <!--然后定义logger，只有定义了logger并引入的appender，appender才会生效 -->
    <loggers>
        <root level="info">
            <!-- <appender-ref ref="RollingFile"/> -->
            <appender-ref ref="Console"/>
            <!-- <appender-ref ref="ERROR" /> -->
            <!-- <appender-ref ref="log"/> -->
        </root>
    </loggers>
</configuration>

Logger logger = LogManager.getLogger(Test2.class);
		logger.fatal("fatal msg");
		logger.error("error msg");
		logger.warn("warn msg");
		logger.info("info ,msg");
		logger.debug("debug msg");
		logger.trace("trace msg");
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值