分类：技术

一个REST请求，始于一个RESTful Web Service资源的地址，终于一个可接受的对资源的表述(比如JSON)。

因此，流程分析的关键点有2个：

• 将请求地址对应到资源类的相应方法上，并触发该方法。
• 将返回值转换成请求所需要的表述，并返回给客户端。

我们使用Eclipse的断点调试服务器端(代码对应本例https://github.com/feuyeux/jax-rs2-guide/)，使用cURL脚本作为客户端。

1 cURL测试

curl -H “Accept:application/json” http://localhost:8080/simple-service-webapp-spring-jpa-jquery/webapi/books/book?id=1

该脚本发送了一个REST GET请求，地址是：

http://localhost:8080/simple-service-webapp-spring-jpa-jquery/webapi/books/book?id=1

对应的服务器端方法是：

com.example.resource.BookResource.getBookByQuery(Integer)

要求返回的类型是JSON：

Accept:application/json

2 Jersey2.x流程

2.1 请求地址到REST方法

2.1.1 ServletContainer.service

ServletContainer.service(HttpServletRequest, HttpServletResponse) line: 248

• baseUri http://localhost:8080/simple-service-webapp-spring-jpa-jquery/webapi/
• requestUri http://localhost:8080/simple-service-webapp-spring-jpa-jquery/webapi/books/book?id=1

ServletContainer是HttpServlet的子类，位于Jersey容器包(.m2\repository\org\glassfish\jersey\containers\jersey-container-servlet-core\2.2\jersey-container-servlet-core-2.2.jar)。我们知道，Servlet的service方法是请求的入口，作为子类，HTTP任何方法的请求都要先经过该类的service方法。

断点堆栈中，重要的两个变量是请求地址信息的baseUri和requestUri。

Jersey包依赖关系图

ServletContainer.service(URI, URI, HttpServletRequest, HttpServletResponse) line: 372

• requestContext.header {user-agent=[curl/7.26.0], host=[localhost:8080], accept=[application/json]}

在容器层级，请求上下文变量除了包括请求地址信息外，还包括请求头信息。这里我们关注accept信息。

2.1.2 对应方法

ApplicationHandler.handle(ContainerRequest) line: 982

ServerRuntime.process(ContainerRequest) line: 211 final Runnable task

new Runnable() {
 public void run() {
  final ContainerRequest data = Stages.process(request, requestProcessingRoot, endpointRef);
  final Endpoint endpoint = endpointRef.get();

• endpoint ResourceMethodInvoker (id=2553)
  public com.example.domain.Book com.example.resource.BookResource.getBookByQuery(java.lang.Integer)

从上面的代码片段，可以看到请求被对应到了一个Endpoint对象，该对象是一个资源方法Invoker，从断点堆栈中可以看到，其内容就是我们期待的那个方法，此后的invoke将调用这个对应REST请求的处理方法。

2.1.3 调用方法

ResourceMethodInvoker.invoke(ContainerRequest, Object) line: 353
dispatcher.dispatch(resource, requestContext);

JavaResourceMethodDispatcherProvider$TypeOutInvoker(AbstractJavaResourceMethodDispatcher).invoke(Object, Object…) line: 158
invokeMethodAction.run();

ResourceMethodInvocationHandlerFactory$1.invoke(Object, Method, Object[]) line: 81

从堆栈中可以轻松定位这个方法：**BookResource.getBookByQuery(Integer) line: 71**

到此，请求地址到方法调用的流程就结束了。在处理业务逻辑方法BookResource.getBookByQuery后，Jersey将开始处理响应信息。

2.2 REST方法到表述

JavaResourceMethodDispatcherProvider$TypeOutInvoker.doDispatch(Object, Request) line: 198

• o Book (id=2686)
• Response response = Response.ok().entity(o).build();

REST请求的返回信息应包括表述信息和HTTP响应代码(通常一个成功的请求应该得到200 OK)。这就是上面代码所做的事情。在设置好response的entity后，需要将该entity对象转化成请求所接受的表述，流程如下。

2.2.1 写向response

ServerRuntime$Responder.process(ContainerResponse) line: 351ServerRuntime$Responder.writeResponse(ContainerResponse) line: 486

• entity Book (id=7076)
• executor WriterInterceptorExecutor (id=7125)

从上面的堆栈中可以看到，这个阶段重点的两个对象是返回对象和写处理对象，就是使用后者将前者恰当地写入response中。

2.2.2 JSON表述

REST的表述不局限于JSON，这里我们以JSON作为常用的表述类型为例，来讨论Jersey的表述处理。 Jersey对JSON的支持有4种方式，在第3章会有详细的讲解，本例使用的是EclipseLink项目的MOXy。其底层依赖是JPA的实现之一(另一个著名的JPA实现是JBoss项目下大名鼎鼎的Hibernate)。

    <dependency>
        <groupId>org.glassfish.jersey.media</groupId>
        <artifactId>jersey-media-moxy</artifactId>
        <version>${jersey.version}</version>
    </dependency>

MOXy依赖关系图

在下面的堆栈中，可以看到JAXB的身影，因为MOXy同样实现了JAXB，其内部实现是以XML的Marshal方式处理对象(OXM:Object-XML-Mapping)，然后转化为JSON数据(XML-2-JSON)。

JsonWithPaddingInterceptor.aroundWriteTo(WriterInterceptorContext) line: 91

WriterInterceptorExecutor$TerminalWriterInterceptor.aroundWriteTo(WriterInterceptorContext) line: 188

ConfigurableMoxyJsonProvider(MOXyJsonProvider).**writeTo**(Object, Class<?>, Type, Annotation[], MediaType, MultivaluedMap<string,object style=”margin: 0px; padding: 0px;”>, OutputStream) line: 782

• object Book (id=7076)
• type Class (com.example.domain.Book) (id=568)
• genericType Class (com.example.domain.Book) (id=568)
• annotations Annotation3
• mediaType AcceptableMediaType (id=7120)
• httpHeaders StringKeyIgnoreCaseMultivaluedMap (id=7121)
• entityStream CommittingOutputStream (id=7124)

开始从对象转化为JSON：

JAXBMarshaller.marshal(Object, OutputStream) line: 395

• object Book (id=7076)
• outputStream CommittingOutputStream (id=7124)

XMLMarshaller(XMLMarshaller<abstract_session,context,descriptor,media_type,namespace_prefix_mapper,object_builder style=”margin: 0px; padding: 0px;”>).marshal(Object, OutputStream, ABSTRACT_SESSION, DESCRIPTOR) line: 852

XMLMarshaller(XMLMarshaller<abstract_session,context,descriptor,media_type,namespace_prefix_mapper,object_builder style=”margin: 0px; padding: 0px;”>).marshal(Object, Writer, ABSTRACT_SESSION, DESCRIPTOR) line: 1031

• object Book (id=7305)
• writer OutputStreamWriter (id=7310)
  -> BufferedWriter (id=7333)

XMLMarshaller(XMLMarshaller<abstract_session,context,descriptor,media_type,namespace_prefix_mapper,object_builder style=”margin: 0px; padding: 0px;”>).marshal(Object, MarshalRecord, ABSTRACT_SESSION, DESCRIPTOR, boolean) line: 583

• object Book (id=7305)
• marshalRecord JSONWriterRecord (id=7342)
• session DatabaseSessionImpl (id=7351)
• descriptor XMLDescriptor (id=7353)
• isXMLRoot false

几经辗转，写入对象变成了MarshalRecord。

JSONWriterRecord.startDocument(String, String) line: 171

TreeObjectBuilder.marshalAttributes(MarshalRecord, Object, CoreAbstractSession) line: 122

XPathObjectBuilder.marshalAttributes(MarshalRecord, Object, CoreAbstractSession) line: 552

这里是可以想见的流程…

ServerRuntime$Responder.processResponse(ContainerResponse) line: 362

最后是将response返回并释放。流程到此结束。

转自：http://feuyeux.iteye.com/blog/1938910

Jersey的过滤器分为：

ContainerRequestFilter: 请求阶段的过滤

ContainerResponseFilter: 响应阶段的过滤

一、使用注解名称绑定

1.1 创建绑定的注解

使用@NameBinding注解，可以定义一个运行时的自定义注解，该注解可以用于定义类级别名称和泪的方法。例如，我们定义一个用户访问的注解。

@NameBinding            //标识名称绑定的注解
@Target({ElementType.TYPE, ElementType.METHOD}) //表示该注解可以使用在类和方法上。
@Retention(value = RetentionPolicy.RUNTIME)
public @interface UserLogger {
}

上面代码我们定义了一个名称绑定注解UserLogger。

1.2 注解绑定过滤器

创建了注解之后，我们需要将注解和Jersey中的Provider 组件绑定，示例中我们使用的是过滤器。

@Provider
@UserLogger
@Priority(Priorities.USER)
public class LoggerFilter implements ContainerRequestFilter ,ContainerResponseFilter{
@Override
public void filter(ContainerRequestContext requestContext) throws IOException {
System.out.println("访问请求日志过滤器执行了>>>>>>>>>>>>");
}
@Override
public void filter(ContainerRequestContext requestContext, ContainerResponseContext responseContext) throws IOException {
System.out.println("访问响应日志过滤器执行了>>>>>>>>>>>");
}
}

@Provider 注解Jersey注解，Jersey扫描到该注解，就会创建对应的组件对象。 @UserLogger 就是我们自定义的名称绑定注解 @Priority 是用于表示该过滤器的执行顺序，其中参数为long类型，对于请求过滤器，该数值越小越先执行，响应过滤器则相反。 ContainerRequestFilter 为请求过滤器 ContainerResponseFilter 为响应过滤器 在请求和响应的过滤方法中，我们简单的打印输出。 需要注意的是，我们创建了过滤器之后需要在Jersey中进行声明，我们在Jerysey的ResourceConfig 子类中，注册该过滤器，注册有两种方式，一种是扫描包的形式，这时需要在过滤器上加上@Provider注解，另一种是直接注册该过滤器。

packages("com.xxxx.xxxx.xxxx.filter"); //扫描包的形式 过滤器所在的包

register(LoggerFilter.class); //直接注册过滤器

1.3 注解绑定接口

上面我们创建好注解和过滤器之后，需要将在我们需要使用过滤器的接口方法上使用注解。

@Path("/test")
public class TestResource {
@GET
@Path("/1")
public String test1(){
return "不带过滤器";
}
@GET
@Path("/2")
@UserLogger
public String test2(){
return "带过滤器";
}
}

我们创建了两个接口，一个路径是/test/1 没有使用过滤器，一个路径是/test/2使用注解，按照我们的设计，当访问./test/1时，日志过滤器不起作用，访问/test/2时日志过滤器起作用。

二、动态绑定

上面介绍的名称保定的形式需要通过自定义注解的形式来实现过滤器绑定，而动态绑定则不需要新增注解，而是需要编码的形式，实现动态绑定。动态绑定需要实现动态特征接口javax.ws.rs.container,DynamiFeature，定义扩展点方法，请求方法类型等匹配信息，在运行期，一旦Provider匹配到当前处理类或方法，面向切面的Provider方法就是触发。

2.1 实现动态绑定特征

public class LoggerDynaimcFeature implements DynamicFeature {
@Override
public void configure(ResourceInfo resourceInfo, FeatureContext context) {
String name = resourceInfo.getResourceMethod().getName();
if("test2".equals(name)){
context.register(LoggerFilter.class);
}
}
}

上面的代码实现的是当我们访问的是test2方法时，就会注册LoggerFilter，实现该过滤器的方法。    我们需要在同样我们需要注册该动态特征来    

1. register(LoggerDynaimcFeature .class);

   这时我们重新启动项目时，分别访问test/1和test/2，就会看到只有test2时，日志过滤器才会起作用。    三. 名称绑定和动态绑定对比    动态绑定相比于名称绑定，不需要自定义注解，使用纯编码的形式实现。    名称绑定相比于动态绑定使用范围更广，因为我们使用注解的方式，可以对任意资源，任意方法进行控制。而使用动态绑定的形式，我们需要在动态特征类进行对应的匹配，适用范围较窄。

public class JerseyInterceptor implements InterceptionService {
private static Map<Annotation, MethodInterceptor> map = new HashMap<>();
static{
Annotation[] annotations = LoginTestMethodInterceptor.class.getAnnotations();
for(Annotation annotation : annotations){
map.put(annotation, new LoginTestMethodInterceptor());
}
}
@Override
public Filter getDescriptorFilter() {
return new Filter() {
public boolean matches(Descriptor descriptor) {
return true;
}
};
}
@Override
public List<MethodInterceptor> getMethodInterceptors(Method method) {
Annotation[] annotations = method.getAnnotations();
List<MethodInterceptor> list = new ArrayList<>();
for (Annotation annotation :annotations){
if(map.get(annotation) != null){
list.add(map.get(annotation));
}
}
return list;
}
@Override
public List<ConstructorInterceptor> getConstructorInterceptors(Constructor<?> constructor) {
return null;
}
}

public class JerseyBinding extends AbstractBinder {
@Override
protected void configure() {
this.bind(JerseyInterceptor.class).to(InterceptionService.class).in(Singleton.class);
}
}

为了使绑定生效，我们需要定义特征类，用于注册该绑定