深入解析JAX-RS过滤器执行顺序与@Priority注解

在开发基于JAX-RS的应用程序时，我们经常会用到过滤器（Filter）来处理请求和响应。当一个应用中存在多个过滤器时，它们的执行顺序就显得尤为重要。为了精确控制过滤器的执行顺序，JavaEE 提供了@Priority注解。通过合理使用@Priority注解，我们可以轻松地对过滤器进行排序，从而确保它们按照预期的顺序执行。
@Priority注解的使用
@Priority注解接受一个整数参数，用于指定过滤器的优先级。优先级的排序规则是升序，即数值越小，优先级越高。这意味着优先级值较低的过滤器会先执行。
示例：使用@Priority注解的过滤器

1. 时间过滤器（TimeFilter）
   我们首先定义一个时间过滤器，用于记录资源方法的执行时间。
   java复制
   @Priority(1) // 设置优先级为1
   @Provider
   public class TimeFilter implements ContainerRequestFilter, ContainerResponseFilter {
   @Override
   public void filter(ContainerRequestContext reqContext) throws IOException {
   System.out.println(“-- TimeFilter request --”);
   reqContext.setProperty(“start-time”, System.currentTimeMillis());
   }

   @Override
   public void filter(ContainerRequestContext reqContext, ContainerResponseContext resContext) throws IOException {
   System.out.println(“-- TimeFilter response --”);
   long startTime = (long) reqContext.getProperty(“start-time”);
   System.out.printf(“Time taken for request %s: %s milli secs%n”,
   reqContext.getUriInfo().getPath(), System.currentTimeMillis() - startTime);
   }
   }

2. 日志过滤器（LogFilter）
   接下来定义一个日志过滤器，用于记录请求和响应的头部信息。
   java复制
   @Priority(2) // 设置优先级为2
   @Provider
   public class LogFilter implements ContainerRequestFilter, ContainerResponseFilter {
   @Override
   public void filter(ContainerRequestContext reqContext) throws IOException {
   System.out.println(“-- req headers --”);
   log(reqContext.getUriInfo(), reqContext.getHeaders());
   }

   @Override
   public void filter(ContainerRequestContext reqContext, ContainerResponseContext resContext) throws IOException {
   System.out.println(“-- res headers --”);
   log(reqContext.getUriInfo(), resContext.getHeaders());
   }

   private void log(UriInfo uriInfo, MultivaluedMap headers) {
   System.out.println("Path: " + uriInfo.getPath());
   headers.entrySet().forEach(h -> System.out.println(h.getKey() + ": " + h.getValue()));
   }
   }

3. JAX-RS资源
   定义一个简单的JAX-RS资源，用于测试过滤器的效果。
   java复制
   @Path(“/”)
   public class MyResource {
   @GET
   @Path("{path:.}")
   public String getResponse(@PathParam(“path”) String path) {
   System.out.printf(“creating response for ‘%s’%n”, path);
   return "dummy-response for " + path;
   }
   }
   测试与输出
   为了测试上述过滤器的效果，我们可以使用嵌入式的Tomcat服务器运行项目。在pom.xml中配置好Tomcat插件后，运行以下命令启动服务器：
   bash复制
   mvn tomcat7:run-war
   使用HTTP客户端工具（如HTTPie）访问资源，观察服务器控制台的输出：
   plaintext复制
   – TimeFilter request –
   – req headers –
   Path: customers
   host: [localhost:8080]
   connection: [keep-alive]
   accept-encoding: [gzip, deflate]
   accept: [/*]
   user-agent: [HTTPie/0.9.9]
   creating response for ‘customers’
   – res headers –
   Path: customers
   Content-Type: [text/plain]
   – TimeFilter response –
   Time taken for request customers: 13 milli secs
   从输出中可以看到，TimeFilter（优先级为1）在LogFilter（优先级为2）之前执行。如果我们将两个过滤器的优先级值互换，它们的执行顺序也会相应地改变。
   总结
   @Priority注解为我们提供了一种简单而强大的方式来控制JAX-RS过滤器的执行顺序。通过合理设置优先级，我们可以确保过滤器按照预期的顺序执行，从而更好地管理请求和响应的处理流程。在实际开发中，合理利用@Priority注解可以极大地提高代码的可维护性和可扩展性。