lombok使用sl4j输出日志

1、导入lombok依赖

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.24</version>
        </dependency>

2、编写日志输出配置

2.1、在application.yam或者application.properties中配置日志输出配置文所在位置:

logging:
  config: classpath:logback-spring.xml
  level:
    root: info

logging.level.root是配置日志输出的级别。
这里我碰到一个问题,一开始我的配置文件名称为logback.xml,启动时会报错

no applicable action for [springProfile], current ElementPath is [[configuration][springProfile]]

原因是因为:如果项目中配置的日志文件的名称是logback.xml的话,logback会先与Spring之前加载日志配置,这时日志文件中的springProfile的配置是无效的。按照官方文档的说法将logback.xml改为logback-spring.xml就可以了(来自文章:https://blog.csdn.net/qq_17394183/article/details/89920053
文件名修改成logback-spring.xml后成功启动。

2.2、编写logback-spring.xml文件,这个文件里面的可以配置的东西挺多的,具体见下面xml里面的注释(xml文件来源不明,很多文章都使用,所以没法标出原创者):

<?xml version="1.0" encoding="UTF-8"?>
<!-- scan:当此属性设置为true时,配置文档如果发生改变,将会被重新加载,默认值为true -->
<!-- scanPeriod:设置监测配置文档是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。
                 当scan为true时,此属性生效。默认的时间间隔为1分钟。 -->
<!-- debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。 -->
<configuration  scan="true" scanPeriod="10 seconds">
    <contextName>logback-spring</contextName>
 
    <!-- name的值是变量的名称,value的值是变量定义的值。通过定义的值会被插入到logger上下文中。定义后,可以使“${}”来使用变量。 -->
    <property name="logging.path" value="具体4个日志文件的父级文件夹名称,自行更改设置" />

    <!--0. 日志格式和颜色渲染 -->
    <!-- 彩色日志依赖的渲染类 -->
    <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" />
    <conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" />
    <conversionRule conversionWord="wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" />
    <!-- 彩色日志格式 -->
    <property name="CONSOLE_LOG_PATTERN" value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>
 
    <!--1. 输出到控制台-->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <!--此日志appender是为开发使用,只配置最底级别,控制台输出的日志级别是大于或等于此级别的日志信息-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>debug</level>
        </filter>
        <encoder>
            <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
            <!-- 设置字符集 -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>
 
    <!--2. 输出到文档-->
    <!-- 2.1 level为 DEBUG 日志,时间滚动输出  -->
    <appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在记录的日志文档的路径及文档名 -->
        <file>${logging.path}/debug.log</file>
        <!--日志文档输出格式-->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            <charset>UTF-8</charset> <!-- 设置字符集 -->
        </encoder>
        <!-- 日志记录器的滚动策略,按日期,按大小记录 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 日志归档 -->
            <fileNamePattern>${logging.path}/debug-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日志文档保留天数-->
            <maxHistory>15</maxHistory>
        </rollingPolicy>
        <!-- 此日志文档只记录debug级别的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>debug</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>
 
    <!-- 2.2 level为 INFO 日志,时间滚动输出  -->
    <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在记录的日志文档的路径及文档名 -->
        <file>${logging.path}/info.log</file>
        <!--日志文档输出格式-->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            <charset>UTF-8</charset>
        </encoder>
        <!-- 日志记录器的滚动策略,按日期,按大小记录 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 每天日志归档路径以及格式 -->
            <fileNamePattern>${logging.path}/info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日志文档保留天数-->
            <maxHistory>15</maxHistory>
        </rollingPolicy>
        <!-- 此日志文档只记录info级别的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>info</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>
 
    <!-- 2.3 level为 WARN 日志,时间滚动输出  -->
    <appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在记录的日志文档的路径及文档名 -->
        <file>${logging.path}/warn.log</file>
        <!--日志文档输出格式-->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            <charset>UTF-8</charset> <!-- 此处设置字符集 -->
        </encoder>
        <!-- 日志记录器的滚动策略,按日期,按大小记录 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${logging.path}/warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日志文档保留天数-->
            <maxHistory>15</maxHistory>
        </rollingPolicy>
        <!-- 此日志文档只记录warn级别的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>warn</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>
 
    <!-- 2.4 level为 ERROR 日志,时间滚动输出  -->
    <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在记录的日志文档的路径及文档名 -->
        <file>${logging.path}/error.log</file>
        <!--日志文档输出格式-->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            <charset>UTF-8</charset> <!-- 此处设置字符集 -->
        </encoder>
        <!-- 日志记录器的滚动策略,按日期,按大小记录 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${logging.path}/error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日志文档保留天数-->
            <maxHistory>15</maxHistory>
        </rollingPolicy>
        <!-- 此日志文档只记录ERROR级别的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>
 
    <!-- 4. 最终的策略 -->
    <!-- 4.1 开发环境:打印控制台-->
    <springProfile name="dev">
        <logger name="此位置填写自己的项目中全mapper\dao路径,用于在开发环境时将sql语句打印在控制台" level="debug"/><!-- 修改此处扫描包名 -->
    </springProfile>
 
    <root level="info">
        <appender-ref ref="CONSOLE" />
        <appender-ref ref="DEBUG_FILE" />
        <appender-ref ref="INFO_FILE" />
        <appender-ref ref="WARN_FILE" />
        <appender-ref ref="ERROR_FILE" />
    </root>
 
    <!-- 4.2 生产环境:输出到文档 -->
    <springProfile name="pro">
        <root level="info">
            <appender-ref ref="CONSOLE" />
            <appender-ref ref="DEBUG_FILE" />
            <appender-ref ref="INFO_FILE" />
            <appender-ref ref="ERROR_FILE" />
            <appender-ref ref="WARN_FILE" />
        </root>
    </springProfile>
</configuration>

这里需要自己修改两个地方:

   <!-- name的值是变量的名称,value的值是变量定义的值。通过定义的值会被插入到logger上下文中。定义后,可以使“${}”来使用变量。 -->
    <property name="logging.path" value="具体4个日志文件的父级文件夹名称,自行更改设置" />
    <springProfile name="dev">
        <logger name="此位置填写自己的项目中全mapper\dao路径,用于在开发环境时将sql语句打印在控制台" level="debug"/><!-- 修改此处扫描包名 -->
    </springProfile>

这里我又碰到一个问题,关于输出日志文件的位置,我一开始使用了绝对路径,比如“D:\logs\my-log”,但不知为何无法输出日志文件,换成了相对路径,比如“…\logs\my-log”后就成功产生了日志文件。
产生问题的原因是:斜杠的方向不对,如果把“D:\logs\my-log”改成"D:/logs/my-log",则可以成功再相应位置输出日志。

3、使用

在想打印日志的方法所在的类上标注@Sl4j注解,然后使用log来打在想要的位置输出日志,注意slf4j的五种日志级别:

package com.wt.lombok.sl4j;

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;

@Slf4j
@Component
public class Sl4jTest {

    //slf4j日志级别有五种:ERROR、WARN、INFO、DEBUG、TRACE,级别从高到底

    public void printErrorLogs(){
        log.error("-----这里是error级别的log-----");
        log.error("+++++这里是error级别的log+-+-+");
    }

    public void printWarnLogs(){
        log.warn("+---+这里是warn级别log===++");
        log.warn("----+这里是warn级别log----+");
    }

    public void printInfoLogs(){
        log.info("--+--这里是info级别log-++++");
        log.info("--+-+这里是info级别log-=--+");
    }

    public void printDebugLogs(){
        log.debug("--+--这里是debug级别log-++++");
        log.debug("==+==这里是debug级别log-===+");
    }
}

然后再测试类中调用这些方法,方法被调用就会输出相应的日志:

package com.wt;

import com.wt.lombok.sl4j.Sl4jTest;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.Date;

@SpringBootTest
class DemoTestApplicationTests {
    @Autowired
    Sl4jTest sl4jTest;

    @Test
    void sl4jTestMethode() {
        sl4jTest.printErrorLogs();
        sl4jTest.printWarnLogs();
        sl4jTest.printInfoLogs();
        sl4jTest.printDebugLogs();
    }

}

控制台输出的日志:

2022-07-27 10:41:25.194 ERROR 17540 --- [           main] com.wt.lombok.sl4j.Sl4jTest              : -----这里是error级别的log-----
2022-07-27 10:41:25.194 ERROR 17540 --- [           main] com.wt.lombok.sl4j.Sl4jTest              : +++++这里是error级别的log+-+-+
2022-07-27 10:41:25.194  WARN 17540 --- [           main] com.wt.lombok.sl4j.Sl4jTest              : +---+这里是warn级别log===++
2022-07-27 10:41:25.195  WARN 17540 --- [           main] com.wt.lombok.sl4j.Sl4jTest              : ----+这里是warn级别log----+
2022-07-27 10:41:25.195  INFO 17540 --- [           main] com.wt.lombok.sl4j.Sl4jTest              : --+--这里是info级别log-++++
2022-07-27 10:41:25.195  INFO 17540 --- [           main] com.wt.lombok.sl4j.Sl4jTest              : --+-+这里是info级别log-=--+

在硬盘的相应位置也输出了日志,内容无误:
在这里插入图片描述

### 使用 SLF4J 和 Lombok 进行日志记录 为了简化 Java 日志记录并减少样板代码,可以结合使用 SLF4J 和 Lombok 库。这种方式不仅能够提供灵活的日志管理功能,还能通过编译期注解处理器自动生成大量重复性的代码。 #### 添加依赖项 首先,在项目中引入必要的 Maven 或 Gradle 依赖: 对于 Maven 用户来说,需在 `pom.xml` 文件内加入如下配置片段[^1]: ```xml <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-api</artifactId> <version>2.0.7</version> </dependency> <!-- Choose one of binding implementations --> <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-classic</artifactId> <version>1.4.8</version> </dependency> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.18.26</version> <scope>provided</scope> </dependency> ``` 而对于采用 Gradle 构建工具的情况,则应在 `build.gradle` 中指定相应的库版本: ```groovy implementation 'org.slf4j:slf4j-api:2.0.7' // Select an appropriate logging framework backend like Logback runtimeOnly 'ch.qos.logback:logback-classic:1.4.8' compileOnly 'org.projectlombok:lombok:1.18.26' annotationProcessor 'org.projectlombok:lombok:1.18.26' ``` #### 编写简洁的日志记录类 接下来展示一段利用上述技术栈实现的日志记录样例程序: ```java import lombok.extern.slf4j.Slf4j; @Slf4j public class Example { public static void main(String[] args) { log.info("Application started."); try { int result = divide(10, 0); log.debug("Result is {}", result); } catch (ArithmeticException e) { log.error("Error occurred while dividing numbers", e); } } private static int divide(int numerator, int denominator) throws ArithmeticException{ return numerator / denominator; } } ``` 在这个例子中,借助于 Lombok 提供的 `@Slf4j` 注解,开发者无需手动声明静态 logger 变量即可直接调用各种级别的日志方法(info(), debug() 等)。这大大减少了冗余代码的数量,并提高了开发效率。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值