参数验证

1.场景

　　参数验证功能 ¹ 是基于 JSR303 实现的，用户只需标识 JSR303 标准的验证 annotation，并通过声明 filter 来实现验证 ²。

 

2.maven以依赖

<dependency>
    <groupId>javax.validation</groupId>
    <artifactId>validation-api</artifactId>
    <version>1.0.0.GA</version>
</dependency>
<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>4.2.0.Final</version>
</dependency>

 

二：示例

1.参数标注示例

 1 import java.io.Serializable;
 2 import java.util.Date;
 3 
 4 import javax.validation.constraints.Future;
 5 import javax.validation.constraints.Max;
 6 import javax.validation.constraints.Min;
 7 import javax.validation.constraints.NotNull;
 8 import javax.validation.constraints.Past;
 9 import javax.validation.constraints.Pattern;
10 import javax.validation.constraints.Size;
11 
12 public class ValidationParameter implements Serializable {
13     private static final long serialVersionUID = 7158911668568000392L;
14 
15     @NotNull // 不允许为空
16     @Size(min = 1, max = 20) // 长度或大小范围
17     private String name;
18 
19     @NotNull(groups = ValidationService.Save.class) // 保存时不允许为空，更新时允许为空 ，表示不更新该字段
20     @Pattern(regexp = "^\\s*\\w+(?:\\.{0,1}[\\w-]+)*@[a-zA-Z0-9]+(?:[-.][a-zA-Z0-9]+)*\\.[a-zA-Z]+\\s*$")
21     private String email;
22 
23     @Min(18) // 最小值
24     @Max(100) // 最大值
25     private int age;
26 
27     @Past // 必须为一个过去的时间
28     private Date loginDate;
29 
30     @Future // 必须为一个未来的时间
31     private Date expiryDate;
32 
33     public String getName() {
34         return name;
35     }
36 
37     public void setName(String name) {
38         this.name = name;
39     }
40 
41     public String getEmail() {
42         return email;
43     }
44 
45     public void setEmail(String email) {
46         this.email = email;
47     }
48 
49     public int getAge() {
50         return age;
51     }
52 
53     public void setAge(int age) {
54         this.age = age;
55     }
56 
57     public Date getLoginDate() {
58         return loginDate;
59     }
60 
61     public void setLoginDate(Date loginDate) {
62         this.loginDate = loginDate;
63     }
64 
65     public Date getExpiryDate() {
66         return expiryDate;
67     }
68 
69     public void setExpiryDate(Date expiryDate) {
70         this.expiryDate = expiryDate;
71     }
72 }

 

2.分组验证示例

1 public interface ValidationService { // 缺省可按服务接口区分验证场景，如：@NotNull(groups = ValidationService.class)   
2     @interface Save{} // 与方法同名接口，首字母大写，用于区分验证场景，如：@NotNull(groups = ValidationService.Save.class)，可选
3     void save(ValidationParameter parameter);
4     void update(ValidationParameter parameter);
5 }

 

3.关联验证示例

import javax.validation.GroupSequence;

public interface ValidationService {   
    @GroupSequence(Update.class) // 同时验证Update组规则
    @interface Save{}
    void save(ValidationParameter parameter);

    @interface Update{} 
    void update(ValidationParameter parameter);
}

 

4.参数验证示例

import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;

public interface ValidationService {
    void save(@NotNull ValidationParameter parameter); // 验证参数不为空
    void delete(@Min(1) int id); // 直接对基本类型参数验证
}

 

三：配置

1.在客户端验证参数

<dubbo:reference id="validationService" interface="com.alibaba.dubbo.examples.validation.api.ValidationService" validation="true" />

 

2.在服务端验证参数

<dubbo:service interface="com.alibaba.dubbo.examples.validation.api.ValidationService" ref="validationService" validation="true" />

 

3.验证异常信息

import javax.validation.ConstraintViolationException;
import javax.validation.ConstraintViolationException;

import org.springframework.context.support.ClassPathXmlApplicationContext;

import com.alibaba.dubbo.examples.validation.api.ValidationParameter;
import com.alibaba.dubbo.examples.validation.api.ValidationService;
import com.alibaba.dubbo.rpc.RpcException;

public class ValidationConsumer {   
    public static void main(String[] args) throws Exception {
        String config = ValidationConsumer.class.getPackage().getName().replace('.', '/') + "/validation-consumer.xml";
        ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext(config);
        context.start();
        ValidationService validationService = (ValidationService)context.getBean("validationService");
        // Error
        try {
            parameter = new ValidationParameter();
            validationService.save(parameter);
            System.out.println("Validation ERROR");
        } catch (RpcException e) { // 抛出的是RpcException
            ConstraintViolationException ve = (ConstraintViolationException) e.getCause(); // 里面嵌了一个ConstraintViolationException
            Set<ConstraintViolation<?>> violations = ve.getConstraintViolations(); // 可以拿到一个验证错误详细信息的集合
            System.out.println(violations);
        }
    } 
}