SpringMVC 整合 Bean Validation 1.1 (Hibernate Validator) 完整指南

SpringMVC 整合 Bean Validation 1.1 (Hibernate Validator) 完整指南

Bean Validation (JSR-349) 為 Java 提供標準化參數校驗能力。本文詳細講解 SpringMVC 整合 Hibernate Validator 5.x 全流程：依賴、配置、實體校驗註解、分組校驗、EL 表達式、方法級校驗、自定義校驗器、類級校驗、腳本校驗、跨參數校驗、組合註解、國際化等進階特性。

1. 依賴與配置

<dependency><groupId>org.hibernate</groupId><artifactId>hibernate-validator</artifactId><version>5.2.4.Final</version></dependency>
<dependency><groupId>javax.el</groupId><artifactId>javax.el-api</artifactId><version>2.2.4</version><scope>provided</scope></dependency>
<!-- slf4j-api 等 -->

Spring MVC 配置

<mvc:annotation-driven validator="validator"/>
<bean id="validator" class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean">
    <property name="validationMessageSource" ref="messageSource"/>
</bean>
<bean id="messageSource" class="org.springframework.context.support.ReloadableResourceBundleMessageSource">
    <property name="basenames">
        <list><value>classpath:messages</value><value>classpath:org/hibernate/validator/ValidationMessages</value></list>
    </property>
</bean>

2. 實體校驗註解

public class User implements Serializable {
    @NotNull(message = "{user.id.null}", groups = First.class)
    private Long id;

    @NotEmpty(message = "{user.name.null}")
    @Length(min = 5, max = 20, message = "{user.name.length.illegal}", groups = Second.class)
    @Pattern(regexp = "[a-zA-Z]{5,20}", message = "{user.name.illegal}", groups = Second.class)
    private String name;

    @NotNull(message = "{user.password.null}", groups = {First.class, Second.class})
    private String password;
}

messages.properties

user.id.null=用戶編號不能為空
user.name.null=用戶名不能為空
user.name.length.illegal=用戶名長度必須在{min}到{max}之間
user.name.illegal=用戶名必須是字母
user.password.null=密碼不能為空

3. Controller 校驗

@Controller
public class UserController {
    @RequestMapping("/save")
    public String save(@Validated({Second.class}) User user, BindingResult result) {
        if (result.hasErrors()) return "error";
        return "success";
    }
}

4. 進階特性速覽

提示： Spring Boot 2.x 僅需引入 spring-boot-starter-validation 即可自動配置，無需 XML。