以CXF为实现限制查询参数JAX-RS的值

Question

我有一个用例，我需要限制可以作为查询参数传递的值。

@Path("/foo")
public interface Foo {

    @GET
    @Path("/details/id/{id}")
    void getFooDetails(@PathParam("id") String id, @QueryParam("sort") String sortDirection);
}

public class FooImpl {
    public void getFooDetails(String id, String sortDir) {
        //Implementation
    }
}

在上面的例子中，我想限制可以通过API传递给ASC， DESC的查询参数的值。

是否有任何现有的CXF注释，我可以用来限制参数上的值？我没有找到任何，所以我尝试了以下解决方案。

我的方法：

@Target({ElementType.PARAMETER, ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface ValueSet {

    String[] allowedValues();
}

修改后的界面如下所示。

@Path("/foo")
public interface Foo {

    @GET
    @PathParam("/details/id/{id}")
    void getFooDetails(@PathParam("id") String id, @QueryParam("sort") @ValueSet(allowedValues = {"ASC", "DESC"}) String sortDirection);
}

我写了一个CXF拦截器来拦截应用编程接口的调用。我使用反射来获取efimpl.get的Foo细节params的句柄。但是我面临的问题是拦截器查看了Fooimpl.get的Foo细节方法，并且没有在方法params上找到注释@QueryParam，因为@QueryParam在基本方法上，并且注释没有被继承。

拦截器实现：

@Provider
public class ParamValidationInterceptor extends AbstractPhaseInterceptor<Message> {

    public ParamValidationInterceptor() {
        super(Phase.PRE_INVOKE);
        super.addBefore(someInterceptor);
    }

    @Override
    public void handleMessage(Message message) throws Fault {

        UriInfo uriInfo = new UriInfoImpl(message);
        MultivaluedMap<String, String> queryParams = uriInfo.getQueryParameters();
        Method methodToInvoke = (Method) message.get("org.apache.cxf.resource.method");
        Parameter[] parameters = methodToInvoke.getParameters();
        for (Parameter parameter : parameters) {

            if (parameter.isAnnotationPresent(ValueSet.class)) {
                ValueSet valueSet = parameter.getAnnotation(ValueSet.class);
                QueryParam queryParam = parameter.getAnnotation(QueryParam.class);
                Object invokedVal = queryParams.get(queryParam.value());

                String[] allowedValues = valueSet.allowedValues();

                if (!Arrays.asList(allowedValues).contains(invokedVal)) {
                    throw new CustomException();
                }
            }
        }

    }
}

有人能提出前进的道路吗？如果有人能提出替代方法，那就太好了。

另外：我将CXF用作JAX-RS的实现，spring用作容器。

更新：

就像@Cássio Mazzochi Molin和@Andy McCright建议的那样，我将使用@Pattern注释。但是我很想知道为什么JAX-RS注释没有从接口中继承，尽管规范说它们将被继承。

Answer 1

也许这只是一个输入错误，但CXF可能无法识别getFooDetails方法（在接口上），因为它是用@PathParam而不是@Path注释的。

我没有使用您的ValueSet方法，而是使用了BeanValidation，但下面的代码对我适用。

Foo.java

@Path("/foo")
public interface Foo {

    @GET
    @Path("/details/id/{id}")
    Response getFooDetails(
            @PathParam("id") @Pattern(regexp="[0-9]*") String id,
            @QueryParam("sort") @Pattern(regexp = "ASC|DESC") String sortDirection);
}

傻瓜mpl.java

public class FooImpl implements Foo {

    @Override
    public Response getFooDetails(String id, String sortDirection) {
        Integer idInt = Integer.parseInt(id);
        if ("ASC".equals(sortDirection) || sortDirection == null) {
            ...
        } else if ("DESC".equals(sortDirection)) {
            ...
        }
        return ...;
    }

我已经在基于CXF 3.1.11的WebSphere Liberty 17.0.0.2上完成了这项工作。

希望这有帮助安迪

Answer 2

根据JAX-RS规范的§3.6注释继承部分，建议总是重复注释，而不是依赖注释继承。

完整的报价请参考这个答案。

请记住，@QueryParam注释可以应用于：

• 资源方法参数

因此，手动验证可能很棘手。

出于验证目的，您应该考虑Bean验证。考虑一个带有允许值的@Pattern注释：

@Pattern(regexp = "ASC|DESC")

只需注释资源方法参数：

@GET
@Path("foo")
public Response getFoos(@QueryParam("sort") 
                        @Pattern(regexp = "ASC|DESC") String sortDirection) {
    ...
}

如果您更喜欢不区分大小写的值，请使用：

@Pattern(regexp = "ASC|DESC", flags = Pattern.Flag.CASE_INSENSITIVE)

如果给定值无效，将抛出ConstraintViolationExctive。要处理此类异常并返回自定义响应，可以使用ExceptionMapper：

@Provider 
public class ConstraintViolationExceptionMapper 
        implements ExceptionMapper<ConstraintViolationException> {

    @Override
    public Response toResponse(ConstraintViolationException exception) {
        ...
    } 
}