【Spring】SpringBoot日志

系统管理员 2024-02-05 18:25 14阅读 0赞

![在这里插入图片描述][3e8b10461a90429aa5afb90f4331a502.webp_pic_center]

#### 文章目录 ####

*  什么是日志
 *  日志的用途
 *  日志的使用
 *  如何打印日志
 *  日志级别
 *  日志框架
 *   *  门面模式（外观模式）
     *  日志级别的使用
     *   *  配置日志级别
         *  日志持久化
         *   *  配置日志的存储目录
             *  配置日志文件名
             *  配置日志文件分割
 *  更简单的日志输出

## 什么是日志 ##

在计算机领域，日志是一个记录了发生在运行中的操作系统或其他软件中的事件，或者记录了在网络聊天软件的用户之间发送的消息。

通常情况下，系统日志是用户可以直接阅读的文本文件，其中包含了一个时间戳和一个信息或者子系统所特有的其他信息。任何系统中，日志都是非常重要的组成部分，它是反映系统运行情况的重要依据，也是排查问题时的必要线索。

前面我们多多少少都用过日志，并且通过日志来解决我们代码中遇到的问题。像 `System.out.println` 打印信息就可以看作是一种简单的日志，通过日志我们可以很快的定位到错误出现的位置或者问题出现的详细信息，日志对我们排查问题来说是非常重要的。

虽然 `System.out.println` 这种形式的日志可以解决问题，但是随着项目复杂度的提升，我们对于日志的打印也有了更高的需求，而不仅仅是定位排查问题。

一些情况，我们往往需要知道程序运行的过程和操作记录，通过这些记录往往能够帮助我们快速的解决遇到的问题。

## 日志的用途 ##

通过前⾯的学习，我们知道⽇志主要是为了发现问题，分析问题，定位问题的，但除此之外，⽇志还有很多⽤途：

1.  系统监控  
    监控现在⼏乎是⼀个成熟系统的标配，我们可以通过⽇志记录这个系统的运⾏状态，每⼀个⽅法的响应时间，响应状态等，对数据进⾏分析，设置不同的规则，超过阈值时进⾏报警。⽐如统计⽇志中关键字的数量，并在关键字数量达到⼀定条件时报警，这也是⽇志的常⻅需求之⼀
2.  数据采集  
    数据采集是⼀个⽐较⼤的范围，采集的数据可以作⽤在很多⽅⾯，⽐如数据统计，推荐排序等

*  数据统计：统计⻚⾯的浏览量(PV)，访客量(UV)，点击量等，根据这些数据进⾏数据分析，优化公司运营策略
 *  推荐排序：⽬前推荐排序应⽤在各个领域，我们经常接触的各⾏各业很多也都涉及推荐排序，⽐如购物，⼴告，新闻等领域。数据采集是推荐排序⼯作中必须做的⼀环，系统通过⽇志记录用户的浏览历史，停留时⻓，算法⼈员通过分析这些数据，训练模型，给用户做推荐

1.  日志审计  
    随着互联⽹的发展，众多企业的关键业务越来越多的运⾏于⽹络之上。⽹络安全越来越受到⼤家的关注，系统安全也成为了项⽬中的⼀个重要环节，安全审计也是系统中⾮常重要的部分。国家的政策法规、⾏业标准等都明确对⽇志审计提出了要求。通过系统⽇志分析，可以判断⼀些⾮法攻击，⾮法调⽤，以及系统处理过程中的安全隐患

## 日志的使用 ##

当我们启动 SpringBoot 项目的时候其实就会存在日志。

![在这里插入图片描述][6f851672418c4e55bb390204e6b49885.png]  
并且通过观察我们可以发现：日志的输出内容包含很多信息，包括时间、在哪个类中打印的和描述信息等等。

就是通过这些日志，我们能根据时间和所属类很快的定位到问题出现的位置。这些是默认存在的会打印的日志，那么我们如何打印出我们自己想要的日志呢？

## 如何打印日志 ##

Spring 中默认内置了一个日志框架——Slf4j，我们可以通过这个框架来打印出我们想要的日志。

要想打印日志，首先需要获取到日志对象。

Logger 对象的所属包是 `org.slf4j` 包。  
![在这里插入图片描述][69f26ff26bd2411fbe7b4a0e5b076f39.png]  
这个 `Logger` 对象是通过 `LoggerFactory` 工厂类中的 `getLoger`获取的。

private static final Logger logger = LoggerFactory.getLogger(LoggerController.class);

