SpringMVC表單驗證器的使用

轉載自 SpringMVC表單驗證器的使用

本章講解SpringMVC中怎麼通過註解對錶單引數進行驗證。

SpringBoot配置

使用springboot， spring-boot-starter-web會自動引入 hiberante-validator, validation-api依賴。

在 WebMvcConfigurerAdapter實現類裡面新增驗證器及國際化指定資原始檔。

@Override
public Validator getValidator() {
    LocalValidatorFactoryBean validator = new LocalValidatorFactoryBean();
    validator.setValidationMessageSource(messageSource());
    return validator;
}

@Bean
public MessageSource messageSource() {
    ResourceBundleMessageSource messageSource = new ResourceBundleMessageSource();
    messageSource.setBasename("i18n/ValidationMessages");
    messageSource.setDefaultEncoding(StandardCharsets.US_ASCII.name());
    return messageSource;
}

驗證器使用

接收引數的表單類：

public class LoginForm {

    @NotNull(message = "{login.loginName.length}")
    @Size(min = 4, max = 20, message = "{login.loginName.length}")
    private String loginName;

    @NotNull(message = "{login.loginPassword.length}")
    @Size(min = 8, max = 20, message = "{login.loginPassword.length}")
    private String loginPassword;

    public String getLoginName() {
        return loginName;
    }

    public void setLoginName(String loginName) {
        this.loginName = loginName;
    }

    public String getLoginPassword() {
        return loginPassword;
    }

    public void setLoginPassword(String loginPassword) {
        this.loginPassword = loginPassword;
    }

}

在要驗證的欄位上面加入驗證註解，更多參考 validation-apijar包下的 javax.validation.constraints包。

SpringMVC控制器：

@PostMapping(value = "/login")
public String login(@Validated LoginForm form) {
...
}

使用 @Validated註解表示該引數需要驗證。

國際化

message裡面 {}引用的是國際化的資源。

新增國際化資原始檔：

ValidationMessages.propertiesValidationMessageszhCN.properties

需要指定編碼為 ASCII，不然會亂碼。

異常處理

異常全域性處理時進行處理：

@ControllerAdvice
public class ExceptionResolver {

    @ExceptionHandler(Throwable.class)
    @ResponseBody
    Object handleEntityException(HttpServletRequest request, Throwable ex) {
        ...
        if (ex instanceof BindException) {
            BindException c = (BindException) ex;
            List<ObjectError> errors = c.getBindingResult().getAllErrors();
            StringBuilder errorMsg = new StringBuilder();
            errors.forEach(x -> errorMsg.append(x.getDefaultMessage()).append(","));

        }
        ...
    }

}

或者在驗證的類後面加 BindingResult，錯誤資訊都會放在該物件裡面，而不會丟擲異常。如：

@PostMapping(value = "/login")
public String login(@Validated LoginForm form, BindingResult bindingResult) {
...
}