在 Jersey 中使用名称绑定注解答案

【问题标题】：Using name binding annotations in Jersey在 Jersey 中使用名称绑定注解
【发布时间】：2016-11-26 00:41:41
【问题描述】：

@NameBinding 注释在 Jersey 中如何工作以对特定资源方法或资源类应用过滤器？

考虑以下注释：

@NameBinding
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.TYPE})
public @interface SomeAnnotaion{}

它是如何工作的？

【问题讨论】：

您是在问它在后台是如何工作的？或者只是如何使用它？

标签： java rest jersey

【解决方案1】：

名称绑定

名称绑定 是一个概念，它允许对 JAX-RS 运行时说特定过滤器或拦截器将仅针对特定资源方法执行。当过滤器或拦截器仅限于特定的资源方法时，我们说它是 name-bound。没有这种限制的过滤器和拦截器称为全局。

定义名称绑定注解

可以使用@NameBinding 注解将过滤器或拦截器分配给资源方法。此注释用作其他用户实现的注释的元注释，这些注释应用于提供程序和资源方法。请参见以下示例：

@NameBinding
@Retention(RetentionPolicy.RUNTIME)
public @interface Compress {}

上面的例子定义了一个新的@Compress注解，它是一个名称绑定注解，因为它是用@NameBinding注解的。 @Compress 注解可用于将过滤器和拦截器绑定到端点。

将过滤器或拦截器绑定到端点

假设您有一个执行 GZIP 压缩的拦截器，并且您希望将此类拦截器绑定到资源方法。为此，请注释资源方法和拦截器，如下所示：

@Compress
public class GZIPWriterInterceptor implements WriterInterceptor {

    @Override
    public void aroundWriteTo(WriterInterceptorContext context)
                    throws IOException, WebApplicationException {
        final OutputStream outputStream = context.getOutputStream();
        context.setOutputStream(new GZIPOutputStream(outputStream));
        context.proceed();
    }
}

@Path("helloworld")
public class HelloWorldResource {

    @GET
    @Produces("text/plain")
    public String getHello() {
        return "Hello World!";
    }

    @GET
    @Path("too-much-data")
    @Compress
    public String getVeryLongString() {
        String str = ... // very long string
        return str;
    }
}

@Compress 应用于资源方法getVeryLongString() 和拦截器GZIPWriterInterceptor。仅当执行带有此类注释的任何资源方法时，才会执行拦截器。

在上面的例子中，拦截器只会为getVeryLongString() 方法执行。方法getHello() 不会执行拦截器。在这个例子中，原因可能很清楚。我们只想压缩长数据，不需要压缩"Hello World!"的短响应。

名称绑定可以应用于资源类。在示例中，HelloWorldResource 将使用@Compress 进行注释。这意味着在这种情况下所有资源方法都将使用压缩。

请注意，全局过滤器始终会执行，即使对于具有任何名称绑定注释的资源方法也是如此。

文档

示例

【讨论】：

我们可以添加Compress("ABC") 并在ContainerRequestFilter 中获取这个“ABC”吗？