在Jersey中使用名称绑定注释

Question

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

请考虑以下注释：

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

它是如何工作的？

Answer 1

名称绑定

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

定义名称绑定注释

可以使用@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!"的简短响应"Hello World!" 。

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

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

文档

• @NameBinding注释文档
• 关于过滤器和拦截器的Jersey文档

例子

• 使用过滤器和名称绑定注释记录HTTP请求和响应
• 使用过滤器和名称绑定注释的基于令牌的身份验证
• 使用拦截器和名称绑定注释向Jackson添加属性到JSON
• 具有名称绑定的过滤器用于安全目