SpringBoot的日志信息及Lombok的常用注解

川长思鸟来 2024-04-26 10:56 79阅读 0赞

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

*  一. 日志的介绍
 *   *  1. 什么是日志
     *  2. 日志的作用
 *  二. 日志的使用
 *   *  1. 日志格式说明
     *  2. 自定义日志的输出
     *  3. 日志级别
     *  4. 日志级别的配置
     *  5. 日志持久化
     *  6. 更简单的输出日志-Lomok
     *  7. Lombok框架实现原理以及其他常见注解

## 一. 日志的介绍 ##

### 1. 什么是日志 ###

日志是我们程序重要组成部分，它是程序在运行过程当中输出的一些提示或异常信息，我们可以通过日志来观察程序执行的情况，如果程序出现 Bug，我们可以根据日志去发现和排查程序的 Bug。

SpringBoot 项目在启动的时候，就会有默认的日志输出，如下图所示：  
![img][]  
之所以会有上面的输出，是因为 SpringBoot 中内置了日志框架。

SpringBoot 中内置了 SLF4J 和 logback 两个日志框架，用户层面并不是直接操作具体的日志对象，而是使用 SLF4J 提供给用户的 API 进而由 logback 操作具体的日志对象实现日志。  
![img][img 1]![img][img 2]

SLF4J 这类框架是使用“门面模式”来实现的，SLF4J 其实和 JDBC 很像，我们知道使用 JDBC 操作数据库，一套 JDBC 代码就可以操作很多种数据库，可以是 MySQL，Oracle，DB2，SqlServer等，而这个JDBC 就相当于代理一样，来代理去操作数据库，我们不必关心各种数据库的实现，只需关注 JDBC 提供给我们的的 API 即可。

类似的，SLF4J 中也并不是真正完成了日志实现的框架，它只是一个门面或者一个代理，我们调用 SLF4J 的 API，SLF4J 中还会去调用 logback 这样的日志实现框架，此时我们就不必关心日志实现的细节，这一层面我们是感知不到的，这就是门面模式所带来的好处，还有一个好处就是如果日志实现层出现了漏洞，只需要修改更换日志实现的框架即可，而 SLF4J 可以匹配相应的日志框架，此时虽然日志实现的框架发生了改变，但我们写的代码仍然不受影响，这样就使得系统的依赖性降低，利于系统更新和维护。

![img][img 3]

### 2. 日志的作用 ###

1.  能够帮助程序猿排除程序的 Bug。
2.  记录用户登录日志，方便分析用户是正常登录还是恶意破解用户。
3.  记录系统的操作日志，方便数据恢复和定位操作人。
4.  记录程序的执行时间，方便为以后优化程序提供数据支持。

## 二. 日志的使用 ##

使用日志框架可以**配置日志的级别**来控制日志的输出，而我们日常使用`System.out.printf`来输出日志是无法做到这一点的。

### 1. 日志格式说明 ###

对于控制台输出的日志，它的各部分含义如下：  
![img][img 4]  
信息中的包名有部分是简写，取的是包名的第一个字母；  
根据这些信息，我们就可以知道日志是发生在什么时间，在哪个线程，哪个类，以及具体的日志信息。

### 2. 自定义日志的输出 ###

1️⃣第一步，在类中先获取到日志对象，这个日志对象来自于日志框架`SLF4J`。

假设我们在类`LogController`设置自定义日志的输出，则日志对象创建代码如下：

每一个类都对应一个日志对象，可以通过日志工厂`LoggerFactory`获取的，导包的时候要注意`Logger`对象是在`org.slf4j`包下的，不要导错。

// 获取日志对象
    private static Logger log =
            LoggerFactory.getLogger(LogController.class);

`getLogger()`一般传入传入当前类的类型，这里的参数用来定位日志的归属类，以方便日志输出，输出的日志信息中有了日志的定位， 才能更方便、更直观的定位到问题类。

2️⃣第二步，使用日志对象提供的方法来实现自定义日志的打印。

