JAX-RS 2.0：服务器端处理管道

这篇文章的灵感来自JAX-RS 2.0规范文档（附录C）中的Processing Pipeline部分。我喜欢它是因为它提供了JAX-RS中所有模块的漂亮快照-以准备好吞咽的胶囊形式！

礼貌– JAX-RS 2.0规范文档

因此，我想到了使用此图简要概述不同的JAX-RS组件以及它们如何相互配合。

涵盖了什么？

过滤器（请求和响应）
方法匹配
注射
拦截器（请求和响应）
实体提供者（请求和响应）

注意：这里讨论的是服务器端处理管道，即在客户端发送HTTP请求（GET，POST，PUT等）后触发的动作序列

当客户端（浏览器或自定义REST客户端）向您的RESTful服务发送HTTP请求时，一切就开始了！

请求过滤器（链）

客户端请求由JAX-RS过滤器处理。它们适用于服务器端和客户端（我们将研究服务器端过滤器-基于请求和响应）

过滤器是可选组件，您可以通过简单地实现ContainerRequestFilter接口来编写过滤器。需要使用@Provider批注对它们进行批注，以通过JAX-RS运行时自动检测

可以更改ContainerRequestContext的实例并更改标头，Cookie，URI等属性。过滤器不允许您访问HTTP请求正文/消息有效负载（ 拦截器可以执行此操作）
可用于实现日志记录，身份验证等
如果需要在资源方法匹配之前执行过滤器实现类，请在实现类上使用@PreMatching批注。
筛选器可以绑定到所有JAX-RS方法（全局），也可以使用@NamedBinding批注或DynamicFeature接口的实现有选择地绑定
@Priority批注可用于确定多个过滤器（顺序链）的执行顺序。

方法匹配

在（成功）执行过滤器之后，JAX-RS运行时将启动资源方法匹配过程

要调用的确切方法基于规范概述的算法（尽管JAX-RS提供程序不受其约束）
由以下提到的注释的组合确定
@ GET，@ PUT，@ POST，@ DELETE等–这些注释应与实际的HTTP操作匹配（注释到HTTP动词的映射非常明显）
@Path –其值（相对于上下文根）用于映射请求URI，例如/ tweeters / all
@Consumes –其值应与HTTP请求中发送的Content-Type标头值匹配
@Produces –其值应与HTTP请求中发送的Accept标头值匹配

HTTP组件注入

方法匹配完成后，所需的HTTP组件将在JAX-RS运行时注入到JAX-RS资源类中（如果已配置）。我们需要做的就是使用适当的注释

HTTP URI参数

@QueryParam –从URI查询参数中提取值并将其注入，例如， http ： //tweeter.com/info？tweeter = abhi_tweeter上的GET请求
@PathParam –从URI模板参数中提取值并将其注入，例如在http://tweeter.com/info/tweeter/abhi_tweeter上的GET请求
@MatrixParam –从URI矩阵参数中提取值并将其注入

其他HTTP组件

JAX-RS使访问（注入）HTTP请求组件（例如标头，cookie甚至HTTP表单数据）变得容易

@HeaderParam –提取请求的标头。您还可以使用@Context批注注入HttpHeaders实例
@CookieParam –用于从HTTP请求注入HTTP cookie

@FormParam –可以帮助使用HTTP POST请求从通过HTML表单发送的属性中插入值

@BeanParam –可以帮助在自定义域类的实例变量上使用上述所有与注入相关的注释，而不是使用这些注释将值注入各个方法参数

请求拦截器（链）

拦截器适用于服务器端和客户端（我们将仅查看服务器端拦截器-基于请求和响应）

拦截器有助于在处理HTTP请求有效负载之前对其进行突变
仅当在JAX-RS运行时中注册了MessageBodyReader （请参见下一主题）实现时，才调用请求拦截器。
用于传入服务器请求的拦截器由ReaderInterceptor接口的实现处理，并且需要使用@Provider注释进行注释，以由JAX-RS运行时自动检测

ReaderInterceptorContext实例在JAX-RS运行时传递，并且可以使用java.io.InputStream形式访问HTTP正文。
拦截器可以（全局）绑定到所有JAX-RS方法，也可以通过使用@NamedBinding批注或DynamicFeature接口的实现有选择地绑定
拦截器可以被链接和（使用@priority）和优先呼叫的继续进行的ReaderInterceptorContext的方法自动调用链中的或化MessageBodyReader实现本身下一个拦截
ReaderInterceptor充当MessageBodyReader的包装器（在内部调用）

实体提供者（

实体提供者帮助将HTTP消息有效负载转换为适当的Java类型（用于注入到JAX-RS资源类的方法参数中），反之亦然

HTTP请求有效负载到其对应的Java类型的转换是通过实现MessageBodyReader接口的具体类完成的
MessageBodyReader实现的readFrom方法是执行操作的地方。 JAX-RS运行时会传入所有上下文信息，包括有效载荷本身（以InputStream的形式），然后可以对其进行自省并将其转换为适当的Java类型。

JAX-RS规范要求，对于某些Java类型（例如String，InputStream，File等），实现应包含MessageBodyReader接口的现成实现。

响应过滤器（链）

响应过滤器类似于前面讨论的以请求为中心的过滤器。

响应过滤器是可选组件，您可以通过简单地实现ContainerResponseFilter接口来编写一个。
这些类型的过滤器用于修改响应标头，添加cookie等。可以更改ContainerResponseContext的实例并更改属性以实现此目的。过滤器不允许您访问HTTP响应正文/消息有效负载（ 拦截器可以执行此操作）
需要使用@Provider批注对它们进行批注，以通过JAX-RS运行时自动检测

筛选器可以绑定到所有JAX-RS方法（全局），也可以使用@NamedBinding批注或DynamicFeature接口的实现有选择地绑定
@Priority批注可用于确定多个过滤器（顺序链）的执行顺序。

响应拦截器（链）

仅当注册MessageBodyWriter （请参阅下一主题）以处理传出的HTTP有效负载时，才调用它们。
传出服务器响应的拦截器由类WriterInterceptor的实现处理，并且需要使用@Provider注释进行注释，以由JAX-RS运行时自动检测

可以将拦截器进行链接和确定优先级（使用@Priority），并调用WriterInterceptorContext的proce方法会自动调用链中的下一个拦截器或MessageBodyWriter实现本身
WriterInterceptor充当MessageBodyWriter的包装器（在内部调用）

实体提供者（

应用程序代码返回的Java对象到HTTP响应有效负载的转换是通过实现MessageBodyWriter接口的具体类完成的
MessageBodyWriter实现的writeTo方法是执行操作的地方。 JAX-RS运行时将所有上下文信息与OutputStream一起传递给OutputStream ，从Java类型转换后，响应流可以写入到OutputStream中

JAX-RS规范要求，对于某些Java类型（例如String，InputStream，File等），实现应包含MessageBodyWriter接口的现成实现。

好吧！这是对服务器端请求处理如何在JAX-RS中工作以及哪些组件起作用的简要概述。谢谢阅读。干杯！

参考文献

JAX-RS规格文件
Java EE 7 API Java文档

翻译自: https://www.javacodegeeks.com/2015/01/jax-rs-2-0-server-side-processing-pipeline.html