65.2. 使用 Bean Validation 开发服务

使用 bean 验证开发服务的第一步是将相关的验证注解应用到代表您的服务的 Java 类或接口。通过验证注释，您可以在每次调用服务时对方法参数、返回值和类字段应用约束，然后每次调用该服务时都会检查它们。

要验证服务方法的参数（其中参数是简单的 Java 类型），您可以应用来自 bean 验证 API (javax.validation.constraints 软件包)的任何约束注解。例如，以下代码示例测试两个参数是否表示 nullness (@NotNull 注释)，ID 字符串是否与 \\d+ 正则表达式(@Pattern 注释)匹配，以及 名称 字符串在范围 1 到 50 范围中的长度：

import javax.validation.constraints.NotNull;
import javax.validation.constraints.Pattern;
import javax.validation.constraints.Size;
...
@POST
@Path("/books")
public Response addBook(
        @NotNull @Pattern(regexp = "\\d+") @FormParam("id") String id,
        @NotNull @Size(min = 1, max = 50) @FormParam("name") String name) {
    // do some work
    return Response.created().build();
}

要验证复杂的输入参数（对象实例），将 @Valid 注释应用到 参数，如下例所示：

import javax.validation.Valid;
...
@POST
@Path("/books")
public Response addBook( @Valid Book book ) {
    // do some work
    return Response.created().build();
}

@Valid 注释本身不指定任何限制。使用 @Valid 标注 Book 参数时，您将有效地告知验证引擎在 Book 类的定义内查看（递归）查找验证限制。在本例中，Book 类使用 ID 和名称字段的验证限制定义，如下所示：

import javax.validation.constraints.NotNull;
import javax.validation.constraints.Pattern;
import javax.validation.constraints.Size;
...
public class Book {
    @NotNull @Pattern(regexp = "\\d+") private String id;
    @NotNull @Size(min = 1, max = 50) private String name;

    // ...
}

要将验证应用到常规方法返回值（非空间），请在方法签名前添加注解。例如，要测试 nullness (@NotNull 注释)的返回值，并以递归方式测试验证约束(@Valid 注释)，注解 getBook 方法，如下所示：

import javax.validation.constraints.NotNull;
import javax.validation.Valid;
...
@GET
@Path("/books/{bookId}")
@Override
@NotNull @Valid
public Book getBook(@PathParam("bookId") String id) {
    return new Book( id );
}

要将验证应用到返回 javax.ws.rs.core.Response 对象的方法，您可以在非空间中使用相同的注解。例如：

import javax.validation.constraints.NotNull;
import javax.validation.Valid;
import javax.ws.rs.core.Response;
...
@GET
@Path("/books/{bookId}")
@Valid @NotNull
public Response getBookResponse(@PathParam("bookId") String id) {
    return Response.ok( new Book( id ) ).build();
}

表 65.1 “Bean 验证的标准注解” 显示 Bean Validation 规范中定义的标准注解，这些注解可用于定义字段和方法的返回值和参数（不在类级别上应用标准注解）。

可以使用 bean 验证 API 定义您自己的自定义约束注解。有关如何在 Hibernate 验证器实现中执行此操作的详情，请查看 Hibernate 验证参考指南 中的 创建自定义约束 章节。