二十SpringBoot2核心技术——整合logback

Posted 2021-09-05 上善若水

一、SpringBoot整合logback

1.1、日志文件

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 

1.1.1、我们一般针对DAO的包进行DEBUG日志设置：

<logger name="com.xbmu.mapper" level="DEBUG" />

这样的话，只打印SQL语句：

1.1.2、代码里打印日志

之前我们大多数时候自己在每个类创建日志对象去打印信息，比较麻烦：

private static final Logger logger = LoggerFactory.getLogger(StudentServiceImpl.class);
logger.error("xxx");

现在可以直接在类上通过@Slf4j标签去声明式注解日志对象

在pom.xml中添加依赖

<!--简化JavaBean，@Slf4j 自动化日志对象-->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
</dependency>

添加lombok插件

1.1.3、logback-spring.xml

<?xml version="1.0" encoding="UTF-8"?>
<!--
日志级别从低到高分为 TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果
设置为 WARN，则低于 WARN 的信息都不会输出
-->
<!-- scan:当此属性设置为 true 时，配置文件如果发生改变，将会被重新加载，默认值为true -->
<!--
scanPeriod:设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认
单位是毫秒。当 scan 为 true 时，此属性生效。默认的时间间隔为 1 分钟。
-->
<!-- debug:当此属性设置为 true 时，将打印出 logback 内部日志信息，实时查看 logback运行状态。默认值为 false。通常不打印 -->
<configuration scan="true" scanPeriod="10 seconds">
    <!--输出到控制台-->
    <!-- 追加器 -->
    <appender name="CONSOLE"
              class="ch.qos.logback.core.ConsoleAppender">
        <!--此日志 appender 是为开发使用，只配置最底级别，控制台输出的日志级别是大
        于或等于此级别的日志信息-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>debug</level>
        </filter>
        <encoder>
            <Pattern>%date [%-5p] [%thread] %logger{60} [%file : %line] %msg%n</Pattern>
            <!-- 设置字符集 -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>
    <appender name="FILE"
              class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--<File>/home/log/stdout.log</File>-->
        <File>D:/log/stdout.log</File>
        <encoder>
            <pattern>%date [%-5p] %thread %logger{60} [%file : %line] %msg%n</pattern>
        </encoder>
        <rollingPolicy
                class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 添加.gz 历史日志会启用压缩 大大缩小日志文件所占空间 -->
            <!--<fileNamePattern>/home/log/stdout.log.%d{yyyy-MM-dd}.log</fileNam
            ePattern>-->
            <fileNamePattern>D:/log/stdout.log.%d{yyyy-MM-dd}.log</fileNamePattern>
            <maxHistory>30</maxHistory><!-- 保留 30 天日志 -->
        </rollingPolicy>
    </appender>
    <!-- 单个定义 -->
    <logger name="com.xbmu.mapper" level="DEBUG" />
    <!-- 如果root标签指定了日志级别，那么以根日志级别为准；如果没有，则已当前追加器为准 -->
    <!-- 全部 -->
    <!--
        appender TRACE TRACE
        root     TRACE

        appender TRACE DEBUG
        root     DEBUG

        appender TRACE DEBUG
        root     空     如果root没有值，默认root级别是debug

        appender DEBUG INFO
        root     INFO

    -->
    <root level="INFO">
        <appender-ref ref="CONSOLE"/>
        <appender-ref ref="FILE"/>
    </root>
</configuration>

1.2、项目代码

pom.xml

<properties>
        <java.version>1.8</java.version>
        <mybatis-spring.version>2.2.0</mybatis-spring.version>
    </properties>

    <dependencies>
        <!-- SpringBoot集成web框架的起步依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!--MyBatis 集成 SpringBoot 框架的起步依赖-->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>${mybatis-spring.version}</version>
        </dependency>

        <!--连接 mysql 的驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>

        <!--SpringBoot 项目内嵌 tomcat 对 jsp 的解析包-->
        <dependency>
            <groupId>org.apache.tomcat.embed</groupId>
            <artifactId>tomcat-embed-jasper</artifactId>
        </dependency>
        <!--如果使用JSTL必须添加该依赖-->
        <!--jstl标签依赖的jar包-->
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>jstl</artifactId>
        </dependency>

        <!--简化JavaBean，@Slf4j 自动化日志对象-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>
    <build>
        <!--
            springboot项目默认推荐使用的前端引擎时thymeleaf，现在我们要使用springboot集成jsp，
            手动指定jsp最后编译的路径。而且springboot集成jsp、编译jsp的路径是springboot规定好的位置
            META-INF/resources
        -->
        <resources>
            <resource>
                <!--源文件夹-->
                <directory>src/main/webapp</directory>
                <!--指定编译到 META-INF/resources -->
                <targetPath>META-INF/resources</targetPath>
                <!--指定源文件夹中的哪个资源要编译进行-->
                <includes>
                    <include>**/*.*</include>
                </includes>
            </resource>
        </resources>
        <!--springboot编译打包插件-->
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

StudentController.java

package com.xbmu.controller;

import com.xbmu.pojo.Stundent;
import com.xbmu.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.RequestMapping;
import org.springframework.web.servlet.ModelAndView;

import java.util.List;

@Controller
@Slf4j
public class StudentController {
    @Autowired
    private StudentService studentService;

    @RequestMapping("/findAllStudent")
    public ModelAndView findAllStudent(){
        ModelAndView mv = new ModelAndView();
        log.info("获取学生信息start");
        List<Stundent> allStudent = studentService.findAllStudent();
        log.info("获取学生信息end");
        mv.setViewName("index");
        mv.addObject("allStudent",allStudent);
        return mv;
    }
}

StudentServiceImpl.java

package com.xbmu.service.impl;

import com.xbmu.mapper.StudentMapper;
import com.xbmu.pojo.Stundent;
import com.xbmu.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 List<Stundent> findAllStudent() {
        return studentMapper.queryAllStudent();
    }
}

StudentMapper.java

package com.xbmu.mapper;

import com.xbmu.pojo.Stundent;

import java.util.List;

public interface StudentMapper {
    List<Stundent> queryAllStudent();
}

StudentMapper.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.xbmu.mapper.StudentMapper">
    <select id="queryAllStudent" resultType="com.xbmu.pojo.Stundent">
        SELECT id,`name`,age FROM `t_student`
    </select>
</mapper>

application.yml

server:
  port: 8082
  servlet:
    context-path: /

spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/springdb?useUnicode=true&characterEncoding=UTF-8&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=GMT%2B8
    username: root
    password: root

  mvc:
    view:
      prefix: /
      suffix: .jsp

mybatis:
  mapper-locations: classpath:mapper/*.xml

LogBackApplication.java

package com.xbmu;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@MapperScan(basePackages = "com.xbmu.mapper")
public class LogBackApplication {
    public static void main(String[] args) {
        SpringApplication.run(LogBackApplication.class,args);
    }
}

index.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
<html>
<head>
    <title>查看所有学生信息</title>
</head>
<body>
    <ul>
    <c:forEach items="${allStudent}" var="student" >
        <li>学生id:${student.id},学生姓名:${student.name},学生年龄:${student.age}</li>
    </c:forEach>
    </ul>
</body>
</html>

1.3、启动测试