日志对象提供的方法有很多，可以设定不同级别的日志信息输出。  
![img][img 5]  
?示例代码：

`@RestController`相当于是将`@Controller`和`@ResponseBody`这两个注解合起来的效果。

package com.example.springboot2.controller;
    
    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 LogController {
        
        // 获取日志对象
        private static Logger log =
                LoggerFactory.getLogger(LogController.class);
        
        @RequestMapping("/log")
        public void log() {
        
            log.trace("我是trace");
            log.debug("我是debug");
            log.info(("我是info"));
            log.warn("我是warn");
            log.error("我是error");
        }
    }

我们启动程序后，访问`http://127.0.0.1:8080/log`后，控制台就有相应的日志输出了。

![img][img 6]

观察输出结果，我们的代码是写了 5 个级别的日志输出的，为什么这里结果只有 3 个结果呢？这是因为SpringBoot 项目下，默认日志级别为`info`，低于`info`日志级别的都不会输出。

### 3. 日志级别 ###

?日志级别分为一下几种：

*  trace：微量，少许的意思，级别最低。
 *  debug：需要调试时候的关键信息打印。
 *  info：普通的打印信息（默认日志级别）。
 *  warn：警告，不影响使用，但需要注意的问题。
 *  error：错误信息，级别较高的错误日志信息。
 *  fatal：致命的，因为代码异常导致程序退出执行的事件，不支持用户自定义。

![img][img 7]

SpringBoot 项目默认的日志级别是`info`，那么比`info`日志级别低的是不能输出的，也就是`debug`与`trace`的日志是不会输出的，只有**大于等于**`info`级别的日志才会输出。

?日志级别的作用：

1.  日志级别可以帮我们筛选出重要的信息，比如设置日志级别为 error，那么就可以只看程序的报错日志了，对于普通的调试日志和业务日志就可以忽略了，从而节省开发者信息筛选的时间。
2.  日志级别可以控制不同环境下，⼀个程序是否需要打印日志，如开发环境我们就需要很详细的日志信息， 而生产环境为了保证性能和安全性就会输⼊尽量少的⽇志，通过日志的级别就可以实现此需求。

简单来说，就是过滤信息，将业务不需要的日志屏蔽掉。

### 4. 日志级别的配置 ###

日志级别是可以通过配置文件进行设置的，日志级别包括两类，一类是全局日志级别，另一类就是局部日志级别，全局日志级别可以影响全局日志的输出，而局部日志级别只会影响一个局部的日志输出，并且局部日志级别配置大于全局日志级别的配置。

?全局日志级别配置，如修改默认日志级别为`trace`：

properties 日志格式：

# 设置全局日志级别
    logging.level.root=trace

yml 日志格式：

logging:
    	level:
    		root: trace

运行上面我们的自定义日志代码，此时就会发现，我们所有的自定义日志信息都会输出，并且随着程序启动相比较默认情况下会有更多的日志信息输出，毕竟这里设置的是全局的配置文件，会影响全局。

![img][img 8]  
?下面来介绍局部日志级别的配置，我们将`LogController`类的日志级别设置为`warn`，此时只会`LogController`类中日志输出级别，并不会影响其他位置的日志信息输出。

properties 格式配置文件：

# 设置夹局部的日志级别 (包名/包名+类名)
    logging.level.com.example.demo.controller.LogController=warn

yml 格式配置文件：

logging:
    	level:
    		com:
    			example:
    				demo:
    					controller: 
                        	LogController :warn

控制台结果：

![img][img 9]

yml 格式配置文件可以一步设置全局和局部的日志级别，比如：

logging:
      level:
        root: info
        com:
          example:
            springboot2:
              controller: error
              service: warn

`root`设置的是全局日志级别，项目中所有日志级别都是`info`；和`root`同级下可设置局部具体类的日志级别m这里就是`com.example.springboot2.controller`和`com.example.springboot2.service`包下的类，级别分别为`error`和`warn`。

### 5. 日志持久化 ###

