SpringBoot | 第八章：統(tǒng)一異常、數(shù)據(jù)校驗處理

前言

在web應(yīng)用中，請求處理時，出現(xiàn)異常是非常常見的。所以當(dāng)應(yīng)用出現(xiàn)各類異常時，進(jìn)行異常的捕獲或者二次處理(比如sql異常正常是不能外拋)是非常必要的，比如在開發(fā)對外api服務(wù)時，約定了響應(yīng)的參數(shù)格式，如respCode、respMsg，調(diào)用方根據(jù)錯誤碼進(jìn)行自己的業(yè)務(wù)邏輯。本章節(jié)就重點講解下統(tǒng)一異常和數(shù)據(jù)校驗處理。

springboot中，默認(rèn)在發(fā)送異常時，會跳轉(zhuǎn)值/error請求進(jìn)行錯誤的展現(xiàn)，根據(jù)不同的Content-Type展現(xiàn)不同的錯誤結(jié)果，如json請求時，直接返回json格式參數(shù)。
瀏覽器訪問異常時：

瀏覽器

使用postman訪問時：

postman

統(tǒng)一異常處理

顯然，默認(rèn)的異常頁是對用戶或者調(diào)用者而言都是不友好的，所以一般上我們都會進(jìn)行實現(xiàn)自己業(yè)務(wù)的異常提示信息。

創(chuàng)建全局的統(tǒng)一異常處理類

利用@ControllerAdvice和@ExceptionHandler定義一個統(tǒng)一異常處理類

  • @ControllerAdvice：控制器增強，使@ExceptionHandler、@InitBinder、@ModelAttribute注解的方法應(yīng)用到所有的 @RequestMapping注解的方法。

  • @ExceptionHandler：異常處理器，此注解的作用是當(dāng)出現(xiàn)其定義的異常時進(jìn)行處理的方法

創(chuàng)建異常類：CommonExceptionHandler

@ControllerAdvice
public class CommonExceptionHandler {

    /**
     *  攔截Exception類的異常
     * @param e
     * @return
     */
    @ExceptionHandler(Exception.class)
    @ResponseBody
    public Map<String,Object> exceptionHandler(Exception e){
        Map<String,Object> result = new HashMap<String,Object>();
        result.put("respCode", "9999");
        result.put("respMsg", e.getMessage());
        //正常開發(fā)中，可創(chuàng)建一個統(tǒng)一響應(yīng)實體，如CommonResp
        return result; 
    }
}

多余不同異常(如自定義異常)，需要進(jìn)行不同的異常處理時，可編寫多個exceptionHandler方法，注解ExceptionHandler指定處理的異常類，如

    /**
     * 攔截 CommonException 的異常
     * @param ex
     * @return
     */
    @ExceptionHandler(CommonException.class)
    @ResponseBody
    public Map<String,Object> exceptionHandler(CommonException ex){
        log.info("CommonException：{}({})",ex.getMsg(), ex.getCode());
        Map<String,Object> result = new HashMap<String,Object>();
        result.put("respCode", ex.getCode());
        result.put("respMsg", ex.getMsg());
        return result; 
    }

由于加入了@ResponseBody，所以返回的是json格式，

image
image

說明異常已經(jīng)被攔截了。
可攔截不同的異常，進(jìn)行不同的異常提示，比如NoHandlerFoundException、HttpMediaTypeNotSupportedException、AsyncRequestTimeoutException等等，這里就不列舉了，讀者可自己加入后實際操作下。

對于返回頁面時，返回ModelAndView即可，如

@ExceptionHandler(value = Exception.class)
    public ModelAndView defaultErrorHandler(HttpServletRequest req, Exception e) throws Exception {
        ModelAndView mav = new ModelAndView();
        mav.addObject("exception", e);
        mav.addObject("url", req.getRequestURL());
        mav.setViewName(DEFAULT_ERROR_VIEW);
        return mav;
    }

