統(tǒng)一結(jié)果返回
目前的前后端開發(fā)大部分數(shù)據(jù)的傳輸格式都是json，因此定義一個(gè)統(tǒng)一規(guī)范的數(shù)據(jù)格式有利于前后端的交互與UI的展示。
統(tǒng)一結(jié)果的一般形式
結(jié)果類枚舉
- 前三者可定義結(jié)果枚舉，如：success，code，message
@Getterpublic enum ResultCodeEnum { SUCCESS(true,20000,”成功”), UNKNOWN_ERROR(false,20001,”未知錯(cuò)誤”),, PARAM_ERROR(false,20002,”參數(shù)錯(cuò)誤”), ; // 響應(yīng)是否成功 private Boolean success; // 響應(yīng)狀態(tài)碼 private Integer code; // 響應(yīng)信息 private String message; ResultCodeEnum(boolean success, Integer code, String message) { this.success = success; this.code = code; this.message = message; }}
統(tǒng)一結(jié)果類
- 第5個(gè)屬于自定義返回，利用前4者可定義統(tǒng)一返回對(duì)象
注意：
@Datapublic class R { private Boolean success; private Integer code; private String message; private Map data = new HashMap(); // 構(gòu)造器私有 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; } // 通用返回失敗，未知錯(cuò)誤 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; } // 設(shè)置結(jié)果，形參為結(jié)果枚舉 public static R setResult(ResultCodeEnum result) { R r = new R(); r.setSuccess(result.getSuccess()); r.setCode(result.getCode()); r.setMessage(result.getMessage()); return r; } /**————使用鏈?zhǔn)骄幊蹋祷仡惐旧?#8212;——–**/ // 自定義返回?cái)?shù)據(jù) public R data(Map map) { this.setData(map); return this; } // 通用設(shè)置data public R data(String key,Object value) { this.data.put(key, value); return this; } // 自定義狀態(tài)信息 public R message(String message) { this.setMessage(message); return this; } // 自定義狀態(tài)碼 public R code(Integer code) { this.setCode(code); return this; } // 自定義返回結(jié)果 public R success(Boolean success) { this.setSuccess(success); return this; }}
控制層返回
- 視圖層使用統(tǒng)一結(jié)果
@RestController@RequestMapping(“/api/v1/users”)public class TeacherAdminController { @Autowired private UserService userService; @GetMapping public R list() { List list = teacherService.list(null); return R.ok().data(“itms”, list).message(“用戶列表”); }}
- json結(jié)果
{ “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” } ] }}
統(tǒng)一結(jié)果類的使用參考了mybatis-plus中R對(duì)象的設(shè)計(jì)。
統(tǒng)一異常處理
使用統(tǒng)一返回結(jié)果時(shí)，還有一種情況，就是程序的保存是由于運(yùn)行時(shí)異常導(dǎo)致的結(jié)果，有些異常我們可以無(wú)法提前預(yù)知，不能正常走到我們r(jià)eturn的R對(duì)象返回。
因此，我們需要定義一個(gè)統(tǒng)一的全局異常來(lái)捕獲這些信息，并作為一種結(jié)果返回控制層
@ControllerAdvice
該注解為統(tǒng)一異常處理的核心
是一種作用于控制層的切面通知（Advice），該注解能夠?qū)⑼ㄓ玫腀ExceptionHandler、@InitBinder和@ModelAttributes方法收集到一個(gè)類型，并應(yīng)用到所有控制器上
該類中的設(shè)計(jì)思路：
自定義全局異常類
@Datapublic 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() + ‘}’; }}
統(tǒng)一異常處理器
// …import org.springframework.web.bind.annotation.ControllerAdvice;import org.springframework.web.bind.annotation.ExceptionHandler;import org.springframework.web.bind.annotation.ResponseBody;@ControllerAdvicepublic class GlobalExceptionHandler { /**——– 通用異常處理方法 ——–**/ @ExceptionHandler(Exception.class) @ResponseBody public R error(Exception e) { e.printStackTrace(); return R.error(); // 通用異常結(jié)果 } /**——– 指定異常處理方法 ——–**/ @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()); }}
控制層展示
以下為展示當(dāng)遇到null指定異常時(shí)，返回的結(jié)果信息
{ “success”: false, “code”: 20007, “message”: “空指針異常”, “data”: {}}
統(tǒng)一日志收集
日志是追蹤錯(cuò)誤定位問(wèn)題的關(guān)鍵，尤其在生產(chǎn)環(huán)境中，需要及時(shí)修復(fù)熱部署，不會(huì)提供開發(fā)者debug的環(huán)境，此時(shí)日志將會(huì)是最快解決問(wèn)題的關(guān)鍵
日志的框架比較豐富，由于spring boot對(duì)logback的集成，因此推薦使用logback在項(xiàng)目中使用。
Logback
配置
以下直接貼出配置信息，介紹信息科直接參考備注
<!– 日志級(jí)別從低到高分為TRACE < DEBUG < INFO < WARN < ERROR logback debug ${CONSOLE_LOG_PATTERN} UTF-8 ${log.path}/edu_debug.log %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} – %msg%n UTF-8 ${log.path}/web-debug-%d{yyyy-MM-dd}.%i.log 100MB 15 debug ACCEPT DENY ${log.path}/edu_info.log %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} – %msg%n UTF-8 ${log.path}/web-info-%d{yyyy-MM-dd}.%i.log 100MB 15 info ACCEPT DENY ${log.path}/edu_warn.log %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} – %msg%n UTF-8 ${log.path}/web-warn-%d{yyyy-MM-dd}.%i.log 100MB 15 warn ACCEPT DENY ${log.path}/edu_error.log %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} – %msg%n UTF-8 ${log.path}/web-error-%d{yyyy-MM-dd}.%i.log 100MB 15 ERROR ACCEPT DENY
日志收集異常信息
日志信息往往伴隨著異常信息的輸出，因此，我們需要修改統(tǒng)一異常的處理器，將異常信息以流的方式寫到日志文件中
- 異常信息文件工具類
@Slf4jpublic 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; }}
- 修改統(tǒng)一異常處理器，將異常方法中的直接打印改為日志輸入并打印
// …import lombok.extern.slf4j.Slf4j;@ControllerAdvice@Slf4jpublic class GlobalExceptionHandler { /**——– 通用異常處理方法 ——–**/ @ExceptionHandler(Exception.class) @ResponseBody public R error(Exception e) { // e.printStackTrace(); log.error(ExceptionUtil.getMessage(e)); return R.error(); } // …}
注意
原文鏈接：https://mp.weixin.qq.com/s/kPb5NYizLf-svFaBrRkcuQ
