【浅学Java】SpringBoot 日志文件

1. 认识日志文件

1.1. 日志文件有什么用？

日志就是我们在运行SpringBoot时，控制台上打印出来的如下内容：

它是用来发现程序在运行时的错误

1.2 日志文件的格式

2. 自定义日志文件的打印

实现步骤：

1. 得到日志对象
2. 通过设置日志级别来筛选和控制日志内容

@RestController
public class TestController {
    //1.得到日志对象
    private static Logger log = LoggerFactory.getLogger(TestController.class);
    @RequestMapping("/hi")
    public String sayhi(){
        log.info("Hi,Spring Boot Log!");
        return "打印成功";
    }
}

运行程序：

注意：在选择Logger 和 LoggerFactory时，都选择s l f 4 j:

那么为什么要选择slf4j呢？
因为 Spring Boot 中内置了⽇志框架 Slf4j，所以咱们可以直接在程序中调⽤slf4j来输出日志。

3. 日志的持久化

3.0 什么时日志持久化

在⽣产环境上咱们需要将⽇志保存下来，以便出现问题之后追
溯问题，把⽇志保存下来的过程就叫做持久化。

持久化日志会有两种方式：

1. 通过设置日志名称
2. 通过设置日志目录

3.1 设置日志名称

配置文件：

# 日志的保存名称
logging:
  file:
    name: springboot.log

运行程序，就会创建一个log文件：

如果没有创建的话，就先删除掉项目目录下的target包，重新运行一遍:

3.2 设置日志目录

配置文件：

# 日志的保存目录
logging:
  file:
    path: C:\work\

运行程序，就在C:\work\创建一个spring.log文件：

3.3 持久化日志的特点

1. 日志不会丢失，会一直追加
2. 当日志较大时，会自动分割成多个文件(随着日志的增多，打开一个大的文件比较费时)

4. 日志的级别

日志级别分为：

1. trace：微量，少许的意思，级别最低；
2. debug：需要调试时候的关键信息打印；
3. info：普通的打印信息（默认⽇志级别）；
4. warn：警告，不影响使⽤，但需要注意的问题；
5. error：错误信息，级别较⾼的错误⽇志信息；
6. fatal：致命的，因为代码异常导致程序退出执⾏的事件。

设置日志级别的目的就是筛选日志，当设置日志级别为info时,控制台上面就不会打印debug和trace级别的日志。也就是不会打印比设置的日志级别低的日志。

5. 设置“日志级别”来筛选日志

通过配置文件来设置日志级别：

logging:
  level:
    root: error  //日志级别设置文error

测试代码：

@RestController
public class TestController {
    //1.得到日志对象
    private static Logger log = LoggerFactory.getLogger(TestController.class);
    @RequestMapping("/hi")
    public String sayhi(){
        //打印日志
        log.trace("hi,i am trace");
        log.debug("hi,i am debug");
        log.info("hi,i am info");
        log.warn("hi,i am warn");
        log.error("hi,i am error");
        return "打印成功";
    }
}

运行程序，结果：

控制台打印的日志里面只有级别 >= error的.

当然，特可以精细化设置日志级别：

6. 简化日志打印——lombok

每次都使⽤ LoggerFactory.getLogger(xxx.class) 很繁琐，且每个类都添加⼀遍，也很麻烦，这⾥讲⼀种更好⽤的⽇志输出⽅式，使⽤ lombok 来更简单的输出，具体步骤如下：

1. 添加 lombok 框架⽀持。
2. 使⽤ @slf4j 注解输出⽇志。

6.1 添加lombok依赖

<dependency>
	<groupId>org.projectlombokgroupId>
	<artifactId>lombokartifactId>
	<version>1.18.20version>
	<optional>trueoptional>
dependency>

6.2 使⽤ @slf4j 注解输出⽇志

@slf4j 就是lombok框架下面的一个注解，作用就是添加一个名为log的日志对象

@RestController
@Slf4j
public class TestController {
    @RequestMapping("/hi")
    public String sayhi(){
        //打印日志
        log.trace("hi,i am trace");
        log.debug("hi,i am debug");
        log.info("hi,i am info");
        log.warn("hi,i am warn");
        log.error("hi,i am error");
        return "打印成功";
    }
}

注意：使⽤ @Slf4j 注解，在程序中使⽤ log 对象即可输⼊⽇志，并且只能使⽤ log 对象才能输出，这是 lombok 提供的对象名

6.3 lombok原理解释

Lombok 的作⽤如下图所示：

即自动给他加上如下代码：

我们为可以在target里面看一下源代码的字节码，进而验证上述观点：

在之前用到的@Data，也是属于lombok注解，要想使用更多的lombok注解，可以在网上搜一下，然后放心使用就行。