【商城秒殺項目】-- 使用JSR303進行參數校驗、全局異常處理

什麼是JSR-303

JSR是Java Specification Requests的縮寫，意思是Java規範提案，是指向JCP(Java Community Process)提出新增一個標準化技術規範的正式請求。任何人都可以提交JSR，以向Java平臺增添新的API和服務，JSR已成爲Java界的一個重要標準

JSR-303是JAVA EE 6中的一項子規範，叫做Bean Validation，Hibernate Validator是Bean Validation的參考實現；Hibernate Validator提供了JSR-303規範中所有內置constraint的實現，除此之外還有一些附加的constraint。說白了，JSR-303就是後端進行數據校驗的一種方式，使得驗證邏輯從業務代碼中脫離出來

Bean Validation 中內置的 constraint：

Hibernate Validator 附加的constraint：

詳細介紹：https://www.ibm.com/developerworks/cn/java/j-lo-jsr303/index.html

JSR-303的使用

本項目在登錄的時候使用了JSR-303進行參數校驗，用法如下：先在實體類的屬性上打上@NotNull、@Length(min=32)等註解，可避免重複的校驗代碼以及代碼冗餘；然後在需要驗證的參數前面打上@Valid註解，那麼此註解就會自動對該實體類進行參數校驗，具體校驗規則在該實體類內部實現

自定義JSR-303註解實現手機號碼的校驗

新建一個註解類IsMobile，並且引入相應的規則：

package com.javaxl.miaosha_05.validator;

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * 自定義註解類：message() + groups() + payload()是必須的
 */
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER})
@Retention(RUNTIME)
@Documented
//繼承校驗器
@Constraint(validatedBy = {IsMobileValidator.class})
public @interface IsMobile {

    boolean required() default true;

    String message() default "手機號碼格式錯誤";

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

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

只有註解系統是不會進行校驗的，還需要做一些處理，因爲IsMobile裏面需要一個@Constraint(validatedBy = { IsMobileValidator.class })，即IsMobileValidator，用來繼承

新建一個IsMobileValidator類，需要實現ConstraintValidator校驗器：

package com.javaxl.miaosha_05.validator;

import com.javaxl.miaosha_05.util.ValidatorUtil;
import org.apache.commons.lang3.StringUtils;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

/**
 * 註解校驗器類：繼承ConstraintValidator類<註解類，註解參數類型>，
 * 實現兩個方法（initialize：初始化操作、isValid：邏輯處理）
 * IsMobile：自定義的註解
 * String：註解參數類型
 */
public class IsMobileValidator implements ConstraintValidator<IsMobile, String> {
    //默認值爲false，用於接收註解上自定義的required屬性
    private boolean required = false;
    
    //1、初始化方法：通過該方法可以拿到我們的註解
    public void initialize(IsMobile constraintAnnotation) {
        required = constraintAnnotation.required();
    }
    
    //2、邏輯處理
    public boolean isValid(String value, ConstraintValidatorContext context) {
        if(required) {
            return ValidatorUtil.isMobile(value);
        }
        else {
            if(StringUtils.isEmpty(value)) {
                return true;
            }
            else {
                return ValidatorUtil.isMobile(value);
            }
        }
    }
}

手機號碼驗證邏輯工具類代碼（ValidatorUtil.java）：

package com.javaxl.miaosha_05.util;

import org.apache.commons.lang3.StringUtils;

import java.util.regex.Matcher;
import java.util.regex.Pattern;

public class ValidatorUtil {

    private static final Pattern mobile_pattern = Pattern.compile("1\\d{10}");

    public static boolean isMobile(String src) {
        if (StringUtils.isEmpty(src)) {
            return false;
        }
        Matcher m = mobile_pattern.matcher(src);
        return m.matches();
    }
}

全局異常處理

當使用了JSR-303校驗器後，校驗不通過時會產生一個BindException（org.springframework.validation.BindException）和一大串錯誤信息（其中就包括校驗的處理信息）；若要對異常進行處理，我們可以定義一個處理全局異常的攔截器

好處：可以實現對項目中所有產生的異常進行攔截，在同一個類中實現統一處理，避免異常漏處理的情況

新建GlobalExceptionHandler類：

package com.javaxl.miaosha_05.exception;

import com.javaxl.miaosha_05.result.CodeMsg;
import com.javaxl.miaosha_05.result.Result;
import org.springframework.validation.BindException;
import org.springframework.validation.ObjectError;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

import java.util.List;

@ControllerAdvice
@ResponseBody
public class GlobalExceptionHandler {
    //攔截所有的異常
    @ExceptionHandler(value = Exception.class)
    public Result<String> exceptionHandler(Exception e) {
        e.printStackTrace();
        if (e instanceof GlobalException) {
            GlobalException ex = (GlobalException) e;
            return Result.error(ex.getCm());
        } else if (e instanceof BindException) {//是綁定異常的情況
            //強轉
            BindException ex=(BindException) e;
            //獲取錯誤信息
            List<ObjectError> errors = ex.getAllErrors();
            ObjectError error = errors.get(0);
            String msg = error.getDefaultMessage();
            return Result.error(CodeMsg.BIND_ERROR.fillArgs(msg));
        } else {//不是綁定異常的情況
            return Result.error(CodeMsg.SERVER_ERROR);
        }
    }
}

注：

• @ControllerAdvice是一個@Component，用於定義@ExceptionHandler，@InitBinder和@ModelAttribute方法，適用於所有使用@RequestMapping的方法，會對所有@RequestMapping方法進行檢查、攔截，並進行異常處理。
• @ExceptionHandler用於標註要被攔截的異常，value=Exception.class代表攔截所有的異常
• @ResponseBody是爲了方便輸出，使得這個GlobalExceptionHandler類裏面的方法跟我們Controller類一樣是輸出的信息，返回值Result類型可以攜帶信息，當參數校驗不通過的時候，輸出也是Result（CodeMsg），傳給前端用於前端顯示獲取處理

新建一個全局異常類GlobalException，出現異常就可以直接拋這個異常；GlobalException繼承Runtime類，重寫構造函數，傳入CodeMsg：

package com.javaxl.miaosha_05.exception;

import com.javaxl.miaosha_05.result.CodeMsg;

/**
 * 自定義異常類繼承RuntimeException（運行時異常）
 */
public class GlobalException extends RuntimeException{

	private static final long serialVersionUID = 1L;
	
	private CodeMsg cm;
	
	public GlobalException(CodeMsg cm) {
		super(cm.toString());
		this.cm = cm;
	}

	public CodeMsg getCm() {
		return cm;
	}
}

全局異常處理使用場景：先檢查異常類型，若業務中發現異常直接拋出我們自定義的異常即可

例如：

JSR-303結合全局異常使用的校驗效果：