从接口设置Jersey响应状态代码而不返回响应

Question

@Path("/roles")
public interface IRoleService {

    @POST
    @Consumes(MediaType.APPLICATION_JSON)
    @Produces(MediaType.APPLICATION_JSON)
    Role create(Role role);

}

因为它创建了一个新的资源，所以如果它返回状态代码201是合适的，但目前它返回200。

我发现如何设置状态代码的唯一方法是让方法返回一个javax.ws.rs.core.Response并在那里设置它，但我确实不希望我的所有接口返回一个泛型响应，而不是实际的响应对象（在本例中是role)。

Answer 1

一种方法是创建一个自定义注释，并使用响应过滤器来设置状态。例如

注释

@NameBinding
@Target({METHOD, TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Status {
    int DEFAULT_CODE = 0;

    int code() default DEFAULT_CODE;
}

ContainerResponseFilter

@Status
@Provider
public class StatusFilter implements ContainerResponseFilter {

    @Context
    private ResourceInfo info;

    @Override
    public void filter(ContainerRequestContext req, ContainerResponseContext res) throws IOException {
        Status status = getInterfaceAnnotation(info.getResourceMethod());
        if (status != null) {
            int code = status.code();
            if (code != Status.DEFAULT_CODE && res.getStatus() == 200) {
                res.setStatus(code);
            }
        }
    }

    private static Status getInterfaceAnnotation(Method resourceMethod) {
        String methodName = resourceMethod.getName();
        Class<?>[] paramTypes = resourceMethod.getParameterTypes();
        Class<?> iface = resourceMethod.getDeclaringClass().getInterfaces()[0];
        Method ifaceMethod;
        try {
            ifaceMethod = iface.getDeclaredMethod(methodName, paramTypes);
        } catch (NoSuchMethodException e) {
            return null;
        }
        return ifaceMethod.getAnnotation(Status.class);
    }
}

在过滤器中，我们使用ResourceInfo获得方法，并执行一些反射以获得@status注释。从那里，可以获取状态代码并将其设置在响应上。

由于它是一个名称绑定筛选器，因此只对用它注释的方法调用它。在这里看到更多。

然后要使用它，只需将注释添加到方法中。

public interface ITestResource {
    @GET
    @Status(code=201)
    String get();
}