目录
- 一、日志文件
- 1.1 日志文件的作用
- 1.2 Spring Boot内置了日志框架
- 1.3 日志的格式说明
- 1.4 自定义日志打印
- 1.5 日志的持久化
- 1.6 日志的级别
- 1.6.1 日志级别有什么作用
- 1.6.2 日志的级别划分
- 1.6.3 日志级别的设置
- 1.7 使用lombok输出日志
- 1.7.1 lombok的原理
- 1.7.2 lombok其他注解
一、日志文件
1.1 日志文件的作用
日志是程序的重要组成部分,最重要的作用是排除和定位问题,还可以通过日志实现一些其他的功能:
- 记录用户登录日志,方便分析用户是正常用户还是恶意破解用户
- 记录系统的操作日志,翻遍数据恢复和定位操作人
- 记录程序的执行时间,方便为以后优化程序提供数据支持
1.2 Spring Boot内置了日志框架
在启动Spring Boot之后,就会有日志输出:
1.3 日志的格式说明
1.4 自定义日志打印
自定义日志的实现步骤:
- 在程序中得到日志对象
- 使用日志对象的相关语法输出要打印的内容
注意:
Logger 对象是属于 org.slf4j 包下的
【常见的日志框架】
日志门面主要用来提高代码的移植性,例如SLF4J会根据日志底层具体实现框架进行适配
【为什么不能有System.out代替日志】
- 只有打印信息,而没有其他的信息,包括级别、类名、时间等
- 对于日志来说可以通过设置级别控制日志在不同的环境是否显示,而System.out做不到
1.5 日志的持久化
正常情况下,日志都是输出到控制台上的,但在生产环境上需要将日志保存下来,以便出现问题之后追朔问题,把日志保存下来的过程就叫持久化
有两种方式可以实现日志的持久化:
- 配置日志文件的保存路径
# 设置日志的保存目录
logging:
file:
path: D:\log\
- 配置日志文件的文件名
# 设置日志的保存文件
logging:
file:
name: springboot.log
相当于在项目的根路径下生成一个springboot.log的日志文件
注意:
- 日志会一直追加到该文件中,不会丢失
- 当日志比较大的时候,会自动分隔成多个文件
1.6 日志的级别
1.6.1 日志级别有什么作用
- 日志的级别能帮助筛选重要的信息,例如设置日志级别为error,那么就可以只看程序的报错日志,对于普通的调试日志和业务日志就被筛选掉了,提高排错误的效率
- 日志可以控制不同环境下,一个程序是否需要打印日志,如开发环境需要详细的日志信息,而生产环境为了保证性能和安全性就会输入尽量少的日志,而通过日志级别可以实现此需求
1.6.2 日志的级别划分
日志的级别分别为:
- trace:微量,稍许,级别最低
- debug:需要调试时候的关键信息打印
- info:普通的日志,Springboot默认日志级别
- warn:警告,不影响程序运行,但需注意
- error:错误信息
- fatal:致命的,因为代码异常导致程序退出执行的事件
越往下,收到的日志信息越少,trace级别,能够收到所有级别的信息,warn级别,只能收到warn、error、fatal级别的信息
1.6.3 日志级别的设置
在配置文件中设置"logging.level"配置项
设置某个目录下的日志级别:
logging:
level:
com:
example:
demo:
model: warn
设置全局的日志级别:
logging:
level:
root: debug
配置全局级别为debug,trace级别的日志不会被打印出来
1.7 使用lombok输出日志
每次都使用LoggerFactory.getLogger(xxx.class) 很繁琐,且每个类都添加⼀遍,而添加了lombok依赖后,输出日志的写法更简单
- 添加lombok框架支持
- 使用@Slf4j注解
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.20</version>
<optional>true</optional>
</dependency>
使用@Slf4j注解,日志的对象名为log,这是lombok提供的对象名
1.7.1 lombok的原理
lombok会根据@Slf4j加到了哪个类上,然后在对应的class文件(字节码文件)中,生成一行这个样的代码:
private static Logger logger= LoggerFactory.getLogger(xxxx.class);
1.7.2 lombok其他注解
@Getter,@Setter,@ToString,@EqualsAndHashCode,@NoArgsConstructor,@AllArgsConstructor,@NonNull,@RequiredArgsConstructor
组合注解:
日志注解: