Spring Boot日志框架原理及使用

最新推荐文章于 2024-05-03 21:57:03 发布

清思越

最新推荐文章于 2024-05-03 21:57:03 发布

阅读量559

点赞数 3

分类专栏：研发架构

本文链接：https://blog.csdn.net/qq_41858479/article/details/104263593

版权

研发架构专栏收录该内容

9 篇文章 0 订阅

订阅专栏

说明：在上一篇文章中讲了《spring Boot的配置文件是如何加载的》通过学习使得我们对spring boot中的配置文件的类型、加载顺序，以及yml的语法等都有了一定理解。相信大家在开发的时候经常使用System.out.println();来打印查询中出现的一些系统日志信息，其中有系统的正常运行信息，也有错误信息。简单的概括就是鱼龙混杂，因此本片为了解决这个问题主要介绍日志框架的使用.

问题1：为什么需要使用日志框架呢？

答：在实际开发的环境当中，我们经常打印一些系统日志信息，但是仅仅局限于控制台的输出，只有开发人员才知道是什么问题，而运维或测试人员完全不知道错误信息。同时当项目发布的时候有些测试的日志需要删除，有些日志需要添加给其他人员看，这样的代码有点画蛇添足之意，而且程序员不好维护这个代码。为了解决这个问题，我们就需要使用日志框架去维护这些系统信息。

使用日志框架可以解决开发环境、测试环境、生产环境不同级别的日志输出，同时也可以监控正常、警告、异常、错误等不同类型的日志，然后分别记录到不同的文件中。

问题2：日志框架实现的思想是什么？（门面模式）

答：某公司的小三参与了一个大型项目，他在开发的时候为了方便测试，将一些开发环境的日志信息都打印在控制台，老板看了之后说这样的日志会不会暴露一些重要的数据？就让小三把控制台的日志信息都删除了，这个时候小三很快按照老板的指示都一一删除了。可是过了一段实现老板觉得之前的蛮好的，让小三在还原回去，这个时候相信小三心理也是很苦。于是小三为了应对老板的需求他想出了一个办法，日志信息与系统业务既然没有关系，那我是不是可以写个jar，而这个jar里面包含分类出日志信息、将日志信息写入文件、将日志信息打印在控制台、可以调控日志的显示的级别等一系列功能。这样第一个版本的日志框架就被小三搞出来了。又过了很长时间，小三的工资翻了几倍了，他想之前开发的日志框架已经对于他来说太Lo了，他想重新写一个，可是要换框架就需要将以前框架卸下来，换上新的框架，重新修改之前相关的API .这个时候小三又想到一个方案：首先开发一个接口层的jar，然后把第一个版本的实现的日志业务封装为一个jar，再把第二次实现的也封装为一个jar.最后在旧系统中直接选择接口jar + 第一个版本实现接口的jar，而当前开发的系统就选择接口jar + 第二个版本实现接口的jar。通过选择具体的实现来实现系统日志的更新与替换。

问题3：常用的日志框架有哪些？我们应该如何选择？

答：目前各种框架中从用的日志有：JUL、JCL、Jboss-logging、logback、log4j、log4j2、slf4j.... 关于这些日志框架背后的故事就不在这里描述了。

选择：在下面表格中左边表格选一个门面（抽象层）、右边来选一个实现组合成系统框架；

日志门面（日志的抽象层）	日志实现
JCL（Jakarta Commons Logging） SLF4j（Simple Logging Facade for Java） jboss-logging	Log4j JUL（java.util.logging） Log4j2 Logback

spring boot 选的是：SLF4J + Logback

问题4：在spring boot中是如何统一各种框架的日志信息的？

答：在一个项目中我们经常使用到 Spring（commons-logging）、Hibernate（jboss-logging）、MyBatis等框架，而这些框架又有属于与自己的日志框架，如果不做处理会导致一个项目出出现乱七八糟的日志信息。spring boot是通过统一日志记录，即使是别的框架和我一起统一使用slf4j进行输出 .

那么如何让系统中所有的日志都统一到slf4j呢？主要原理就是下面给出的三步：（适配器模式）

将系统中其他日志框架先排除出去；
用中间包来替换原有的日志框架；
我们导入slf4j其他的实现

总结：我们不管使用什么框架，我们调用的时候是调用日志抽象层里面的方法，具体实现实把原有的框架使用日志给替换掉（需要排除jar），而这个新的jar中不仅仅包含之前的实现，而且还包含SLF4J的实现，这样就实现了统一。

排除参考：

<exclusions>
	<exclusion>
		<groupId>commons-logging</groupId>
		<artifactId>commons-logging</artifactId>
	</exclusion>
</exclusions>

问题5：在spring boot中日志之间的关系是什么？

SpringBoot底层也是使用slf4j+logback的方式进行日志记录
SpringBoot也把其他的日志都替换成了slf4j；
中间替换包

问题6：我们如何使用spring boot中自动配置好的日志框架呢？

答：从上面的分析，发现 Spring Boot 默认已经使用了 SLF4J + LogBack . 所以我们在不进行任何额外操作的情况下就可以使用 SLF4J + Logback 进行日志输出。

   @Test
    public void testPerson(){
        Logger logger = LoggerFactory.getLogger(getClass());
        logger.trace("这个运行日志");
        logger.debug("这个是debug日志");
        logger.info("这个是info日志");
        logger.warn("这个是warn日志");
        logger.error("这个是error日志");
    }

