【Java】Spring Boot 日志文件

梦里梦外; 2024-03-26 16:08 30阅读 0赞

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

*  SpringBoot日志文件
 *   *  1. 日志有什么用
     *  2. 日志怎么用
     *  3. 自定义日志打印
     *   *  3.1 在程序中得到日志对象
         *  3.2 使用日志对象打印日志
     *  4. 日志级别
     *   *  4.1 日志级别有什么用？
         *  4.2 日志级别的分类与使用
     *  5. 日志持久化
     *  6. 更简单的日志输出--lombok
     *   *  6.1 添加 lombok 依赖
         *  6.2 输出日志
         *  6.3 lombok原理解释
         *  6.4 lombok更多注解说明
     *  7. 总结

## SpringBoot日志文件 ##

### 1. 日志有什么用 ###

日志是程序的重要组成部分，想象一下，如果程序报错了，不让你打开控制台看日志，那么你能找到报错的原因吗。

日志对于我们来说，最主要的用途就是排除和定位问题。除了发现和定位问题之外，我们还可以通过日志实现以下功能：

*  记录用户登录日志，方便分析用户是正常登录，还是恶意破解用户
 *  记录系统的操作日志，方便数据恢复和定位操作人
 *  记录程序的执行时间，方便以后优化程序提供数据支持

### 2. 日志怎么用 ###

Spring Boot项目在启动的时候默认就会有日志的输出，如下图：

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

通过上述信息我们可以发现：

*  Spring Boot内置了日志框架
 *  默认情况下，输出的日志并不是开发者定义和打印的，那么开发者怎么在程序中定义打印日志？
 *  日志默认是打印在控制台上，而控制台的日志是不能被保存的， 如何将日志永久的保存下来？

### 3. 自定义日志打印 ###

开发者自定义打印日志的实现步骤：

1.  在程序中得到日志
2.  使用日志对象的相关语法输出要打印的内容

#### 3.1 在程序中得到日志对象 ####

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

日志工厂需要将每个类的类型传进去，这样我们才能知道日志的归属类，才能更方便更直观的定位到问题

注意：logger对象属于org.slf4j包下的，不要导错了  
![在这里插入图片描述][b128b5c11252412fafee35d52781774d.png]

#### 3.2 使用日志对象打印日志 ####

日志对象的打印方法有很多种，我们可以使用info方法来输出日志，

@Controller
    @ResponseBody
    public class UserController {
        
        private static final Logger log = LoggerFactory.getLogger(UserController.class);
        @RequestMapping("/sayhi")
        public void sayHi() {
        
            log.trace("trace");
            log.debug("debug");
            log.info("info");
            log.warn("warn");
            log.error("error");
        }
    }

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

### 4. 日志级别 ###

#### 4.1 日志级别有什么用？ ####

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

#### 4.2 日志级别的分类与使用 ####

日志级别分为：

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

日志级别的顺序：  
![在这里插入图片描述][a378470bcb564916985f643752a73e06.png]

越往上，接收到的信息就越少，如设置了warn就只能接收到warn及其上面的级别

**日志级别设置**

logging:
      level:
        root: error

**默认日志输出级别**

清除掉配置文件当中的日志设置，观察控制台输出的日志级别

得到结论，日志输出级别默认是info

**当存在局部日志级别和全局日志级别设置，那么当访问局部日志时，使用的是局部日志级别。也就是局部日志优先级高于全局日志的优先级**

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

以上的日志都是输出在控制台上，然而生产环境上咱们需要将日志保存下来，以便出现问题之后追溯问题，把日志保存下来的过程叫做持久化

想要将日至持久化，只需要在配置文件中指定日志的存储目录或者是指定日志保存文件名，Spring Boot就会将控制台的日志写到相应的目录或文件下

配置日志文件的保存路径：

logging:
      file:
        path: D:\rizhi

保存的路径，当中包含转义字符方面的设置我们可以使用这个`/`来作为分割符。

