（5）Spring Boot 与日志

一、日志框架

小张：开发了一个大型分布式系统；

System.out.println("")；将关键数据打印在控制台；去掉？写在一个文件？
框架来记录系统的一些运行时信息；日志框架； zhanglogging.jar；
高大上的几个功能？异步模式？自动归档？xxxx？ zhanglogging-good.jar？
将以前框架卸下来？换上新的框架，重新修改之前相关的API；zhanglogging-prefect.jar；
JDBC---数据库驱动；

写了一个统一的接口层；日志门面（日志的一个抽象层）；logging-abstract.jar；

给项目中导入具体的日志实现就行了；我们之前的日志框架都是实现的抽象层；

（1）市面上的日志框架；

JUL、JCL、Jboss-logging、logback、log4j、log4j2、slf4j....

日志门面（日志的抽象层）	日志实现
~~JCL（Jakarta Commons Logging）(废弃)~~ SLF4j（Simple Logging Facade for Java） ~~jboss-logging （不常用）~~	Log4j (没有logback先进) JUL（java.util.logging）（jdk自带的） Log4j2 (apache 开发特别好，但是很多框架还未适配起来) Logback

日志门面（日志的抽象层）

日志实现

~~JCL（Jakarta Commons Logging）(废弃)~~

SLF4j（Simple Logging Facade for Java）

~~jboss-logging （不常用）~~

Log4j (没有logback先进)

JUL（java.util.logging）（jdk自带的）

Log4j2 (apache 开发特别好，但是很多框架还未适配起来)

Logback

左边选一个门面（抽象层）、右边来选一个实现；

日志门面： SLF4J；
日志实现：Logback；
SpringBoot：底层是Spring框架，Spring框架默认是用JCL；‘

SpringBoot选用 SLF4j和logback；

二、SLF4j 日志的使用 slf4j官网链接

（1）如何在系统中使用SLF4j.

以后开发的时候，日志记录方法的调用，不应该来直接调用日志的实现类，而是调用日志抽象层里面的方法；

给系统里面导入slf4j的jar和 logback的实现jar.

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");
  }
}

图示日志使用方法：

ç¹å»æ¾å¤§

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

（2）遗留问题（以前的框架用自己的日志框架，最后一个系统用了很多不同的日志框架的问题）

slf4j+logback
Spring（commons-logging）
Hibernate（jboss-logging）
MyBatis、xxxx

如何统一日志框架记录，即使是别的框架和我一起统一使用slf4j进行输出？

官网给出桥接旧版本日志框架的API

ç¹å»æ¾å¤§

如何让系统中所有的日志都统一到slf4j；

先将系统中其他日志框架先排除出去

再用中间包来替换原有的日志框架

然后我们导入slf4j其他的实现

三、Spring Boot 日志关系

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

SpringBoot使用它来做日志功能；

    <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-logging</artifactId>
    </dependency>

底层依赖关系

总结：

SpringBoot底层也是使用slf4j+logback的方式进行日志记录
SpringBoot也把其他的日志都替换成了slf4j；
中间替换包？（偷梁换柱包）

@SuppressWarnings("rawtypes")
public abstract class LogFactory {

    static String UNSUPPORTED_OPERATION_IN_JCL_OVER_SLF4J =
          "http://www.slf4j.org/codes.html#unsupported_operation_in_jcl_over_slf4j";
    
           //中间包  实际是对log4j日志 new slf4j的对象 进行替换过度

    static LogFactory logFactory = new SLF4JLogFactory();

如果我们要引入其他框架？一定要把这个框架的默认日志依赖移除掉？

Spring框架用的是commons-logging；

        <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的方式记录日志，引入其他框架的时候，只需要把这个框架依赖的日志框架排除掉即可；

四、Spring Boot 日志使用

（1）默认配置 Spring Boot 2.2.5官网日志使用说明

SpringBoot默认帮我们配置好了日志；

