SpringBoot 日志文件

客官°小女子只卖身不卖艺 2023-10-10 17:32 18阅读 0赞

## 1.日志的作用 ##

日志是程序的重要组成部分,最常见的,当程序报错时,打开控制台就能看到报错信息,这些就是日志.通过日志,可以看到错误信息,找到错误原因

除了发现和定位问题,日志还能实现这些实用的功能:

> 记录用户登录日志,分析用户是正常登录还是恶意破解用户(用来分析用户的行为)
> 
> 记录系统的操作日志,方便数据恢复和定位操作人
> 
> 记录程序时间,为优化程序提供数据支持

## 2.如何使用日志? ##

当我们启动SpringBoot项目时,控制台就会出现系统打印的日志

这是SpringBoot内置了日志框架,才能输出日志

![48961f6034124ad48bcb71c37f91a451.png][] 默认情况下,输出的日志并非是开发者自定义的,那么开发者如何自定义日志呢?

当项目重启,控制台就会输出新的日志,那么旧的日志是不能被保存的,如何让日志持久保存呢?

常见的日志框架

![baafb81eeeb14e7a98d57c3b1220a8b8.png][]

> SpringBoot内置的日志框架:Slf4j 日志实现是:logback
> 
> 我们并没有在依赖中引入,是因为SpringBoot已经内置了
> 
> ![152e72faee87491f9969c3b75523fe9f.png][]
> 
> ![51caa1ad5449472792fcc903faaabe0c.png][]

所以我们可以在程序中直接调用Slf4j直接输出日志

自定义日志实现(尽可能设施8080之后的端口,端口太小可能启动失败!)

![f0f8fb4a142148d4a7a2c395adefc8ac.png][]

结果:

![a812fe4b6dc940d3b143331a919d4f65.png][]

控制台:

![8f420ed62e2b4a6cacc92cc0ad7c557a.png][]

可以看到:SpringBoot输出的日志非常详细,可以用来定位问题位置

我们打印的没有时间,位置等等.无法精确定位到一个问题,并且不支持持久化,不能保存

使用SpringBoot日志打印分为两步

1.得到日志对象

![7e96c3a23ba74975a5a7742872d2f559.png][]

参数是类类型

![2d68ed7d3dd94756b3866831da513c68.png][]

这里传参,就决定了日志打印时,打印的类的信息

2.使用对象的方法打印日志

![75439226c98b473ea71dafb46901cdd2.png][]

![0b43ac5a733d4826ac28458d8063e76a.png][]上述只出现了三个自定义打印的日志信息:info,error,warn,和日志级别有关

info是默认的日志级别,日志打印只能打印比默认级别更高的日志信息,所以trace和debug没打印

这里有日志时间,级别,日志线程的id,日志的线程名,简化包名加完整类名,自定义信息

@Controller
    @ResponseBody
    public class UserController {
    
        //1.得到日志对象
        /*
        每个日志对象只归属于一个类,是类私有的
        日志打印时需要输出:是在哪个类中的日志
        修饰符为private,静态方法可直接调用
        不期望被修改,加上final
         */
        private static final Logger log = LoggerFactory.getLogger(UserController.class);
    
        //2.打印日志
        @RequestMapping("/hi")
        public String hi(){
            //System.out.println("打印日志");
            log.trace("i'm trace");
            log.debug("i'm debug");
            log.info("i'm info");
            log.error("i'm error");
            log.warn("i'm warn");
            return "hi world -> ";
        }
    }

使用另一个注解也能完成:@RestContrller ,更加简单

![33c9c4a7068e4a218572ca21b87252fa.png][]

![875a54e342444341bab3a369fbe94c79.png][]

![1bc98c0e83314828a905bc9f0c79c44a.png][]

打印的日志是没有包名的,如果一个项目其它包中有相同名称的类,就分不清楚了

自定义日志推荐使用参数为类类型的,信息更全

## 3.日志级别 ##

> 日志级别可以筛选出重要的信息,设置为error,就能看到程序的报错日志,普通的调试日志和业务日至就忽略了
> 
> 日志级别可以控制不同环境下,一个程序是否需要打印日志,开发时需要详尽的日志帮助开发;生产环境下需要尽可能少的日志信息,保证程序的性能和安全性

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

日志级别从低到高分为:

> trace:级别最低
> 
> debug:需要调试的时候的关键信息打印
> 
> info:(默认日志级别)普通信息打印
> 
> warn:警告,不影响使用,但需要注意问题
> 
> error:错误信息,级别较高
> 
> fatal:致命的,代码异常导致程序退出

如何设置日志默认级别?  
在配置文件中,设置 logging.level 即可

