[[400097]]

本文轉載自微信公眾號「JAVA日知錄」，作者單一色調。轉載本文請聯系JAVA日知錄公眾號。

對于 web服務來說，為防止非法參數對業務造成影響，在 Controller層一定要對參數進行校驗!本章我們以SpringBoot項目為例，介紹參數校驗的基本用法以及一些高級技巧，希望能對你有所幫助。

簡單使用

1.要在Springboot項目中加入參數校驗功能首先得加入spring-boot-starter-validation依賴

<dependency> 
 <groupId>org.springframework.boot</groupId> 
 <artifactId>spring-boot-starter-validation</artifactId> 
</dependency> 

2.然后給需要校驗的字段添加上約束性注解，如我們對實體類參數進行校驗

@Data 
public class ValidEntity{ 
    private int id; 
    @NotBlank 
    private String appId; 
   
    @NotBlank 
    private String name; 
   
    @Email 
    private String email; 
} 

常見約束注解如下：

注：此表格只是簡單的對注解功能的說明，并沒有對每一個注解的屬性進行說明;可詳見源碼。

3.在Controller層對需要參數校驗的方法加上@Validated注解

參數校驗一般分為兩類：在Controller使用模型接收數據時， @Validated注解直接放在該模型參數前即可。

@PostMapping(value = "test1") 
public String test1(@Validated @RequestBody ValidEntity validEntity){ 
 return "test1 valid success"; 
} 
 
@PostMapping(value = "test3") 
public String test3(@Validated ValidEntity validEntity){ 
 return "test3 valid success"; 
} 

當我們是直接在Controller層中的參數前，使用約束注解時，@Validated要直接放在類上

@PostMapping(value = "test2") 
public String test2(@Email String email){ 
    return "test2 valid success"; 
} 

此時需要在主類上增加@Validated注解

@Validated 
@RestController 
@RequestMapping("/demo/valid") 
public class ValidController { 
 ... 
} 

在參數校驗時我們既可以使用@Validated也可以使用@Valid注解，兩者功能大部分類似;

主要區別在于：

@Valid屬于javax下的，而@Validated屬于spring下;

@Valid支持嵌套校驗、而@Validated不支持，@Validated支持分組，而@Valid不支持。

統一異常處理

如果參數校驗未通過Spring會拋出三種類型的異常

1.當對@RequestBody需要的參數進行校驗時會出現org.springframework.web.bind.MethodArgumentNotValidException

當直接校驗具體參數時會出現javax.validation.ConstraintViolationException，也屬于ValidationException異常

當直接校驗對象時會出現org.springframework.validation.BindException

在SpringBoot中統一攔截處理只需要在配置類上添加 @RestControllerAdvice注解，然后在具體方法中通過 @ExceptionHandler指定需要處理的異常，具體代碼如下：

@RestControllerAdvice 
@Slf4j 
public class GlobalExceptionHandler { 
    public static final String ERROR_MSG = "系統異常，請聯系管理員。"; 
 
    @ExceptionHandler(value = {BindException.class, ValidationException.class, MethodArgumentNotValidException.class}) 
    public ResponseEntity<Result<String>> handleValidatedException(Exception e) { 
        Result<String> resp = null; 
 
        if (e instanceof MethodArgumentNotValidException) { 
            // BeanValidation exception 
            MethodArgumentNotValidException ex = (MethodArgumentNotValidException) e; 
            resp = new Result<>(Integer.toString(HttpStatus.BAD_REQUEST.value()), 
                    ex.getBindingResult().getAllErrors().stream().map(ObjectError::getDefaultMessage).collect(Collectors.joining(", ")) 
                    , getStackTrace(ex)); 
        } else if (e instanceof ConstraintViolationException) { 
            // BeanValidation GET simple param 
            ConstraintViolationException ex = (ConstraintViolationException) e; 
            resp = new Result<>(Integer.toString(HttpStatus.BAD_REQUEST.value()), 
                    ex.getConstraintViolations().stream().map(ConstraintViolation::getMessage).collect(Collectors.joining(", ")) 
                    , getStackTrace(ex)); 
        } else if (e instanceof BindException) { 
            // BeanValidation GET object param 
            BindException ex = (BindException) e; 
            resp = new Result<>(Integer.toString(HttpStatus.BAD_REQUEST.value()), 
                    ex.getAllErrors().stream().map(ObjectError::getDefaultMessage).collect(Collectors.joining(", ")) 
                    , getStackTrace(ex)); 
        } 
 
        return new ResponseEntity<>(resp,HttpStatus.BAD_REQUEST); 
    } 
 
 
    private String getStackTrace(Exception e) { 
        //打印日志開關，可通過配置讀取 
        boolean printStrackTrace = false; 
        if(printStrackTrace){ 
            StringWriter sw = new StringWriter(); 
            e.printStackTrace(new PrintWriter(sw)); 
            return sw.toString(); 
        }else{ 
            return ERROR_MSG; 
        } 
 
    } 
 
} 

最終實現效果如下：

參數分組

有下面一個實體類，我們需要對其進行參數校驗。

@Data 
public class ValidEntity { 
    private int id; 
 
    @NotBlank 
    private String appId; 
 
    @NotBlank 
    private String name; 
 
    @Email 
    private String email; 
} 

但是實際業務是在編輯的時候 appId才是必填，在新增的時候 name必填，這時候可以用groups分組功能來實現：同一個模型在不同場景下，動態區分校驗模型中的不同字段。

使用方式

首先我們定義一個分組接口ValidGroup，再在分組接口總定義出多個不同的操作類型，Create，Update，Query，Delete

public interface ValidGroup extends Default{ 
   
    interface Crud extends ValidGroup{ 
       
        interface Create extends Crud{ 
 
        } 
     
        interface Update extends Crud{ 
 
        } 
       
        interface Query extends Crud{ 
 
        } 
   
        interface Delete extends Crud{ 
 
        } 
    } 
} 

這里的 ValidGroup繼承了Default，當然也可以不繼承，具體區別我們后面再說。

在模型中給校驗參數分配分組

@Data 
@ApiModel(value="ValidEntity") 
public class ValidEntity { 
    private int id; 
 
    @NotBlank(groups = ValidGroup.Crud.Update.class) 
    private String appId; 
 
    @NotBlank(groups = ValidGroup.Crud.Create.class) 
    private String name; 
 
    @Email 
    private String email; 
} 

tips：這里@Email注解未指定分組，默認會屬于Default分組，appId和name指定了分組就不會再屬于Default分組了。

在參數校驗時通過value屬性指定分組

這里通過 @Validated(value = ValidGroup.Crud.Update.class)指定了具體的分組，上面提到的是否繼承Default的區別在于：

如果繼承了Default，@Validated標注的注解也會校驗未指定分組或者Default分組的參數，比如email

如果不繼承Default則不會校驗未指定分組的參數，需要加上@Validated(value = {ValidGroup.Crud.Update.class, Default.class}才會校驗

快速失敗(Fali Fast)

默認情況下在對參數進行校驗時Spring Validation會校驗完所有字段然后才拋出異常，可以通過配置開啟 Fali Fast模式，一旦校驗失敗就立即返回。

@Configuration 
public class ValidatedConfig { 
 
    @Bean 
    public Validator validator() { 
        ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator.class) 
                .configure() 
                // 快速失敗模式 
                .failFast(true) 
                .buildValidatorFactory(); 
        return validatorFactory.getValidator(); 
    } 
} 

以上，希望對你有所幫助!