Spring boot学习之集成logback和lombok(4)

我会带着你远行 2022-04-17 02:07 317阅读 0赞

## 集成logback ##

1、在resources下新建 logback.xml 文件，并写入以下代码，注意路径(路径是你保存日志文件的地方)  
ps：这个文件在网上很容易找到，所以我就针对一些配置加上了解释，可以根据需要自行修改

<?xml version="1.0" encoding="UTF-8"?>
    <configuration>
        
        <property name="LOG_HOME" value="C:/" />
        
        <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
            <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
                
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            </encoder>
        </appender>
        
        <appender name="FILE"  class="ch.qos.logback.core.rolling.RollingFileAppender">
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                
                <FileNamePattern>${LOG_HOME}/system.log.%d{yyyy-MM-dd}.log</FileNamePattern>
                
                <MaxHistory>30</MaxHistory>
            </rollingPolicy>
            <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
                
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            </encoder>
            
            <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
                <MaxFileSize>10MB</MaxFileSize>
            </triggeringPolicy>
        </appender>
    
        
        <root level="INFO">
            <appender-ref ref="STDOUT" />
            <appender-ref ref="FILE" />
        </root>
    </configuration>

2、也可以同步到数据库，参考如下配置，直接配置在 lombok.xml中

<appender name="DB" class="ch.qos.logback.classic.db.DBAppender">
         
         <connectionSource class="ch.qos.logback.core.db.DriverManagerConnectionSource">
             
             <dataSource class="com.mchange.v2.c3p0.ComboPooledDataSource">
                 <driverClass>com.mysql.jdbc.Driver</driverClass>
                 <url>jdbc:mysql://127.0.0.1:3306/yourDatabaseName</url>
                 <user>root</user>
                 <password>admin</password>
             </dataSource>
         </connectionSource>
     </appender>

3、日志也是可以按环境去划分的，只需要像application-local.yml一样，只需要在后面加 -local 就可以了  
4、接着在系统中记录日志，主要有两处，日志声明和日志记录

package cn.xt.app.controller;
    
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RequestMethod;
    import org.springframework.web.bind.annotation.RestController;
    
    // @RestController 以JSON格式返回数据
    @RestController
    public class MyController {
    
        // 获取到日志对象，注意包名
        private Logger log = LoggerFactory.getLogger(MyController.class);
    
        // 请求名为：sayHello
        // 请求方式为：get
        @RequestMapping(value = "sayHello", method = RequestMethod.GET)
        public String sayHello() {
            // 记录不同类型的日志
            log.info("info");
            log.debug("debug");
            log.error("error");
            log.warn("warn");
            return "hello world";
        }
    }

5、\[可选\]可以在指定的环境配置某个包下日志的详细信息，如：可在 application-local.yml配置如下信息

# 配置日志为debug
    # 有时候本地环境为了方便看详细日志，如SQL，所以设置dubg，而生产(prod)则不设置
    logging:
      level:
         # 针对某个包 Mapper
         cn.xt.app.mapper: debug

## 集成lombok ##

*  当你写完一个实体类的时候，你会快速的用工具生成 get/set 方法
 *  当你变量名字发生更改的时候，你会重新生成一遍 get/set 方法
 *  当你需要使用日志的时候，你需要 Logger log = LoggerFactory.getLogger()
 *  当你需要使用 toString 的时候，你默默的按下了熟悉的按键…

ok，这些全都可以交给 lombok  
1、添加依赖

<lombok.version>1.16.20</lombok.version>
    
    
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>${lombok.version}</version>
        <scope>provided</scope>
    </dependency>

我的 pom 文件参考如下

<?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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
    
        <groupId>cn.xt</groupId>
        <artifactId>logback-and-lombok</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <packaging>jar</packaging>
    
        <name>spring-boot-logback-lombok</name>
        <description>SpringBoot集成logback和lombok</description>
    
        <parent>
            <groupId>cn.xt.parent</groupId>
            <artifactId>spring-boot-parent-core</artifactId>
            <version>1.0.0.RELEASE</version>
            <relativePath>../pom.xml</relativePath>
        </parent>
    
        
        <properties>
            <lombok.version>1.16.20</lombok.version>
        </properties>
    
        
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
    
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-tomcat</artifactId>
            </dependency>
    
            
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <version>${lombok.version}</version>
                <scope>provided</scope>
            </dependency>
    
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    
    
    </project>

2、项目中配置好了之后，为了方便的在 IDEA中使用(因为ide有时候不能很快的编译代码，导致写了lombok注解也识别不到)，所以 ide 也需要装一个插件  
3、点击 file -> settings -> plugins，在输入框输入：lombok，然后点击 browser  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwNjk4OTgz_size_16_color_FFFFFF_t_70]  
4、选择lombok plugins，然后点击 install  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwNjk4OTgz_size_16_color_FFFFFF_t_70 1]  
5、安装完后必须重启IDE  
6、lombok的常用注解

1.  @Getter 生成get 方法
2.  @Setter 生成set 方法
3.  @ToString 生成 toString方法
4.  @Data 同时生成 get/set 方法
5.  @Slf4j 日志注解，默认生成一个名称为 log 的变量(写好这个注解后，直接可能使用log.error)
6.  @Cleanup 自动关闭流
7.  @NonNull 不为空校验
8.  @Builder 支持属性链式写法，如：UserDTO.builder().user(“小天”).pass(“12345”).build();

更多注解挖掘中…

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwNjk4OTgz_size_16_color_FFFFFF_t_70]: /images/20220417/c9dd0f1e2884428e8c92ea0a261c58e6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwNjk4OTgz_size_16_color_FFFFFF_t_70 1]: /images/20220417/c26a281f28bf44ba9d68276a5c411bb6.png