java - 使用 RESTful API 进行自定义验证

Question

我是 Java 世界的新手(来自 .Net 背景)。我使用 Jersey 框架创建了一个 RESTful 服务。它有几种方法。以下是客户服务的示例代码片段。我的代码中还有更多服务。

@Path("/CustomerService")
public interface ICustomerService {

    @POST
    @Produces(MediaType.APPLICATION_JSON)
    @Consumes(MediaType.APPLICATION_JSON)
    @Path("/getCustomerInfo")
    Response query(String constraints);

    @POST
    @Produces(MediaType.APPLICATION_JSON)
    @Consumes(MediaType.APPLICATION_JSON)
    @Path("/getCustomerDetails")
    Response fetchDetails(String customerID);

}

我有一些验证逻辑，我想在向客户端公开的每个 API 上执行这些逻辑。在 C# 世界中，我们可以定义自己的验证逻辑。类似以下内容，这可以应用于方法或 Controller 级别。

[MyValdationLogic()]

Java 中的等价物是什么？我如何编写可以在方法的多个位置应用的代码。

此外，我不想让管理员使用该配置。我发现有一个叫做过滤器的东西，但它是在配置文件中配置的。管理员可以禁用它。

Answer 1

您可以创建一个Validator 类 并在您的bean 上使用该Validator 类 进行验证。虽然，这个过程有点冗长。

下面是一个这样做的例子-

泽西资源

@POST
@Path("/addEmp")
@Produces("text/plain")
public String doOrder(@BeanParam final @Valid Employee emp) {

    // Some implementation here
}

示例 Bean - 假设，我想对地址应用验证，即地址或城市或邮政编码必须在那里。

@Address
public final class Employee {

    @FormDataParam("id")
    private String id;

    @FormDataParam("address")
    private String address;

    @FormDataParam("city")
    private String city;

    @FormDataParam("postcode")
    private String postcode;

        // Other member variables

        // Getters and setters

}

地址注释 - 定义自定义地址注释

@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE})
@Retention(RUNTIME)
@Constraint(validatedBy = AddressValidator.class)
@Documented
public @interface Address {

    String message() default "Address required";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};
}

validator 类 - 这是包含实际验证逻辑的 validator 类 -

public class AddressValidator implements ConstraintValidator<Address, Employee> {

    @Override
    public boolean isValid(Employee emp, ConstraintValidatorContext constraintValidatorContext) {

    // Check for at least one value
    if((emp.getAddress() != null && !emp.getAddress().equals("") ||
            (emp.getCity() != null && !emp.getCity().equals("")) ||
            (emp.getPostcode() != null && !emp.getPostcode().equals("")))) {
        return true;
    }

    return false;
    }
    public void initialize(Address emp) {
          ...
    }
}

通过这种方式，您可以创建可重用的 validator 类。您可以采用 Object 类 或某个父类，然后相应地更改逻辑，而不是直接在此 Validator 类 中采用 Employee。

您可以在bean-validation中查看更多详细信息