【日志】Log4j基本内容介绍

Log4j

一、简单介绍

log4j日志的一些基本知识总结。

三个重要组件结构

1. Logger（记录器）；
2. Appender（输出源）；
3. Layout（布局）；

Logger

Loggers组件在此系统中被分为五个级别：DEBUG、INFO、WARN、ERROR和FATAL。这五个级别是有顺序的，DEBUG < INFO < WARN < ERROR < FATAL，分别用来指定这条日志信息的重要程度，明白这一点很重要，Log4j有一个规则：只输出级别不低于设定级别的日志信息，假设Loggers级别设定为INFO，则INFO、WARN、ERROR和FATAL级别的日志信息都会输出，而级别比INFO低的DEBUG则不会输出。

Appender输出源：

 常见APPender：
org.apache.log4j.ConsoleAppender（控制台）
org.apache.log4j.FileAppender（文件）
org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件）
org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件）
org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）
org.apache.log4j.jdbc.JDBCAppender（把日志用JDBC记录到数据库中）

Layout布局：

常见Layout：
org.apache.log4j.HTMLLayout（以HTML表格形式布局），
org.apache.log4j.PatternLayout（可以灵活地指定布局模式），
org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），
org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

最常见的PatternLayout：
%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)

Appender、Layout、Logger三者之间的关系：

每个Appender都要引用自己的Layout；
每个Logger都可以指定一个级别，同时引用多个Appender；
而一个Appender也同时可以被多个Logger引用

获取日志操作类

public class A {
private static Logger logger = Logger.getLogger(A.class);
}

二、配置

配置方式：

Log4j有两种配置方式，一种是xml格式，一种是properties格式。都是放在classpath下面。默认名称分别是：log4j.xml和log4j.properties

log4j.xml比log4j.properties多的功能：

1. log4j.xml优先于log4j.properties，如果同时存在log4j.xml和log4j.properites，以log4j.xml为准
2. 在log4j.properties里，控制级别的时候，只能打印出大于指定级别的所有信息；但是在log4j.xml中可以通过filter来完成过滤：典型的引用是只打印出某种级别的信息
3. 可以通过logger的additivity=“false”属性，来设置多个logger是否重复输出同一条信息

log4j.properties

1.配置根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

2.配置日志信息输出目的地（Appender）

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

    org.apache.log4j.ConsoleAppender（控制台）
	org.apache.log4j.FileAppender（文件）
	org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件）
	org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件）
	org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）
	org.apache.log4j.jdbc.JDBCAppender（把日志用JDBC记录到数据库中

1. ConsoleAppender选项：
   Threshold=WARN：指定日志信息的最低输出级别，默认为DEBUG。
   ImmediateFlush=true：表示所有消息都会被立即输出，设为false则不输出，默认值是true。
   Target=System.err：默认值是System.out。

2. FileAppender选项：
   Threshold=WARN：指定日志信息的最低输出级别，默认为DEBUG。
   ImmediateFlush=true：表示所有消息都会被立即输出，设为false则不输出，默认值是true。
   Append=false：true表示消息增加到指定文件中，false则将消息覆盖指定的文件内容，默认值是true。
   File=D:/logs/logging.log4j：指定消息输出到logging.log4j文件中。

3. 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：每分钟

4. 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文件。

3.配置日志信息的输出格式（Layout）

log4j.appender.appenderName.layout=className
className：可设值如下

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

1. HTMLLayout选项：
   LocationInfo=true：输出java文件名称和行号，默认值是false。
   Title=My Logging： 默认值是Log4J Log Messages。
2. 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平台为”rn”，Unix平台为”n”。
   %x：输出和当前线程相关联的NDC(嵌套诊断环境)，尤其用到像java servlets这样的多客户多线程的应用中。
   %%：输出一个”%”字符。

控制台（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

log4j.xml

<?xml version="1.0" encoding="UTF-8"?>  
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">    
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">    
    <appender name="appender1"  
        class="org.apache.log4j.RollingFileAppender">  
        <param name="File" value="logfile08.html" />  
        <param name="MaxFileSize" value="1MB" />  
        <param name="MaxBackupIndex" value="5" />  
        <layout class="org.apache.log4j.HTMLLayout">  
        </layout>  
    </appender>    
    <root>  
        <level value="debug" />  
        <appender-ref ref="appender1" />  
    </root>  
</log4j:configuration> 

加粗样式## 注意的问题：重复级别判断
if (logger.isDebugEnabled()){
logger.debug(“debug：“+name);
}
为什么不是直接logger.debug(“debug：“+name);呢？
在配置文件中虽然可以使用控制级别为比debug级别更高的级别，而不输出debug信息。为了提高运行效率，往往在输出信息之前，还要进行级别判断，以避免无效的字符串连接操作；但是，这里的字符串连接操作仍然会影响运行效率；如果先判断当前logger的级别，如果级别不合适的话，连这句字符串连接都可以不做了。

slf4j-不需要冗长的级别判断

先传入带有占位符的字符串，同时把其他参数传入，在slf4j的内容部实现中，如果级别合适再去用传入的参数去替换字符串中的占位符，否则不用执行。
logger.info("{} is {}", new String[]{“x",“y"});

优秀博客地址：

https://blog.csdn.net/wu2374633583/article/details/79283407
https://blog.csdn.net/projectNo/article/details/79411464