前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >如何在Spring项目使用SLF4J框架?

如何在Spring项目使用SLF4J框架?

作者头像
收心
发布2024-03-04 09:25:46
5730
发布2024-03-04 09:25:46
举报
文章被收录于专栏:Java实战博客

在Spring项目中使用SLF4J框架非常简单。SLF4J(Simple Logging Facade for Java)是一个日志框架的抽象层,它允许你在项目中使用统一的日志接口,而不用关心具体使用哪个日志实现。

在Spring项目中使用SLF4J的步骤

添加依赖

首先,在你的项目中添加SLF4J的依赖。如果你使用Maven,可以在pom.xml文件中添加以下依赖:

代码语言:javascript
复制
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.30</version> <!-- 替换为最新版本 -->
</dependency>

选择日志实现

SLF4J本身并不提供日志的具体实现,因此你还需要选择一个具体的日志实现,比如Logback或者Log4j2。你可以根据自己的喜好和项目需求选择一个。以Logback为例,你可以添加以下依赖:

代码语言:javascript
复制
<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>1.2.3</version> <!-- 替换为最新版本 -->
</dependency>

配置日志

在Spring项目中,你可以在src/main/resources目录下创建一个名为logback.xml的文件来配置Logback日志框架。如果你选择了其他日志实现,也需要根据其相应的配置方式进行配置。

代码语言:javascript
复制
<?xml version="1.0" encoding="UTF-8" ?>

