Springboot整合log4j2日志全解总结

在项目推进中，如果说第一件事是搭spring框架的话，那么第二件事情就是在sring基础上搭建日志框架，我想很多人都知道日志对于一个项目的重要性，尤其是线上web项目，因为日志可能是我们了解应用如何执行的唯一方式。 在18年大环境下，更多的企业使用springboot和springcloud来搭建他们的企业微服务项目 ，此篇文章是博主在实践中用springboot整合log4j2日志的总结。

常用日志框架

• java.util.logging：是jdk在1.4版本中引入的java原生日志框架
• log4j：apache的一个开源项目，可以控制日志信息输送的目的地是控制台、文件、gui组件等，可以控制每一条日志的输出格式，这些可以通过一个配置文件来灵活地进行配置，而不需要修改应用的代码。虽然已经停止维护了，但目前绝大部分企业都是用的log4j。
• logback：是log4j的一个改良版本
• log4j2：log4j2已经不仅仅是log4j的一个升级版本了，它从头到尾都被重写了
  

日志门面slf4j

上述介绍的是一些日志框架的实现，这里我们需要用日志门面来解决系统与日志实现框架的耦合性。slf4j，即简单日志门面（simple logging facade for java），它不是一个真正的日志实现，而是一个抽象层（ abstraction layer），它允许你在后台使用任意一个日志实现。

前面介绍的几种日志框架一样，每一种日志框架都有自己单独的api，要使用对应的框架就要使用其对应的api，这就大大的增加应用程序代码对于日志框架的耦合性。

使用了slf4j后，对于应用程序来说，无论底层的日志框架如何变，应用程序不需要修改任意一行代码，就可以直接上线了。

为什么选用log4j2

相比与其他的日志系统，log4j2丢数据这种情况少；disruptor技术，在多线程环境下，性能高于logback等10倍以上；利用jdk1.5并发的特性，减少了死锁的发生；

在这列举一下一些网上其他博文中对它们的性能评测：

 

可以看到在同步日志模式下, logback的性能是最糟糕的. log4j2的性能无论在同步日志模式还是异步日志模式下都是最佳的.

log4j2优越的性能其原因在于log4j2使用了lmax,一个无锁的线程间通信库代替了,logback和log4j之前的队列. 并发性能大大提升。

整合步骤

引入jar包

springboot默认是用logback的日志框架的，所以需要排除logback，不然会出现jar依赖冲突的报错。

<dependency> 
 <groupid>org.springframework.boot</groupid> 
 <artifactid>spring-boot-starter-web</artifactid> 
 <exclusions><!-- 去掉springboot默认配置 --> 
  <exclusion> 
   <groupid>org.springframework.boot</groupid> 
   <artifactid>spring-boot-starter-logging</artifactid> 
  </exclusion> 
 </exclusions> 
</dependency> 

<dependency> <!-- 引入log4j2依赖 --> 
 <groupid>org.springframework.boot</groupid> 
 <artifactid>spring-boot-starter-log4j2</artifactid> 
</dependency> 

配置文件

如果自定义了文件名，需要在application.yml中配置

logging:
 config: xxxx.xml
 level:
 cn.jay.repository: trace

默认名log4j2-spring.xml，就省下了在application.yml中配置

配置文件模版

log4j是通过一个.properties的文件作为主配置文件的，而现在的log4j2则已经弃用了这种方式，采用的是.xml，.json或者.jsn这种方式来做，可能这也是技术发展的一个必然性，因为properties文件的可阅读性真的是有点差。