这是yml的写法:

![d80b2b35995f48a58d363217498ad02b.png][]

重启项目,访问 UserController 的 hi 方法

## ![147fe5791f784555a70b88013e28de9f.png][]4.日志持久化 ##

上述日志都是输出在控制台的,生产环境下需要保存日志,以便出问题时追溯问题,把日志保存下来的过程叫做日志持久化

进行日志持久化,需要在配置文件中指定日志的存储目录或者指定日志保存文件名之后,Spring Boot就会将控制台的日志写到相应目录或文件下

### 1.设置日志保存路径 ###

![2cabf15652254145a408fcf134e716a1.png][]

记得在主配置文件中设置下运行环境

![691b5a0d67234b03a7e2924c018cceec.png][]

![561b655d401f4e47922d2b6a9dcf7ccc.png][]

![2ea77fa1535c455a9cd298c7725c3b39.png][] 访问hi方法后会进行日志的追加

![6ba8a4eee1c64ee3883494c44a6d36d7.png][] 日志文件一旦产生,文件及其内容就会永久保存,不会出现文件或内容丢失,无论任何操作都会保持以上特性

### 2.设置日志保存名称 ###

![b9de4287fd284309aa5720db5f116e33.png][]

没有设置过路径,会默认保存在项目路径下

![6b8733afeba4478c9dc684c5f44f4844.png][]

路径+名称可以实现在某个路径下保存日志

![bddef60e537c40ec942137b6bf81015f.png][]

![70fe3f5877a64031ba91f0d265d0da99.png][]

日志是中文需要设置字符集为utf8

> 当日志文件超过10m,就会重新创建一个新的日志文件,所以不用担心文件时间太长积累数据过大
> 
> 也可以通过配置修改文件存储上限(loggin.logback.rollingpolicy.max-file-size)

生产级别日志分类:

1.程序运行日志,存放在文件中

2.业务日志,存放到数据库

### 更简单的输出日志-loombok ###

步骤:

1.添加lombok支持

快速添加springboot的依赖方式:

1.安装插件,重启IDEA

![079011fa7a9f44f6af072ccbaccc4e00.png][]

2.pom.xml中右键Generate

![48d9d6d1d5b549a8a19a6d0eaf339ea3.png][]

![6dc109c5344c466194eb8a03f1635058.png][]

reload一下,添加lombok

2.使用@Slf4j注解输出日志

![aac3a7ba46314fccae16a459fde8572b.png][]

![b2873dc87b5443e0936eeac03d43b278.png][]![4b05164c9257419095f73f59006b5322.png][]

这种方法就省略了我们自己获取日志对象的过程,非常简便!

## 4.lombok的使用 ##

之前已经介绍和使用了lombok

Lombok能通过注解的方式，在编译时自动为属性生成构造函数、getter/setter、equals、hashcode、toString等方法。奇妙之处在于源码中没有getter和setter方法，但是在编译生成的字节码文件中有getter和setter方法。省去了手动重建这些代码的麻烦，使代码看起来更简洁明了

原理就是在编译时,根据语义生成相应的字节码文件,是一个编译期框架

这么多注解,可以使用一个聚合注解代替:@Data

![10361a8858bb407eaa8861006f3f9018.png][]

`@Data`注解在类上，会为类的所有属性自动生成setter/getter、equals、canEqual、hashCode、toString方法，如为final属性，则不会为该属性生成setter方法。`@Value`注解和`@Data`类似，区别在于它会把所有成员变量默认定义为private final修饰，并且不会生成set方法

`@NoArgsConstructor`、`@RequiredArgsConstructor`和`@AllArgsConstructor`

三个注解都是用在类上的，第一个和第三个都很好理解，为该类产生无参的构造方法和包含所有参数的构造方法，第二个注解则使用类中所有带有@NonNull注解的或者带有final修饰的成员变量生成对应的构造方法，当然，成员变量都是非静态的，另外，如果类中含有final修饰的成员变量，是无法使用@NoArgsConstructor注解的

