Logback Day02:使用注解创建 log 对象

zhizhiqiuya

已于 2023-09-28 09:28:04 修改

阅读量178

点赞数

分类专栏： Logback 文章标签： logback

于 2023-09-27 20:29:50 首次发布

本文链接：https://blog.csdn.net/zhiqiuqiu2/article/details/133362898

版权

Logback 专栏收录该内容

4 篇文章 0 订阅

订阅专栏

前言

上一章讲了原始的 New 出来一个 log 对象，那么是不是每次都要我们去 New 出来才能使用日志输出呢？不是的，官方也有提供一个注解，只要使用这个注解就可以去使用日志输出了，从而提升开发效率。

一、新建一个 Maven 项目，结构如下

1、添加依赖

   <dependencies>
 
        <!-- https://mvnrepository.com/artifact/ch.qos.logback/logback-classic -->
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>1.4.5</version>
        </dependency>
 
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.26</version>
        </dependency>
    </dependencies>

2、在 resources 下，新建一个 logback.xml 配置文件

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!-- 控制台输出 -->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} [%t] %p %C - %m%n</pattern>
        </encoder>
    </appender>

    <!-- 日志文件输出,FileAppender:就是输出到文件中 -->
    <appender name="file" class="ch.qos.logback.core.FileAppender">
        <!-- 日志文件的保存路径和文件名
             可以是相对路径也可以是绝对路径
        -->
        <file>ch02/logs/service.log</file>
        <!-- append：设置为 true 标识日志每次都会追加到文件的末尾，
             false 这是先清空原有日志，然后再重新输入，默认是 true
        -->
        <append>true</append>

        <!-- 指定日志输出格式，这里和输出控制台的一样 -->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} [%t] %p %C - %m%n</pattern>
        </encoder>
    </appender>

    <!-- 日志输出级别 -->
    <root level="trace">
        <appender-ref ref="console"/>
        <appender-ref ref="file"/>
    </root>
</configuration>

注意：日志是支持多种方式输出的，这里既有控制台输出，也有输出到文件中。
<file>ch02/logs/service.log</file>
这一行代码的意思是，日志文件输出保存的位置，这里写的是相对路径，在我们的项目路径下创建一个 logs 文件，并且创建一个记录日志的文件 service.log。输出到文件中同样也设置了 encoder 日志输出格式，这个格式是可以自定义的，我这里是和控制台输出的格式一致。日志输出的级别是 trace 最小的级别，所有只要输出的时候指定了所有级别，所有的信息都会输出来。
<appender-ref ref="file"/>
注意：如果要输出到文件中，一定要设置这一行代码，指定为 file 文件，不然运行的时候无法在 logs 文件夹中创建 service.xml 文件记录日志，只会在控制台输出。

二、新建一个 Main 类，输出日志信息

1、使用注解创建 log 对象，这个注解就是 @Slf4j


@Slf4j
public class Main {

//    private final static Logger log = LoggerFactory.getLogger(Main.class);

    public static void main(String[] args) {
        log.trace("简单的日志输出");
        log.debug("调试日志信息");
        log.info("业务日志信息");
        log.warn("警告日志信息");
        log.error("错误日志信息");
    }

}

注释的代码是手动的去 New 一个 log 对象去给我们自己使用，现在使用注解创建 log 对象，就不需要了。

2、测试运行结果

这就是控制台输出日志和输出到文件中的方法。为了验证我们刚刚说的，如果不设置

<appender-ref ref="file"/>

这一行代码，日志信息就不会输出到文件中，并且不会创建这个 service.xml 文件

3、验证

1）先把 service.xml 文件删除，并且把 <appender-ref ref="file"/> 也删掉

我把 service.xml 文件删除后，并且把 <appender-ref ref="file"/> 代码注释掉了，运行代码后，并没有在 logs 文件夹中创建 service.xml 去记录我们的日志信息。这也是在平时开发中容易忘记（本人）的一个细节，所以在这里特意演示了一边给大家看，如果大家测试的时候发现没有创建出 service.xml 文件就知道哪里出问题了吧。