SpringBoot之log4j

什么是log4j？

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

Logger

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

其中重要的是name和additivity。

name :定义了logger的层级，如x.y 表示两层，x层和y层，x是y的父层级，x.y所在层级是y层级。additivity：默认为true，表示当前logger将打印日志到当前的appender及所有的父层级所指定的appender；false 为只打到当前自己的appender

日志记录器	添加的输出源	附加特性标识	输出目标	评论
root	A1	not applicable	A1	根日志记录器是匿名的，但是可以用Logger.getRootLogger()方法来存取。根日志记录器没有默认输出源。
x	A-x1, A-x2	true	A1, A-x1, A-x2	x和根的输出源
x.y	none	true	A1, A-x1, A-x2	x和根的输出源
x.y.z	A-xyz1	true	A1, A-x1, A-x2, A-xyz1	x.y.z 、x和根的输出源
security	A-sec	false	A-sec	由于附加标识被设置为false，没有输出源聚集
security.access	none	true	A-sec	由于安全中附加标识被设置为false，所以仅仅有安全的输出源。

Appender

允许把日志输出到不同的地方，常使用的类包括：

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

ConsoleAppender选项：

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

org.apache.log4j.FileAppender（文件）

FileAppender选项：

Threshold=WARN：指定日志信息的最低输出级别，默认为DEBUG。
ImmediateFlush=true：表示所有消息都会被立即输出，设为false则不输出，默认值是true。
Append=false：true表示消息增加到指定文件中，false则将消息覆盖指定的文件内容，默认值是true。
File=D:/logs/logging.log4j：指定当前消息输出到logging.log4j文件中。
DatePattern=’.’yyyy-MM：每月滚动一次日志文件，即每月产生一个新的日志文件。当前月的日志文件名为system.log，前一个月的日志文件名为system.log.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：每分钟
org.apache.log4j.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则可以产生system.log.1，system.log.2两个滚动文件和一个system.log文件。
org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）

Layouts

用户希望根据自己的喜好格式化自己的日志输出，Log4j可以在Appenders的后面附加Layouts来完成这个功能。常使用的类如下：

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

LocationInfo=true：输出java文件名称和行号，默认值是false。
Title=My Logging：默认值是Log4J Log Messages。

org.apache.log4j.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这样的多客户多线程的应用中。
%%：输出一个”%”字符。
另外，还可以在%与格式字符之间加上修饰符来控制其最小长度、最大长度、和文本的对齐方式。如：
1) c：指定输出category的名称，最小的长度是20，如果category的名称长度小于20的话，默认的情况下右对齐。
2)%-20c：”-“号表示左对齐。
3)%.30c：指定输出category的名称，最大的长度是30，如果category的名称长度大于30的话，就会将左边多出的字符截掉，但小于30的话也不会补空格。
org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串）
org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等信息）

如何使用log4j?

以我在项目中使用为例

xml形式

<appender name="systemLogAppender" class="org.apache.log4j.DailyRollingFileAppender">
        <param name="File" value="/system.log" />
        <param name="DatePattern" value="'.'yyyy-MM-dd" />
        <param name="Append" value="true" />
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="%-d{HH:mm:ss} %-5p [%t] %C(%F:%L) - %m%n" />
        </layout>
    </appender>
<appender name="consoleAppender" class="org.apache.log4j.ConsoleAppender">
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern"
                   value="%-d{yyyy-MM-dd HH:mm:ss,SSS} [[%t]] %-5p [%c] (%C:%L) - %m%n" />
        </layout>
    </appender>
<logger name="tech.luckylau" additivity="false">
        <level value="INFO" />
        <appender-ref ref="systemLogAppender" />
    </logger>
 <root>
      <priority value="WARN" />
      <appender-ref ref="consoleAppender" />
 </root>

log4j.properties形式

log4j.rootLogger=WARN, consoleAppender
log4j.appender.consoleAppender=org.apache.log4j.ConsoleAppender
log4j.appender.consoleAppender.layout=org.apache.log4j.PatternLayout
log4j.appender.consoleAppender.layout.ConversionPattern=%-d{yyyy-MM-dd HH:mm:ss,SSS} [[%t]] %-5p [%c] (%C:%L) - %m%n
log4j.logger.tech.luckylau=Info,systemLogAppender
log4j.additivity.tech.luckylau=false
log4j.appender.systemLogAppender=org.apache.log4j.DailyRollingFileAppender
log4j.appender.systemLogAppender.File=/system.log
log4j.appender.systemLogAppender.DatePattern='.'yyyy-MM-dd
log4j.appender.systemLogAppender.Append=true
log4j.appender.systemLogAppender.layout=org.apache.log4j.PatternLayout
log4j.appender.systemLogAppender.layout.ConversionPattern=%-d{HH:mm:ss} %-5p [%t] %C(%F:%L) - %m%n

如何自定义appender?

比如有个需求，使用DailyRollingFileAppender时，错误打印频繁如何限速？这时候可以自定义appender。这里是用ratelimter限速。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j</artifactId>
</dependency>
<dependency>
     <groupId>com.google.guava</groupId>
     <artifactId>guava</artifactId>
     <version>23.0</version>
 </dependency>

public class RateLimiterDailyRollingFileAppender extends DailyRollingFileAppender {
    private final RateLimiter rateLimiter = rateLimiter = RateLimiter.create(0.5);
    @Override
    protected void subAppend(LoggingEvent event) {
        Level level = event.getLevel();
        /**
         * 处理error
         */
        if(level != null && level.getSyslogEquivalent() == 3){
            if(rateLimiter.tryAcquire()){
                super.subAppend(event);
            }
            return;
        }
        super.subAppend(event);
    }
}

参考：

Log4j DailyRollingFileAppender源码详读

Log4J日志配置详解

支持设置最大日志数量的DailyRollingFileAppender