Spring Boot 專案統一結果，統一例外，統一日志，寫的太好了。。-有解無憂

作者：永動的圖靈機
鏈接：https://juejin.cn/post/6844904033488994317

統一結果回傳

目前的前后端開發大部分資料的傳輸格式都是json，因此定義一個統一規范的資料格式有利于前后端的互動與UI的展示，

統一結果的一般形式

是否回應成功；
回應狀態碼；
狀態碼描述；
回應資料
其他識別符號

結果類列舉

前三者可定義結果列舉，如：success，code，message

@Getter
public enum ResultCodeEnum {
    SUCCESS(true,20000,"成功"),
    UNKNOWN_ERROR(false,20001,"未知錯誤"),,
    PARAM_ERROR(false,20002,"引數錯誤"),
    ;

    // 回應是否成功
    private Boolean success;
    // 回應狀態碼
    private Integer code;
    // 回應資訊
    private String message;

    ResultCodeEnum(boolean success, Integer code, String message) {
        this.success = success;
        this.code = code;
        this.message = message;
    }
}

統一結果類

第5個屬于自定義回傳，利用前4者可定義統一回傳物件

注意：

外接只可以呼叫統一回傳類的方法，不可以直接創建，影刺構造器私有；
內置靜態方法，回傳物件；
為便于自定義統一結果的資訊，建議使用鏈式編程，將回傳物件設類本身，即return this;
回應資料由于為json格式，可定義為JsonObject或Map形式；

@Data
public class R {
    private Boolean success;

    private Integer code;

    private String message;

    private Map<String, Object> data = https://www.cnblogs.com/javastack/p/new HashMap<>();

    // 構造器私有
    private R(){}

    // 通用回傳成功
    public static R ok() {
        R r = new R();
        r.setSuccess(ResultCodeEnum.SUCCESS.getSuccess());
        r.setCode(ResultCodeEnum.SUCCESS.getCode());
        r.setMessage(ResultCodeEnum.SUCCESS.getMessage());
        return r;
    }

    // 通用回傳失敗，未知錯誤
    public static R error() {
        R r = new R();
        r.setSuccess(ResultCodeEnum.UNKNOWN_ERROR.getSuccess());
        r.setCode(ResultCodeEnum.UNKNOWN_ERROR.getCode());
        r.setMessage(ResultCodeEnum.UNKNOWN_ERROR.getMessage());
        return r;
    }

    // 設定結果，形參為結果列舉
    public static R setResult(ResultCodeEnum result) {
        R r = new R();
        r.setSuccess(result.getSuccess());
        r.setCode(result.getCode());
        r.setMessage(result.getMessage());
        return r;
    }

    /**------------使用鏈式編程，回傳類本身-----------**/
    
    // 自定義回傳資料
    public R data(Map map) {
        this.setData(map);
        return this;
    }

    // 通用設定data
    public R data(String key,Object value) {
        this.data.put(key, value);
        return this;
    }

    // 自定義狀態資訊
    public R message(String message) {
        this.setMessage(message);
        return this;
    }

    // 自定義狀態碼
    public R code(Integer code) {
        this.setCode(code);
        return this;
    }

    // 自定義回傳結果
    public R success(Boolean success) {
        this.setSuccess(success);
        return this;
    }
}

控制層回傳

視圖層使用統一結果

@RestController
@RequestMapping("/api/v1/users")
public class TeacherAdminController {

    @Autowired
    private UserService userService;

    @GetMapping
    public R list() {
        List<Teacher> list = teacherService.list(null);
        return R.ok().data("itms", list).message("用戶串列");
    }
}

json結果

{
  "success": true,
  "code": 20000,
  "message": "查詢用戶串列",
  "data": {
    "itms": [
      {
        "id": "1",
        "username": "admin",
        "role": "ADMIN",
        "deleted": false,
        "gmtCreate": "2019-12-26T15:32:29",
        "gmtModified": "2019-12-26T15:41:40"
      },{
        "id": "2",
        "username": "zhangsan",
        "role": "USER",
        "deleted": false,
        "gmtCreate": "2019-12-26T15:32:29",
        "gmtModified": "2019-12-26T15:41:40"
      }
    ]
  }
}

