混乱的JAVA日志体系

曾经终败给现在 2023-05-21 15:10 20阅读 0赞

> [https://blog.csdn.net/millmanxh/article/details/9835391][https_blog.csdn.net_millmanxh_article_details_9835391]

--------------------

# 1 日志门面和日志实现 #

> 当我们的系统变的更加复杂的时候，我们的日志就容易发生混乱；随着系统开发的进行，可能会更新不同的日志框架，造成当前系统中存在不同的日志依赖，让我们难以统一的管理和控制；就算我们强制要求所有的模块使用相同的日志框架，系统中也难以避免使用其他类似spring，mybatis等其他的第三方框架，它们依赖于我们规定不同的日志框架，而且他们自身的日志系统就有着不一致性，依然会出来日志体系的混乱
> 
> 所以我们需要借鉴JDBC的思想，为日志系统也提供一套门面，那么我们就可以面向这些接口规范来开发，避免了直接依赖具体的日志框架；这样我们的系统在日志中，就存在了日志的门面和日志的实现

<table> 
 <thead> 
  <tr> 
   <th style="width:482px;">日志门面 （日志的抽象层）</th> 
   <th style="width:422px;">日志实现</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td style="width:482px;"> <p><span style="color:#f33b45;">slf4j</span>（Simple Logging Facade for Java）</p> <p>JCL（Jakarta Commons Logging）</p> <p>jboss-logging</p> </td> 
   <td style="width:422px;"> <p><span style="color:#f33b45;">logback</span></p> <p><span style="color:#f33b45;">log4j2</span></p> <p>JUL（java util logging）</p> <p>log4j</p> </td> 
  </tr> 
 </tbody> 
</table>

> 日志框架出现的历史顺序：log4j --> JUL --> JCL --> slf4j --> logback --> log4j2  
> 
> slf4j、log4j、logback出至同一人之手（Ceki Gülcü）；Ceki Gülcü将log4j捐献给了Apache软件基金会，使之成为了Apache日志服务的一个子项目，并且作者也在Apache工作了一段时间；由于log4j存在性能问题作者放弃维护log4j，开发了新的日志框架 slf4j \+ logback；由于log4j相对于slf4j+logback没有任何优势Apache慌了（此时Ceki Gülcü自己创建了公司），赶紧对log4j进行升级也就是后面的log4j2

> JCL全称为Jakarta Commons Logging，是**Apache**提供的一个通用日志API；它是为 "所有的Java日志实现"提供一个统一的接口，它自身也提供一个日志的实现，但是功能非常常弱 （SimpleLog）；所以一般不会单独使用它；他允许开发人员使用不同的具体日志实现工具Log4j、Jdk自带的日志（JUL)
> 
> --------------------
> 
> SLF4J简单日志门面(Simple Logging Facade For Java) SLF4J主要是为了给Java日志访问提供一套标准、规范 的API框架，其主要意义在于提供接口，具体的实现可以交由其他日志框架，例如log4j和logback等； 当然slf4j自己也提供了功能较为简单的实现，但是一般很少用到；对于一般的Java项目而言，日志框架 会选择slf4j-api作为门面，配上具体的实现框架（log4j、logback等），中间使用桥接器完成桥接

> JUL全称Java util Logging是**java原生**的日志框架，使用时不需要另外引用第三方类库，相对其他日志框 架使用方便，学习简单，能够在小型应用中灵活使用
> 
> --------------------
> 
> log4j是**Apache**下的一款开源的日志框架，通过在项目中使用 Log4J，我们可以控制日志信息输出到控制台、文件、甚至是数据库中；我们可以控制每一条日志的输出格式，通过定义日志的输出级别，可以 更灵活的控制日志的输出过程；方便项目的调试
> 
> --------------------
> 
> log4j2是对**log4j**的升级版，参考了logback的一些优秀的设计，并且修复了一些问题，因此带来了一些重大的提升
> 
> 1.  **异常处理** : 在logback中，Appender中的异常不会被应用感知到，但是在log4j2中，提供了一些异常处理机制
> 2.  **性能提升** : log4j2相较于log4j和logback都具有很明显的性能提升
> 3.  **自动重载配置** : 参考了logback的设计，当然会提供自动刷新参数配置，最实用的就是我们在生产上可以动态的修改日志的级别而不需要重启应用
> 4.  **无垃圾机制** : log4j2在大部分情况下，都可以使用其设计的一套无垃圾机制，避免频繁的日志收集导致的jvm gc

--------------------

# 2 SLF4j和其他日志框架的整合 #

