?1、搭建系統(tǒng)的目錄結(jié)構(gòu)

編輯

common目錄用于存放全局的設(shè)置和內(nèi)容。?

1. 
   

2. 
   

   ?annotation? ? ?注釋信息

   
   

3. 
   

4. 
   

   ?config? ? ? 配置相關(guān)

   
   

5. 
   

6. 
   

   ?constant? 常數(shù)

   
   

7. 
   

8. 
   

   core?核心?通用的類的信息。

   
   

9. 
   

10. 
    

    enum? ?枚舉類型

    
    

11. 
    

12. 
    

    exception? 異常信息

    
    

13. 
    

14. 
    

    filter? ? 過濾器

    
    

15. 
    

16. 
    

    until? 工具類

    
    

2、創(chuàng)建全局返回結(jié)果

JsonResult

package com.example.demo0108.common.core.model; import com.fasterxml.jackson.annotation.JsonInclude; import io.swagger.annotations.ApiModelProperty; import lombok.Data; import java.io.Serializable; /** * 統(tǒng)一返回?cái)?shù)據(jù)結(jié)構(gòu) * * @author zfb * */ @Data @JsonInclude(JsonInclude.Include.NON_NULL) public class JsonResult implements Serializable { ? private static final long serialVersionUID = -4177895470291082085L; ? @ApiModelProperty("成功標(biāo)志:true成功 false失敗") ? private boolean flag; ? // 響應(yīng)業(yè)務(wù)狀態(tài) @ApiModelProperty("業(yè)務(wù)狀態(tài)碼") ? private String code; ? // 響應(yīng)消息 @ApiModelProperty("業(yè)務(wù)提示") ? private String message; ? // 響應(yīng)中的數(shù)據(jù) @ApiModelProperty("數(shù)據(jù)") ? private Object data; ? public JsonResult() { ? } ? public JsonResult(boolean flag, String msg) { ? ? ?this.flag = flag; ? ? ?this.code = "00000"; ?//默認(rèn)狀態(tài)碼為0000 this.message = msg; ? ? ?this.data = null; ? } ? public JsonResult(boolean flag, String code, String msg, Object data) { ? ? ?this.flag = flag; ? ? ?this.code = code; ? ? ?this.message = msg; ? ? ?this.data = data; ? } ? public JsonResult(Object data) { ? ? ?this.flag = true; ? ? ?this.code = "00000"; ? ? ?this.message = "success"; ? ? ?this.data = data; ? } ? public static JsonResult ok() { return new JsonResult(null); } ? public static JsonResult ok(String msg) { ? ? ?return new JsonResult(true, "00000", msg, null); ? } ? public static JsonResult ok(Object data) { return new JsonResult(data); } ? public static JsonResult ok(String msg, Object obj) { ? ? ?return new JsonResult(true, "00000", msg, obj); ? } ? ?//通用的錯(cuò)誤放回編碼 public static JsonResult error(String msg) { return new JsonResult(false, "-9999", msg, null); } ? public static JsonResult error(String code, String msg) { return new JsonResult(false, code, msg, null); } ? public static JsonResult error(String code, String msg, Object obj) { return new JsonResult(false, code, msg, obj); } ? @Override public String toString() { ? ? ?StringBuilder builder = new StringBuilder(); ? ? ?builder.append("JsonResult [flag=").append(flag).append(", code=").append(code).append(", message=").append(message) ? ? ? ? ? ?.append(", data=").append(data).append("]"); ? ? ?return builder.toString(); ? } }

新增方法測(cè)試異常類。

@ApiOperation(value = "測(cè)試統(tǒng)一返回類") @PostMapping("/springboot") public JsonResult index2(){ ? ?return JsonResult.ok("Welcome to the world of Spring Boot!"); }

在swagger內(nèi)測(cè)試接口,測(cè)試成功。

編輯

3、整合全局捕獲異常

創(chuàng)建全局異常類? ? GlobalExceptionHandler?

@ExceptionHandler?表示攔截異常

• 
  

• @ControllerAdvice 是 controller 的一個(gè)輔助類，最常用的就是作為全局異常處理的切面類

• 
  

• @ControllerAdvice 可以指定掃描范圍

• 
  

• @ControllerAdvice 約定了幾種可行的返回值，如果是直接返回 model 類的話，需要使用 @ResponseBody 進(jìn)行 json 轉(zhuǎn)換

package com.example.demo0108.common.exception; import com.example.demo0108.common.core.model.JsonResult; import lombok.extern.slf4j.Slf4j; import org.springframework.http.HttpStatus; import org.springframework.http.converter.HttpMessageNotReadableException; import org.springframework.stereotype.Component; import org.springframework.web.bind.annotation.ControllerAdvice; import org.springframework.web.bind.annotation.ExceptionHandler; import org.springframework.web.bind.annotation.ResponseBody; import org.springframework.web.bind.annotation.ResponseStatus; import javax.validation.ConstraintViolation; import javax.validation.ConstraintViolationException; import javax.validation.ValidationException; import java.util.Set; /** * 全局捕獲異常處理 * Created by Kong on 2019-06-28. * 處理po的入?yún)⒋a的合理性。 */ @ControllerAdvice @Component @Slf4j public class GlobalExceptionHandler { ? ?@ExceptionHandler (ValidationException.class) //返回所有校驗(yàn)類異常時(shí)處理。 @ResponseBody //攔截返回是json結(jié)果 @ResponseStatus(HttpStatus.OK) ? ?public JsonResult handle(ValidationException exception) { ? ? ? ?JsonResult message = new JsonResult(); ? ? ? ?StringBuilder sb = new StringBuilder(); ? ? ? ?if (exception instanceof ConstraintViolationException) { ? ? ? ? ? ?ConstraintViolationException exs = (ConstraintViolationException) exception; ? ? ? ? ? ?Set<ConstraintViolation<?>> violations = exs.getConstraintViolations(); ? ? ? ? ? ?for (ConstraintViolation<?> item : violations) { ? ? ? ? ? ? ? ?/*不通過的信息拼接*/ sb.append(item.getMessage()).append(","); ? ? ? ? ? ?} ? ? ? ?} else { ? ? ? ? ? ?sb.append(exception.getMessage()); ? ? ? ?} ? ? ? ?message.setFlag(false); ? ? ? ?message.setMessage(deleteLastChar(sb.toString())); ? ? ? ?return message; ? ?} ? ?@ExceptionHandler(Exception.class) ? //返回所有的運(yùn)行時(shí)異常。 @ResponseBody @ResponseStatus(HttpStatus.OK) ? ?public JsonResult handleException(Exception ex) { ? ? ? ?JsonResult response = new JsonResult(); ? ? ? ?response.setFlag(false); ? ? ? ?response.setCode("-9999"); ? ? ? ?//2019-09-11 @Kong json序列化異常 if (ex instanceof HttpMessageNotReadableException) { ? ? ? ? ? ?response.setMessage(ex.getCause().getMessage().split(" at ")[0]); ? ? ? ?}else { ? ? ? ? ? ?response.setMessage(ex.getMessage()); ? ? ? ?} ? ? ? ?log.error("系統(tǒng)發(fā)生異常:{}",ex); ? ? ? ?return response; ? ?} ? ?/** * 去掉最后一個(gè)字符。 返回異常時(shí)候，存在異常拼接，去除最后一個(gè)‘，’分隔符。 */ public static String deleteLastChar(String string) { ? ? ? ?if (string == null || string.equals("")) { ? ? ? ? ? ?return string; ? ? ? ?} ? ? ? ?return string.substring(0, string.length() - 1); ? ?} }