注意：getLogger 方法中的参数需要传递一个类对象，用来知道是哪个类输出的日志，当遇到问题时，我们可以根据这个所属类更快的定位到问题所在位置。

当获取到 `Logger` 日志对象之后，我们就可以通过 `Logger` 类当中的方法打印出对应的日志。

![在这里插入图片描述][10f105e93add488b834f088bb11abdf5.png]  
logger 类中有很多方法，但是主要打印日志的方法就是 `trace()、deBug()、info()、warn()、error()`方法，那么这些方法有什么区别呢？后面再为大家解释，这里我们先使用。一个方法会有很多种的重载方法，我们可以根据需要选择使用哪种传递参数的方法。

![在这里插入图片描述][83fac2072c3c42429a76179fca0302f3.png]

package com.example.logger;
    
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    public class LoggerController {
        
        private static final Logger logger = LoggerFactory.getLogger(LoggerController.class);
    
        @RequestMapping("/getLogger")
        public String getLogger() {
        
            logger.trace("我是 trace");
            logger.debug("我是 deBug");
            logger.info("我是 info");
            logger.warn("我是 warn");
            logger.error("我是 error");
    
            return "hello logger";
        }
    }

![在这里插入图片描述][2ccf8b955bb6401f93465bfb97b6d222.png]  
![在这里插入图片描述][bf7ef6acdc064dcbbbabef418f07a762.png]

当使用网页访问这个程序的时候，可以发现：虽然控制台中有添加的日志输出，但是可以发现只有 `info、warn、error` 方法的日志被输入了，那么这是为什么呢？

这里就需要了解什么是日志级别了？

## 日志级别 ##

日志级别是用于控制程序日志输出内容的一种方式，不同的级别对应不同的方法。日志级别代表着日志信息对应问题的严重性。其主要意义在于：

1.  帮助开发者快速定位问题。针对不同级别的日志信息，开发者可以针对性地分析和定位问题，从而更快地解决问题。
2.  排除不必要的日志信息。通过设置适当的日志级别，可以避免记录过多的无用信息，从而节约系统资源，提高应用程序的性能。
3.  监控系统运行状态。应用程序在运行时会产生大量的信息，这些信息有助于开发者对系统状态进行监控和分析，从而确保应用程序能够稳定运行。
4.  保护系统安全。

⽇志的级别从⾼到低依次为：FATAL、ERROR、WARN、INFO、DEBUG、TRACE。

*  FATAL：致命信息，表⽰需要立即被处理的系统级错误
 *  ERROR：错误信息，级别较⾼的错误⽇志信息，但仍然不影响系统的继续运⾏
 *  WARN：警告信息，不影响使⽤，但需要注意的问题
 *  INFO：普通信息，⽤于记录应⽤程序正常运⾏时的⼀些信息，例如系统启动完成、请求处理完成等
 *  DEBUG：调试信息，需要调试时候的关键信息打印
 *  TRACE：追踪信息，⽐DEBUG更细粒度的信息事件(除⾮有特殊⽤意，否则请使⽤DEBUG级别替代)

如果我们不设置日志级别的话，所有级别的日志信息都会被打印，这样的话控制台就会出现非常多的日志信息，就会导致我们不容易找到具体的需要的日志信息。一些 `trace、deBug、info` 级别的日志信息，在我们的生产环境是用不到的，这些级别的信息就是在开发环境中会使用到，在生产环境中我们主要使用 `warn、error` 级别的日志。

⽇志级别是开发⼈员设置的，⽤来给开发⼈员看的。⽇志级别的正确设置，也与开发⼈员的⼯作经验有关。如果开发⼈员把error级别的⽇志设置成了info，就很有可能会影响开发⼈员对项⽬运⾏情况的判断。出现error级别的⽇志信息较多时，可能也没有任何问题。测试的bug级别更多是依据现象和影响范围来判断。

![在这里插入图片描述][5e98b77ea91c4757abb1cbc4a6c939dd.png]

## 日志框架 ##

在使用日志框架之前，我们还需要了解 Spring 中的日志框架。

![在这里插入图片描述][535dbeaf4c334805a2d548b3b85ded3a.png]  
Spring 中日志框架分为两层，与我们程序员直接交接的是日志门面，日志的实际打印是日志实现完成的，这个日志门面层相当于中间层。这种模式叫做门面模式。

### 门面模式（外观模式） ###

门面模式（Facade Pattern），也叫外观模式，是一种软件设计模式，它为子系统中的一组接口提供一个统一的高层接口，使得子系统更容易使用。

门面模式的主要特征包括：