  // 记录器
    Logger LOGGER = LoggerFactory.getLogger(SpringBootTest.class);
    @Test
    public void contextLoad(){
        // System.out.println();
        /**
         * 日志级别由高到低
         * 日志级别：ERROR，WARN，INFO，DEBUG，或TRACE。
         * 可以调整输出的日志级别；日志就只会在这个级别以以后的高级别生效
         */
        LOGGER.trace("日志踪迹");
        LOGGER.debug("日志debug模式");
        //SpringBoot默认给我们使用的是info级别的
        //，没有指定级别的就用SpringBoot默认规定的级别；root级别
        LOGGER.info("日志提示信息");
        LOGGER.warn("日志警告信息");
        LOGGER.error("日志提示错误信息");
    }

日志输出格式说明：

   日志输出格式：
        %d表示日期时间，
        %thread表示线程名，
        %-5level：级别从左显示5个字符宽度
        %logger{50} 表示logger名字最长50个字符，否则按照句点分割。 
        %msg：日志消息，
        %n是换行符
    -->
    %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n


# 调整日志隔离级别 wxw目录下的调成trace   springboot 默认是root级别
#logging.level.com.wxw=trace
        
# 默认是控制台输出
# 写入spring.log指定的目录。名称可以是确切的位置，也可以相对于当前目录。
#logging.file.path=springboot/log

# 指定目录 logging.file.name :写入指定的日志文件。名称可以是确切的位置，也可以相对于当前目录。
#logging.file.name=springboot/boot.log

#  在控制台输出的日志的格式
#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

日志记录属性：

`logging.file.name`	`logging.file.path`	例	描述
（没有）	（没有）		仅控制台记录。
具体档案	（没有）	`my.log`	写入指定的日志文件。名称可以是确切的位置，也可以相对于当前目录。
（没有）	具体目录	`/var/log`	写入`spring.log`指定的目录。名称可以是确切的位置，也可以相对于当前目录。

（2）自定义日志配置

可以通过在类路径中包含适当的库来激活各种日志记录系统，并可以通过在类路径的根目录或以下Spring Environment属性指定的位置中提供适当的配置文件来进一步自定义各种日志记录系统logging.config。

禁用默认日志：可以通过使用org.springframework.boot.logging.LoggingSystemsystem属性来强制Spring Boot使用特定的日志系统。该值应该是实现的完全限定的类名LoggingSystem。您还可以通过使用值完全禁用Spring Boot的日志记录配置none。
给类路径下放上每个日志框架自己的配置文件即可；SpringBoot就不使用他默认配置的了

Logging System	Customization
Logback	`logback-spring.xml`, `logback-spring.groovy`, `logback.xml`, or `logback.groovy`
Log4j2	`log4j2-spring.xml` or `log4j2.xml`
JDK (Java Util Logging)	`logging.properties`

注意：

logback.xml：直接就被日志框架识别了；
logback-spring.xml：日志框架就不直接加载日志的配置项，由SpringBoot解析日志配置，可以使用SpringBoot的高级Profile功能
springboot 环境切换开启方式，(1) properties/yml 配置文件（2）命令行配置

<springProfile name="staging">
    <!-- configuration to be enabled when the "staging" profile is active -->
      可以指定某段配置只在某个环境下生效
</springProfile>

例如：

<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
        <!--
        日志输出格式：
            %d表示日期时间，
            %thread表示线程名，
            %-5level：级别从左显示5个字符宽度
            %logger{50} 表示logger名字最长50个字符，否则按照句点分割。 
            %msg：日志消息，
            %n是换行符
        -->
        <layout class="ch.qos.logback.classic.PatternLayout">
            <springProfile name="dev">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ---->
                      [%thread] ---> %-5level %logger{50} - %msg%n</pattern>
            </springProfile>
            <springProfile name="!dev">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ==== [%thread] ==== 
                                     %-5level %logger{50} - %msg%n</pattern>
            </springProfile>
        </layout>
    </appender>

如果使用logback.xml作为日志配置文件，还要使用profile功能，会有以下错误

no applicable action for [springProfile]

五、Spring Boot 切换日志框架

可以按照slf4j的日志适配图，进行相关的切换；

（1）slf4j+log4j的方式；

<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>

切换为log4j2

 <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>

查看专栏详情

战斗，然后凯旋

发布了108 篇原创文章 · 获赞 58 · 访问量 5万+

私信关注

（5）Spring Boot 与日志

猜你喜欢