前面的介绍都是将日志输出在控制台上的，然而我们在生产环境下往往需要将日志保存下来，以便于后续出现问题时去追溯原因，将日志保存下来的过程就称之为持久化。

实现日志持久化的方式就是将日志信息保存到磁盘，同样可以通过设置配置文件实现。

?方式1：设置日志保存路径

properties 格式配置文件：

logging.file.path=D:\\bit\\logs

yml 格式配置文件：

logging:
      file:
        path: D:\\bit\\logs

启动程序，此时 SpringBoot 就会将控制台中打印的日志写到对应的目录了，日志文件默认名的为`spring.log`。

![img][img 10]  
![img][img 11]

?方式2：设置日志保存文件

properties 格式配置文件：

logging.file.name=D:\\bit\\log\\logging.log

yml 格式配置文件：

logging:
      file:
        name: D:\\bit\\log\\logging.log

效果如下：  
![img][img 12]  
![img][img 13]

还要注意，多次访问程序产生的日志是以追加的形式保存到日志文件当中的，SpringBoot 默认保存日志文件的大小为`10MB`\*\*，\*\*超出范围就会自动创建新的日志文件，然后保存到新的日志文件当中。

当然，也可以通过配置文件自定义日志文件的大小，配置方式如下：

# properties格式
    logging.logback.rollingpolicy.max-file-size=10MB
    
    # yml格式
    logging:
    	logback:
        	rollingpolicy:
        		max-file-size: 10MB

### 6. 更简单的输出日志-Lomok ###

每次都使⽤ LoggerFactory.getLogger(xxx.class) 很繁琐，且每个类都添加⼀遍，也很麻烦，在 Lombok 中有一个`@Slf4j`注解，可以使用该注解更简单的输出日志。

准备工作，首先要确保你的 IDEA 中有 Lombok 这个插件，没有的话去下载一下。

![img][img 14]

然后，添加 Lombok 依赖，可以使用 Edit Starters 插件快捷添加。  
![img][img 15]

刷新一下，依赖就添加好了。  
![img][img 16]

?使用方法：在想打印日志的类上加上 @Slf4j 注解即可，它会为当前类提供一个 log 对象。

要注意使用 @Slf4j 注解，在程序中使用 log 对象即可输⼊⽇志，并且只能使⽤ log 对象才能输出，这是 lombok 提供的对象名；代码中输入 log 后就会有相关方法的提醒（前提是安装了 lombok 插件）。

package com.example.springboot2.controller;
    
    import lombok.extern.slf4j.Slf4j;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    @Slf4j  // 当前的类中就可以直接使用 log 对象, @Slf4j 产生一个 log 对象, 直接使用即可
    public class LogController2 {
        
        @RequestMapping("/log2")
        public void log2(){
        
            log.trace("我是trace");
            log.debug("我是debug");
            log.info(("我是info"));
            log.warn("我是warn");
            log.error("我是error");
        }
    
    }

启动程序，访问路路径`http://127.0.0.1:8080/log2`，同样可以输出日志，代码更简单。  
![img][img 17]  
@Slf4j 注解替代了日志对象获取的代码：

private  final static Logger log = LoggerFactory.getLogger(LogController2.class);

### 7. Lombok框架实现原理以及其他常见注解 ###

Lombok 框架其实在编译的时候，将依据注解去替生成对应的代码，比如就像上面的日志对象创建，加上一个 @Slf4j 注解后，在编译时就会将类似与上面创建日志对象的代码生成到我们所写代码里面去，包括Lombok 其他的注解，如生成 Setter 的注解 @Setter，生成 Getter 的注解 @Getter 等都是通过编译时期间实现的。

![img][img 18]  
?Lombok作用：  
![img][img 19]

比如上面我们写的代码最终生成相应的字节码文件就在 target 目录中，target 目录中的代码才是项目最终执行的代码，查看 target 目录如下：

![img][img 20]

我们来对比一下我们`LogController2.java`原文件代码和程序运行起来后生成`LogController2.class`文件中的代码（由 IDEA 反编译显示）。