1.  提供一个统一的接口，用来访问子系统中的一群接口。
2.  定义了一个高层接口，让子系统更容易使用。

![在这里插入图片描述][5e9caed202aa4f57bd929b48eb0b4330.png]  
外观⻆⾊(Facade)：也称门面角，系统对外的统⼀接⼝

⼦系统⻆⾊(SubSystem)：可以同时有⼀个或多个 SubSystem。每个SubSytem 都不是⼀个单独的类，⽽是⼀个类的集合。SubSystem 并不知道 Facade 的存在，对于 SubSystem ⽽⾔，Facade 只是另⼀个  
客户端⽽已(即 Facade 对 SubSystem 透明)

对于我们的日志框架来说，为什么会使用门面模式呢？其实关键的原因是为了解耦合。如果我们直接使用日志实现中的接口的话，假设 `log4j 1/2` 打印日志时使用的是 `logger.logger()`，那么我们在打印日志的时候调用的方法就是`logger.logger()`方法，如果后面有一天 `log4j 1/2` 出现了漏洞，为了安全，公司决定不再使用这个接口，而是改用 `logback` 接口，但是呢？`logback` 打印日志使用的方法是 `log.log()`方法，那么我们之前项目中的 `logger.logger()` 方法都要修改成 `log.log()` 方法，如果这代码使用的少还好，如果是一千、一万行呢？这样我们程序员的工作量就会很大，通过使用门面模式，也就是相当于添加了一个中介，我们只告诉中介我们需要干什么，具体的中介安排谁来做，我们呢不关心，由中介来安排，这样就算底层日志实现的接口更换了，因为有这个日志门面也就是中介在，我们还是不需要做出改变的。

这里给大家用代码演示一下：

//这是我们程序员调用log打印日志方法，通过调用slf4j类中的log()方法
    slf4j.log("xxxxxx");

//这是slf4j类中的log方法
    public void log(String str) {
        
    	//假设日志门面slf4j使用的日志实现是log4j 1/2
    	log4j.log(str);
    }

这里 log4j 12 的具体实现我们先不关心，假设调用 `log4j.log()` 可以实现日志的打印，如果日志的实现因为漏洞等安全问题需要更改日志实现接口的话，我们程序员的代码是不需要更改的，只需要在 `slf4j`的 `log()` 方法中更改调用的接口就行了。

public void log(String str) {
        
    	//日志实现的接口更换为logback
    	logback.log(str);
    }

通过门面模式能够解耦合，很大程度的减少我们程序员的负担。

### 日志级别的使用 ###

SpringBoot 默认使用的门面日志是 `SLF4J`，默认日志实现是 `logback`，logback 没有 fatal 级别，它是被映射到 eror 中的。

出现fatal⽇志，表⽰服务已经出现了某种程度的不可⽤，需要需要系统管理员紧急介⼊处理。通常情况下，⼀个进程⽣命周期中应该最多只有⼀次FATAL记录。

打印日志的时候只会打印默认日志级别以及默认日志级别之上的日志级别的日志。

SpringBoot 默认的日志级别是 `info` 级别，也就是说，只会打印出 `info、warn、error`的日志级别的日志，那么我们如何修改默认日志级别呢？

#### 配置日志级别 ####

前面我们学习了 SpringBoot 配置文件，配置日志级别就是在配置文件中配置的。

在 properties 配置文件中这样设置 `logging.lever.root=debug`，yml 配置文件中这样设置：

logging:
      level:
        root: debug # root 表示当前项目的所有文件的默认日志级别

再次启动项目可以发现出现了 debug 日志级别以及 debug 日志级别之上的日志级别的日志。  
![在这里插入图片描述][2a1c6695652843908ce43ea971af2503.png]  
root 表示设置当前项目所有文件的默认日志级别，那么如果我们想要不同文件具有不同的默认日志级别该怎么办呢？其实也不难。我们只需要在配置文件中为指定文件配置默认日志级别就可以达到不同文件配置不同默认日志级别的功能了。

# 这里我们将controller包下的默认日志级别设置为trace
    logging:
      level:
        root: debug
        com:
          example:
            logger:
              controller: trace

那么这样设置的话，除了controller包下的默认日志级别为trace，其他的文件的默认日志级别就是debug了。

![在这里插入图片描述][af84a7211a25459ab6108b9b33398b10.png]

#### 日志持久化 ####

出现在控制台的日志是保存在内存中的，当我们重启程序或者重启 idea 的时候，之前的日志就会被丢掉，在实际生活中我们往往需要将日志保存在磁盘上永久保存，这种方式就叫做日志的持久化。

