专栏首页丁老师的技术随笔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 条评论
登录 后参与评论

相关文章

  • 走进Java接口测试之日志框架Logback

    【摘要】 对于一个成熟的接口测试框架,日志管理这个是必不可少的。在开发和调试阶段,日志可以帮助我们更快的定位问题;而在测试的运维过程中,日志系统又可以帮助我们记...

    玖柒的小窝
  • Spring Boot(十)Logback和Log4j2集成与日志发展史

    Java知名的日志有很多,比如:JUL、Log4j、JCL、SLF4J、Logback、Log4j2,那么这些日志框架之间有着怎样的关系?诞生的原因又是解决什么...

    Java中文社群-磊哥
  • 走进Java接口测试之日志框架Logback

    对于一个成熟的接口测试框架,日志管理这个是必不可少的。在开发和调试阶段,日志可以帮助我们更快的定位问题;而在测试的运维过程中,日志系统又可以帮助我们记录大部分的...

    高楼Zee
  • Spring Boot 中使用 LogBack 配置

    LogBack是一个日志框架,它与Log4j可以说是同出一源,都出自Ceki Gülcü之手。(log4j的原型是早前由Ceki Gülcü贡献给Apache基...

    搜云库
  • 『互联网架构』软件架构-Spring boot集成日志框架(89)

    在spring-boot-starter 依赖中,添加了 spring-boot-starter-logging依赖

    IT架构圈
  • Spring Boot从零入门4_日志记录及其配置详解

    Spring Boot使用Apache Commons Logging接口记录所有内部日志记录。Spring Boot的默认配置对Java Util Loggi...

    别打名名
  • springboot-日志系统

    JUL、JCL、Jboss-logging、logback、log4j、log4j2、slf4j....

    Java开发者之家
  • 求求你别再用System.out.println 了!!

    1、System.out.println("");将关键数据打印在控制台;去掉?写在一个文件?

    程序IT圈
  • 求求你别再用System.out.println 了!!

    1、System.out.println("");将关键数据打印在控制台;去掉?写在一个文件?

    乔戈里
  • SpringBoot 笔记 ( 三 ):日志系统

    SpringBoot 笔记 ( 三 ):日志系统 1、日志框架 日志框架就是防止我们再去像以前那样,一直进行System.out.println(“”)将关键数...

    lwen
  • 求求你,别再用 System.out.println("");了!

    1、System.out.println("");将关键数据打印在控制台;去掉?写在一个文件?

    java进阶架构师
  • Spring boot集成日志框架

    在spring-boot-starter 依赖中,添加了 spring-boot-starter-logging依赖

    IT架构圈
  • SpringBoot之logback配置

    日志对于应用程序来说是非常重要的,Spring框架本身集成了不少其他工具,我们自身的应用也会使用到第三方库,所以我们推荐在Spring应用中使用SLF4J/Lo...

    王念博客
  • Spring Boot 2 集成log4j2日志框架

    Log4j2是 Log4j 的进化版本,并提供了许多 Logback 可用的改进,同时解决了 Logback 体系结构中的一些固有问题。而且日志处理中我们会用到...

    码农小胖哥
  • Spring Boot 日志Spring Boot 日志

    在任何一个生产系统中,对日志的合理记录是非常重要的。这对系统故障的定位处理极其关键。Spring Boot支持Java Util Logging,Log4j2,...

    一个会写诗的程序员
  • 丢人不!还用System.out.println("");太 Low了!

    1、System.out.println("");将关键数据打印在控制台;去掉?写在一个文件?

    Leetcode名企之路
  • Springboot 系列(四)Spring Boot 日志框架

    Spring 框架选择使用了 JCL 作为默认日志输出。而 Spring Boot 默认选择了 SLF4J 结合 LogBack。那我们在项目中该使用哪种日志框...

    未读代码
  • SpringBoot入门建站全系列(七)日志组件的使用

    前面六篇已经对SpringBoot的基础用做了介绍,日常项目使用已经足够,本篇介绍下SpringBoot日志使用的注意事项。

    品茗IT
  • log4j日志不输出的问题

    今天服务器上报错,想先去看一下日志进行排查,结果发现日志很久都没有输出过了。从上午排查到下午,刚刚解决,因此记录一下,但现在也只是知其然,并不知其所以然,所以如...

    健程之道

扫码关注云+社区

领取腾讯云代金券