专栏首页丁老师的技术随笔Spring Boot中集成Slf4j 与Logback

Spring Boot中集成Slf4j 与Logback

每个系统中都会有个日志,不管你是自己实现的单纯写文件,还是利用多功能的日志框架,大的系统会有相应的日志系统。什么是日志门面?什么是日志框架?SpringBoot 中如何使用日志。

目录

1.日志门面与日志框架

2.引入方式

3. Slf4j 两种使用方式

4.Logback 的两种配置方式

1

日志门面与日志框架

日志门面:是门面模式的一个典型的应用。门面模式(Facade Pattern),也称之为外观模式,其核心为:外部与一个子系统的通信必须通过一个统一的外观对象进行,使得子系统更易于使用,主要用来隔离解耦。

Java中常见日志门面如 JCL,slf4j等。就好像抽象出来的接口,只是用来发指令,不管底层实现。大概像微服务的注册中心,负载均衡服务器,代理服务器。又像PHP里面的PDO 一样,无论操作的是mysql 还是sql server ,实现起来都一样,只不过加载的驱动一个是 pdo_mysql ,一个是 pdo_sqlsrv。

日志框架:Java中有 jul,Log4j,Log4j2,Logback 几种日志框架一样,每一种日志框架都有自己单独的API,要使用对应的框架就要使用其对应的API,这就大大的增加应用程序代码对于日志框架的耦合性。《阿里巴巴Java开发手册》 中强制要求使用日志门面+日志框架 ,禁止直接调用框架的API。

主要是为了在应用中屏蔽掉底层日志框架的具体实现,即使有一天要更换代码的日志框架,只需要修改jar包,最多再改改日志输出相关的配置文件就可以了,无需修改代码中的日志代码。

2

引入方式

<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
</dependency>
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>jcl-over-slf4j</artifactId>
</dependency>

3

Slf4j 两种使用方式

第一种 不使用注解

package com.qustdjx.product.respository;


import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.test.context.SpringBootTest;




import static org.junit.jupiter.api.Assertions.*;


@SpringBootTest
class ProductInfoRepositoryTest {




    private final Logger logger = LoggerFactory.getLogger(ProductInfoRepositoryTest.class);


    @Test
    void findByProductStatus() {


        String var = "World";
        logger.info("Hello {}",var);
        logger.error("error");


    }
}

第二种使用@Slf4j注解,更方便

package com.qustdjx.product.respository;


import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.test.context.SpringBootTest;




import static org.junit.jupiter.api.Assertions.*;


@SpringBootTest
@Slf4j
class ProductInfoRepositoryTest {




    //private final Logger logger = LoggerFactory.getLogger(ProductInfoRepositoryTest.class);


    @Test
    void findByProductStatus() {


        String var = "World";
        log.info("Hello {}",var);
        log.error("error");


    }
}

4

Logback 的两种配置方式

第一种 使用application.yml 简单配置

spring:
  profiles:
    active: dev


logging:
  pattern:
    console: "%d -%msg%n"
  file:
    name: springboot.log
    path: ./
  level:
    com.qustdjx.product.respository.ProductInfoRepositoryTest: debug