日志持久化有两种方式：

1.  配置日志的存储目录
2.  配置日志文件名

##### 配置日志的存储目录 #####

当我们使用配置日志的存储目录实现日志的持久化的话，spring 会使用默认的文件名来命名文件。如果指定的文件目录不存在，也会自动创建。

配置日志的存储目录在 properties 配置文件中使用 `logging.file.path=xxx`配置，在 yml 配置文件中这样配置。

logging:
      file:
        path: d://logs

配置文件存储目录，spring 默认的日志文件名是 `spring.log`，如果日志内容太多操作一个文件的存储大小限制的话，spring 会再创建一个新的文件  
![在这里插入图片描述][b0a9116ddb0e4b11ada031f3e434a2dd.png]  
![在这里插入图片描述][4746a706bfc645a0b642751714afdbe0.png]

##### 配置日志文件名 #####

保存日志我们也可以指定文件的文件名，在 properties 配置文件中使用 `logging.file.name=xxx`，在 yml 配置文件中使用：

logging:
      file:
        name: springboot-log.log

当访问这个程序之后，会在我们的项目下生成一个指定文件名的文件。

![在这里插入图片描述][7b7c6031a23f4dc3a56b38f914e342cc.png]  
![在这里插入图片描述][f31df245c3774fb2852d700eb8a2aaff.png]  
以配置日志文件名的方式保存日志，如果日志的内容过多超出最大限制的话，spring 会在你指定日志文件名的基础上再创建出一个日志文件来做区别。

##### 配置日志文件分割 #####

如果我们将日志都放在一个文件的话，那么随着项目运行时间的增长，文件中的内容会越来越多，如果文件中的数据达到一定数量之后，那么我们想要在这个文件中查找指定日志的话就会显得非常麻烦，那么如何解决这个问题呢？

解决这个问题可以实现对日志文件的分割，当日志文件达到一定大小之后，会再创建出一个日志文件，将后面的日志保存在这个新创建的文件中。

关于更多的 SpringBoot 日志的配置项，大家可以去官网看看[SpeingBoot配置][SpeingBoot]

这里日志文件分割主要与这两个配置有关。

![在这里插入图片描述][7a7790aa0faa4cca8e85469914b817e4.png]  
第一个配置是日志文件分割的名称定义规则，第二个则是日志文件的最大容量，当日志文件的大小大于这个最大容量的话，那么就会根据这个日志文件分割的名称定义规则创建出新的文件存储后面的日志信息。

`logging.logback.rollingpolicy.file-name-pattern`配置的默认值是 `${LOG_FILE}.%d{yyyy-MM-dd}.%i`  
也就是这种形式：

![在这里插入图片描述][3575f004194040f5b5ab429f505742c3.png]

然后我们设置日志文件的最大容量为 1KB 来看看效果：

logging:
      file:
        name: d://logs/springboot.log
    
      logback:
        rolling policy:
          file-name-pattern: ${
        LOG_FILE}.%d{
        yyyy-MM-dd}.%i
          max-file-size: 1KB
      level:
        root: debug

![在这里插入图片描述][2b9a5bad2ccc4f319d9fa62d34e16a62.png]

## 更简单的日志输出 ##

这里简单主要是简单在日志对象的创建上，使用上面的方法创建文件对象的话，每次都需要这样创建。

`private static final Logger logger = LoggerFactor.getLogger(Main.class)`

每个类中创建日志对象的代码百分之其实都是相同的，所以为了节省这个创建日志对象的代码，我们就可以使用一个工具类 Lombok，在这篇文章中为大家说明了如何下载 Lombok [SpringMVC案例][SpringMVC]

使用 Lombok 工具类之后我们只需要在类上加上一个 `slf4j` 注解，那么这个类中就会默认创建出一个 `Logger` 类的实例 `log`，可以直接使用。

![在这里插入图片描述][e1586718966b4978bfd9d4590ff152fd.png]  
![在这里插入图片描述][069f55f21fbf492c9a239492f14d1b12.png]

package com.example.logger.controller;
    
    import lombok.extern.slf4j.Slf4j;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    @Slf4j
    public class LombokController {
        
        
        @RequestMapping("/getLombok")
        public String getLog() {
        
            log.trace("我是 trace");
            log.debug("我是 deBug");
            log.info("我是 info");
            log.warn("我是 warn");
            log.error("我是 error");
            
            return "hi lombok";
        }
    }