已知日志级别从小到大为 trace < debug < info < warn < error . 运行得到输出如下。

2020-02-12 20:44:57.501 [main] INFO  com.hello.demo.DemoApplicationTests - 这个是info日志
2020-02-12 20:44:57.501 [main] WARN  com.hello.demo.DemoApplicationTests - 这个是warn日志
2020-02-12 20:44:57.501 [main] ERROR com.hello.demo.DemoApplicationTests - 这个是error日志

从上面的结果可以看出SpringBoot默认给我们使用的是info级别的，没有指定级别的就用SpringBoot默认规定的级别

其实这个日志信息是可以修改的，那么默认的日志信息如下：

    %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n

       %d表示日期时间，
       %thread表示线程名，
       %-5level：级别从左显示5个字符宽度
       %logger{50} 表示logger名字最长50个字符，否则按照句点分割。
       %msg：日志消息，
       %n是换行符

问题7：自定义日志配置应该如何使用？

答：我们在配置文件application.properties中测试如下配置信息

# 日志配置
# 指定具体包的日志级别
logging.level.net.codingme=debug
# 控制台和日志文件输出格式
logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
logging.pattern.file=%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
# 日志文件大小
logging.file.max-size=10MB
# 保留的日志时间
logging.file.max-history=10
# 日志输出路径，默认文件spring.log
logging.path=systemlog
#logging.file=log.log

指定配置的只需要给类路径下放上每个日志框架自己的配置文件即可，SpringBoot就不使用他默认配置的了。具体的配置文件名称如下：

Logging System	Customization
Logback	`logback-spring.xml`, `logback-spring.groovy`, `logback.xml` or `logback.groovy`
Log4j2	`log4j2-spring.xml` or `log4j2.xml`
JDK (Java Util Logging)	`logging.properties`

为了使我们的日志框架可以切换开发环境与运行环境等，来打印不同的日志信息，我们需要使用配置文件名称带spring(logback-spring.xml)日志框架就不直接加载日志的配置项，由SpringBoot解析日志配置，可以使用SpringBoot的高级Profile功能 .

<?xml version="1.0" encoding="UTF-8"?>
<!--
scan：当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
scanPeriod：设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒当scan为true时，此属性生效。默认的时间间隔为1分钟。
debug：当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。
-->
<configuration scan="false" scanPeriod="60 seconds" debug="false">
    <!-- 定义日志的根目录 -->
    <property name="LOG_HOME" value="/app/log" />
    <!-- 定义日志文件名称 -->
    <property name="appName" value="atguigu-springboot"></property>
    <!-- ch.qos.logback.core.ConsoleAppender 表示控制台输出 -->
    <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
        <!--
        日志输出格式：
			%d表示日期时间，
			%thread表示线程名，
			%-5level：级别从左显示5个字符宽度
			%logger{50} 表示logger名字最长50个字符，否则按照句点分割。 
			%msg：日志消息，
			%n是换行符
        -->
        <layout class="ch.qos.logback.classic.PatternLayout">
            <springProfile name="dev">
                <!-- configuration to be enabled when the "staging" profile is active -->
                <pattern>dev：%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            </springProfile>
            <springProfile name="!dev">
                <!-- configuration to be enabled when the "staging" profile is active -->
                <pattern>prd: %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            </springProfile>
        </layout>
    </appender>

    <!-- 滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件 -->  
    <appender name="appLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 指定日志文件的名称 -->
        <file>${LOG_HOME}/${appName}.log</file>
        <!--
        当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名
        TimeBasedRollingPolicy： 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。
        -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--
            滚动时产生的文件的存放位置及文件名称 %d{yyyy-MM-dd}：按天进行日志滚动 
            %i：当文件大小超过maxFileSize时，按照i进行文件滚动
            -->
            <fileNamePattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <!-- 
            可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每天滚动，
            且maxHistory是365，则只保存最近365天的文件，删除之前的旧文件。注意，删除旧文件是，
            那些为了归档而创建的目录也会被删除。
            -->
            <MaxHistory>365</MaxHistory>
            <!-- 
            当日志文件超过maxFileSize指定的大小是，根据上面提到的%i进行日志文件滚动 注意此处配置SizeBasedTriggeringPolicy是无法实现按文件大小进行滚动的，必须配置timeBasedFileNamingAndTriggeringPolicy
            -->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <!-- 日志输出格式： -->     
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern>
        </layout>
    </appender>

    <!-- 
		logger主要用于存放日志对象，也可以定义日志类型、级别
		name：表示匹配的logger类型前缀，也就是包的前半部分
		level：要记录的日志级别，包括 TRACE < DEBUG < INFO < WARN < ERROR
		additivity：作用在于children-logger是否使用 rootLogger配置的appender进行输出，
		false：表示只用当前logger的appender-ref，true：
		表示当前logger的appender-ref和rootLogger的appender-ref都有效
    -->
    <!-- hibernate logger -->
    <logger name="com.atguigu" level="debug" />
    <!-- Spring framework logger -->
    <logger name="org.springframework" level="debug" additivity="false"></logger>



    <!-- 
    root与logger是父子关系，没有特别定义则默认为root，任何一个类只会和一个logger对应，
    要么是定义的logger，要么是root，判断的关键在于找到这个logger，然后判断这个logger的appender和level。 
    -->
    <root level="info">
        <appender-ref ref="stdout" />
        <appender-ref ref="appLogAppender" />
    </root>
</configuration>