如何優(yōu)雅的處理異常?SpringBoot全局異常與數(shù)據(jù)校驗(yàn)
要思考的問(wèn)題
在現(xiàn)在的前后端交互中,通常都規(guī)范了接口返回方式,如返回的接口狀態(tài)(成功|失?。┮约耙祷氐臄?shù)據(jù)在那個(gè)字段取,或者說(shuō)失敗了以后提示信息從接口哪里返回,因此,如果想做全局異常,并且異常發(fā)生后能準(zhǔn)確的返回給前端解析,那么需要異常發(fā)生時(shí)返回給前端的格式與正常失敗場(chǎng)景的格式一致。
項(xiàng)目建立
利用idea 工具,很容易的搭建一個(gè)SpringBoot項(xiàng)目,要引入的maven依賴(lài)如下:
- <dependency>
- <groupId>org.springframework.boot</groupId>
- <artifactId>spring-boot-starter-validation</artifactId>
- </dependency>
- <dependency>
- <groupId>org.springframework.boot</groupId>
- <artifactId>spring-boot-starter-web</artifactId>
- </dependency>
- <dependency>
- <groupId>org.springframework.boot</groupId>
- <artifactId>spring-boot-starter-test</artifactId>
- <scope>test</scope>
- </dependency>
很簡(jiǎn)單,除了加入web功能還加入了我們需要用到的JSR-303校驗(yàn)框架。
定義成功失敗 返回碼
- public class Code {
- /**
- * 成功
- */
- public static int SUCCESSED = 1;
- /**
- * 失敗
- */
- public static int FAILED = -1;
- }
定義接口返回響應(yīng)實(shí)體
- public class Response<T> implements Serializable{
- /**
- *
- */
- private static final long serialVersionUID = 4250719891313555820L;
- /**
- * 返回結(jié)果集
- */
- private T result;
- /**
- * 返回消息
- */
- private String msg;
- /**
- * 響應(yīng)碼
- */
- private Integer code;
- //set get 略
- }
全局異常攔截和驗(yàn)證
定義自定義業(yè)務(wù)異常
- public class MyException extends RuntimeException {
- private static final long serialVersionUID = -5875371379845226068L;
- public MyException(){}
- public MyException(String msg){
- this.msg = msg ;
- }
- /**
- * 異常信息
- */
- private String msg ;
- /**
- * 具體異常碼
- */
- private int code = Code.FAILED;
- get set 略
編寫(xiě)全局異常控制器并對(duì)自定義異常做處理
- @ControllerAdvice
- public class GlobalExceptionHandler {
- private Logger logger = LoggerFactory.getLogger(GlobalExceptionHandler.class);
- @ExceptionHandler(value = MyException.class)
- @ResponseBody
- public Response<String> myExceptionErrorHandler(MyException ex) throws Exception {
- logger.error("myExceptionErrorHandler info:{}",ex.getMessage());
- Response<String> r = new Response<>();
- r.setMsg(ex.getMsg());
- r.setCode(ex.getCode());
- return r;
- }
編寫(xiě)controller模擬拋出業(yè)務(wù)異常
- @RestController
- @RequestMapping("/user")
- public class UserController {
- @PostMapping(value = "/update")
- Response<Boolean> update(User user){
- //todo 此處為模擬異常拋出
- if(true){
- throw new MyException("更新失敗");
- }
- //todo 此處為模擬返回
- Response<Boolean> response = new Response<>();
- response.setCode(Code.SUCCESSED);
- response.setResult(true);
- return response;
- }
- }
postMan模擬請(qǐng)求接口,進(jìn)行驗(yàn)證
數(shù)據(jù)綁定異常處理
通常我們操作數(shù)據(jù)的時(shí)候,不僅前端需要進(jìn)行數(shù)據(jù)校驗(yàn),后端也應(yīng)當(dāng)進(jìn)行攔截和進(jìn)行相應(yīng)的錯(cuò)誤提示,JSR-303校驗(yàn)框架也是我們的一種選擇。
編寫(xiě)實(shí)體`User`,并對(duì)屬性進(jìn)行注解控制
- public class User {
- @NotNull(message = "用戶(hù)名不能為空")
- private String userName;
- private int age;
- //...
全局異常控制類(lèi)加入攔截
- @ControllerAdvice
- public class GlobalExceptionHandler {
- private Logger logger = LoggerFactory.getLogger(GlobalExceptionHandler.class);
- @ExceptionHandler(value = BindException.class)
- @ResponseBody
- public Response<String> bindExceptionErrorHandler(BindException ex) throws Exception {
- logger.error("bindExceptionErrorHandler info:{}",ex.getMessage());
- Response<String> r = new Response<>();
- StringBuilder sb = new StringBuilder();
- FieldError fieldError = ex.getFieldError();
- sb.append(fieldError.getDefaultMessage());
- r.setMsg(sb.toString());
- r.setCode(Code.FAILED);
- return r;
- }
- //...
編寫(xiě)控制器
- @RestController
- @RequestMapping("/user")
- public class UserController {
- @PostMapping(value = "/add")
- Response<User> add(@Validated User user){
- //todo 此處為模擬返回
- Response<User> response = new Response<>();
- response.setCode(Code.SUCCESSED);
- response.setResult(new User());
- return response;
- }
- //...
postMan模擬請(qǐng)求
不填寫(xiě)任何屬性,模擬添加操作,準(zhǔn)確進(jìn)行攔截和報(bào)錯(cuò)
項(xiàng)目結(jié)構(gòu)預(yù)覽:
結(jié)尾
適合的才是***的,每個(gè)團(tuán)隊(duì)都應(yīng)摸索出自己的一套異常解決方案,本文所提僅針對(duì)業(yè)務(wù)異常,希望大家也能有所收獲