SpringBoot日志

日志有什么用？

日志最主要的用途就是排查和定位错误，除此之外，日志还可以将错误信息具体化，比如时间、位置等。

如何打印日志

使用Logger类

使用方法：

Logger log = LoggerFactory.getLogger（类名/类名.class）

（注意：Logger是 org.slf4j 包下的）

如果括号为类名，此时打印的日志中就不会有类所处的包名信息；如果是类名.class此时会打印包名和类名。（建议使用类名.class）

@RestController // = @Controller + @ResponseBody
public class StudentController {
    private static final Logger log = LoggerFactory.getLogger(StudentController.class);

    @RequestMapping("stu/sayHi")
    public String sayHi() {
        log.trace("stu trace");
        log.debug("stu debug");
        log.info("stu info");
        log.warn("stu warn");
        log.error("stu error");
        return "hello stu";
    }
}

 打开127.0.0.1:端口号/stu/sayHi后打印如下：

info、warn、error的日志部分都进行了打印，但是没有打印trace和debug的日志。

这是因为SpringBoot默认日志级别为info，低于info级别的日志不会打印，而trace和debug的级别都低于info。

设置日志打印级别

日志的级别分为六种，由低到高：

trace、debug、info、warn、error、fatal（fatal级别对应代码出现异常退出，这个级别的日志是无法打印的，但是它会存在日志信息里）

设置打印级别需要再配置文件里面设置。

配置文件详情看：SpringBoot配置文件_追梦不止～的博客-CSDN博客

日志级别可以设置全局目录 root（root也可以换成*），也可以设置某个路径下的日志级别。

# 日志级别设置
logging:
  level:
    root: error # 全局目录
    com: #设置某个目录，输入包名/类名
      example:
        demo:
          controller: error
          service: warn

上述代码的意思是：全局目录的日志打印的最低级别为error（比error级别低的日志不打印），在com.example.demo包下的controller包的最低打印日志级别为error，service包的最低日志打印级别为warn。（设置某个类也是同理 类名：级别）

日志的持久化存储

如果想实现日志持久化存储就要将日志存储到硬盘中（文件/数据库）

我们可以通过设置配置文件的方式将日志存储到指定的文件中。

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

此时我们的日志会存储到 D:\log\log_all.log 这个文件里面（文件可以不自己创建/指定），即使重启项目打印了新的日志，旧的日志也会存在文件中。

使用lombok实现更简单的打印日志

安装lombok插件

安装流程可以查看SpringBoot项目创建和使用_追梦不止～的博客-CSDN博客

如果项目已经创建好了，此时可以安装另一个插件：Edit Starters

 

在设置中的插件里查找Edit Starters，安装后重启项目（不重启也可能生效），然后在pom.xml中右击鼠标，点击生成。

点击Edit Starters

  

最后在里面搜索需要的依赖，add即可。

安装好之后，在需要加日志的类上加 @Slf4j 标签之后，类中就自带了一个Logger的对象，对象名为log，此时就不必再实例化一个Logger对象了，直接使用log即可。

@RestController
@Slf4j // 给当前类当中添加一个 名为 log 的日志对象 ( = slf4j里面的 Logger 对象)
public class LogController {
    @RequestMapping("/log/sayHi")
    public String sayHi() {
        log.trace("this log trace");
        log.debug("this log debug");
        log.info("this log info");
        log.warn("this log warn");
        log.error("this log error");
        return "log sayHi";
    }
}

lombok的原理

lombok实现的这些功能是在类编译阶段实现的（生成.class文件之前），我们来查看一下.class文件就可以很好的看到了。

比如这个类：

@Setter
@Getter
@ToString
public class StudentComponent {
    private int id;
    private String name;
    private int age;
}

它的.class文件如下：

package com.example.demo.component;

public class StudentComponent {
    private int id;
    private String name;
    private int age;

    public StudentComponent() {
    }

    public void setId(final int id) {
        this.id = id;
    }

    public void setName(final String name) {
        this.name = name;
    }

    public void setAge(final int age) {
        this.age = age;
    }

    public int getId() {
        return this.id;
    }

    public String getName() {
        return this.name;
    }

    public int getAge() {
        return this.age;
    }

    public String toString() {
        return "StudentComponent(id=" + this.getId() + ", name=" + this.getName() + ", age=" + this.getAge() + ")";
    }
}

可以看到，lombok在编译阶段会将我们需要的方法加入到类中，并且由于是在编译阶段完成，所以lombok并不会对运行时的效率产生影响。