<?xml version="1.0" encoding="utf-8"?>
<!--configuration后面的status，这个用于设置log4j2自身内部的信息输出，可以不设置，当设置成trace时，你会看到log4j2内部各种详细输出-->
<!--monitorinterval：log4j能够自动检测修改配置 文件和重新配置本身，设置间隔秒数-->
<configuration monitorinterval="5">
 <!--日志级别以及优先级排序: off > fatal > error > warn > info > debug > trace > all -->

 <!--变量配置-->
 <properties>
 <!-- 格式化输出：%date表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度 %msg：日志消息，%n是换行符-->
 <!-- %logger{36} 表示 logger 名字最长36个字符 -->
 <property name="log_pattern" value="%date{hh:mm:ss.sss} [%thread] %-5level %logger{36} - %msg%n" />
 <!-- 定义日志存储的路径，不要配置相对路径 -->
 <property name="file_path" value="更换为你的日志路径" />
 <property name="file_name" value="更换为你的项目名" />
 </properties>

 <appenders>

 <console name="console" target="system_out">
  <!--输出日志的格式-->
  <patternlayout pattern="${log_pattern}"/>
  <!--控制台只输出level及其以上级别的信息（onmatch），其他的直接拒绝（onmismatch）-->
  <thresholdfilter level="info" onmatch="accept" onmismatch="deny"/>
 </console>

 <!--文件会打印出所有信息，这个log每次运行程序会自动清空，由append属性决定，适合临时测试用-->
 <file name="filelog" filename="${file_path}/test.log" append="false">
  <patternlayout pattern="${log_pattern}"/>
 </file>

 <!-- 这个会打印出所有的info及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
 <rollingfile name="rollingfileinfo" filename="${file_path}/info.log" filepattern="${file_path}/${file_name}-info-%d{yyyy-mm-dd}_%i.log.gz">
  <!--控制台只输出level及以上级别的信息（onmatch），其他的直接拒绝（onmismatch）-->
  <thresholdfilter level="info" onmatch="accept" onmismatch="deny"/>
  <patternlayout pattern="${log_pattern}"/>
  <policies>
  <!--interval属性用来指定多久滚动一次，默认是1 hour-->
  <timebasedtriggeringpolicy interval="1"/>
  <sizebasedtriggeringpolicy size="10mb"/>
  </policies>
  <!-- defaultrolloverstrategy属性如不设置，则默认为最多同一文件夹下7个文件开始覆盖-->
  <defaultrolloverstrategy max="15"/>
 </rollingfile>

 <!-- 这个会打印出所有的warn及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
 <rollingfile name="rollingfilewarn" filename="${file_path}/warn.log" filepattern="${file_path}/${file_name}-warn-%d{yyyy-mm-dd}_%i.log.gz">
  <!--控制台只输出level及以上级别的信息（onmatch），其他的直接拒绝（onmismatch）-->
  <thresholdfilter level="warn" onmatch="accept" onmismatch="deny"/>
  <patternlayout pattern="${log_pattern}"/>
  <policies>
  <!--interval属性用来指定多久滚动一次，默认是1 hour-->
  <timebasedtriggeringpolicy interval="1"/>
  <sizebasedtriggeringpolicy size="10mb"/>
  </policies>
  <!-- defaultrolloverstrategy属性如不设置，则默认为最多同一文件夹下7个文件开始覆盖-->
  <defaultrolloverstrategy max="15"/>
 </rollingfile>

 <!-- 这个会打印出所有的error及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
 <rollingfile name="rollingfileerror" filename="${file_path}/error.log" filepattern="${file_path}/${file_name}-error-%d{yyyy-mm-dd}_%i.log.gz">
  <!--控制台只输出level及以上级别的信息（onmatch），其他的直接拒绝（onmismatch）-->
  <thresholdfilter level="error" onmatch="accept" onmismatch="deny"/>
  <patternlayout pattern="${log_pattern}"/>
  <policies>
  <!--interval属性用来指定多久滚动一次，默认是1 hour-->
  <timebasedtriggeringpolicy interval="1"/>
  <sizebasedtriggeringpolicy size="10mb"/>
  </policies>
  <!-- defaultrolloverstrategy属性如不设置，则默认为最多同一文件夹下7个文件开始覆盖-->
  <defaultrolloverstrategy max="15"/>
 </rollingfile>

 </appenders>

 <!--logger节点用来单独指定日志的形式，比如要为指定包下的class指定不同的日志级别等。-->
 <!--然后定义loggers，只有定义了logger并引入的appender，appender才会生效-->
 <loggers>

 <!--过滤掉spring和mybatis的一些无用的debug信息-->
 <logger name="org.mybatis" level="info" additivity="false">
  <appenderref ref="console"/>
 </logger>
 <!--监控系统信息-->
 <!--若是additivity设为false，则 子logger 只会在自己的appender里输出，而不会在 父logger 的appender里输出。-->
 <logger name="org.springframework" level="info" additivity="false">
  <appenderref ref="console"/>
 </logger>

 <root level="info">
  <appender-ref ref="console"/>
  <appender-ref ref="filelog"/>
  <appender-ref ref="rollingfileinfo"/>
  <appender-ref ref="rollingfilewarn"/>
  <appender-ref ref="rollingfileerror"/>
 </root>
 </loggers>

</configuration>

配置参数简介

在这里简单介绍下常用的配置参数

日志级别