> [http://slf4j.org/manual.html][http_slf4j.org_manual.html]

## 2.1 整合原理 ##

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNzk0OTcz_size_16_color_FFFFFF_t_70][]

> 每一个日志的实现框架都有自己的配置文件；使用**slf4j**以后**配置文件还是做成日志实现框架自己本身的配置文件**

import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    public class HelloWorld {
      public static void main(String[] args) {
        Logger logger = LoggerFactory.getLogger(HelloWorld.class);
        logger.info("Hello World");
      }
    }

## 2.2 遗留问题 ##

> [http://slf4j.org/legacy.html][http_slf4j.org_legacy.html]

> 当我们项目有多个框架的时候，每个框架使用的日志不一样；比如 a(slf4j+logback)、 Spring(commons-logging)、Hibernate(jboss-logging)、MyBatis、xxxx；采用桥接旧的日志框架即可实习统一使用slf4j进行日志输出

> 如何让系统中所有的日志都统一到**slf4j**
> 
> 1.  将系统中其他日志框架先排除出去
> 2.  用中间包来替换原有的日志框架（中间包和原有的日志框架一模一样，只是具体调用的时候调用的是**slf4j**）
> 3.  为项目添加**slf4j**的具体实现

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNzk0OTcz_size_16_color_FFFFFF_t_70 1][]

--------------------

# 3 SpringBoot与日志 #

## 3.1 SpringBoot默认日志原理 ##

> 1.  SpringBoot底层使用**slf4j****+****logback**方式进行日志记录
> 2.  SpringBoot也把其他的日志都替换成了**slf4j**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNzk0OTcz_size_16_color_FFFFFF_t_70 2][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNzk0OTcz_size_16_color_FFFFFF_t_70 3][]

![2020041719170846.png][] Spring框架默认是用JCL（Jakarta Commons Logging）

//比如中间替换包 ：jcl-over-slf4j
    package org.apache.commons.logging;
    public abstract class LogFactory {
        //偷梁换柱
        static LogFactory logFactory = new SLF4JLogFactory();

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNzk0OTcz_size_16_color_FFFFFF_t_70 4][]

<dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-core</artifactId>
        <exclusions>
            <exclusion>
                <groupId>commons-logging</groupId>
                <artifactId>commons-logging</artifactId>
            </exclusion>
        </exclusions>
    </dependency>

> SpringBoot能自动适配所有的日志，而且底层使用**slf4j**\+**logback**的方式记录日志，引入其他框架的时候，只需要把这个框架依赖的日志框架排除掉即可

## 3.2 SpringBoot日志框架的使用 ##

@SpringBootTest
    @RunWith(SpringRunner.class)
    public class LogApplicationTests {
        //记录器 org.slf4j.Logger org.slf4j.LoggerFactory
        Logger logger = LoggerFactory.getLogger(getClass());
        /**
         * 日志的级别 : trace < debug < info < warn < error
         * 调整输出的日志级别 : 日志就只会在这个级别以后的高级别生效
         */
        @Test //org.junit.Test;
        public void contextLoads() {
            logger.trace("这是trace日志..."); //跟踪轨迹
            logger.debug("这是debug日志..."); //调试
            //SpringBoot默认给我们使用的是info级别的，没有指定级别的就用SpringBoot默认规定的级别（root级别）
            logger.info("这是info日志...");
            logger.warn("这是warn日志...");
            logger.error("这是error日志...");
        }

> springboot 设置指定包的日志级别

logging.level.com.nobug=trace

logging:
      level:
        com.nobug: trace

>  springboot 设置输出路径

# 指定日志文件存放的目录（Windows为当前项目所在目录的根路径），默认的文件名 spring.log
    logging.file.path=/logs/springboot/

> springboot 设置日志输出格式

# 在控制台输出的日志的格式
    logging.pattern.console=%d{yyyy-MM-dd} [%thread] %-5level %logger{50} - %msg%n
    # 指定文件中日志输出的格式
    logging.pattern.file=%d{yyyy-MM-dd} - [%thread] - %-5level - %logger{50} - %msg%n

## 3.3 使用自定义日志配置文件 ##

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNzk0OTcz_size_16_color_FFFFFF_t_70 5][]