統一結果類的使用參考了mybatis-plus中R物件的設計

統一例外處理

使用統一回傳結果時，還有一種情況，就是程式的保存是由于運行時例外導致的結果，有些例外我們可以無法提前預知，不能正常走到我們return的R物件回傳，

因此，我們需要定義一個統一的全域例外來捕獲這些資訊，并作為一種結果回傳控制層

@ControllerAdvice

該注解為統一例外處理的核心

是一種作用于控制層的切面通知（Advice），該注解能夠將通用的@ExceptionHandler、@InitBinder和@ModelAttributes方法收集到一個型別，并應用到所有控制器上

該類中的設計思路：

使用@ExceptionHandler注解捕獲指定或自定義的例外；
使用@ControllerAdvice集成@ExceptionHandler的方法到一個類中；
必須定義一個通用的例外捕獲方法，便于捕獲未定義的例外資訊；
自定一個例外類，捕獲針對專案或業務的例外;
例外的物件資訊補充到統一結果列舉中；

自定義全域例外類

@Data
public class CMSException extends RuntimeException {
    private Integer code;

    public CMSException(Integer code, String message) {
        super(message);
        this.code = code;
    }

    public CMSException(ResultCodeEnum resultCodeEnum) {
        super(resultCodeEnum.getMessage());
        this.code = resultCodeEnum.getCode();
    }

    @Override
    public String toString() {
        return "CMSException{" + "code=" + code + ", message=" + this.getMessage() + '}';
    }
}

統一例外處理器

// ...
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

@ControllerAdvice
public class GlobalExceptionHandler {

    /**-------- 通用例外處理方法 --------**/
    @ExceptionHandler(Exception.class)
    @ResponseBody
    public R error(Exception e) {
        e.printStackTrace();
        return R.error();	// 通用例外結果
    }

    /**-------- 指定例外處理方法 --------**/
    @ExceptionHandler(NullPointerException.class)
    @ResponseBody
    public R error(NullPointerException e) {
        e.printStackTrace();
        return R.setResult(ResultCodeEnum.NULL_POINT);
    }

    @ExceptionHandler(HttpClientErrorException.class)
    @ResponseBody
    public R error(IndexOutOfBoundsException e) {
        e.printStackTrace();
        return R.setResult(ResultCodeEnum.HTTP_CLIENT_ERROR);
    }
    
    /**-------- 自定義定例外處理方法 --------**/
    @ExceptionHandler(CMSException.class)
    @ResponseBody
    public R error(CMSException e) {
        e.printStackTrace();
        return R.error().message(e.getMessage()).code(e.getCode());
    }
}

控制層展示

以下為展示當遇到null指定例外時，回傳的結果資訊

{
  "success": false,
  "code": 20007,
  "message": "空指標例外",
  "data": {}
}

統一日志收集

日志是追蹤錯誤定位問題的關鍵，尤其在生產環境中，需要及時修復熱部署，不會提供開發者debug的環境，此時日志將會是最快解決問題的關鍵

日志的框架比較豐富，由于spring boot對logback的集成，因此推薦使用logback在專案中使用，

Spring Boot 基礎就不介紹了，推薦下這個實戰教程：

https://github.com/javastacks/spring-boot-best-practice

Logback

配置

以下直接貼出配置資訊，介紹資訊科直接參考備注