• 机制：如果一条日志信息的级别大于等于配置文件的级别，就记录。
• trace：追踪，就是程序推进一下，可以写个trace输出
• debug：调试，一般作为最低级别，trace基本不用。
•  info：输出重要的信息，使用较多
• warn：警告，有些信息不是错误信息，但也要给程序员一些提示。
• error：错误信息。用的也很多。
• fatal：致命错误。

输出源

•  console（输出到控制台）
• file（输出到文件）

格式

• simplelayout：以简单的形式显示
• htmllayout：以html表格显示
• patternlayout：自定义形式显示

patternlayout自定义日志布局：

%d{yyyy-mm-dd hh:mm:ss, sss} : 日志生产时间,输出到毫秒的时间
%-5level : 输出日志级别，-5表示左对齐并且固定输出5个字符，如果不足在右边补0
%c : logger的名称(%logger)
%t : 输出当前线程名称
%p : 日志输出格式
%m : 日志内容，即 logger.info("message")
%n : 换行符
%c : java类名(%f)
%l : 行号
%m : 方法名
%l : 输出语句所在的行数, 包括类名、方法名、文件名、行数
hostname : 本地机器名
hostaddress : 本地ip地址

log4j2配置详解

根节点configuration

有两个属性:

• status
• monitorinterval

有两个子节点:

• appenders
• loggers(表明可以定义多个appender和logger).

status用来指定log4j本身的打印日志的级别.

monitorinterval用于指定log4j自动重新配置的监测间隔时间，单位是s,最小是5s.

appenders节点

常见的有三种子节点:console、rollingfile、file

console节点用来定义输出到控制台的appender.

•  name:指定appender的名字.
• target:system_out 或 system_err,一般只设置默认:system_out.
• patternlayout:输出格式，不设置默认为:%m%n.

 file节点用来定义输出到指定位置的文件的appender.

•  name:指定appender的名字.
• filename:指定输出日志的目的文件带全路径的文件名.
• patternlayout:输出格式，不设置默认为:%m%n.

 rollingfile节点用来定义超过指定条件自动删除旧的创建新的appender.

• name:指定appender的名字.
• filename:指定输出日志的目的文件带全路径的文件名.
• patternlayout:输出格式，不设置默认为:%m%n.
• filepattern : 指定当发生rolling时，文件的转移和重命名规则.
• policies:指定滚动日志的策略，就是什么时候进行新建日志文件输出日志.
• timebasedtriggeringpolicy:policies子节点，基于时间的滚动策略，interval属性用来指定多久滚动一次，默认是1 hour。modulate=true用来调整时间：比如现在是早上3am，interval是4，那么第一次滚动是在4am，接着是8am，12am...而不是7am.
• sizebasedtriggeringpolicy:policies子节点，基于指定文件大小的滚动策略，size属性用来定义每个日志文件的大小.
• defaultrolloverstrategy:用来指定同一个文件夹下最多有几个日志文件时开始删除最旧的，创建新的(通过max属性)。

loggers节点，常见的有两种:root和logger.

• root节点用来指定项目的根日志，如果没有单独指定logger，那么就会默认使用该root日志输出
• level:日志输出级别，共有8个级别，按照从低到高为：all < trace < debug < info < warn < error < appenderref：root的子节点，用来指定该日志输出到哪个appender.
• logger节点用来单独指定日志的形式，比如要为指定包下的class指定不同的日志级别等。
• level:日志输出级别，共有8个级别，按照从低到高为：all < trace < debug < info < warn < error < fatal < off.
• name:用来指定该logger所适用的类或者类所在的包全路径,继承自root节点.
• appenderref：logger的子节点，用来指定该日志输出到哪个appender,如果没有指定，就会默认继承自root.如果指定了，那么会在指定的这个appender和root的appender中都会输出，此时我们可以设置logger的additivity="false"只在自定义的appender中进行输出。

简单使用

public class logexampleother {
 private static final org.slf4j.logger log = org.slf4j.loggerfactory.getlogger(logexampleother.class);
 
 public static void main(string... args) {
 log.error("something else is wrong here");
 }
}

使用lombok工具简化创建logger类

lombok就是一个注解工具jar包，能帮助我们省略一繁杂的代码。具体介绍可以看我的。

使用lombok后下面的代码等效于上述的代码，这样会更方便的使用日志。

@slf4j
public class logexampleother {
 
 public static void main(string... args) {
 log.error("something else is wrong here");
 }
}

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。