如果坚持使用Windows下的分割符，我们需要使用`\`转义字符来转义一下

配置日志文件的文件名：

logging:
      file:
        name: D:/rizhi/logger/spring.log

### 6. 更简单的日志输出–lombok ###

每次使用LoggerFactory.getLogger很繁琐，且每个类都添加一遍，也很麻烦。这里的lombok是一种更好的日志输出方式

1.  添加lombok框架支持
2.  使用@slf4j注解输出日志

#### 6.1 添加 lombok 依赖 ####

首先要安装一个插件：![在这里插入图片描述][c500bb57df0b4bdc99629a085874497c.png]

然后再pom.xml页面右键、![在这里插入图片描述][a0b3ab5fbffe4993ace069ca9edc4437.png]![在这里插入图片描述][911ab6f881b242e6b077f8bb4766ab35.png]  
![在这里插入图片描述][e28018e97f6747ad88314b4c851cef00.png]

最后重新添加依赖就可以了  
![在这里插入图片描述][21af3d1227bf4d5d84d35330e4f973c8.png]

#### 6.2 输出日志 ####

使用@Slf4j注解，在程序中使用log对象即可输入日志并且只能使用log对象才能输出，这是lombok提供的对象名

#### 6.3 lombok原理解释 ####

lombok 能够打印⽇志的密码就在 target ⽬录⾥⾯，target 为项⽬最终执⾏的代码，查看 target ⽬录我们可以发现：

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

这里的@Slf4j注解变成了一个对象。

下面是java程序的运行原理：

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

#### 6.4 lombok更多注解说明 ####

基本注解

<table> 
 <thead> 
  <tr> 
   <th>注解</th> 
   <th>作用</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@Getter</td> 
   <td>自动添加get方法</td> 
  </tr> 
  <tr> 
   <td>@Setter</td> 
   <td>自动添加set方法</td> 
  </tr> 
  <tr> 
   <td>@ToString</td> 
   <td>自动添加toString方法</td> 
  </tr> 
  <tr> 
   <td>@EqualsAndHashCode</td> 
   <td>自动添加equals和hasCode方法</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>@RequiredArgsConstructor</td> 
   <td>自动添加必须属性的构造方法，final + @NonNull的属性为需</td> 
  </tr> 
 </tbody> 
</table>

组合注解：

<table> 
 <thead> 
  <tr> 
   <th align="center">注解</th> 
   <th align="center">作用</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="center">@Data</td> 
   <td align="center">@Getter+@Setter+EqualsAndHashCode+@RequiredArgsConstructor+@NoArgsConstructor</td> 
  </tr> 
 </tbody> 
</table>

日志注解

<table> 
 <thead> 
  <tr> 
   <th>注解</th> 
   <th>作用</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@Slf4j</td> 
   <td>添加一个名为log的对象</td> 
  </tr> 
 </tbody> 
</table>

### 7. 总结 ###

日志是程序员中的重要组成部分，使用日志可以快速的发现和定位问题，Spring Boot提供了日志框架，默认情况下使用的是info日志级别将日志输出到控制台的。我们可以通过lombok提供的@Slf4j注解和log对象快速的打印自定义日志，日志包含了6个级别：

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

日志级别依次提升，而日志级别越高，收到的日志信息也就越少，我们可以通过配置日志的保存域名或保存目录来将日志永久的保存下来

[3e3c7158dcb349ff995562d987b76b3f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/9af48e86e0dc4dd98dca968fc0d6a47b.png
[b128b5c11252412fafee35d52781774d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/e53db56259724e6e9f5d4b5c881089f8.png
[4c049fa82a914b06b4bdd25dc26c6ab2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/b011292a2cf04e879b5a34ae8e03f384.png
[a378470bcb564916985f643752a73e06.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/4cf3b91114e94a399eb0735942d77851.png
[c500bb57df0b4bdc99629a085874497c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/f61c70cdf2014a668ede6ca521ffe1a2.png
[a0b3ab5fbffe4993ace069ca9edc4437.png]: https://img-blog.csdnimg.cn/a0b3ab5fbffe4993ace069ca9edc4437.png
[911ab6f881b242e6b077f8bb4766ab35.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/bda1a2b2f8b749b4a9a625cce76fbdc3.png
[e28018e97f6747ad88314b4c851cef00.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/305436e15fce4d988d2790a79f6df117.png
[21af3d1227bf4d5d84d35330e4f973c8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/99222d8e1f07403780916e61c526a4f3.png
[351605165f324ce5bce86642fece3a58.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/cc04fa8ab1c94d8cb51f82974a1eed66.png
[e61a70175c1a47b29845493658a9ceec.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/0cd0e776c9724a608f7d4bbddf14bd0e.png