Spring Boot 日志文件 ——打印日志和日志持久化详解

1. 日志有什么用

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

答案是否定的，写程序不是买彩票，不能完全靠猜，因此日志对应我们来说，最重要的用途就是排除和定位问题。

除了发现和定位问题之外，我们还可以通过日志实现以下功能：

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

2. 日志怎么用

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

以上内容就是 Spring Boot 输出的控制台日志信息。
通过上述日志信息我们可以发现以下3个问题：

• Spring Boot 内置了日志框架（不然也输出不了日志）
• 默认情况下，输出的⽇志并⾮是开发者定义和打印的，那开发者怎么在程序中⾃定义打印⽇志呢？
• ⽇志默认是打印在控制台上的，⽽控制台的⽇志是不能被保存的，那么怎么把⽇志永久的保存下来 呢？

下面我们一起来找寻这些问题的答案。

3. Spring Boot 自定义日志的打印

1. 在一个类中先获取到打印日志对象（日志框架提供的日志对象，而日志框架默认已经集成到 Spring Boot 里了）
2. 使用日志对象提供的方法实现日志的打印

3.1 先获取到打印日志对象

在程序中获取日志对象需要使用日志工厂 LoggerFactory,如下代码所示：

 // 1.先得到日志对象（来自 slf4j）
    private static final Logger log =
            LoggerFactory.getLogger(UserController.class);

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

注意：Logger 对象是属于 org.slf4j 包下的，不要导入错误。

因为 Spring Boot 中内置了日志框架 slf4j，所以 咋们可以直接在程序中调用 slf4j 来输出日志

3.2 使用日志对象打印日志

日志对象的打印方法有很多，我们可以先使用 info（） 方法来输出日志，如下代码所示：

// 2.使用日志对象提供的打印方法进行日志打印
        log.trace("我是 trace");
        log.debug("我是 debug");
        log.info("我是 info");
        log.warn("我是 warn");
        log.error("我是 error");

打印效果展示：

3.3 日志格式说明

4. 日志级别

5. 日志持久化（将日志永久的保存到磁盘的某个位置）

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

想要将⽇志进⾏持久化，只需要在配置⽂件中指定⽇志的存储⽬录或者是指定⽇志保存⽂件名之后， Spring Boot 就会将控制台的⽇志写到相应的⽬录或⽂件下了。

5.1 实现：设置日志的保存路径

在配置文件中，输入如下代码：

# 设置日志的保存路径
# 正确设置日志路径的方式1
logging.file.path=D:/JavaCode/
# 正确设置日志路径的方式2
logging.file.path=D:\\JavaCode\\

保存后：

注意：

logging.file.path=D:\JavaCode\

这种写法，Spring Boot 会认为是一个特殊字符，而非目录，所以日志持久化不会成功。

6. 更简单的日志输出—lombok

每次都使用 LoggerFactory.getLogger(xxx.class) 很繁琐，而且每个类都要添加一遍，也很麻烦，这里有种更好的日志输出方式，使用 lombok 来更简单的输出。

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

6.1 添加 lombok 到当前项目

1 在 pom.xml 中先删除已有的 lombok 依赖

2.下载插件

下载好之后，手动引入 lombok 依赖

6.2 使用 @Slf4j 得到日志对象 log

@Controller
@ResponseBody
@Slf4j // 替代了之前需要通过 LoggerFactory.getLogger 操作
public class UserService {
        @RequestMapping("/sayhi2")
        public void sayHi2() {
                log.trace("我是 trace");
                log.debug("我是 debug");
                log.info("我是 info");
                log.warn("我是 warn");
                log.error("我是 error");
        }
}

控制台打印结果如下：

总结

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

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

⽇志级别依次提升，⽽⽇志界别越⾼，收到的⽇志信息也就越少，我们可以通过配置⽇志的保存名称或 保存⽬录来将⽇志永久地保存下来。