<!-- 级别从高到低 OFF 、 FATAL 、 ERROR 、 WARN 、 INFO 、 DEBUG 、 TRACE 、 ALL -->
<!-- 日志输出规则 根据当前ROOT 级别,日志输出时,级别高于root默认的级别时 会输出 -->
<!-- 以下 每个配置的 filter 是过滤掉输出文件里面,会出现高级别文件,依然出现低级别的日志信息,通过filter 过滤只记录本级别的日志 -->
<!-- scan 当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。 -->
<!-- scanPeriod 设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。 -->
<!-- debug 当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。 -->
<configuration scan="true" scanPeriod="60 seconds" debug="false">
    <!-- 动态日志级别 -->
    <jmxConfigurator/>

    <!-- 定义日志文件 输出位置 -->
    <property name="log.home_dir" value="./opt/logs"/>
    <property name="log.app_name" value="日志文件名前缀"/>
    <!-- 日志最大的历史 30天 -->
    <property name="log.maxHistory" value="5"/>
    <property name="log.level" value="DEBUG"/>
    <property name="log.maxSize" value="50MB"/>
    <property name="log.pattern"
              value="%d{yyy-MM-dd HH:mm:ss.SSS}|%-5level|%X{appName}|%X{ip}|%X{identifyCode}|%X{TraceId}|%X{SpanId}|[%thread]|%logger{20} - [%method,%line] - %msg%n"/>

    <!-- ConsoleAppender 控制台输出日志 -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <!-- 设置过滤级别 -->
            <level>INFO</level>
            <!-- 用于配置符合过滤条件的操作 -->
            <onMatch>ACCEPT</onMatch>
            <!-- 用于配置不符合过滤条件的操作 -->
            <onMismatch>ACCEPT</onMismatch>
        </filter>
        <encoder>
            <pattern>${log.pattern}</pattern>
        </encoder>
    </appender>

    <appender name="MIDDLE_WARE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 过滤器,只记录WARN级别的日志 -->
        <!-- 果日志级别等于配置级别,过滤器会根据onMath 和 onMismatch接收或拒绝日志。 -->
        <file>${log.home_dir}/middle_ware.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
            <fileNamePattern>${log.home_dir}/middle_ware-%i.log</fileNamePattern>
            <minIndex>1</minIndex>
            <maxIndex>7</maxIndex>
        </rollingPolicy>
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <maxFileSize>50MB</maxFileSize>
        </triggeringPolicy>
        <encoder>
            <pattern>${log.pattern}</pattern>
        </encoder>
    </appender>

    <!-- ERROR级别日志 -->
    <!-- 滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件 RollingFileAppender -->
    <appender name="ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 过滤器,只记录WARN级别的日志 -->
        <!-- 果日志级别等于配置级别,过滤器会根据onMath 和 onMismatch接收或拒绝日志。 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <!-- 设置过滤级别 -->
            <level>ERROR</level>
            <!-- 用于配置符合过滤条件的操作 -->
            <onMatch>ACCEPT</onMatch>
            <!-- 用于配置不符合过滤条件的操作 -->
            <onMismatch>DENY</onMismatch>
        </filter>
        <!-- 最常用的滚动策略,它根据时间来制定滚动策略.既负责滚动也负责触发滚动 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <!--日志输出位置 可相对、和绝对路径 -->
            <fileNamePattern>
                ${log.home_dir}/error-%d{yyyy-MM-dd}.%i.log
            </fileNamePattern>
            <!-- 可选节点,控制保留的归档文件的最大数量,超出数量就删除旧文件,假设设置每个月滚动,且<maxHistory>是6,
            则只保存最近6个月的文件,删除之前的旧文件。注意,删除旧文件是,那些为了归档而创建的目录也会被删除 -->
            <maxHistory>${log.maxHistory}</maxHistory>
            <!--日志文件最大的大小-->
            <MaxFileSize>${log.maxSize}</MaxFileSize>
        </rollingPolicy>
        <encoder>
            <pattern>${log.pattern}</pattern>
        </encoder>
    </appender>

    <appender name="CURRENT_APP" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${log.home_dir}/${log.app_name}.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
            <fileNamePattern>${log.home_dir}/${log.app_name}-%i.log</fileNamePattern>
            <minIndex>1</minIndex>
            <maxIndex>7</maxIndex>
        </rollingPolicy>
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <maxFileSize>50MB</maxFileSize>
        </triggeringPolicy>
        <encoder>
            <pattern>${log.pattern}</pattern>
        </encoder>
    </appender>
    <appender name="OPERATE_LOGGER" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 最常用的滚动策略,它根据时间来制定滚动策略.既负责滚动也负责触发滚动 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志输出位置 可相对、和绝对路径 -->
            <fileNamePattern>
                ${log.home_dir}/operate.%d{yyyy-MM-dd}.log
            </fileNamePattern>
            <!-- 可选节点,控制保留的归档文件的最大数量,超出数量就删除旧文件,假设设置每个月滚动,且<maxHistory>是6,
            则只保存最近6个月的文件,删除之前的旧文件。注意,删除旧文件是,那些为了归档而创建的目录也会被删除 -->
            <maxHistory>${log.maxHistory}</maxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>${log.pattern}</pattern>
        </encoder>
    </appender>

    <!--org.springframework.web包下的类的日志输出-->
    <logger name="org.springframework" additivity="true" level="WARN">
        <appender-ref ref="MIDDLE_WARE"/>
    </logger>
    <logger name="com.alibaba" additivity="true" level="WARN">
        <appender-ref ref="MIDDLE_WARE"/>
    </logger>
    <logger name="com.tencent.tsf.unit.sync" additivity="false" level="WARN">
        <appender-ref ref="MIDDLE_WARE"/>
    </logger>

    <!-- root级别   DEBUG -->
    <root>
        <!-- 打印debug级别日志及以上级别日志 -->
        <level value="${log.level}"/>
        <!-- 控制台输出 -->
        <appender-ref ref="CONSOLE"/>
        <!-- 不管什么包下的日志都输出文件 -->
        <appender-ref ref="ERROR"/>
        <appender-ref ref="CURRENT_APP"/>
    </root>
</configuration>

在Spring配置文件添加(yaml格式)

代码语言:javascript
复制
# 指定logback.xml配置文件的路径
logging:
  config: classpath:logback.xml

在代码中使用SLF4J

在你的Java类中,你可以通过SLF4J的Logger接口来记录日志。例如:

代码语言:javascript
复制
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class MyClass {
    private static final Logger logger = LoggerFactory.getLogger(MyClass.class);

    public void doSomething() {
        logger.debug("This is a debug message");
        logger.info("This is an info message");
        logger.error("This is an error message");
    }
}

通过以上步骤,你就可以在Spring项目中使用SLF4J来统一处理日志了。SLF4J的优势在于它提供了统一的日志接口,使得你可以在不改变代码的情况下切换不同的日志实现。

本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
原始发表:2024-03-03,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 在Spring项目中使用SLF4J的步骤
    • 添加依赖
      • 选择日志实现
        • 配置日志
          • 在Spring配置文件添加(yaml格式)
            • 在代码中使用SLF4J
            领券
            问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档