第二种,使用自定义规则的xml,可以实现每天生成一个日志文件,日志文件按等级分文件保存,保存日期等 复杂规则日志

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
    <contextName>study</contextName>
    <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径-->
    <property name="LOG_HOME" value="./logs" />
    <property name="appName" value="onlineStudy" />




    <!--layout 为日志展示的形式-->
    <appender name="consoleLog" class="ch.qos.logback.core.ConsoleAppender">
      <layout class="ch.qos.logback.classic.PatternLayout">
         <pattern>
             %d-%msg%n
         </pattern>
      </layout>
    </appender>
    <!--控制台日志, 控制台输出 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度,%msg:日志消息,%n是换行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
        </encoder>
    </appender>
    <!--RollingFileAppender:滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件-->
    <!--文件日志, 按照每天生成日志文件 -->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是true -->
        <append>true</append>
        <!--当发生滚动时,决定RollingFileAppender的行为,涉及文件移动和重命名-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志文件输出的文件名-->
            <!--logType:日志类型,如 stats/monitor/access-->
            <FileNamePattern>${LOG_HOME}/${appName}_monitor_debug_%d{yyyy-MM-dd}.log</FileNamePattern>
            <!--日志文件保留天数-->
            <MaxHistory>30</MaxHistory>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度%msg:日志消息,%n是换行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
        </encoder>
        <!--日志文件最大的大小-->
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <MaxFileSize>10MB</MaxFileSize>
        </triggeringPolicy>
    </appender>


    <!-- 按日志级别打印  INFO -->
    <appender name="infoAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。-->
        <file>${LOG_HOME}/info/info.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 文件名称 -->
            <fileNamePattern>${LOG_HOME}/info/info.%d{yyyy-MM-dd}.log</fileNamePattern>
            <!-- 文件最大保存历史数量 -->
            <MaxHistory>30</MaxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
        </encoder>
        <!--filter 过滤输出-->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>INFO</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>




    <!-- show parameters for hibernate sql 专为 Hibernate 定制 -->
    <logger name="org.hibernate.type.descriptor.sql.BasicBinder" level="TRACE" />
    <logger name="org.hibernate.type.descriptor.sql.BasicExtractor" level="DEBUG" />
    <logger name="org.hibernate.SQL" level="DEBUG" />
    <logger name="org.hibernate.engine.QueryParameters" level="DEBUG" />
    <logger name="org.hibernate.engine.query.HQLQueryPlan" level="DEBUG" />




    <!--myibatis log configure-->
    <logger name="com.apache.ibatis" level="TRACE"/>
    <logger name="java.sql.Connection" level="DEBUG"/>
    <logger name="java.sql.Statement" level="DEBUG"/>
    <logger name="java.sql.PreparedStatement" level="DEBUG"/>


    <!-- 日志输出级别设置,ref 属性为 appender 的name-->
    <root level="DEBUG">
        <appender-ref ref="consoleLog" />
        <appender-ref ref="STDOUT" />
        <appender-ref ref="FILE"/>
        <appender-ref ref="infoAppender"/>

    </root>

</configuration>

END

本文分享自微信公众号 - 丁老师的技术随笔(IT-teacherding),作者:丁老师

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2020-03-01

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 使用Python判断文件下是否有空文件夹

    国内代码托管工具推荐码云,速度快还支持svn提交。但是码云代码提交时也有限制,不能上传空文件夹,有时你搞了个项目,里面某些目录都是空的,那么就会来回提交很多次。

    酒馆丁老师
  • JS,PHP,Python,Java对JSON数据的处理

    现在只要编写接口,接口调用,大家都绕不过JSON,各种编程语言里面都有对JSON数据的处理,今天用代码对比下JS,PHP,Python,Java对JSON数据的...

    酒馆丁老师
  • 你在小程序中怎么计算两个经纬度的距离?

    在没有官方支持时,小程序中的位置获取,可以采用腾讯地图,高德地图,百度地图都可以,但是你需要先通过小程序的wx.getLocation 获取当前的经纬度,然后再...

    酒馆丁老师
  • SQL Server 2012事务日志截断、回绕与收缩

    每个 SQL Server 数据库都具有事务日志,用于记录所有事务以及每个事务对数据库所做的修改。 必须定期截断事务日志以避免它被填满。 但是,一些因素可能延迟...

    逸鹏
  • 小记 | 从 0 到 1,看我玩弄千万日志于股掌

    3. 调试程序,和控制台的作用类似,但是控制台中的内容并不会保存到文件中,而日志可以长期保存。

    程序员鱼皮
  • 业务上云使用腾讯云日志服务方案

    日志服务(Cloud Log Service,下文简称CLS服务)是腾讯云提供的一站式日志数据解决方案,可以快速便捷的接入,享受日志采集、日志存储到日志内容搜索...

    覃春善
  • 腾讯云容器服务日志采集最佳实践

    roc,腾讯高级工程师,Kubernetes Contributor,热爱开源,专注云原生领域。目前主要负责腾讯云TKE 的售中、售后的技术支持,根据客户需求...

    腾讯云原生
  • 集中日志系统ELK

    以前都是登陆到每个机器去看日志,特别是一个服务有多个机器集群部署,还要下载多个机器的日志(运维下载日志,然后给开发排查问题),现在elk是集中式日志系统,所有的...

    青乡java
  • 有赞移动日志实践

    日志系统,是移动端定位排查线上问题非常有效的一个工具。以往商家使用App出现问题,向客服咨询时,客服需要详细收集商家的问题信息、店铺信息(操作步骤、操作视频等)...

    有赞coder
  • TKE集群日志解决方案之日志采集

    当前技术领域容器盛行,已然是一个云原生的时代, 在技术领域都或多火烧跟云计算、容器、Kubernetes、云原生应用有着不同的渊源。云原生的技术变更带来了革命性...

    朱瑞卿

扫码关注云+社区

领取腾讯云代金券