springboot整合日志+多環境配置+熱部署

前言

本篇文章主要介紹的是springboot的日志配置，主要包括使用Slf4j+logback記錄日志、使用AOP統一處理Web請求日志、多環境切換、熱部署。

GitHub源碼鏈接位於文章底部。

工程結構

首先來看工程結構

POM文件

pom文件中引入相關依賴

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.3.RELEASE</version>
    </parent>
    <dependencies>
        <!-- SpringBoot 核心組件 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--AOP依賴-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>
        <!--引入@Slf4j注解-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>

一、使用Slf4j+logback輸出日志

1.在resources資源目錄下創建logback.xml文件

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">

    <!--定義日志文件的存儲地址 勿在 LogBack 的配置中使用相對路徑-->
    <property name="LOG_HOME" value="D:/logs/" ></property>

    <!--控制台日志， 控制台輸出 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化輸出：%d表示日期，%thread表示線程名，%-5level：級別從左顯示5個字符寬度,%msg：日志消息，%n是換行符-->
            <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}/%d{yyyy-MM-dd}/pro.log</FileNamePattern>
            <!--日志文件保留天數-->
            <MaxHistory>30</MaxHistory>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化輸出：%d表示日期，%thread表示線程名，%-5level：級別從左顯示5個字符寬度%msg：日志消息，%n是換行符-->
            <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>

    <!-- show parameters for hibernate sql 專為 Hibernate 定制 -->
    <logger name="org.hibernate.type.descriptor.sql.BasicBinder" level="TRACE" ></logger>
    <logger name="org.hibernate.type.descriptor.sql.BasicExtractor" level="DEBUG" ></logger>
    <logger name="org.hibernate.SQL" level="DEBUG" ></logger>
    <logger name="org.hibernate.engine.QueryParameters" level="DEBUG" ></logger>
    <logger name="org.hibernate.engine.query.HQLQueryPlan" level="DEBUG" ></logger>

    <!--myibatis log configure-->
    <logger name="com.apache.ibatis" level="TRACE" ></logger>
    <logger name="java.sql.Connection" level="DEBUG" ></logger>
    <logger name="java.sql.Statement" level="DEBUG" ></logger>
    <logger name="java.sql.PreparedStatement" level="DEBUG" ></logger>

    <!-- 日志輸出級別 -->
    <root level="INFO">
        <appender-ref ref="STDOUT" ></appender-ref>
        <appender-ref ref="FILE" ></appender-ref>
    </root>
</configuration>

2.application.yml配置文件中配置

server:
  port: 8080

#配置日志文件路徑
logging:
  config: classpath:logback.xml

2.controller層中創建LogsController，添加getLog函數如下：

@RestController
@Slf4j
public class LogsController {
    @RequestMapping("/log")
    public void getLog() {
        try {
            log.error("錯誤日志輸出");
            log.info("信息日志輸出");
            int i = 10 / 0;
        } catch (Exception e) {
            log.error("Exception", e);
        }
    }
}

Slf4j注解定義了log變量。
訪問http://localhost:8080/log ，可以看到生成了D:\logs\2019-12-10\pro.log文件，這是在logback.xml文件中配置了的。
這里故意制造了一個除以0的異常，配合抓取的異常信息。
控制台輸出：

D:\logs\2019-12-10\pro.log文件輸出：

二、springboot的多環境配置

springboot使用配置簡化了xml，極大地方便了開發。但是開發環境、測試環境、生產環境的配置是不一樣的，舉個例子，當我們連接數據庫時，需要在配置文件中配置數據源，如果一直每次部署到線上測試的時候都要修改數據庫連接、賬戶密碼等，就會非常麻煩，還容易改錯。多環境配置就解決了這個問題，只需要創建多個配置文件，需要修改的時候只切換所選配置文件就行。

首先創建三個配置文件：application-dev.yml、application-test.yml、application-pro.yml
在application-dev.yml配置

lxg:
  msg: 這是開發環境

在application-test.yml配置

lxg:
  msg: 這是測試環境

在application-pro.yml配置

lxg:
  msg: 這是生產環境

在application.yml配置文件中引入對應環境的配置文件

spring:
  profiles:
    active: dev

這里的值是根據之前創建的配置文件的名后綴定義的。

在LogsController中定義一個全局變量，使用Value注解引入對應的變量，語法如下

@Value("${lxg.msg}")
private String msg;

添加接口，輸出該變量。

輸出的是我們選擇的配置文件中定義的變量。

三、使用AOP統一處理Web請求日志

在config目錄中創建WebLogAspect切面類

@Component
@Aspect
@Slf4j
public class WebLogAspect {
    /**
     * 設置切點
     */
    @Pointcut("execution(public * com.lxg.controller.*.*(..))")
    public void webLog() {
    }

    @Before("webLog()")
    public void doBefore() {
        // 接收到請求，記錄請求內容
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        // 記錄下請求內容
        log.info("URL : " + request.getRequestURL().toString());
        log.info("HTTP_METHOD : " + request.getMethod());
        log.info("IP : " + request.getRemoteAddr());
        Enumeration<String> enu = request.getParameterNames();
        while (enu.hasMoreElements()) {
            String name = enu.nextElement();
            log.info("name:{},value:{}", name, request.getParameter(name));
        }
    }

    @AfterReturning(returning = "ret", pointcut = "webLog()")
    public void doAfterReturning(Object ret){
        // 處理完請求，返回內容
        log.info("RESPONSE : " + ret);
    }
}

Component注解是將當前類注入到spring容器中，且每次調用該類都是新創建的對象。
Slf4j注解定義了log變量。
Pointcut設置了切點的位置
此時再次訪問http://localhost:8080/msg 控制台輸出日志,

日志文件輸出：

四、熱部署

熱部署就是在不手動重新部署的情況下，代碼修改后自動編譯部署。

spring-boot-devtools 是一個為開發者服務的一個模塊，其中最重要的功能就是自動應用代碼更改到最新的App上面去。原理是在發現代碼有更改之后，重新啟動應用，但是速度比手動停止后再啟動還要更快，更快指的不是節省出來的手工操作的時間。

其深層原理是使用了兩個ClassLoader，一個Classloader加載那些不會改變的類（第三方Jar包），另一個ClassLoader加載會更改的類，稱為restart ClassLoader,這樣在有代碼更改的時候，原來的restart ClassLoader 被丟棄，重新創建一個restart ClassLoader，由於需要加載的類相比較少，所以實現了較快的重啟時間。

1.打開菜單欄 File -> Settings -> Default Settings -> Build -> Compiler 然后勾選 Build project automatically 。

2.同時按住 Ctrl + Shift + Alt + / 然后進入Registry ，勾選自動編譯並調整延時參數。

3.選擇更新范圍

4.添加依賴

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-devtools</artifactId>
	<optional>true</optional>
	<scope>true</scope>
</dependency>

啟動項目后，修改yml文件中引入的dev,test,pro，訪問msg接口會返回不同的結果。

本文GitHub源碼：https://github.com/lixianguo5097/springboot/tree/master/springboot-logs

CSDN：https://blog.csdn.net/qq_27682773
簡書：https://www.jianshu.com/u/e99381e6886e
博客園：https://www.cnblogs.com/lixianguo
個人博客：https://www.lxgblog.com