<?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">
    <contextName>logback</contextName>

    <!-- name的值是變數的名稱，value的值時變數定義的值，通過定義的值會被插入到logger背景關系中，定義后，可以使“${}”來使用變數， -->
    <property name="log.path" value="D:/Documents/logs/edu" />

    <!--0. 日志格式和顏色渲染 -->
    <!-- 彩色日志依賴的渲染類 -->
    <conversionRule conversionWord="clr" converter />
    <conversionRule conversionWord="wex" converter />
    <conversionRule conversionWord="wEx" converter />
    <!-- 彩色日志格式 -->
    <property name="CONSOLE_LOG_PATTERN" value="https://www.cnblogs.com/javastack/p/${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>

    <!--1. 輸出到控制臺-->
    <appender name="CONSOLE" >
        <!--此日志appender是為開發使用，只配置最底級別，控制臺輸出的日志級別是大于或等于此級別的日志資訊-->
        <filter >
            <level>debug</level>
        </filter>
        <encoder>
            <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
            <!-- 設定字符集 -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!--2. 輸出到檔案-->
    <!-- 2.1 level為 DEBUG 日志，時間滾動輸出  -->
    <appender name="DEBUG_FILE" >
        <!-- 正在記錄的日志檔案的路徑及檔案名 -->
        <file>${log.path}/edu_debug.log</file>
        <!--日志檔案輸出格式-->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            <charset>UTF-8</charset> <!-- 設定字符集 -->
        </encoder>
        <!-- 日志記錄器的滾動策略，按日期，按大小記錄 -->
        <rollingPolicy >
            <!-- 日志歸檔 -->
            <fileNamePattern>${log.path}/web-debug-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy >
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日志檔案保留天數-->
            <maxHistory>15</maxHistory>
        </rollingPolicy>
        <!-- 此日志檔案只記錄debug級別的 -->
        <filter >
            <level>debug</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!-- 2.2 level為 INFO 日志，時間滾動輸出  -->
    <appender name="INFO_FILE" >
        <!-- 正在記錄的日志檔案的路徑及檔案名 -->
        <file>${log.path}/edu_info.log</file>
        <!--日志檔案輸出格式-->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            <charset>UTF-8</charset>
        </encoder>
        <!-- 日志記錄器的滾動策略，按日期，按大小記錄 -->
        <rollingPolicy >
            <!-- 每天日志歸檔路徑以及格式 -->
            <fileNamePattern>${log.path}/web-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy >
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日志檔案保留天數-->
            <maxHistory>15</maxHistory>
        </rollingPolicy>
        <!-- 此日志檔案只記錄info級別的 -->
        <filter >
            <level>info</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!-- 2.3 level為 WARN 日志，時間滾動輸出  -->
    <appender name="WARN_FILE" >
        <!-- 正在記錄的日志檔案的路徑及檔案名 -->
        <file>${log.path}/edu_warn.log</file>
        <!--日志檔案輸出格式-->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            <charset>UTF-8</charset> <!-- 此處設定字符集 -->
        </encoder>
        <!-- 日志記錄器的滾動策略，按日期，按大小記錄 -->
        <rollingPolicy >
            <fileNamePattern>${log.path}/web-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy >
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日志檔案保留天數-->
            <maxHistory>15</maxHistory>
        </rollingPolicy>
        <!-- 此日志檔案只記錄warn級別的 -->
        <filter >
            <level>warn</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!-- 2.4 level為 ERROR 日志，時間滾動輸出  -->
    <appender name="ERROR_FILE" >
        <!-- 正在記錄的日志檔案的路徑及檔案名 -->
        <file>${log.path}/edu_error.log</file>
        <!--日志檔案輸出格式-->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            <charset>UTF-8</charset> <!-- 此處設定字符集 -->
        </encoder>
        <!-- 日志記錄器的滾動策略，按日期，按大小記錄 -->
        <rollingPolicy >
            <fileNamePattern>${log.path}/web-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy >
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日志檔案保留天數-->
            <maxHistory>15</maxHistory>
        </rollingPolicy>
        <!-- 此日志檔案只記錄ERROR級別的 -->
        <filter >
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!--
        <logger>用來設定某一個包或者具體的某一個類的日志列印級別、
        以及指定<appender>，<logger>僅有一個name屬性，
        一個可選的level和一個可選的addtivity屬性，
        name:用來指定受此logger約束的某一個包或者具體的某一個類，
        level:用來設定列印級別，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，
              還有一個特俗值INHERITED或者同義詞NULL，代表強制執行上級的級別，
              如果未設定此屬性，那么當前logger將會繼承上級的級別，
        addtivity:是否向上級logger傳遞列印資訊，默認是true，
        <logger name="org.springframework.web" level="info"/>
        <logger name="org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor" level="INFO"/>
    -->

    <!--
        使用mybatis的時候，sql陳述句是debug下才會列印，而這里我們只配置了info，所以想要查看sql陳述句的話，有以下兩種操作：
        第一種把<root level="info">改成<root level="DEBUG">這樣就會列印sql，不過這樣日志那邊會出現很多其他訊息
        第二種就是單獨給dao下目錄配置debug模式，代碼如下，這樣配置sql陳述句會列印，其他還是正常info級別：
        【logging.level.org.mybatis=debug logging.level.dao=debug】
     -->

    <!--
        root節點是必選節點，用來指定最基礎的日志輸出級別，只有一個level屬性
        level:用來設定列印級別，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，
        不能設定為INHERITED或者同義詞NULL，默認是DEBUG
        可以包含零個或多個元素，標識這個appender將會添加到這個logger，
    -->

    <!-- 4. 最終的策略 -->
    <!-- 4.1 開發環境:列印控制臺-->
    <springProfile name="dev">
        <logger name="com.cms" level="info"/>
        <root level="info">
            <appender-ref ref="CONSOLE" />
            <appender-ref ref="DEBUG_FILE" />
            <appender-ref ref="INFO_FILE" />
            <appender-ref ref="WARN_FILE" />
            <appender-ref ref="ERROR_FILE" />
        </root>
    </springProfile>


    <!-- 4.2 生產環境:輸出到檔案-->
    <springProfile name="pro">
        <logger name="com.cms" level="warn"/>
        <root level="info">
            <appender-ref ref="ERROR_FILE" />
            <appender-ref ref="WARN_FILE" />
        </root>
    </springProfile>

