SpringBoot集成logback日志—日志配置文件—@Slf4j注解的使用

最新推荐文章于 2024-04-29 20:54:10 发布

848698119

最新推荐文章于 2024-04-29 20:54:10 发布

阅读量6.2k

点赞数 2

分类专栏： Spring Boot 文章标签： spring boot logback mybatis

本文链接：https://blog.csdn.net/qq_45896330/article/details/126218881

版权

Spring Boot 专栏收录该内容

44 篇文章 3 订阅

订阅专栏

SpringBoot集成logback日志

SpringBoot集成logback日志

SpringBoot集成logback日志

Spring Boot 默认使用Logback记录日志
Spring Boot starter 都会默认引入spring-boot-starter-logging，不需要再引入
日志级别从高到低分为：TRACE < DEBUG < INFO < WARN < ERROR < FATAL
如果设置为 WARN ，则低于 WARN 的信息都不会输出。
Spring Boot中默认配置ERROR、WARN和INFO级别的日志输出到控制台。

使用该功能的步骤：

创建SpringBoot框架web项目
添加依赖
核心配置文件
手动指定资源文件夹
编写控制层，业务逻辑层，持久层
日志文件
Application启动类
启动测试

1. 创建SpringBoot框架web项目

2. 添加依赖

src/main/resources/logback-spring.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.7.RELEASE</version>
        <relativePath/>
    </parent>
    <groupId>com.guo.springboot</groupId>
    <artifactId>springboot-logback</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <!--SpringBoot框架web项目起步依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--MySQL依赖-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <!--Mybatis-Plus-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.5.1</version>
        </dependency>
        <dependency>
            <groupId>com.h2database</groupId>
            <artifactId>h2</artifactId>
            <scope>runtime</scope>
        </dependency>
        <!--查看日志用-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.1</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

3. 核心配置文件

src/main/resources/application.properties

# 应用名称
server.servlet.context-path=/
# 应用服务 WEB 访问端口
server.port=8079
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.url=jdbc:mysql://localhost:3306/study?useUnicode=true&characterEncoding=UTF-8&serverTimezone=GMT%2B8
spring.datasource.type=com.zaxxer.hikari.HikariDataSource

4. 手动指定资源文件夹

默认情况下，Mybatis 的 xml 映射文件不会编译到 target 的 class 目录下，所以我们需要在 pom.xml 文件中配置 resource。

本次程序引入依赖是Mybatis-Plus，不需要xml映射文件，，所以可以省略这一步

