SpringBoot日志框架

Z时代
2024-01-10
分类：综合

第一部分脑图

第二部分知识点总结

（1）市面上的日志框架均采用日志规范（接口）+日志框架（实现类）设计，和JDBC-数据库驱动设计思想相似；使用时只需调用接口API，导入实现类即可

（2）常见日志框架介绍

日志规范——slf4j 日志框架——log4j（旧，已经适配到slf4j）、logback（推荐）其他日志规范——jcl、Jboss-logging 其他日志框架——jul（java.util.logging）、log4j2、commons-logging Spring默认日志框架是commons-logging、Hibernate默认日志框架是JBoss-logging SpringBoot则选用了slf4j规范+logback日志框架；并通过中间包统一其他日志框架到slf4j规范 SpringBoot在引入其他框架时需要先排除该框架所依赖的日志框架；否则中间包会与引入的日志框架冲突；框架整合时已经帮我们做了如何让系统中所有的日志框架都统一到slf4j规范： 1，将其他日志框架先排除（maven的exclusion排除） 2，用中间包替换被排除的日志框架 3，导入需要的日志框架，如logback 日志框架切换图： http://www.slf4j.org/manual.html

http://www.slf4j.org/legacy.html

（3）slf4j-logback 使用示例

    导入logback.jar
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    public class HelloWorld {
      public static void main(String[] args) {
        Logger logger = LoggerFactory.getLogger(HelloWorld.class);
        logger.info("Hello World");
      }    }

（4）SpringBoot日志级别与日志配置

日志的级别；
    //由低到高 trace<debug<info<warn<error
    logger.trace("这是trace日志...");
    logger.debug("这是debug日志...");
    //SpringBoot默认日志级别是info
    logger.info("这是info日志...");
    logger.warn("这是warn日志...");
    logger.error("这是error日志...");
application.properties配置日志:
    logging.level.cn.xing=trace #根据包设置日志级别
    # 指定文件名
    logging.file=springboot.log #在当前项目下生成日志文件=springboot.log
    # 指定目录；在当前磁盘的根路径下创建spring/log,生成spring.log
    logging.path=/spring/log
    # file与path二选一
    #  指定控制台输出的日志格式
    logging.pattern.console===》%d{yyyy-MM-dd} [%thread] %-5level %logger{50} - %msg%n
     # 指定文件中日志输出格式    logging.pattern.file=%d{yyyy-MM-dd} === [%thread]%-5level%logger{50}%msg%n

（5）SpringBoot中自定义日志配置文件

logback.xml直接就被日志框架识别，绕过了SpringBoot
推荐用logback-spring.xml，不会被日志框架识别，由SpringBoot来加载，可以使用SpringBoot的高级Profile功能：根据生产/测试环境不同，使用不同的日志配置
logback-spring.xml的Profile功能配置，根据环境的不同使用不同的配置：
    <layout class="ch.qos.logback.classic.PatternLayout">
        <springProfile name="dev">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ----> [%thread] ---> 
            %-5level %logger{50} - %msg%n</pattern>
        </springProfile>
        <springProfile name="!dev">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ==== [%thread] ====
             %-5level %logger{50} - %msg%n</pattern>
        </springProfile>    </layout>

（6）logback-spring.xml 示例模板

<?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">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ----> [%thread] ---> %-5level %logger{50} - %msg%n</pattern>
            </springProfile>
            <springProfile name="!dev">
                <pattern>%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>