在泽西岛使用名称绑定注释

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注释可用于将筛选器和拦截器绑定到endpoint。

假设您有一个执行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进行注释。这将意味着在这种情况下所有资源方法都将使用压缩。

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

• @namebinding注释文档
• 关于筛选器和拦截器的泽西岛文档

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