由于工作中都是才有前后端分離開發(fā)模式，所以一般上都沒有直接返回資源頁的需求了，一般上都是返回固定的響應(yīng)格式，如respCode、respMsg、data，前端通過判斷respCode的值進(jìn)行業(yè)務(wù)判斷，是彈窗還是跳轉(zhuǎn)頁面。

數(shù)據(jù)校驗

在web開發(fā)時，對于請求參數(shù)，一般上都需要進(jìn)行參數(shù)合法性校驗的，原先的寫法時一個個字段一個個去判斷，這種方式太不通用了，所以java的JSR 303: Bean Validation規(guī)范就是解決這個問題的。

JSR 303只是個規(guī)范，并沒有具體的實現(xiàn)，目前通常都是才有hibernate-validator進(jìn)行統(tǒng)一參數(shù)校驗。

JSR303定義的校驗類型

Constraint 詳細(xì)信息
@Null 被注釋的元素必須為 null
@NotNull 被注釋的元素必須不為 null
@AssertTrue 被注釋的元素必須為 true
@AssertFalse 被注釋的元素必須為 false
@Min(value) 被注釋的元素必須是一個數(shù)字，其值必須大于等于指定的最小值
@Max(value) 被注釋的元素必須是一個數(shù)字，其值必須小于等于指定的最大值
@DecimalMin(value) 被注釋的元素必須是一個數(shù)字，其值必須大于等于指定的最小值
@DecimalMax(value) 被注釋的元素必須是一個數(shù)字，其值必須小于等于指定的最大值
@Size(max, min) 被注釋的元素的大小必須在指定的范圍內(nèi)
@Digits (integer, fraction) 被注釋的元素必須是一個數(shù)字，其值必須在可接受的范圍內(nèi)
@Past 被注釋的元素必須是一個過去的日期
@Future 被注釋的元素必須是一個將來的日期
@Pattern(value) 被注釋的元素必須符合指定的正則表達(dá)式

Hibernate Validator 附加的 constraint

Constraint 詳細(xì)信息
@Email 被注釋的元素必須是電子郵箱地址
@Length 被注釋的字符串的大小必須在指定的范圍內(nèi)
@NotEmpty 被注釋的字符串的必須非空
@Range 被注釋的元素必須在合適的范圍內(nèi)

創(chuàng)建實體類


@Data
@NoArgsConstructor
@AllArgsConstructor
public class DemoReq {
    
    @NotBlank(message="code不能為空")
    String code;
    
    @Length(max=10,message="name長度不能超過10")
    String name;

}

然后在控制層方法里，加入@Valid即可，這樣在訪問前，會對請求參數(shù)進(jìn)行檢驗。

    @GetMapping("/demo/valid")
    public String demoValid(@Valid DemoReq req) {
        return req.getCode() + "," + req.getName();
    }

啟動，后訪問http://127.0.0.1:8080/demo/valid

image

加上正確參數(shù)后，http://127.0.0.1:8080/demo/valid?code=3&name=s

image

這樣數(shù)據(jù)的統(tǒng)一校驗就完成了，對于其他注解的使用，大家可自行谷歌下，基本上都很簡單的，對于已有的注解無法滿足校驗需要時，也可進(jìn)行自定義注解的開發(fā)，一下簡單講解下，自定義注解的編寫

不使用@valid的情況下，也可利用編程的方式編寫一個工具類，進(jìn)行實體參數(shù)校驗

public class ValidatorUtil {
    private static Validator validator = ((HibernateValidatorConfiguration) Validation
            .byProvider(HibernateValidator.class).configure()).failFast(true).buildValidatorFactory().getValidator();

    /**
     * 實體校驗
     * 
     * @param obj
     * @throws CommonException
     */
    public static <T> void validate(T obj) throws CommonException {
        Set<ConstraintViolation<T>> constraintViolations = validator.validate(obj, new Class[0]);
        if (constraintViolations.size() > 0) {
            ConstraintViolation<T> validateInfo = (ConstraintViolation<T>) constraintViolations.iterator().next();
            // validateInfo.getMessage() 校驗不通過時的信息，即message對應(yīng)的值
            throw new CommonException("0001", validateInfo.getMessage());
        }
    }
}

