Springboot (二) 日志

最新推荐文章于 2024-02-06 10:40:28 发布

大米饭66

最新推荐文章于 2024-02-06 10:40:28 发布

阅读量159

点赞数

分类专栏： Spring 全家桶文章标签： springboot

本文链接：https://blog.csdn.net/oschina_40730821/article/details/102746389

版权

Spring 全家桶专栏收录该内容

37 篇文章 3 订阅

订阅专栏

Spring Boot 日志

spring boot 对的默认实现使用sl4j + logback 的日志结构实现
日志门面： SLF4J；

日志实现：Logback；

日志门面（日志的抽象层）日志实现
JCL（Jakarta Commons Logging） SLF4j（Simple Logging Facade for Java） jboss-logging Log4j JUL（java.util.logging） Log4j2 Logback
si4j 和logback ，log4j是同一个开发者开发，log4j因为性能问题又重新开发了logbak.

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

1. spring boot 结合sl4j

sl4j 使用适配器包，来适配以前的不持sl4j 的日志框架。

因为新开发的框架logback是支持sl4j的，所以不需要中间的适配层，log4j这种比较老的实现，一开始没有开率到门面的问题，就需要加一个中间适配层。

图示：
spring boot 在结合日志的时候，会使用转换包 spring-boot-starter-logging

Spring（commons-logging）、Hibernate（jboss-logging）、MyBatis、xxxx

因为在多框架的时候会有使用不同日志实现的问题，spring boot 进行了日志统一，使用转换包进行将日志调用改成sl4j，然后sl4j 下面调用的logback是实现。

应用使用的包路径还是一样，不过内部实现使用了sl4j的方法，实现了替换。

让系统中所有的日志都统一到slf4j大概分为一下步骤：

1、将系统中其他日志框架先排除出去；

2、用中间包来替换原有的日志框架；

3、我们导入slf4j其他的实现

图示：

2. spring boot 日志关系

    <dependency>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-logging</artifactId>
	</dependency>

spring boot 的默认日志关系如下图：
在这里插入图片描述

1）、SpringBoot底层也是使用slf4j+logback的方式进行日志记录

2）、SpringBoot也把其他的日志都替换成了slf4j；

3）、中间替换包

3. spring boot 日志快速使用

在spring boot 中使用logback 非常简单。

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`

logback.xml：直接就被日志框架识别了；

logback-spring.xml：日志框架就不直接加载日志的配置项，由SpringBoot解析日志配置，可以使用SpringBoot的高级Profile功能。

在指定环境下生效，依赖 spring配置文件 的 profile application-{profile}.yml
<springProfile name="dev">
      <appender-ref ref="console"/>
</springProfile>
<springProfile name="prod,test">
      <appender-ref ref="file_info"/>
</springProfile>

4. logback 配置文件简单样例

<?xml version="1.0" encoding="UTF-8"?>
<configuration>

    <property name="log.path" value="./logs"/>
    <!--
        日志输出格式：
			%d表示日期时间，
			%thread表示线程名，
			%-5level：级别从左显示5个字符宽度
			%logger{50} 表示logger名字最长50个字符，否则按照句点分割。 
			%msg：日志消息，
			%n是换行符
        -->
    <property name="log.pattern" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{20} - [%method,%line] - %msg%n"/>

    <!-- 控制台输出 -->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${log.pattern}</pattern>
        </encoder>
    </appender>

    <!-- 文件输出 -->
    <appender name="file_info" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${log.path}/sys-info.log</file>
         <!-- 设置文件名称 和回滚规则，按照每天回滚 最长存在15天 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${log.path}/sys-info.%d{yyyy-MM-dd}.log</fileNamePattern>
            <maxHistory>15</maxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>${log.pattern}</pattern>
        </encoder>
    </appender>
    
  <!-- 日志收集器  包路径 和 收集的日志等级-->
   <logger name="com.backend.*" level="debug"/>
    
    <root level="info">
        <!-- 开发环境在控制台输出日志 -->
        <springProfile name="dev">
            <appender-ref ref="console"/>
        </springProfile>
          <!-- 非开发环境在文件中输出日志 -->
        <springProfile name="!dev">
            <appender-ref ref="file_info"/>
        </springProfile>
    </root>
</configuration>

5. logback 配置文件详细说明

<?xml version="1.0" encoding="UTF-8"?>
<!--
scan：当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
scanPeriod：设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒当scan为true时，此属性生效。默认的时间间隔为1分钟。
debug：当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。
-->
<configuration scan="true" scanPeriod="60 seconds" debug="false">

    <property name="log.path" value="./logs"/>
    <!--
        日志输出格式：
			%d表示日期时间，
			%thread表示线程名，
			%-5level：级别从左显示5个字符宽度
			%logger{50} 表示logger名字最长50个字符，否则按照句点分割。 
			%msg：日志消息，
			%n是换行符
        -->
    <property name="log.pattern" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{20} - [%method,%line] - %msg%n"/>

    <!-- 控制台输出  ch.qos.logback.core.ConsoleAppender 表示控制台输出 -->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${log.pattern}</pattern>
        </encoder>
    </appender>

    <!-- 文件输出 -->
    <appender name="file_info" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${log.path}/sys-info.log</file>
         <!-- 设置文件名称 和回滚规则，按照每天回滚 最长存在15天 -->
           <!--
        当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名
        TimeBasedRollingPolicy： 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。
        -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
           <!--
            滚动时产生的文件的存放位置及文件名称 %d{yyyy-MM-dd}：按天进行日志滚动 
            %i：当文件大小超过maxFileSize时，按照i进行文件滚动
            -->
           <fileNamePattern>${log.path}/sys-info-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
             <!-- 
            可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每天滚动，
            且maxHistory是365，则只保存最近365天的文件，删除之前的旧文件。注意，删除旧文件是，
            那些为了归档而创建的目录也会被删除。
            -->
            <maxHistory>15</maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder>
            <pattern>${log.pattern}</pattern>
        </encoder>
        <!-- 
        过滤器 level 等级  onMatch 匹配的接受   onMismatch 不匹配不接受
        -->
        <!--
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
         -->
    </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都有效
    -->
  <!-- 日志收集器  包路径 和 收集的日志等级-->
   <logger name="com.backend.*" level="debug"/>
     <!-- 
    root与logger是父子关系，没有特别定义则默认为root，任何一个类只会和一个logger对应，
    要么是定义的logger，要么是root，判断的关键在于找到这个logger，然后判断这个logger的appender和level。 
    -->
    <root level="info">
        <!-- 开发环境在控制台输出日志 -->
        <springProfile name="dev">
            <appender-ref ref="console"/>
        </springProfile>
          <!-- 非开发环境在文件中输出日志 -->
        <springProfile name="!dev">
            <appender-ref ref="file_info"/>
        </springProfile>
    </root>
</configuration>