統一結果傳回
目前的前後端開發大部分資料的傳輸格式都是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 = 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<String,Object> 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在項目中使用。
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" converterClass="org.springframework.boot.logging.logback.ColorConverter" />
<conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" />
<conversionRule conversionWord="wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" />
<!-- 彩色日志格式 -->
<property name="CONSOLE_LOG_PATTERN" value="${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" class="ch.qos.logback.core.ConsoleAppender">
<!--此日志appender是為開發使用，隻配置最底級别，控制台輸出的日志級别是大于或等于此級别的日志資訊-->
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<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" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 正在記錄的日志文檔的路徑及文檔名 -->
<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 class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!-- 日志歸檔 -->
<fileNamePattern>${log.path}/web-debug-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
<!--日志文檔保留天數-->
<maxHistory>15</maxHistory>
</rollingPolicy>
<!-- 此日志文檔隻記錄debug級别的 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>debug</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!-- 2.2 level為 INFO 日志，時間滾動輸出 -->
<appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 正在記錄的日志文檔的路徑及文檔名 -->
<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 class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!-- 每天日志歸檔路徑以及格式 -->
<fileNamePattern>${log.path}/web-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
<!--日志文檔保留天數-->
<maxHistory>15</maxHistory>
</rollingPolicy>
<!-- 此日志文檔隻記錄info級别的 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>info</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!-- 2.3 level為 WARN 日志，時間滾動輸出 -->
<appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 正在記錄的日志文檔的路徑及文檔名 -->
<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 class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${log.path}/web-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
<!--日志文檔保留天數-->
<maxHistory>15</maxHistory>
</rollingPolicy>
<!-- 此日志文檔隻記錄warn級别的 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>warn</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!-- 2.4 level為 ERROR 日志，時間滾動輸出 -->
<appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 正在記錄的日志文檔的路徑及文檔名 -->
<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 class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${log.path}/web-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
<!--日志文檔保留天數-->
<maxHistory>15</maxHistory>
</rollingPolicy>
<!-- 此日志文檔隻記錄ERROR級别的 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<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插件可實作控制台的自定義顔色輸出