SpringBoot——介绍日志的使用,知道代码报错的原因【必备技能】

举报
我是一棵卷心菜 发表于 2022/03/14 15:02:33 2022/03/14
【摘要】 学习笔记

一、前言

相信各位小伙伴或多或少使用过日志,日志其实就是记录程序日常运行的信息,主要作用如下:

  • 编程期调试代码
  • 运营期记录信息
  • 记录日常运营重要信息(峰值流量、平均响应时长……)
  • 记录应用报错信息(错误堆栈)
  • 记录运维过程数据(扩容、宕机、报警……)

或许各位小伙伴并不习惯于使用日志,没关系,慢慢多用,习惯就好。想进大厂,这是最基本的,别去面试的时候说没用过,完了,没机会了。

二、日志级别

在讲解如何使用日志之前,先介绍日志有哪些级别,这个很关键哦~

日志的级别分为6种,分别是:

  • TRACE:运行堆栈信息,使用率低
  • DEBUG:程序员调试代码使用
  • INFO:记录运维过程数据
  • WARN:记录运维过程报警数据
  • ERROR:记录错误堆栈信息
  • FATAL:灾难信息,合并计入ERROR

一般情况下,开发时候使用DEBUG,上线后使用INFO,运维信息记录使用WARN即可。

三、设置日志级别

在配置文件properties中,我们进行日志文件的配置,参考代码:

# 开启debug模式,输出调试信息,常用于检查系统运行状况
debug: true

但是这么设置太简单粗暴了,日志系统通常都提供了细粒度的控制

# 开启debug模式,输出调试信息,常用于检查系统运行状况
debug: true

# 设置日志级别,root表示根节点,即整体应用日志级别
logging:
	level:
    	root: debug

但是这还不够,还可以再设置更细粒度的控制,我们该怎么使用呢?

四、日志组

设置日志组,控制指定包对应的日志输出级别,也可以直接控制指定包对应的日志输出级别,通过这种方式,我们设置更细粒度的控制

logging:
  level:
    root: info
#    设置某个包的日志级别,即代码包
    com.cabbage.controller: debug
    one: error
#    设置分组,对某个组设置日志级别
  group:
    one: com.cabbage.controller,com.cabbage.controller
    two: com.cabbage.controller,com.cabbage.controller

需要注意的是,我举例中的包都是同一个,大家在实际使用的时候,根据自己的需要,选择自己想要的日志级别就可以了。

对以上内容进行总结

  • 日志用于记录开发调试与运维过程消息
  • 日志的级别共6种,通常使用4种即可,分别是DEBUGINFO,WARN,ERROR
  • 可以通过日志组或代码包的形式进行日志显示级别的控制

五、使用日志

在使用日志之前,我们需要导入需要的依赖:

<dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
 </dependency>

然后写一个代码用来测试,代码如下图:
在这里插入图片描述
再来看看运行结果:
在这里插入图片描述
最后来介绍注解@Slf4j,这个就是使用log对象的关键注解。当我们在类上面使用该注解后,就会自动含有一个内置的log对象这个log对象就可以使用日志的不同级别来检查代码了,非常的方便。需要注意的是,使用该代码之前,一定不要忘记添加lombok依赖哦~

六、日志输出格式

日志已经能够记录了,但是目前记录的格式是SpringBoot给我们提供的,如果想自定义控制就需要自己设置了。先分析一下当前日志的记录格式:
在这里插入图片描述
对于单条日志信息来说,日期触发位置记录信息是最核心的信息。级别用于做筛选过滤,PID与线程名用于做精准分析,了解这些信息后就可以DIY日志格式了,下面给出官网的日志模板,简单了解一下:

logging:
	pattern:
    	console: "%d %clr(%p) --- [%16t] %clr(%-40.40c){cyan} : %m %n"

七、日志文件

前面讲解了这么多,接下来就要说一说日志的转存了。日志不能仅显示在控制台上,还要把日志记录到文件中,方便后期维护查阅。

​记录日志到文件中格式非常简单,设置日志文件名和文件路径即可:

logging:
  file:
    path: E:\log
    name: log.server

虽然使用上述格式可以将日志记录下来了,但是面对实际的复杂情况,一个文件记录肯定是不能够满足要求的,通常会每天记录日志文件,同时为了便于维护,还要限制每个日志文件的大小。下面给出日志文件的常用配置方式,大家可以当做是一种模板:

logging:
  file:
    name: server.log
  logback:
    rollingpolicy:
      max-file-size: 3KB
      file-name-pattern: server.%d{yyyy-MM-dd}.%i.log

日志要求容量到达3KB以后就转存信息到第二个文件中。文件命名规则中的%d标识日期,%i是一个递增变量,用于区分日志文件。

当达到3K之后呢,就会形成另一个文档,如图:
在这里插入图片描述

八、总结

对于日志的介绍,相信各位小伙伴们已经对日志的使用有了一定的了解,还不赶紧去试一试~ 如果感觉博主写的还不错,可以三连支持一下哦~

【版权声明】本文为华为云社区用户原创内容,转载时必须标注文章的来源(华为云社区)、文章链接、文章作者等基本信息, 否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱: cloudbbs@huaweicloud.com
  • 点赞
  • 收藏
  • 关注作者

评论(0

0/1000
抱歉,系统识别当前为高风险访问,暂不支持该操作

全部回复

上滑加载中

设置昵称

在此一键设置昵称,即可参与社区互动!

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。