springboot开发笔记-(10)-日志框架SLF4J和logback等

tech spring logging

发布时间 : 2020-09-01 00:00

字数:1.8k 阅读 :

10.1 slf4j和logback关系
10.2 各日志框架使用
10.3 日志框架遗留问题
10.4 slf4j实战
10.5 slf4j日志框架的切换

10.1 slf4j和logback关系

slf4j是门面,相当于一个接口; logback是实现, 真正调用的实现;

使用时应该用抽象层的, 不要用实现类的!

下面是slf4j官网的图片:

浅蓝色是日志门面(抽象层); 深蓝色是slf4j的本地实现->主要就是 logback; 浅灰色是具体的实现;
深蓝色是slf4j的本地实现: 主要就是 logback, log4j和jul都需要借助适配层才能使用: logback-classic.jar, logback-core.jar
log4j和jul都需要借助适配层:
- log4j的适配: slf4j-log412.jar
- jul的适配: slf4j-jdk14.jar

10.2 各日志框架使用

使用方式:

10.2.1 slf4j+log4j:

slf4j-api.jar (门面抽象层)
slf4j-log412.jar (适配中间层)
log4j.jar (log4j的实现)

10.2.2 slf4j+logback:

slf4j-api.jar (门面抽象层)
logback-classic.jar, logback-core.jar (slf4j本地实现, 不需要中间适配)

10.2.3 slf4j+jul:

slf4j-api.jar (门面抽象层)
slf4j-jdk14.jar (中间适配层)
jvm运行时调用, 不需引入jar包;

10.3 日志框架遗留问题

各框架用不同的日志框架, 比如: springboot(slf4j+logback), spring(commons-logging) , hibernate(jboss-logging), Mybatis, 其他…

如何统一使用 slf4j? 看下图中的三种:

图上左方: 在logback中替换原来的 commons-logging/log4j/jul
图上右方: 在log4j中替换原来的 commons-logging/jul
图下左方: 在jul中替换原来的 commons-logging/log4j

10.3.1 使用logback替换commons-logging/log4j/jul

替换commons-logging.jar:
jcl-over-slf4j.jar 替换 commons-logging.jar, 操作:
- 排除掉 commons-logging.jar ;
- 引入入jcl-over-slf4j.jar;
替换log4j.jar
log4j-over-slf4j.jar 替换 log4j.jar:
- 排除掉 log4j.jar
- 加入 log4j-over-slf4j.jar
替换 jul:

引入 jul-to-slf4j.jar: 因为jul本身不需要引入包, 所以不需要排除依赖;

他们的原理都一样:

源码中就是把原来的类的实际对象, 改为了slf4j提供的实现类了; 具体做法可以参见 springboot 源码中的 spring-boot-starter-logging的依赖的jar包! 偷梁换柱的哲学!

10.3.2 使用log4j替换commons-logging/jul

同理:依照图中的说明;

10.3.3 使用jul替换commons-logging/log4j

同理:依照图中的说明;

日志适配图:

10.4 slf4j实战

10.4.1 设置日志级别 logging.level

# 设置所有的 com.niewj包下的日志级别为 info
logging.level.com.niewj=info

10.4.2 设置生成日志文件的名称 logging.file.name

# 设置生成日志文件的名称, 也可以加目录名, 忽略logging.file.path
logging.file.name=/app/logs/boot.log

10.4.3 设置日志格式 logging.pattern

# 设置日志格式:
logging.pattern.console= %d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%thread] %logger{15} - %msg%n
logging.pattern.file= %d{yyyy-MM-dd HH:mm:ss.SSS} === %-5level === [%thread] === %logger{15} - %msg%n

10.4.4 日志文件的选择

logback: logback-spring.xml, logback.xml

jdk(jul): logging.properties

推荐使用 logback-spring.xml: 加了spring可以使用profile: <springProfile name="dev">

<?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="niewj-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.niewj" 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>

10.5 slf4j日志框架的切换

从logback切换到log4j: 可以参照上面的日志适配图来处理, 略

转载请注明来源，欢迎对文章中的引用来源进行考证，欢迎指出任何有错误或不够清晰的表达。可以在下面评论区评论，也可以邮件至 hi@niewj.com