![img][img 21]

发现代码中的 @Slf4j 注解就不存存在了，被 log 对象替代了，所以，Lombok 是不会影响程序运行的信能的，它要完成的工作都是在编译生成字节码文件前完成的。  
?其他常用注解：  
基本注解：

<table> 
 <thead> 
  <tr> 
   <th><strong>注解</strong></th> 
   <th><strong>作用</strong></th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@Setter</td> 
   <td>⾃动添加 setter 方法</td> 
  </tr> 
  <tr> 
   <td>@Getter</td> 
   <td>⾃动添加 getter 方法</td> 
  </tr> 
  <tr> 
   <td>@ToString</td> 
   <td>⾃动添加 toString 方法</td> 
  </tr> 
  <tr> 
   <td>@EqualsAndHashCode</td> 
   <td>⾃动添加 equals 和 hashCode 方法</td> 
  </tr> 
  <tr> 
   <td>@NoArgsConstructor</td> 
   <td>⾃动添加⽆参构造方法</td> 
  </tr> 
  <tr> 
   <td>@AllArgsConstructor</td> 
   <td>⾃动添加全属性构造⽅法，顺序按照属性的定义顺序</td> 
  </tr> 
  <tr> 
   <td>@NonNull</td> 
   <td>属性不能为 null</td> 
  </tr> 
  <tr> 
   <td>@RequireArgsConstructor</td> 
   <td>⾃动添加必需属性的构造方法，final + @NonNull 的 属性为必需</td> 
  </tr> 
 </tbody> 
</table>

组合注解：

<table> 
 <thead> 
  <tr> 
   <th><strong>注解</strong></th> 
   <th><strong>作用</strong></th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@Data</td> 
   <td>@Getter + @Setter + @ToString + @EqualsAndHashCode + @RequiredArgsConstructor + @NoArgsConstructor</td> 
  </tr> 
 </tbody> 
</table>

日志注解：

使用 Lombok 提供给我们的这些注释，可以很好的帮助我们消除项目中大量冗余的代码，可以使得我们的 Java 类可以看起来非常的干净整洁。

[img]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/26/683363e69d5e4d8aae020f88b3527245.png
[img 1]: https://img-blog.csdnimg.cn/img_convert/d1556898cdbb6e711b8f468bf805e937.png
[img 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/26/676c0ff0be5143b09acc7b5f9cbbf8f2.png
[img 3]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/26/a9952d358b7a4ecab9a9415d68774b2e.png
[img 4]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/26/3085c2275d044c40bee275a67d01dd45.png
[img 5]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/26/b1689d366a664aad91fdebe9ccf9ea95.png
[img 6]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/26/d80e3f170f6048fcb09eb69b6785a44a.png
[img 7]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/26/cd4d3b12579941a3a56804f9681cc5c8.png
[img 8]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/26/5c78923c1c344cee82b63be389415fd9.png
[img 9]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/26/0ca9234b63964e1388c040cb6674565d.png
[img 10]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/26/eab4fbfc65ef478cbd5a88a583b594ed.png
[img 11]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/26/96a192df54054e64a7b4556738a03a98.png
[img 12]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/26/fd7a11d81c87484bb1c269da27d6cd9c.png
[img 13]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/26/73d415fe58e44085bd70364302a58e35.png
[img 14]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/26/54b82be5873647d48b38d534f8869771.png
[img 15]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/26/f560991a8eca4c9b9940621d35dc956d.png
[img 16]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/26/fd2d6f63826c4236bc2d7678b49c2760.png
[img 17]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/26/4eca9274c2894ec888bc386fdbc718ad.png
[img 18]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/26/d1baad548e1a4a45a9a2c730fa17f89f.png
[img 19]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/26/ae8ce63cebf942df87445a7e3f244cfe.png
[img 20]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/26/b77d173f0ed848ada68fba363fcbd6f1.png
[img 21]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/26/f816721c46e141bfadddccadb30c64ef.png