<build>
   <!--
        手动指定文件夹为resources
    -->
    <resources>
        <resource>
            <directory>src/main/java</directory>
            <includes>
                <include>**/*.xml</include>
            </includes>
        </resource>
    </resources>
    <!--springboot编译打包插件-->
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
        </plugin>
    </plugins>
</build>

5. 编写控制层，业务逻辑层，持久层

5.1 控制层——添加@Slf4j注解

在类上添加@Slf4j注解，在方法中直接使用log.xxx();

src/main/java/com/guo/springboot/controller/StudentController.java

package com.guo.springboot.controller;
import com.guo.springboot.model.Student;
import com.guo.springboot.service.StudentService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
@Controller
@Slf4j
public class StudentController {
    @Autowired
    private StudentService studentService;
//    log.info("查询当前学生总人数");

    @GetMapping("/student/count")
    public @ResponseBody Object studentCount(){
        int i = studentService.queryStudentCount();
        log.trace("查询学生人数trace");
        log.debug("查询学生人数debug");
        log.info("查询学生人数info");
        log.warn("查询学生人数warn");
        log.error("查询学生人数error");
        return "学生人数为"+i;
    }
    @RequestMapping("/student/detail")
    public @ResponseBody Object student(Integer id){
        Student student = studentService.queryStudentById(id);
        return student;
    }
    @RequestMapping("/student")
    public @ResponseBody Object student1(){
        return studentService.queryStudentList();
    }
}

5.2 业务逻辑层

接口

src/main/java/com/guo/springboot/service/StudentService.java

package com.guo.springboot.service;
import com.guo.springboot.model.Student;
import java.util.List;
public interface StudentService {
    Integer queryStudentCount();
    Student queryStudentById(Integer id);
    List<Student> queryStudentList();
}

映射接口

src/main/java/com/guo/springboot/mapper/StudentMapper.java

package com.guo.springboot.mapper;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.guo.springboot.model.Student;
public interface StudentMapper extends BaseMapper<Student> {
}

接口实现类

src/main/java/com/guo/springboot/service/impl/StudentServiceImpl.java

package com.guo.springboot.service.impl;

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.guo.springboot.mapper.StudentMapper;
import com.guo.springboot.model.Student;
import com.guo.springboot.service.StudentService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;
@Service
public class StudentServiceImpl implements StudentService {
    @Autowired
    private StudentMapper studentMapper;
    @Override
    public Integer queryStudentCount() {
        QueryWrapper<Student> queryWrapper=new QueryWrapper();
        Long aLong = studentMapper.selectCount(queryWrapper);
        int num = Math.toIntExact(aLong);
        return num;
    }
    @Override
    public Student queryStudentById(Integer id) {
        Student student = studentMapper.selectById(id);
        return student;
    }
    @Override
    public List<Student> queryStudentList() {
        return studentMapper.selectList(null);
    }
}

5.3 持久层

src/main/java/com/guo/springboot/model/Student.java

package com.guo.springboot.model;
public class Student {
  private Integer id;
  private String name;
  private String sex;
  private Integer age;
  public Integer getId() {
    return id;
  }
  public void setId(Integer id) {
    this.id = id;
  }
  public String getName() {
    return name;
  }
  public void setName(String name) {
    this.name = name;
  }
  public String getSex() {
    return sex;
  }
  public void setSex(String sex) {
    this.sex = sex;
  }
  public Integer getAge() {
    return age;
  }
  public void setAge(Integer age) {
    this.age = age;
  }
}

6. 日志文件

Spring Boot官方推荐优先使用带有-spring 的文件名作为你的日志配置（如使用logback-spring.xml ，而不是logback.xml)，命名为logback-spring.xml的日志配置文件。默认的命名规则，并且放在 src/main/resources 下如果你即想完全掌控日志配置，但又不想用logback.xml作为Logback配置的名字，application.yml可以通过logging.config属性指定自定义的名字:
logging.config=classpath:logging-config.xml

在这里插入图片描述

logback-spring.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">
    <!--1. 输出到控制台-->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <!--此日志appender是为开发使用，只配置最底级别，控制台输出的日志级别是大于或等于此级别的日志信息-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>info</level>
        </filter>
        <encoder>
            <Pattern>>%date %5p [%thread] %logger{60} [%file :  %line] %msg%n</Pattern>
            <!-- 设置字符集 -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!--2. 输出到文档-->
    <!-- level为 DEBUG 日志，时间滚动输出  -->
    <appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在记录的日志文档的路径及文档名 -->
        <file>D:\myDev\log\debug.log</file>
        <!--日志文档输出格式-->
        <encoder>
            <pattern>%date %5p [%thread] %logger{60} [%file :  %line] %msg%n</pattern>
            <charset>UTF-8</charset> <!-- 设置字符集 -->
        </encoder>
        <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 添加.gz历史日志会启用压缩大大缩小日志文件所占空间-->
            <!--<fileNamePattern>/ home/log/stdout.log .%d{yyyy-MIA-dd}.log</fileNamePattern>-->
            <fileNamePattern>D:\myDev\log\debug-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <!--日志文档保留天数-->
            <maxHistory>30</maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <!-- 此日志文档只记录debug级别的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>debug</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!--单个指定-->
    <logger name="com.guo.springboot.mapper" level="DEBUG"/>
    <!--全部指定-->
    <!--如果root标签不指定日志级，默认日志级别为debug,,,,
        root标签指定日志级别和追加器指定日志级别，哪个日志级别高以哪个为准
    -->
    <root level="debug">
        <appender-ref ref="CONSOLE"/>
        <appender-ref ref="DEBUG_FILE"/>    <!--引用appender name-->
    </root>
</configuration>

7. Application启动类

package com.guo.springboot;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
@MapperScan(basePackages = "com.guo.springboot.mapper")
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

8. 启动测试

8.1 root日志级别低于追加器

root ：< root level=“debug”>
追加器： info
日志打印：日志级别：info

在这里插入图片描述

8.2 root日志级别高于追加器

root ：< root level=“info”>
追加器： debug
日志打印：日志级别：info

在这里插入图片描述

8.3 root日志级别低于追加器

root ：< root level=“info”>
追加器： error
日志打印：日志级别：error
在这里插入图片描述

848698119

关注

2
点赞
踩
10

收藏

觉得还不错? 一键收藏
打赏
1
评论
SpringBoot集成logback日志—日志配置文件—@Slf4j注解的使用

的文件名作为你的日志配置（如使用logback-spring.xml ，而不是logback.xml)，命名为logback-spring.xml的日志配置文件。默认情况下，Mybatis 的 xml 映射文件不会编译到 target 的 class 目录下，所以我们需要在 pom.xml 文件中配置 resource。Spring Boot中默认配置ERROR、WARN和INFO级别的日志输出到控制台。日志打印：日志级别：error。日志打印：日志级别：info。日志打印：日志级别：info。
复制链接

扫一扫