//org.springframework.boot.logging.LoggingSystemProperties
    class LoggingSystemProperties {
        //LoggingApplicationListener就是配置文件配置的（点击配置文件即可进入）
        static final String EXCEPTION_CONVERSION_WORD = LoggingApplicationListener.EXCEPTION_CONVERSION_WORD;
        public void apply(LogFile logFile) {
            RelaxedPropertyResolver propertyResolver = RelaxedPropertyResolver.ignoringUnresolvableNestedPlaceholders(this.environment,     "logging.");
            setSystemProperty(propertyResolver, EXCEPTION_CONVERSION_WORD,"exception-conversion-word");
            setSystemProperty(PID_KEY, new ApplicationPid().toString());
            setSystemProperty(propertyResolver, CONSOLE_LOG_PATTERN, "pattern.console");
            setSystemProperty(propertyResolver, FILE_LOG_PATTERN, "pattern.file");
            setSystemProperty(propertyResolver, LOG_LEVEL_PATTERN, "pattern.level");
            if (logFile != null) {
    	    logFile.applyToSystemProperties();
            }
        }

> [https://docs.spring.io/spring-boot/docs/2.1.14.BUILD-SNAPSHOT/reference/html/boot-features-logging.html][https_docs.spring.io_spring-boot_docs_2.1.14.BUILD-SNAPSHOT_reference_html_boot-features-logging.html]
> 
> [https://docs.spring.io/spring-boot/docs/2.1.14.BUILD-SNAPSHOT/reference/html/boot-features-logging.html\#boot-features-custom-log-configuration][https_docs.spring.io_spring-boot_docs_2.1.14.BUILD-SNAPSHOT_reference_html_boot-features-logging.html_boot-features-custom-log-configuration]
> 
> 给类路径下放上每个日志框架自己的配置文件即可；SpringBoot就**不使用**它**默认配置**的了

<table> 
 <thead> 
  <tr> 
   <th>Logging System</th> 
   <th>Customization</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td style="vertical-align:top;"> <p>Logback</p> </td> 
   <td style="vertical-align:top;"> <p><code>logback-spring.xml</code>,&nbsp;<code>logback-spring.groovy</code>,&nbsp;<code>logback.xml</code>, or&nbsp;<code>logback.groovy</code></p> </td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;"> <p>Log4j2</p> </td> 
   <td style="vertical-align:top;"> <p><code>log4j2-spring.xml</code>&nbsp;or&nbsp;<code>log4j2.xml</code></p> </td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;"> <p>JDK (Java Util Logging)</p> </td> 
   <td style="vertical-align:top;"> <p><code>logging.properties</code></p> </td> 
  </tr> 
 </tbody> 
</table>

> 使用logback.xml直接就被日志框架识别了；使用**logback-spring.xml**日志框架就不直接加载日志的配置项，由SpringBoot解析日志配置，可以使用SpringBoot的高级Profile功能

spring:
      profiles:
        active: dev

<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
        <layout class="ch.qos.logback.classic.PatternLayout">
        <springProfile name="dev">
            <pattern>开发环境输出格式</pattern>
        </springProfile>
        <springProfile name="!dev">
            <pattern>非开发环境输出格式</pattern>
        </springProfile>
        </layout>
    </appender>

> 如果使用logback.xml作为日志配置文件，还要使用profile功能会有以下错误 `no applicable action for [springProfile]`

> logback.xml

<?xml version="1.0" encoding="UTF-8"?>
    <configuration>
        <property name="pattern" value="[%-5level] %d{yyyy-MM-dd HH:mm:ss.SSS} %c %M %L [%thread] %m%n"/>
        <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
            <target>System.err</target>
            <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
                <pattern>${pattern}</pattern>
            </encoder>
        </appender>
        <logger name="com.nobug" level="trace" additivity="false">
            <appender-ref ref="console"/>
        </logger>
    </configuration>

## 3.4 切换日志框架 ##

### 3.4.1 slf4j + log4j ###

> [http://slf4j.org/images/legacy.png][http_slf4j.org_images_legacy.png]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNzk0OTcz_size_16_color_FFFFFF_t_70 6][]

<properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.10.RELEASE</version>
        <relativePath/>
    </parent>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <exclusions>
                <exclusion>
                    <artifactId>logback-classic</artifactId>
                    <groupId>ch.qos.logback</groupId>
                </exclusion>
                <exclusion>
                    <artifactId>log4j-over-slf4j</artifactId>
                    <groupId>org.slf4j</groupId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-log4j12</artifactId>
        </dependency>
    </dependencies>

<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.6.RELEASE</version>
        <relativePath/>
    </parent>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <exclusions>
                <exclusion>
                    <artifactId>logback-classic</artifactId>
                    <groupId>ch.qos.logback</groupId>
                </exclusion>
                <exclusion>
                    <artifactId>log4j-to-slf4j</artifactId>
                    <groupId>org.apache.logging.log4j</groupId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-log4j12</artifactId>
        </dependency>
    </dependencies>

> log4j.properties

log4j.rootLogger = debug,stdout
    ### 输出信息到控制抬 ###
    log4j.appender.stdout = org.apache.log4j.ConsoleAppender
    log4j.appender.stdout.Target = System.out
    log4j.appender.stdout.layout = org.apache.log4j.PatternLayout
    log4j.appender.stdout.layout.ConversionPattern = [%-5p] %d{yyyy-MM-dd HH:mm:ss,SSS} method:%l%n%m%n

### 3.4.2 切换为log4j2  ###

> [https://docs.spring.io/spring-boot/docs/2.1.14.BUILD-SNAPSHOT/reference/html/using-boot-build-systems.html\#using-boot-starter][https_docs.spring.io_spring-boot_docs_2.1.14.BUILD-SNAPSHOT_reference_html_using-boot-build-systems.html_using-boot-starter]

<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.2.RELEASE</version>
        <relativePath/>
    </parent>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            
            <exclusions>
                <exclusion>
                    <artifactId>spring-boot-starter-logging</artifactId>
                    <groupId>org.springframework.boot</groupId>
                </exclusion>
            </exclusions>
        </dependency>
        
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-log4j2</artifactId>
        </dependency>
    </dependencies>

> log4j2.xml

<?xml version="1.0" encoding="UTF-8"?>
    <Configuration status="debug" monitorInterval="5">
        <Appenders>
            <Console name="console" target="SYSTEM_ERR">
                <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] [%-5level] %c{36}:%L %m%n"/>
            </Console>
        </Appenders>
        <Loggers>
            <Root level="trace">
                <AppenderRef ref="console"/>
            </Root>
        </Loggers>
    </Configuration>

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNzk0OTcz_size_16_color_FFFFFF_t_70 7][]

> [https://segmentfault.com/a/1190000021121882][https_segmentfault.com_a_1190000021121882]

[https_blog.csdn.net_millmanxh_article_details_9835391]: https://blog.csdn.net/millmanxh/article/details/9835391
[http_slf4j.org_manual.html]: http://slf4j.org/manual.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNzk0OTcz_size_16_color_FFFFFF_t_70]: /images/20230521/e7bc942b64614f31be26234b036e1f40.png
[http_slf4j.org_legacy.html]: http://slf4j.org/legacy.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNzk0OTcz_size_16_color_FFFFFF_t_70 1]: /images/20230521/c6798405b1fa42cf8bdc84ce0814473e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNzk0OTcz_size_16_color_FFFFFF_t_70 2]: /images/20230521/a748ecb70bba48eebbe3eeac3529c73f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNzk0OTcz_size_16_color_FFFFFF_t_70 3]: /images/20230521/0cdd933090cc49968d93f30b50051771.png
[2020041719170846.png]: /images/20230521/78163e1617c24bf4b851f31b041556e4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNzk0OTcz_size_16_color_FFFFFF_t_70 4]: /images/20230521/2965077301df46f486ec71495e9368d5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNzk0OTcz_size_16_color_FFFFFF_t_70 5]: /images/20230521/1fbcf7168b824a689d4f01138a40e8fb.png
[https_docs.spring.io_spring-boot_docs_2.1.14.BUILD-SNAPSHOT_reference_html_boot-features-logging.html]: https://docs.spring.io/spring-boot/docs/2.1.14.BUILD-SNAPSHOT/reference/html/boot-features-logging.html
[https_docs.spring.io_spring-boot_docs_2.1.14.BUILD-SNAPSHOT_reference_html_boot-features-logging.html_boot-features-custom-log-configuration]: https://docs.spring.io/spring-boot/docs/2.1.14.BUILD-SNAPSHOT/reference/html/boot-features-logging.html#boot-features-custom-log-configuration
[http_slf4j.org_images_legacy.png]: http://slf4j.org/images/legacy.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNzk0OTcz_size_16_color_FFFFFF_t_70 6]: /images/20230521/eefec984675e45ae8f7f7d785114a1f0.png
[https_docs.spring.io_spring-boot_docs_2.1.14.BUILD-SNAPSHOT_reference_html_using-boot-build-systems.html_using-boot-starter]: https://docs.spring.io/spring-boot/docs/2.1.14.BUILD-SNAPSHOT/reference/html/using-boot-build-systems.html#using-boot-starter
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNzk0OTcz_size_16_color_FFFFFF_t_70 7]: /images/20230521/4f211f07f02b4e538cfa97a4b2da25a7.png
[https_segmentfault.com_a_1190000021121882]: https://segmentfault.com/a/1190000021121882