[48961f6034124ad48bcb71c37f91a451.png]: https://img-blog.csdnimg.cn/48961f6034124ad48bcb71c37f91a451.png
[baafb81eeeb14e7a98d57c3b1220a8b8.png]: https://img-blog.csdnimg.cn/baafb81eeeb14e7a98d57c3b1220a8b8.png
[152e72faee87491f9969c3b75523fe9f.png]: https://img-blog.csdnimg.cn/152e72faee87491f9969c3b75523fe9f.png
[51caa1ad5449472792fcc903faaabe0c.png]: https://img-blog.csdnimg.cn/51caa1ad5449472792fcc903faaabe0c.png
[f0f8fb4a142148d4a7a2c395adefc8ac.png]: https://img-blog.csdnimg.cn/f0f8fb4a142148d4a7a2c395adefc8ac.png
[a812fe4b6dc940d3b143331a919d4f65.png]: https://img-blog.csdnimg.cn/a812fe4b6dc940d3b143331a919d4f65.png
[8f420ed62e2b4a6cacc92cc0ad7c557a.png]: https://img-blog.csdnimg.cn/8f420ed62e2b4a6cacc92cc0ad7c557a.png
[7e96c3a23ba74975a5a7742872d2f559.png]: https://img-blog.csdnimg.cn/7e96c3a23ba74975a5a7742872d2f559.png
[2d68ed7d3dd94756b3866831da513c68.png]: https://img-blog.csdnimg.cn/2d68ed7d3dd94756b3866831da513c68.png
[75439226c98b473ea71dafb46901cdd2.png]: https://img-blog.csdnimg.cn/75439226c98b473ea71dafb46901cdd2.png
[0b43ac5a733d4826ac28458d8063e76a.png]: https://img-blog.csdnimg.cn/0b43ac5a733d4826ac28458d8063e76a.png
[33c9c4a7068e4a218572ca21b87252fa.png]: https://img-blog.csdnimg.cn/33c9c4a7068e4a218572ca21b87252fa.png
[875a54e342444341bab3a369fbe94c79.png]: https://img-blog.csdnimg.cn/875a54e342444341bab3a369fbe94c79.png
[1bc98c0e83314828a905bc9f0c79c44a.png]: https://img-blog.csdnimg.cn/1bc98c0e83314828a905bc9f0c79c44a.png
[d80b2b35995f48a58d363217498ad02b.png]: https://img-blog.csdnimg.cn/d80b2b35995f48a58d363217498ad02b.png
[147fe5791f784555a70b88013e28de9f.png]: https://img-blog.csdnimg.cn/147fe5791f784555a70b88013e28de9f.png
[2cabf15652254145a408fcf134e716a1.png]: https://img-blog.csdnimg.cn/2cabf15652254145a408fcf134e716a1.png
[691b5a0d67234b03a7e2924c018cceec.png]: https://img-blog.csdnimg.cn/691b5a0d67234b03a7e2924c018cceec.png
[561b655d401f4e47922d2b6a9dcf7ccc.png]: https://img-blog.csdnimg.cn/561b655d401f4e47922d2b6a9dcf7ccc.png
[2ea77fa1535c455a9cd298c7725c3b39.png]: https://img-blog.csdnimg.cn/2ea77fa1535c455a9cd298c7725c3b39.png
[6ba8a4eee1c64ee3883494c44a6d36d7.png]: https://img-blog.csdnimg.cn/6ba8a4eee1c64ee3883494c44a6d36d7.png
[b9de4287fd284309aa5720db5f116e33.png]: https://img-blog.csdnimg.cn/b9de4287fd284309aa5720db5f116e33.png
[6b8733afeba4478c9dc684c5f44f4844.png]: https://img-blog.csdnimg.cn/6b8733afeba4478c9dc684c5f44f4844.png
[bddef60e537c40ec942137b6bf81015f.png]: https://img-blog.csdnimg.cn/bddef60e537c40ec942137b6bf81015f.png
[70fe3f5877a64031ba91f0d265d0da99.png]: https://img-blog.csdnimg.cn/70fe3f5877a64031ba91f0d265d0da99.png
[079011fa7a9f44f6af072ccbaccc4e00.png]: https://img-blog.csdnimg.cn/079011fa7a9f44f6af072ccbaccc4e00.png
[48d9d6d1d5b549a8a19a6d0eaf339ea3.png]: https://img-blog.csdnimg.cn/48d9d6d1d5b549a8a19a6d0eaf339ea3.png
[6dc109c5344c466194eb8a03f1635058.png]: https://img-blog.csdnimg.cn/6dc109c5344c466194eb8a03f1635058.png
[aac3a7ba46314fccae16a459fde8572b.png]: https://img-blog.csdnimg.cn/aac3a7ba46314fccae16a459fde8572b.png
[b2873dc87b5443e0936eeac03d43b278.png]: https://img-blog.csdnimg.cn/b2873dc87b5443e0936eeac03d43b278.png
[4b05164c9257419095f73f59006b5322.png]: https://img-blog.csdnimg.cn/4b05164c9257419095f73f59006b5322.png
[10361a8858bb407eaa8861006f3f9018.png]: https://img-blog.csdnimg.cn/10361a8858bb407eaa8861006f3f9018.png