logback的使用
在学习JAVA闲暇时间翻阅别人的随笔中的过程中,我发现在学习开发中我们经常使用System.out.println()来打印一些信息用来输出日志,但是这样不好,因为这样会在大量的使用System.out的过程中会增加资源的消耗,在查阅相关资料后我发现在实际项目中我们可以使用的slf4j的logback来输出日志,使用这种方式来输出日志的话可以很明显的提高效率,SpringBoot提供了一套日志系统,从中可以看出logback是最优的选择。 在此之前,我一直是使用着使用System.out的方式来打印信息,输出日志,方式如下:控制台打印输出日志: System.out.println(需要输出的内容字符串)
但是在浏览随笔时我发现在一般开发阶段开发阶段,通常需要输出大量的信息以便于调试和追踪程序运行过程。然而,当将应用程序部署为产品时,由于安全性和性能等考虑,通常会减少对日志的输出。为了实现这种输出控制的需求,可以引入一种常量的定义方式。
如图:
为了控制输出的级别,你可以通过定义一个Constants
接口来管理常量,并使用int
类型的常量来表示不同的输出级别。
一、有关slf4j 介绍
SLF4J就是简单日志门面,它并不是具体的日志解决方案,它服务于各种各样的日志系统,在查看官方给出的介绍,按照官方的说法,SLFJ是一个用于日志系统的简单Facade,允许最终用户在部署其应用时使用其所希望的日志系统。
在我的理解来看,官方说法的意思应该是在需要写记录日志的代码的时候,只需要按照统一的方式来写记录日志的代码即可,使用者并不需要关心日志的输出时通过那个日志系统,或者是用什么样的风格用来输出。因为上述两者都是取决于部署项目的时候绑定的日志系统。
例如:如果在项目中使用了slf4j记录日志,并且绑定了log4j,也就是绑定了相关的依赖,那么日志就会用log4j的风格进行输出;如果后期需要将风格改为logback的风格输出日志,只需要将log4j替换成logback就可以,在过程中并不需要修改代码,这种方式对于第三方组件的引入的不同日志来说的学习成本很低,更不用说它的优点并不只是只有这一个,同时,它还具备这简洁的占位符的使用以及日志级别的判断。
在查阅资料的过程中我发现在2021年12月8日爆出的log4j2的远程代码执行漏洞【cve-2021-44228】,这个漏洞被称为史诗级核弹漏洞,logj时Apache的一个开源项目,是一个基于java的日志记录框架。log4j2时log4j的后继者,记录日志信息,很多互联网公司都在使用这个框架。Apache Log4j2 组件在开启日志记录功能后,凡是在触发错误记录日志的地方,插入漏洞利用代码,就可以利用成功,特殊情况下,如果这个组件记录的日志有很多其他系统的记录日志,就有可能造成间接投毒,通过中间系统,是的组件间接读取了具有攻击性的漏洞利用代码,也可以造成漏洞触发。
二、slf4j-log4j 通过 slf4j 调用 log4j 的实现
1.添加依赖
2.在 resources 根目录下创建一个 log4j 的配置文件 log4j.properties
log4j.rootLogger=DEBUG, stdout 根日志记录器,参数 1 为需要输出的日志等级,参数 2 为日志输出的目标地名称 stuout
log4j.appender.stdout=org.apache.log4j.ConsoleAppender 设置 stdout 是控制台输出
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout 配置日志输出的格式
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n
其中,对于Log4j 输出的目的地有如下几个:
org.apache.log4j.ConsoleAppender(控制台)
org.apache.log4j.FileAppender(文件)
org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件)
org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件)
org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)
3.编程中使用日志记录器输出用户自定义日志信息
三、结合springboot使用slf4j
因为 sfl4j 有如此多的优点,因此阿里将 slf4j 作为日志框架。
在《阿里 Java 开发手册(正式版)》中,日志规约一项第一条就强制要求使用 slf4j:
1.强制指的是在应用中不可以直接使用日志系统(Log4j、Logback)中的API,而是应该依赖于日志框架SLF4J中的API,使用门面模式的日志框架,有利于维护各个类的日志处理方式统一。看得出来强制这两个字可以很明显的看出slf4j的优势,所以在实际项目中可以适当使用slf4j作为自己的日志框架,slf4j记录日志是比较简单的,直接使用LoggerFactory创建就可以。目前SpringBoot针对日志系统默认采用的是logback。
import org.slf4j.Logger; import org.slf4j.LoggerFactory; public class Test { private static final Logger logger = LoggerFactory.getLogger(Test.class); // …… }
2.application.yml 中对日志的配置
Spring Boot 对于slf4支持的很好,它的内部集成了slf4j,一般情况下,在使用的时候会对slf4j做一下配置。application.yml 文件是 Spring Boot 中唯一需要配置的文件,一开始创建工程的时候是 application.properties 文件,但是一般情况下推荐使用 yml 文件,因为 yml 文件的层次感特别好,看起来更直观,但是 yml 文件对格式要求比较高,比如英文冒号后面必须要有个空格,否则项目估计无法启动,而且也不报错。用 properties 还是 yml 视个人习惯而定,实际上都是可以的。 application.yml 文件中对日志的配置如下:
logging:
config: logback.xml
level: 针对不同的包可以设置不同的日志输出等级,基本格式为【包名称: 等级】
com.zhao.dao: trace
logging.config 的作用是指定项目启动的时候,它要读取哪个配置文件,这里指定的是日志配置文件是根路径下的 logback.xml 文件,关于日志的相关配置信息,都放在 logback.xml 文件中了。logging.level 是用来指定具体的 mapper 中日志的输出级别,例如配置表示 com.yan.dao 包下的所有 mapper 日志输出级别为 trace,会将操作数据库的 sql 打印出来,开发时设置成 trace 方便定位问题,在生产环境上,将这个日志级别再设置成 error 级别即可。
常用的日志级别按照从高到低依次为:ERROR、WARN、INFO、DEBUG 和 TRACE。可以通过日志输出等级来控制日志输出的详细程度。
3.logback.xml 配置文件解析在application.ynl文件中,指定配置文件logback.xml,logback.xml文件中主要用来做日志的相关配置。在 logback.xml 中可以定义日志输出的格式、路径、控制台输出格式、文件大小、保存时长等。
3.1:具体配置,定义日志输出格式和存储路径
<configuration> <property name="LOG_PATTERN" value="%date{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n" /> <property name="FILE_PATH" value="D:/logs/demo.%d{yyyy-MM-dd}.%i.log" /> </configuration>
配置文件的含义为:
首先定义一个格式,命名为 LOG_PATTERN,该格式中%date 表示日期,%thread 表示线程名,%-5level 表示级别从左显示 5 个字符宽度,%logger{36}表示 logger 名字最长 36 个字符,%msg 表示日志消息,%n 是换行符。
然后再定义一下名为 FILE_PATH 文件路径,日志都会存储在该路径下。%i 表示第 i 个文件,当日志文件达到指定大小时,会将日志生成到新的文件里,这里的 i 就是文件索引,日志文件允许的大小可以设置。
需要注意的是,不管是 windows 系统还是 Linux 系统,日志存储的路径必须要是绝对路径。
3.2 定义控制台输出
<configuration> <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender"> <encoder><!-- 按照上面配置的 LOG_PATTERN 来打印日志 --> <pattern>${LOG_PATTERN}</pattern> </encoder> </appender> </configuration>
使用<appender>节点设置个控制台输出 class="ch.qos.logback.core.ConsoleAppender"的配置,定义为 CONSOLE。使用上面定义好的输出格式 LOG_PATTERN 来输出,使用${}引用进来即可。
3.3 定义日志文件的相关参数
<configuration> <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <!-- 按照上面配置的 FILE_PATH 路径来保存日志 --> <fileNamePattern>${FILE_PATH}</fileNamePattern> <maxHistory>15</maxHistory> 日志保存 15 天 <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"> <maxFileSize>10MB</maxFileSize> 单个日志文件的最大,超过则新建日志文件存储 </timeBasedFileNamingAndTriggeringPolicy> </rollingPolicy> <encoder> <!-- 按照上面配置的 LOG_PATTERN 来打印日志 --> <pattern>${LOG_PATTERN}</pattern> </encoder> </appender> </configuration>
在这里使用<appender>定义一个名为 FILE 的文件配置,主要是为了配置日志文件保存的时间、单个日志文件存储的大小、以及文件保存的路径和日志的输出格式。
3.4 定义日志输出级别
<configuration> <logger name="com.zhao" level="INFO" /> <root level="INFO"> <appender-ref ref="CONSOLE" /> <appender-ref ref="FILE" /> </root> </configuration>
在设定好以上定义之后,最后使用<logger>来定义一下项目中默认的日志输出级别,这里定义级别为 INFO,然后针对 INFO 级别的日志,使用<root>引用上面定义好的控制台日志输出和日志文件的参数。这样 logback.xml 文件中的配置就设置完了。
4. 在使用 Logger 在项目中打印日志在代码中一般使用 Logger 对象来打印出一些 log 信息,可以指定打印出的日志级别,也支持占位符,很便捷。
import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; @RestController @RequestMapping("/test") public class TestController { private final static Logger logger = LoggerFactory.getLogger(TestController.class); @RequestMapping("/log") public String testLog() { logger.debug("=====测试日志 debug 级别打印===="); logger.info("======测试日志 info 级别打印====="); logger.error("=====测试日志 error 级别打印===="); logger.warn("======测试日志 warn 级别打印====="); // 可以使用占位符打印出一些参数信息 String str1 = "尘白"; String str2 = "https://www.cnblogs.com/zhaokeke/" // 输出日志内容时,允许使用{}表示一个占位符,后续参数按照位置对应进行赋值 logger.info("======编写人:{};str1); ogger.info("======编写人的个人博客:{};str2); return "success"; } }
启动该项目,在浏览器中输入 localhost:8080/test/log 后可以看到控制台的日志记录:
> ======测试日志 info 级别打印=====
> =====测试日志 error 级别打印====
> ======测试日志 warn 级别打印=====
> ======编写人:尘白;编写人的个人博客:https://www.cnblogs.com/zhaokeke/
在控制台的日志记录中,我发现没有debug级别的打印,在查找资料之后,我发现是因为在上面项目中默认的日志输出级为定义级别为 INFO,而 INFO 级别比 DEBUG 级别高,所以 debug 这条没有打印出来,如果将 logback.xml 中的日志级别设置成 DEBUG,那么四条语句都可以打印出来可以测试。
同时,也可以可以打开 D:\logs\demo\目录,里面有项目启动后,以及后面生成的所有日志记录。在项目部署后,大部分都是通过查看日志文件来定位问题。
5. 总结
在了解 slf4j 的使用之后,并且对 Spring Boot 中使用 slf4j 输出日志有了一定的实操之后,分析了下 logback.xml 文件中对日志相关信息的配置,包括日志的不同级别。载最后,我针对这些配置,在代码中使用 Logger 打印出一些进行测试。
在看了大量的资料后,很明显的可以看到在实际项目中,这些日志都是排查问题的过程中非常重要的资料。
另外,在查找日志输出方法时我发现SpringBoot也有输出日志的方式
在yml文件中输入
debug:
true 在 SpringBoot 框架启动时自动输出日志信息,会同时显示相互之间的依赖关系。这种方式仅仅用于开发阶段,产品阶段一定关闭,或者删除该配置。标签:输出,Spring,Boot,slf4j,日志,logback,log4j,级别 From: https://www.cnblogs.com/zhaokeke/p/17572340.html