</configuration>

日志收集例外資訊

日志資訊往往伴隨著例外資訊的輸出，因此，我們需要修改統一例外的處理器，將例外資訊以流的方式寫到日志檔案中

例外資訊檔案工具類

@Slf4j
public class ExceptionUtil {

    /**
     * 列印例外資訊
     */
    public static String getMessage(Exception e) {
        String swStr = null;
        try (StringWriter sw = new StringWriter(); PrintWriter pw = new PrintWriter(sw)) {
            e.printStackTrace(pw);
            pw.flush();
            sw.flush();
            swStr = sw.toString();
        } catch (IOException ex) {
            ex.printStackTrace();
            log.error(ex.getMessage());
        }
        return swStr;
    }
}

修改統一例外處理器，將例外方法中的直接列印改為日志輸入并列印

// ...
import lombok.extern.slf4j.Slf4j;

@ControllerAdvice
@Slf4j
public class GlobalExceptionHandler {

    /**-------- 通用例外處理方法 --------**/
    @ExceptionHandler(Exception.class)
    @ResponseBody
    public R error(Exception e) {
        // e.printStackTrace();
        log.error(ExceptionUtil.getMessage(e));
        return R.error();
    }
    
   // ...
}

注意

日志的環境即spring.profiles.acticve，跟隨專案啟動；
啟動后，即可到自定目錄查找到生成的日志檔案；
本地idea除錯時，推薦Grep Console插件可實作控制臺的自定義顏色輸出

近期熱文推薦：

1.1,000+ 道 Java面試題及答案整理(2022最新版)

2.勁爆！Java 協程要來了，，，

3.Spring Boot 2.x 教程，太全了！

4.別再寫滿屏的爆爆爆炸類了，試試裝飾器模式，這才是優雅的方式！！

5.《Java開發手冊（嵩山版）》最新發布，速速下載！

覺得不錯，別忘了隨手點贊+轉發哦！

轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/491817.html

標籤：Java

上一篇：Spring依賴注入的簡介說明

下一篇：如何使用php使用帶有用戶名和密碼的API？