使用

    @GetMapping("/demo/valid")
    public String demoValid(@Valid DemoReq req) {
        //手動校驗
        ValidatorUtil.validate(req);
        return req.getCode() + "," + req.getName();
    }

自定義校驗注解

自定義注解，主要時實現(xiàn)ConstraintValidator的處理類即可，這里已編寫一個校驗常量的注解為例：參數(shù)值只能為特定的值。

自定義注解

@Documented
//指定注解的處理類
@Constraint(validatedBy = {ConstantValidatorHandler.class })
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER })
@Retention(RUNTIME)
public @interface Constant {

   String message() default "{constraint.default.const.message}";

   Class<?>[] groups() default {};

   Class<? extends Payload>[] payload() default {};

   String value();

}

注解處理類

public class ConstantValidatorHandler implements ConstraintValidator<Constant, String> {

    private String constant;

    @Override
    public void initialize(Constant constraintAnnotation) {
        //獲取設(shè)置的字段值
        this.constant = constraintAnnotation.value();
    }

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        //判斷參數(shù)是否等于設(shè)置的字段值，返回結(jié)果
        return constant.equals(value);
    }

}

使用

    @Constant(message = "verson只能為1.0",value="1.0")
    String version;

運行：

image

此時，自定義注解已生效。大家可根據(jù)實際需求進(jìn)行開發(fā)。

大家看到在校驗不通過時，返回的異常信息是不友好的，此時可利用統(tǒng)一異常處理，對校驗異常進(jìn)行特殊處理，特別說明下，對于異常處理類
共有以下幾種情況(被@RequestBody和@RequestParam注解的請求實體，校驗異常類是不同的)

@ExceptionHandler(MethodArgumentNotValidException.class)
    public Map<String,Object> handleBindException(MethodArgumentNotValidException ex) {
        FieldError fieldError = ex.getBindingResult().getFieldError();
        log.info("參數(shù)校驗異常:{}({})", fieldError.getDefaultMessage(),fieldError.getField());
        Map<String,Object> result = new HashMap<String,Object>();
        result.put("respCode", "01002");
        result.put("respMsg", fieldError.getDefaultMessage());
        return result;
    }


    @ExceptionHandler(BindException.class)
    public Map<String,Object> handleBindException(BindException ex) {
        //校驗 除了 requestbody 注解方式的參數(shù)校驗 對應(yīng)的 bindingresult 為 BeanPropertyBindingResult
        FieldError fieldError = ex.getBindingResult().getFieldError();
        log.info("必填校驗異常:{}({})", fieldError.getDefaultMessage(),fieldError.getField());
        Map<String,Object> result = new HashMap<String,Object>();
        result.put("respCode", "01002");
        result.put("respMsg", fieldError.getDefaultMessage());
        return result;
    }

啟動后，提示就友好了

image

所以統(tǒng)一異常還是很有必要的。

總結(jié)

本章節(jié)主要是闡述了統(tǒng)一異常處理和數(shù)據(jù)的合法性校驗，同時簡單實現(xiàn)了一個自定義的注解類，大家在碰見已有注解無法解決時，可通過自定義的形式進(jìn)行，當(dāng)然對于通用而已，利用@Pattern(正則表達(dá)式)基本上都是可以實現(xiàn)的。

最后

目前互聯(lián)網(wǎng)上很多大佬都有springboot系列教程，如有雷同，請多多包涵了。本文是作者在電腦前一字一句敲的，每一步都是實踐的。若文中有所錯誤之處，還望提出，謝謝。

老生常談

  • 個人QQ：499452441
  • 微信公眾號：lqdevOps
公眾號

個人博客：https://blog.lqdev.cn

完整示例：chapter-8

原文地址：http://blog.lqdev.cn/2018/07/20/springboot/chapter-eight/

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點，簡書系信息發(fā)布平臺，僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容