![在这里插入图片描述][0e5de3fab38b44bb8567fae0497c5a29.png]  
那么为什么加了 `@Slf4j` 之后就会自动创建出一个 `Logger` 对象呢？其实 Lombok 在代码编译阶段做了“手脚”。

Java程序运行原理

![在这里插入图片描述][1e8269e293a0463eb259234b0085b499.png]  
Lombok 作用：

![在这里插入图片描述][54218e41dcdf4a789be117fc814325f9.png]  
我们来看看编译形成的.class文件，看看跟正常的创建 `Logger` 对象有什么区别。

![在这里插入图片描述][c19437c68551460dbde5ad1902807560.png]  
![在这里插入图片描述][bd9bef9fe226489184da68e5c0f28201.png]  
可以看到，Lombok作用在代码的编码期间，在这个过程在 `@Slf4j` 注解会被替换为 `private static final Logger log = LoggerFactory.getLogger(LombokController.class)`这个创建 `Logger` 的代码，因此，当我们加上这个注解之后，该类中就会自动创建一个 `Logger` 对象 `log`。通过这个注解可以简化我们的创建过程。

[3e8b10461a90429aa5afb90f4331a502.webp_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/b85e7c162b2e48ddbcdec3dbc0d5744f.png
[6f851672418c4e55bb390204e6b49885.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/f331a07fec5846509e394df3f71caed8.png
[69f26ff26bd2411fbe7b4a0e5b076f39.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/caf7eb56984643d881d8771bcdb9d7e9.png
[10f105e93add488b834f088bb11abdf5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/50d4a18fc8a64e9b8265643f2f44ae9b.png
[83fac2072c3c42429a76179fca0302f3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/130d69b19e7643eeb5e6b9818f28ff59.png
[2ccf8b955bb6401f93465bfb97b6d222.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/051f4a0672ae440396ea9d6853f5eda6.png
[bf7ef6acdc064dcbbbabef418f07a762.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/00d3ad21631c4dd9a92e532efc6f14a9.png
[5e98b77ea91c4757abb1cbc4a6c939dd.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/e348cb3d79a441968da854e3b0573052.png
[535dbeaf4c334805a2d548b3b85ded3a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/be747939bb114f3c9a362221218e1a46.png
[5e9caed202aa4f57bd929b48eb0b4330.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/9b2af279564e4e888a049bf4e4f5595f.png
[2a1c6695652843908ce43ea971af2503.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/495db150434349a6a1890569c83b0e44.png
[af84a7211a25459ab6108b9b33398b10.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/e5978066198b44eea45a3bf33bdeea8b.png
[b0a9116ddb0e4b11ada031f3e434a2dd.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/9cedbe5bc3bc4cef98b54f7bf3923165.png
[4746a706bfc645a0b642751714afdbe0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/2f34dad68fa041ee89cfe8b17fa7fb96.png
[7b7c6031a23f4dc3a56b38f914e342cc.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/5a875c79b85b4f398a35b4ca9bfb7403.png
[f31df245c3774fb2852d700eb8a2aaff.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/83e27ea4fa3845b2b1d4a9e897dd42ea.png
[SpeingBoot]: https://docs.spring.io/spring-boot/docs/current/reference/html/application-properties.html#appendix.application-properties
[7a7790aa0faa4cca8e85469914b817e4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/e0024ea07b68446fa74c2d49a33d8085.png
[3575f004194040f5b5ab429f505742c3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/8abc11adfa644c899bea9fac3659d35f.png
[2b9a5bad2ccc4f319d9fa62d34e16a62.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/9b654a15f6934f63bade997560d93d1a.png
[SpringMVC]: https://blog.csdn.net/m0_73888323/article/details/134840959?spm=1001.2014.3001.5501
[e1586718966b4978bfd9d4590ff152fd.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/cf0c322b4ef4483d92abe7726c4df0e5.png
[069f55f21fbf492c9a239492f14d1b12.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/810e244218474b5ebbd96ec11ae03e2f.png
[0e5de3fab38b44bb8567fae0497c5a29.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/1dc9969df511476aa85d63f971198fd8.png
[1e8269e293a0463eb259234b0085b499.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/7398f2612ede452a8ab56d519030552c.png
[54218e41dcdf4a789be117fc814325f9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/3b900151d236429c88fcabf0792782a7.png
[c19437c68551460dbde5ad1902807560.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/7a80ac0f89b648bbaf619d25dd1c60e3.png
[bd9bef9fe226489184da68e5c0f28201.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/f86b5e3d1187405e8e1efe57556a490f.png