使用RESTful API进行自定义验证

时间:2017-04-08 09:53:35

标签: java rest validation jersey

我是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#world中我们可以定义自己的验证逻辑。类似于以下内容,这可以在方法或控制器级别应用。

[MyValdationLogic()]

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

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

1 个答案:

答案 0 :(得分:3)

您可以创建Validator class并使用Validator class上的bean进行验证。虽然,这个过程有点冗长。

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

泽西岛资源

@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 {};
}

验证员类 - 这是验证器类包含实际验证逻辑 -

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 class。您可以使用Validator class或某个父类,而不是直接在此Object class中使用Employee,然后相应地更改逻辑。

您可以在bean-validation

中查看更多详情