springboot整合log4j2日志框架1

[一 log4j基本知识](#一 log4j基本知识)

[1.1 log4j的日志级别](#1.1 log4j的日志级别)

[1.2 log4j的日志文件结构*](#1.2 log4j的日志文件结构*)

[1.2.1 概述](#1.2.1 概述)

[1.2.2 详解](#1.2.2 详解)

[1.3 log4j的日志格式化api](#1.3 log4j的日志格式化api)

[1.3.1 api详解](#1.3.1 api详解)

[1.3.2 演示案例](#1.3.2 演示案例)

[1.3.3 演示案例](#1.3.3 演示案例)

[1.4 log4j中onmatch和onmismatch的区别*](#1.4 log4j中onmatch和onmismatch的区别*)

[1.4.1 案例](#1.4.1 案例)

[1.4.2 onmatch的api](#1.4.2 onmatch的api)

[1.5 logback，log4j2和slf4j的区别](#1.5 logback，log4j2和slf4j的区别)

[1.6 log4j2的异常日志格式配置](#1.6 log4j2的异常日志格式配置)

[1.7 log4j2的异步日志配置](#1.7 log4j2的异步日志配置)

[1.8 log4j2的日志滚动和过期策略配置](#1.8 log4j2的日志滚动和过期策略配置)

[1.9 log4j2设置颜色](#1.9 log4j2设置颜色)

[1.9.1 设置颜色](#1.9.1 设置颜色)

[1.9.2 设置颜色方式](#1.9.2 设置颜色方式)

[1.9.3 设置颜色案例](#1.9.3 设置颜色案例)

[1.10 log4j2的配置使用](#1.10 log4j2的配置使用)

[1.11 log4j2中includeLocation=true](#1.11 log4j2中includeLocation=true)

[1.12 log4j2中日志格式化和日志分片](#1.12 log4j2中日志格式化和日志分片)

[1.13 log4j2中排除包和依赖包](#1.13 log4j2中排除包和依赖包)

一 log4j基本知识

1 .1 log4j的日志级别

Log4j定义了8个级别的log（除去OFF和ALL，可以说分为6个级别），优先级从低到高 依次为： All，trace，debug，info，warn，error，fatal，off。

当日志级别设置为某个值的时候，低于它的日志信息将不会被记录，只有高于设置的级别的信息会被记录。

【ALL】：最低等级的，用于打开所有日志记录。

【Trace】：很低日志级别，一般很少使用

【Debug】：debug级别的主要输出调试性质的内容，该级别日志主要用于在开发、测试阶段输出，该级别的日志应尽可能地详尽，便于在开发、测试阶段出现问题或者异常时，对齐进行分析。

【Info】：INFO日志主要记录系统关键信息，旨在保留系统正常工作期间关键运行指标，开发人员可以将初始化系统配置、业务状态变化信息，或者用户业务流程中的核心处理记录到INFO日志中，方便日常运维工作以及错误回溯时上下文场景复现。建议在项目完成后，****在测试环境将日志级别调成 INFO，然后通过 INFO 级别的信息看看是否能了解这个应用的运用情况，****如果出现问题后是否这些日志能否提供有用的排查问题的信息。

【warn】：warn级别的主要输出警告性质的内容，这些内容是可以预知且是有规划的，比如，某个方法入参为空或者该参数的值不满足运行该方法的条件时，在warn级别时应输出较为详尽的信息，以便于事后对日志进行分析。

【error】：error级别主要对于一些不可预知的信息，如，错误，异常等，比如，在catch快中捕获的网络通信，数据库连接等异常，如果异常对系统的整个流程影响不大，可以使用warn级别日志输出。在输出error级别的日志时，尽量多地输出方法入参数、方法执行过程中产生的对象等数据，在带有错误、异常对象的数据时，需要将该对象一并输出。

【fatal】：指出每个严重的错误事件，将会导致应用程序的退出，这个级别比较高了。重大错误，这种级别你可以直接停止程序了。【1】https://blog.csdn.net/wsskl/article/details/137580290

【OFF】：最高等级的，用于关闭所有日志记录。

1 . 2 log4j的日志文件结构*

1.2.1 概述

Log4j的日志文件主要结构：Loggers(记录器)，Appenders (输出源)和Layouts(布局)。 这里可简单理解为日志类别，日志要输出的地方和日志以何种形式输出 。

1.properties：定义一些变量，如日志格式，路径等。

2.Appenders：定义日志输出的目标位置，如控制台，文件等。

3.Loggers：定义日志记录器，控制日志的输出级别和目标。

4.filters：定义过滤条件，控制日志输出。

其中<configuration>标签的status属性用于设置log4j2自身jar里代码的日志输出级别。将status设置为debug可以获得更详细的内部日志输出，这对于调试和问题排查非常有帮助。

5.完整的结构

1.2.2 详解

Loggers(记录器)：Loggers组件被分为7个级别，优先级从低到高 ：all、debug、info、warn、error、fatal、off。 任何一个级别只输出本级别以及它级别以上的级别内容。

Appends（输出源）：Log4j允许把日志输出到不同的地方，如控制台（Console）、文件（Files）等。

Layout（布局）：Layout的作用是控制Log信息的输出方式，也就是格式化输出的信息。

1根节点Configuration有两个属性 ：status和monitorinterval，有两个子节点：Appenders和Loggers(表明可以定义多个 Appender和Logger)：

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

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

2 . Appenders节点，常见的有三种子节点：Console、RollingFile、File：

1) Console节点用来定义输出到控制台的Appender

name：指定 Appender 的名字

target：SYSTEM_OUT 或SYSTEM_ERR，一般只设置默认：SYSTEM_OUT

PatternLayout：输出格式，不设置默认为%m%n

2)File节点用来定义输出到指定位置的文件的Appender

name：指定Appender的名字

fileName：指定输出日志的目的文件带全路径的文件名

PatternLayout：输出格式，不设置默认为%m%n

3) RollingFile节点用来定义超过指定大小自动删除旧的创建新的的Appender

name：指定Appender的名字

fileName：指定输出日志的目的文件带全路径的文件名

PatternLayout：输出格式，不设置默认为%m%n

filePattern：指定新建日志文件的名称格式

Policies：指定滚动日志的策略，就是什么时候进行新建日志文件输出日志

TimeBasedTriggeringPolicy：Policies子节点，基于时间的滚动策略，interval属性用来指定多久滚动一次，默认是1 hour。modulate=true用来调整时间：比如现在是早上3am，interval是4，那么第一次滚动是在4am，接着是8am，12am...而不是7am

SizeBasedTriggeringPolicy：Policies子节点，基于指定文件大小的滚动策略，size 属性用来定义每个日志文件的大小。

DefaultRolloverStrategy：用来指定同一个文件夹下最多有几个日志文件时开始删除最旧的，创建新的(通过max属性)。

3 . Loggers节点，常见的有两种Root和Logger：

1) root节点用来指定项目的根日志，如果没有单独指定 Logger，那么就会默认使用该 Root日志输出

level：日志输出级别，共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF

AppenderRef：Root的子节点，用来指定该日志输出到哪个Appender ，子节点的ref属性也就是前面的RollingFile中指定的name名称，子节点的level也是日志输出级别。

2) logger节点用来单独指定日志的形式，比如要为指定包下的class指定不同的日志级别等。 每个logger可以指定一个level（TRACE, DEBUG, INFO, WARN, ERROR, ALL or OFF），不指定时level默认为ERROR。

level：日志输出级别，共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF

name：用来指定该 Logger所适用的类或者类所在的包全路径,继承自 Root节点.

AppenderRef：Logger的子节点，用来指定该日志输出到哪个Appender，如果没有指定，就会默认继承自 Root 。如果指定了，那么会在指定的这个Appender和 Root的Appender中都会输出，此时我们可以设置 Logger的 additivity="false"只在自定义的 Appender中进行输出。

案例配置：

1 . 3 log4j的日志格式化api

1.3.1 api详解

log4j - 输出格式控制, PatternLayout参数含义以及详细配置 - frank_cui - 博客园

1.3.2 演示案例

1.查看 %l

查看%L

查看%L

3查看%msg

1.3.3 演示案例

%L，%line：显示日志输出的代码所在的行数。Log4j在输出行号时会检查堆栈信息，是耗时的操作。

%c{precision}，%logger{precision}:

logger名称，precision可以是一个正整数、负整数、"1."、"1.1.."、"."等格式，用于指定输出的logger的名称的层级和详细程度。

%C{precision}，%class{precision}：输出调用者的权限定类名，precision的规则与logger名称的用法相同。Log4j在输出类名时会检查堆栈信息，是耗时的操作，建议使用%c{precision}或%logger{precision}代替。

%d{pattern}，%date{pattern}：输出日志事件的时间，pattern经常包含若干对包含时间/日期格式（SimpleDateFormat）的花括号。

%m，%msg：输出应用中自定义的日志内容；

%M，%method：输出方法名。Log4j在输出行号时会检查堆栈信息，是耗时的操作；

%n：输出当前运行平台所用的换行符，一般放在末尾；

%p|level{level=label, level=label, ...}，%p|level{length=n}%p|level{lowerCase=true|false}：

输出日志的级别。可以每个日志级别指定别名，如%level{WARN=W, DEBUG=D, ERROR=E, TRACE=T, INFO=I}，%level{length=1}也可以实现同样的效果，如果length的值超过了日志级别的名称，那么使用正常的日志级别名称。

level=label和length=n可以组合使用，如%level{ERROR=Error, length=2}为ERROR级别指定了别名，为其他日志级别限定了长度。此外，还可以指定级别的大小写。

%T，%tid，%threadId：输出日志的线程号，非常有必要；

%t，%tn，%thread，%threadName： 输出日志的线程名称，类似于线程号作用相同，可选择其中一个。https://blog.csdn.net/qq_34253002/article/details/129821103

1 . 4 log4j中onmatch和onmismatch的区别*

1.4.1 案例

表示匹配级别info以上的则输出，info级别以下的不匹配则忽略。

1.4.2 onmatch的api

OnMatch和onMismatch都有3个属性值，分别为ACCEPT，deny和neutal

|---------------------------------------------------|---------------------------------------------|
| Onmatch | Onmismatch |
| Accept：匹配该级别以上 | Accept:匹配该级别以下 |
| Deny：不匹配该级别以上 | Deny：不匹配该级别以下 |
| Neutral：该级别以上的，由下一个filter处理，如果当前是最后一个，则表示匹配该级别以上。 | 该级别以及以下的，由下一个filter处理，如果当前是最后一个，则不匹配该级别以下的。 |

Log4j2的onMatch和onMismatch属性值详解-CSDN博客

在log4j2中，日志级别从低到高依次为： all，trace，debug，info，warn，error，fatal，off。

当设置onMismatch=neutal时，当前过滤器不会对日志事件做出接受或拒绝的决定，而是将事件传递给下一个过滤器处理，如果当前过滤器是最后一个 ，那么不匹配当前日志级别以下的事件将被忽略。

例如，第一个过滤器level设置为error且onmatch为deny，onmismatch=accept，这意味着会输出error以下级别（warn，info，debug，trace）的日志，

当onmismatch=netral，则这些日志事件会继续传递给下一个过滤器处理，而不是被当前过滤器直接处理或者忽略掉。

1 . 5 logback，log4j2和slf4j的区别

1)SLF4J : 是一个日志门面（抽象层），不是具体实现;提供统一的日志接口，允许用户在部署时选择不同的日志实现;支持多个日志实现：logback、log4j、java.util.logging等

****2)Log4j:****Apache的开源日志实现;Log4j 1.x已经停止维护;Log4j 2.x是完全重写的版本

3)Logback; Log4j创始人开发的新一代日志框架;作为Log4j的继承者，是SLF4J的原生实现。深入解析Java日志框架：Logback、Log4j 2与SLF4J的区别与使用指南_slf4j logback-CSDN博客4)推荐使用方案：

SLF4J + Logback（首选）
SLF4J + Log4j2（备选）

5）为什么选用log4j2

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

对于Java工程师来说，关于日志工具的使用，最佳实践就是在应用中使用。如****log4j2 + slf4j这样的组合来进行日志输出。这样做的最大好处，就是业务层的开发不需要关心底层日志框架的实现及细节，****在编码的时候也不需要考虑日后更换框架所带来的成本。这也是日志接口（门面模式）所带来的好处。

Log4j2使用详解

1 . 6 log4j2的异常日志格式配置

https://blog.csdn.net/sz85850597/article/details/120572827

1 . 7 log4j2的异步日志配置

https://blog.51cto.com/1936625305/11823448

1 . 8 log4j2的日志滚动和过期策略配置

|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|   <RollingRandomAccessFile name="FILE-INFO" fileName=" ${BASE_LOG_PATH}/$ {SERVER_NAME}/ ${SERVER_NAME}-info.log" filePattern="$ {BASE_LOG_PATH}/ ${SERVER_NAME}/$ {SERVER_NAME}-info.%d{yyyy-MM-dd}-%i.log.gz">  <LevelRangeFilter minLevel="WARN" maxLevel="DEBUG" onMatch="ACCEPT" onMismatch="DENY"/>  <PatternLayout pattern=" ${PATTERN}" charset="$ {CHARSET}" /> <Policies>  <TimeBasedTriggeringPolicy interval="1"/>  <SizeBasedTriggeringPolicy size="10KB"/> </Policies>    <DefaultRolloverStrategy fileIndex="nomax">   <Delete basePath=" ${BASE_LOG_PATH}/$ {SERVER_NAME}" maxDepth="2">  <IfFileName glob="*-info.*.log.gz"/>   <IfLastModified age="P1D"/> </Delete> </DefaultRolloverStrategy> </RollingRandomAccessFile> |

详细配置：https://blog.51cto.com/1936625305/11823448

1 . 9 log4j2设置颜色

1.9.1 设置颜色

SpringBoot整合Log4j2日志框架 - Evan1024 - 博客园整个log4j2框架

1.9.2 设置颜色方式

修改日志配置中pattern属性，通过%style{xxxx}{styleValue1,styleValue2}和%highlight{}可以很容易修改日志样式。设置属性disableAnsi为false,表示开启Ansi，这样才会输出有样式的日志。

https://mp.weixin.qq.com/s/jN9h2FjSQKPXv8mkShkJ_g

方式1：style{pattern}{ANSI style}

%style{%d{ISO8601}}{black} %style{[%t]}{blue} %style{%-5level:}{yellow} %style{%msg%n%throwable}{green}

方式2：highlight{pattern}{style}

%highlight{%d [%t] %-5level: %msg%n%throwable}

%highlight{%d [%t] %-5level: %msg%n%throwable}{STYLE=Logback}

1.9.3 设置颜色案例

%style{%throwable}{red} 异常信息标红色

案例截图如下：https://mp.weixin.qq.com/s/yYzFN7OTMh9IO8x_LaGLWg

1 . 10 log4j2的配置使用

https://cloud.tencent.com/developer/article/2332025

使用了Lombok提供的@Log4j2注解，自动生成了一个名为log的Logger对象。在类中的方法中通过log对象记录了相应的日志信息。

1 . 11 log4j2中includeLocation=true

在includeLocation=true的作用确保日志输出中包含类的路径和行号信息，对于调式和定位问题非常有帮助。如下图

|---------------------------------------------------------------------------------|
| <AsyncLogger name="st" level="debug" includeLocation="true"> </AsyncLogger> |

当设置为false时，不再输出行号信息。

1 . 12 log4j2中日志格式化和日志分片

1.日志格式化

2.日志分片：https://mp.weixin.qq.com/s/-a3tvoOo_3ppX68fP92FOA

1 . 13 log4j2中排除包和依赖包

1.排除包

log4j与log4j2性能对比及log4j升级至log4j2方案

2.新增包

3.框架对应的包名

在log4j版本，Logger的包路径是org.apache.log4j。

在log4j2版本，Logger的包路径是org.apache.logging.log4j

4替换日志配置文件。

在log4j版本，配置文件为log4j.xml或者log4j.properties。

在log4j2版本，配置文件为log4j2.xml。