RestEasy 框架了解



1,背景知识;

1.1)了解Rest是什么?

1.2)了解JAX-RS是什么?

1.3)RestEasy简介

2,手把手教你使用Resteasy;

3,揭秘Resteasy的实现原理;

4,总结;


一、Rest简介及Resteasy产生背景


1.1)了解Rest是什么:


REST是英文RepresentationalState Transfer 的缩写,有中文翻译为“具象状态传输”。REST 这个术语是由 RoyFielding 在他的博士论文《Architectural Styles and the Design ofNetwork-based Software Architectures 》中提出的。REST并非标准,而是一种开发 Web 应用的架构风格,可以将其理解为一种设计模式。REST 基于 HTTP,URI,以及 XML 这些现有的广泛流行的协议和标准,伴随着 REST,HTTP 协议得到了更加正确的使用。


相较于基于 SOAP 和 WSDL 的 Web 服务,REST 模式提供了更为简洁的实现方案。目前,越来越多的 Web 服务开始采用 REST 风格设计和实现,真实世界中比较著名的 REST 服务包括:Google AJAX 搜索 API、Amazon Simple Storage Service (AmazonS3) 等。

基于 REST 的 Web 服务遵循一些基本的设计原则:


1)系统中的每一个对象或是资源都可以通过一个唯一的 URI 来进行寻址,URI 的结构应该简单、可预测且易于理解,比如定义目录结构式的 URI。


2)以遵循RFC-2616 所定义的协议的方式显式地使用 HTTP 方法,建立创建、检索、更新和删除(CRUD:Create, Retrieve, Update and Delete)操作与 HTTP 方法之间的一对一映射:


若要创建资源,应该使用 POST方法, URI : xxx/book(在服务器端新建图书信息,需提供该图书所有信息)


若要检索某个资源,应该使用 GET 方法, URI:xxx/book/{ID} (从服务器端获得某图书信息)

若要更改资源状态或对其进行更新,应该使用 PUT 方法,URI:xxx/book/{ID}(在服务器端更新某已存在的图书信息,需提供更新的内容)


若要删除某个资源,应该使用 DELETE 方法, URI :xxx/book/{ID} (从服务器端删除某图书信息)


URI 所访问的每个资源都可以使用不同的形式加以表示(比如 XML 或者 JSON),具体的表现形式取决于访问资源的客户端,客户端与服务提供者使用一种内容协商的机制(请求头与 MIME 类型)来选择合适的数据格式,最小化彼此之间的数据耦合。


1.2) 了解JAX-RS是什么?


Java EE 6 引入了对 JSR-311 的支持。JSR-311(JAX-RS:JavaAPI for RESTful Web Services)旨在定义一个统一的规范,使得 Java 程序员可以使用一套固定的接口来开发 REST 应用,避免了依赖于第三方框架。同时,JAX-RS 使用 POJO 编程模型和基于标注的配置,并集成了JAXB,从而可以有效缩短 REST 应用的开发周期。


JAX-RS是一套用java实现REST服务的规范,提供了一些标注将一个资源类,一个POJOJava类,封装为Web资源. 这些标注包括以下:


@Path:标注资源类或方法的相对路径。


@GET,@PUT,@POST,@DELETE:标注方法是用的HTTP请求的类型。


@Produces:标注返回的MIME媒体类型。


@Consumes:标注可接受请求的MIME媒体类型。


@PathParam,@QueryParam,@HeaderParam,@CookieParam,@MatrixParam,@FormParam:分别标注方法的参数来自于HTTP请求的不同位置,例如@PathParam来自于URL的路径,@QueryParam来自于URL的查询参数,@HeaderParam来自于HTTP请求的头信息,@CookieParam来自于HTTP请求的Cookie。


更通俗些说如果你用java写了一套框架,当开发者自己写的JAVA类使用了JAX-RS定义的这些注解标注过,然后通过你写的这套框架就可以将有这些JAX-RS标注的类发布成web资源,供其他客户端程序去调用。那么你写的这套框架就是一套RestFul Web Service框架,就是JAX-RS规范的实现者之一,是JAX-RS标准定义的这些标注的解释执行者。


目前比较流行的JAX-RS实现有以下几种:


Apache CXF,开源的Web服务框架开源组织Apache的实现。Jersey,由Sun提供的JAX-RS的参考实现。RestEasy,JBoss的JAX-RS的实现。

与其他几个框架相比较而言,RestEasy以其高性能,轻量级,简单易上手,高可靠性和稳定性以及易于与其他容器集成等特点,越来越受到开发人员的欢迎。


1.3)Resteasy简介:


RESTEasy是JBoss的一个开源项目,提供一套完整的框架帮助开发人员构建RESTful Web Service和RESTful Java应用程序。它是JAX-RS 2.0规范的一个完整实现并通过JCP认证,通过Http协议对外提供基于Java API的 RestFul Web Service。


RestEasy可以运行在任何Servlet容器中,作为JBoss的官方实现它可以更好的和Jboss服务器紧密融合从而提供更好的用户体验。


作为JAX-RS的标准实现,RestEasy还具有以下亮点特性:


1)不需要配置文件,只要把JARs文件放到类路径里面,添加 @Path等标注就可以了

2)完全的把 RESTEeasy 配置作为Seam 组件来看待

3)HTTP 请求由Seam来提供,不需要一个额外的Servlet

4)Resources 和providers可以作为Seam components (JavaBean or EJB),具有全面的Seaminjection,lifecycle, interception, 等功能支持

5)支持在客户端与服务器端自动实现GZIP解压缩

6)支持异步请求处理

7)支持多种数据传输格式: XML, JSON, YAML, Fastinfoset, Multipart, XOP, Atom

……



二、手把手教你使用Resteasy


Resteasy的配置方法有很多种,本节内容是为了给下节讲解RestEasy原理做个铺垫,便于大家理解其实现原理,所以使用了RestEasy最基础的配置方式,其他配置方法大家可以去官网找到相关资料。


RestEasy的配置使用非常的简单,现在我们通过一个 Demo来看一下如何使用RestEasy。


新建一个JAVA Web工程: 我使用了Maven来创建webapp项目:

RestEasy 框架了解_第1张图片RestEasy 框架了解_第2张图片RestEasy 框架了解_第3张图片

引入依赖包:pom.xml 配置如下:

RestEasy 框架了解_第4张图片

新建Java 资源类,并添加相应的注解;(要发布成rest服务的类)

配置web.xml,添加使用Resteasy将资源类发布成rest服务的能力,配置如下:

验证,启动服务器打开浏览器访问:

http://localhost:8080/resteasydemo/path1/subpath/123

出现以上结果说明通过Resteasy发布 Rest服务成功.怎么样 SoEasy吧。


三、揭秘Resteasy的实现原理


通过上面的Demo相信大家都已经学会如何使用Resteasy把一个JavaBean发布成Rest服务了,接下来我们结合Demo一起来看一下Resteasy的实现原理。


我本人研究Resteasy实现原理的方法是:通过上面这个Demo来调试阅读Resteasy的源码进而理解其实现原理。

首先要发布restful的service要解决以下几个问题:


1) 谁来接受来自客户端的请求,并进行分发交给对应的对象的方法去处理。


2) 负责处理客户端请求的对象由谁来负责产生(上面Demo中的TestRest对象)。


3) 如何解析Java类上面的JAX-RS注解,使客户端过来的请求可以找到对应的对象的方法去执行。

带着上面的三个问题我们来看一下Resteasy是如何设计实现来解决上面的问题的。


在上面的Demo中要把TestRest发布成Rest服务首先在web.xml文件中做了以下配置:

其中ResteasyBootstrap作为监听器是拉起Resteasy服务的入口,在服务启动时主要做了以下动作:

1)通过ListenerBootstrap组件读取在web.xml文件中的一些系统配置信息,创建ResteasyDeployment对象,并将这些配置信息初始化到该对象中,其中就包括将”resteasy.resources”中配置的资源类的路径初始化到其成员变量resourceClasses中;


2)通过调用ResteasyDeployment的start()方法,并根据相关配置信息初始化Resteasy的核心组件ResteasyProviderFactory ,Dispatcher,Registry.


3)最关键的部分是调用registration(),在该方法中会遍历之前在web.xml中配置的资源并将其注册到Registry中, 以Demo中的例子来看会遍历resourceClasses中配置好的TestRest资源路径,并加载该类然后通过调用registry.addPerRequestResource(clazz)注册到Registry中; 详见以下代码片段:

在addPerRequestResource()中做了两个主要的事情:其中一个是会使用相应的ResourceFactory来包装资源类TestRest,见以下代码片段:

通过阅读POJOResourceFactory的源码可以了解到其作用就是包含了资源类的所有元信息,因此它可以利用ResteasyProviderFactory提供的注入器在需要时通过createResource()来创建资源类TestRest的对象;


第二个主要的事情是Registry可以通过资源类中的元信息来解析上面的JAX-RS注解,并将该注解的路径和对应的方法生成的invoker对象注册到Registry中,在Demo中就是把”/path1/subpath/{id}”和 test()方法的invoker对象注册到Registry中。


(Resteasy在服务启动时初始化过程图)

在web.xml文件中另一个配置是配置了HttpServletDispatcher,该类是HttpServlet的实现是所有请求的入口,通过其service()方法最终将请求交给之前启动服务时已经初始化好的Dispatcher对象来处理. 以Demo为例,当请求”http://localhost:8080/resteasydemo/path1/subpath/123”过来时,Dispatcher对象会调用其成员变量Registry对象来解析该请求中的路径”/path1/subpath/123”, 然后匹配到相应的invoker来执行客户端请求(详见以下代码段),并将结果返回,页面会显示”Hello 123”;



(Resteasy 客户端请求处理流程图)

四、总结


通过对Resteasy源码的解读分析我们就可以解答刚开始的三个问题:


1)谁来接受来自客户端的请求,并进行分发交给对应的对象的方法去处理。

----->HttpServletDispatcher,(接受并分发客户端http请求)


2)负责处理客户端请求的对象由谁来负责产生。

----->ResourceFactory (在服务器启动时通过web.xml读取class的配置信息然后通过反射机制产生)


3)如何解析Java类上面的注解,使客户端过来的请求可以找到对应的方法去执行。

------>Registry(服务器启动时加载用户自定义Rest资源时,会解析上面的注解,并将注解相对路径和该类中执行的方法建立对应关系注册到Registry中,当客户端请求过来时会根据请求中的相对路径去Registry中查找对应的invoker对象,然后执行并将处理结果返回)


Resteasy就是通过以上几个核心组件的相互配合,最终将一个JavaBean发布成Rest服务,这种基于服务注册的实现方式,使得Resteasy具有较好的可扩展性,例如它能很好的和Spring进行整合将SpringBean发布成Rest服务,它是如何做到的呢?首先扩展了Resteasy的ResourceFactory实现了一个SpringResourceFactory(用来从Spring容器中获得对象),然后在服务启动时当Spring容器初始化好以后,通过扩展Spring的BeanFactoryPostProcessor,将Spring容器中初始化好的SpringBean以及对应的SpringResourceFactory注册到Resteasy的Registry中.这样客户端请求过来后,当请求路径在Registry中匹配到相应的SpringBean时就可以调用该SpringBean的ResourceFactory的createResource方法,该方法可以从Spring容器中获得对象来处理请求。


Tips:


Resteasy发布Rest服务的两种方式:


一种是通过listener (ResteasyBootstrap)方式在server启动时通过该listener的contextInitialized()初始化Resteasy核心组件及Rest资源。
第二种是如果没有在web.xml中配置ResteasyBootstrap监听器,则在HttpServletDispatcher,第一次请求过来时通过servlet的init方法初始化Resteasy核心组件及Rest资源。

无论哪种方式原理都是一样的,只是初始化的时机不同。




RestEasy技术说明

简介

RESTEasy

RESTEasy是JBoss的一个开源项目,提供各种框架帮助你构建RESTful Web Services和RESTful Java应用程序。它是JAX-RS规范的一个完整实现并通过JCP认证。作为一个JBOSS的项目,它当然能和JBOSS应用服务器很好地集成在一起。但是,它也能在任何运行JDK5或以上版本的Servlet容器中运行。RESTEasy还提供一个RESTEasy JAX-RS客户端调用框架。能够很方便与EJB、Seam、Guice、Spring和Spring MVC集成使用。支持在客户端与服务器端自动实现GZIP解压缩。

RESTEasy 项目是 JAX-RS 的一个实现,集成的一些亮点:

  • 不需要配置文件,只要把JARs文件放到类路径里面,添加 @Path 标注就可以了。
  • 完全的把 RESTEeasy 配置作为Seam 组件来看待。
  • HTTP 请求由Seam来提供,不需要一个额外的Servlet。
  • Resources 和providers可以作为 Seam components (JavaBean or EJB),具有全面的Seam injection,lifecycle, interception, 等功能支持。
  • 支持在客户端与服务器端自动实现GZIP解压缩。

名词解释:

JAX-RS: Java API for RESTful Web Services是一个Java编程语言的应用程序接口,支持按照 表象化状态转变 (REST)架构风格创建Web服务Web服务[1]. JAX-RS使用了Java SE 5引入的Java 标注来简化Web服务客户端和服务端的开发和部署。

规范内容

JAX-RS提供了一些标注将一个资源类,一个POJOJava类,封装为Web资源。标注包括:

@Path,标注资源类或方法的相对路径

@GET,@PUT,@POST,@DELETE,标注方法是用的HTTP请求的类型

@Produces,标注返回的MIME媒体类型

@Consumes,标注可接受请求的MIME媒体类型

@PathParam,@QueryParam,@HeaderParam,@CookieParam,@MatrixParam,@FormParam,分别标注方法的参数来自于HTTP请求的不同位置,例如@PathParam来自于URL的路径,@QueryParam来自于URL的查询参数,@HeaderParam来自于HTTP请求的头信息,@CookieParam来自于HTTP请求的Cookie。

 

REST

基百科REST条的解

深入浅出REST

详细介绍

如何配置

单独配置

 WEB-INF/web.xml 中配置如下:

    Archetype Created Web Application

    

        Resteasy

        

            org.jboss.resteasy.plugins.server.servlet.HttpServletDispatcher

        

        

            javax.ws.rs.Application

            com.restfully.shop.services.ShoppingApplication

        

    

    

        Resteasy

        /*

    

 

配置开关

Resteasy采用 元素来配置,参数如下:

 

参数名

默认值

描述

resteasy.servlet.mapping.prefix

no default

If the url-pattern for the Resteasy servlet-mapping is not /*

resteasy.scan

FALSE

Automatically scan WEB-INF/lib jars and WEB-INF/classes directory for both @Provider and JAX-RS resource classes (@Path, @GET, @POST etc..) and register them

resteasy.scan.providers

FALSE

Scan for @Provider classes and register them

resteasy.scan.resources

FALSE

Scan for JAX-RS resource classes

resteasy.providers

no default

A comma delimited list of fully qualified @Provider class names you want to register

 

resteasy.use.builtin.providers

 

TRUE

Whether or not to register default, built-in @Provider classes. (Only available in 1.0-beta-5 and later)

 

resteasy.resources

 

no default

 

A comma delimited list of fully qualified JAX-RS resource class names you want to register

 

resteasy.jndi.resources

 

no default

 

A comma delimited list of JNDI names which reference objects you want to register as JAX-RS resources

 

javax.ws.rs.Application

 

no default

 

Fully qualified name of Application class to bootstrap in a spec portable way

 

resteasy.media.type.mappings

 

no default

 

Replaces the need for an Accept header by mapping file name extensions (like .xml or .txt) to a media type. Used when the client is unable to use a Accept header to choose a representation (i.e. a browser). See JAX-RS Content Negotiation chapter for more details.

 

resteasy.language.mappings

 

no default

 

Replaces the need for an Accept-Language header by mapping file name extensions (like .en or .fr) to a language. Used when the client is unable to use a Accept-Language header to choose a language (i.e. a browser). See JAX-RS Content Negotiation chapter for more details

 

 

使用ServletContextListener来配置

  

      

         org.jboss.resteasy.plugins.server.servlet.ResteasyBootstrap

      

  

  

  

      Resteasy

      

         org.jboss.resteasy.plugins.server.servlet.HttpServletDispatcher

      

  

  

      Resteasy

      /resteasy/*

  

 

使用ServletFilter来配置

    

        Resteasy

        

            org.jboss.resteasy.plugins.server.servlet.FilterDispatcher

        

        

            javax.ws.rs.Application

            com.restfully.shop.services.ShoppingApplication

        

    

    

        Resteasy

        /*

    

 

与Spring集成

   Archetype Created Web Application

  

      org.jboss.resteasy.plugins.server.servlet.ResteasyBootstrap

  

  

      org.jboss.resteasy.plugins.spring.SpringContextLoaderListener

  

  

      Resteasy

      org.jboss.resteasy.plugins.server.servlet.HttpServletDispatcher

  

  

      Resteasy

      /*

  

 

使用@Path,@Get,@Post等标注

示例:

@Path("/library")

public class Library {

   @GET

   @Path("/books")

   public String getBooks() {...}

   @GET

   @Path("/book/{isbn}")

   public String getBook(@PathParam("isbn") String id) {

      // search my database and get a string representation and return it

   }

   @PUT

   @Path("/book/{isbn}")

   public void addBook(@PathParam("isbn") String id, @QueryParam("name") String name) {...}

   @DELETE

   @Path("/book/{id}")

   public void removeBook(@PathParam("id") String id {...}

   

}

以下操作都是针对library这个资源的

GET http://myhost.com/services/library/books 意思为获得所有的books调用的方法为getBooks

GET http://myhost.com/services/library/book/333 意思为获得ID为333的book调用的方法为getBook

PUT http://myhost.com/services/library/book/333 新增一个ID为333的book调用的方法为addBook

DELETE http://myhost.com/services/library/book/333 删除一个ID为333的book调用的方法为removeBook

@Path这个标注可以在类上也可以在方法上,如果类和方法上都有的话,那么方法上的路径是级联的如上面例子的/library/book/

@Path和使用正则表达式匹配路径

@Path不仅仅接收简单的路径表达式,也可以使用正则表达式:

@Path("/resources)

public class MyResource {

   @GET

   @Path("{var:.*}/stuff")

   public String get() {...}

}

如下操作就能获得该资源

GET /resources/stuff

GET /resources/foo/stuff

GET /resources/on/and/on/stuff

表达式的格式为:

"{" variable-name [ ":" regular-expression ] "}"

正则表达式部分是可选的,当未提供时,则会匹配一个默认的表达式"([]*)"

@Path("/resources/{var}/stuff")

会匹配如下路径

GET /resources/foo/stuff

GET /resources/bar/stuff

下面的则不会匹配

GET /resources/a/bunch/of/stuff

@PathParam

@PathParam 参数标注是用来获取映射路径上的变量值供方法使用

@Path("/library")

public class Library {

   @GET

   @Path("/book/{isbn}")

   public String getBook(@PathParam("isbn") String id) {

      // search my database and get a string representation and return it

   }

}

GET http://myhost.com/services/library/book/333 就会调用到getBook方法,id的值就会被自动映射为333

@Path中的变量名要和@PathParam中的变量名一致,参数类型可以是任意类型,一个String,一个Java对象,注意如果是Java对象时,这个对象要拥有一个带String类型参数的构造器或者一个返回值为String的静态valueOf方法,例如:

构造器方式:

  @GET

   @Path("/book/{isbn}")

   public String getBook(@PathParam("isbn") ISBN id) {...}

   public class ISBN {

      public ISBN(String str) {...}

   }

valueOf方式:

 public class ISBN {

     public static ISBN valueOf(String isbn) {...}

  }

这样做的目的是底层会把请求的参数通过String的方式传递的前端,构造对象的方式由业务层来自己构建

@PathParam高级使用

允许指定一个或多个路径参数在一个URI段中。例如:

  1. @Path("/aaa{param}bbb")

"/aaa111bbb"会匹配,param=111

  1. @Path("/{name}-{zip}")

"/bill-02115" 会匹配,name=bill,zip=02115

  1. @Path("/foo{name}-{zip}bar")

"/foobill-02115bar " 会匹配,name=bill,zip=02115

正则表达式方式例子:

@GET

@Path("/aaa{param:b+}/{many:.*}/stuff")

public String getIt(@PathParam("param") String bs, @PathParam("many") String many) {...}

GET /aaabb/some/stuff bs=bb,many=some

GET /aaab/a/lot/of/stuff bs= b,many=a/lot/of

@QueryParam

@QueryParam这个标注是给通过?的方式传参获得参数值的,如:

GET /books?num=5&index=1

@GET

   public String getBooks(@QueryParam("num") int num,@QueryParam("index") int index) {

   ...

   }

这里同上面的@PathParam,参数类型可以是任意类型

@HeaderParam

这个标注时用来获得保存在HttpRequest头里面的参数信息的,如:

@PUT

   public void put(@HeaderParam("Content-Type") MediaType contentType, ...)

这里同上面的@PathParam,参数类型可以是任意类型

@CookieParam

用来获取保存在Cookie里面的参数,如:

@GET

   public String getBooks(@CookieParam("sessionid") int id) {

   ...

   }

@FormParam

用来获取Form中的参数值,如:

页面代码:

First name: 


Middle name: 

Last name: 

后台代码

@Path("/")

public class NameRegistry {

   @Path("/resources/service")

   @POST

   public void addName(@FormParam("firstname") String first, @FormParam("lastname") String last) {...}

标注了@FormParam,会把表达里面的值自动映射到方法的参数上去.

如果要取得Form里面的所有属性,可以通过在方法上增加一个MultivaluedMap form这样的对象来获得,如下:

@Path("/resources/service")

   @POST

   public void addName(@FormParam("firstname") String first, @FormParam("lastname") String last,MultivaluedMap form) {...}

@Form

上面已经说的几种标注都是一个属性对应一个参数的,那么如果属性多了,定义的方法就会变得不好阅读,此时最好有个东西能够把上面的几种自动标注自动封装成一个对象,@Form这个标注就是用来实现这个功能的,如:

public class MyForm {

   @FormParam("stuff")

   private int stuff;

   @HeaderParam("myHeader")

   private String header;

   @PathParam("foo")

   public void setFoo(String foo) {...}

}

@POST

@Path("/myservice")

public void post(@Form MyForm form) {...}

@DefaultValue

在以上标注使用的时候,有些参数值在没有值的情况下如果需要有默认值,则使用这个标注,如:

@GET

   public String getBooks(@QueryParam("num") @DefaultValue("10") int num) {...}

 

满足JAX-RS规范的 Resource Locators和子资源

资源处理类定义的某个方法可以处理某个请求的一部分,剩余部分由子资源处理类来处理,如:

@Path("/")

public class ShoppingStore {

   @Path("/customers/{id}")

   public Customer getCustomer(@PathParam("id") int id) {

      Customer cust = ...; // Find a customer object

      return cust;

   }

}

public class Customer {

    @GET

    public String get() {...}

    @Path("/address")

    public String getAddress() {...}

}

当我们发起GET /customer/123这样的请求的时候,程序会先调用 ShoppingStore的 getCustomer这个方法,然后接着调用 Customer里面的 get方法

当我们发起GET /customer/123/address这样的请求的时候,程序会先调用 ShoppingStore的 getCustomer这个方法,然后接着调用 Customer里面的 getAddress 方法

JAX-RS Content Negotiation

@Consumes

我们从页面提交数据到后台的时候,数据的类型可以是text的,xml的,json的,但是我们在请求资源的时候想要请求到同一个资源路径上面去,此时怎么来区分处理呢?使用@Consumes标注,下面的例子将说明:

 @Consumes("text/*")

         @Path("/library")

         public class Library {

         @POST

         public String stringBook(String book) {...}

         @Consumes("text/xml")

         @POST

         public String jaxbBook(Book book) {...}

      

当客户端发起请求的时候,系统会先找到所有匹配路径的方法,然后根据content-type找到具体的处理方法,比如:

 POST /library

content-type: text/plain

就会执行上面的 stringBook这个方法,因为这个方法上面没有标注@ Consumes,程序找了所有的方法没有找到标注 @ Consumes(“text/plain”)这个类型的,所以就执行这个方法了.如果请求的content-type=xml,比如:

POST /library

         content-type: text/xml

此时就会执行 jaxbBook这个方法

@Produces

当服务器端实行完成相关的逻辑需要返回对象的时候,程序会根据@Produces返回相应的对象类型

@Produces("text/*")

         @Path("/library")

         public class Library {

         @GET

         @Produces("application/json")

         public String getJSON() {...}

         @GET

         public String get() {...}

如果客户端发起如下请求

         GET /library

那么则会调用到get方法并且返回的格式是json类型的

这些标注能不能写多个呢?答案是可以的,但是系统只认第一个

 

Content Marshalling/Providers

这个东西是用来根据消息题格式来组装对象或者根据对象生成相应的消息体的,默认的对应关系如下

 

Media Types

Java Type

 

application/*+xml, text/*+xml, application/*+json, application/*+fastinfoset, application/atom+*

 

JaxB annotated classes

 

application/*+xml, text/*+xml

 

org.w3c.dom.Document

 

*/*

 

java.lang.String

javax.activation.DataSource

java.io.File

byte[]

 

application/x-www-form-urlencoded

 

javax.ws.rs.core.MultivaluedMap

 

text/plain

 

primtives, java.lang.String, or any type that has a String constructor, or static valueOf(String) method for input, toString() for output

 

 

 

生成 JavaScript API

RESTEasy能够生成JavaScript API使用AJAX来执行 JAX-RS操作,比如:

@Path("orders")

public interface Orders {

 @Path("{id}")

 @GET

 public String getOrder(@PathParam("id") String id){

  return "Hello "+id;

 }

}

以上代码可以在js里面通过var order = Orders.getOrder({id: 23});

这种方式来调用,很酷吧,这里应该是跟Google的一项技术类似的Java代码可以通过js方式来调用

通过JavaApi调用资源

上面介绍了生成jsapi的方式调用,另外如果别的应用需要通过Java的方式调用资源该怎么处理呢,下面的例子将说明:

ClientRequest request = new ClientRequest("http://localhost:8080/rest/services/demoservice/child/22222");

// request.header("custom-header", "value");

// We're posting XML and a JAXB object

// request.body("application/xml", someJaxb);

// we're expecting a String back

ClientResponse response = request.get(Object.class);

if (response.getStatus() == 200) // OK!

{

Object str = response.getEntity();

System.out.println(str);

}

把资源当做一个标准servlet接收处理方法

我们可以把一个资源url当做一个接收servlet请求的处理类或者处理方法

jaxb介绍

对@PathParam, @QueryParam, @MatrixParam, @FormParam, and @HeaderParam参数的处理

@PathParam, @QueryParam, @MatrixParam, @FormParam, and @HeaderParam标注传递的参数类型是String型的,对于这些参数我们的方法可能希望接收的参数是经过转换后的对象类型的参数,比如如下的方法:

void put(@QueryParam("pojo")POJO q, @PathParam("pojo")POJO pp,@MatrixParam("pojo")POJO mp,@HeaderParam("pojo")POJO hp);

这里的Put方法需要的是一个Pojo类型的参数,但是@PathParam, @QueryParam, @MatrixParam, @FormParam, and @HeaderParam传递的都是String类型的,怎么是怎么转换为对象的呢?

可以使用StringConverter或者StringParamUnmarshaller

StringConverter

package org.jboss.resteasy.spi;

public interface StringConverter

{

   T fromString(String str);

   String toString(T value);

}

实现类如下:

@Provider

      public static class POJOConverter implements StringConverter

      {

         public POJO fromString(String str)

         {

            System.out.println("FROM STRNG: " + str);

            POJO pojo = new POJO();

            pojo.setName(str);

            return pojo;

         }

         public String toString(POJO value)

         {

            return value.getName();

         }

      }

FromString就是你自己需要实现的如何把接收的String参数转换为Pojo类

toString方法是用来把Pojo对象转换为String

 

 

现在已经能够把String参数转换为对象了,我们更进一步的想使用一些自定义的标注来做一些逻辑,比如说日期的格式化,就要使用下面的StringParamUnmarshaller

StringParamUnmarshaller

package org.jboss.resteasy.spi;

public interface StringParameterUnmarshaller

{

   void setAnnotations(Annotation[] annotations);

   T fromString(String str);

}

实现类

public class DateFormatter implements StringParameterUnmarshaller

   {

      private SimpleDateFormat formatter;

      public void setAnnotations(Annotation[] annotations)

      {

         DateFormat format = FindAnnotation.findAnnotation(annotations, DateFormat.class);

         formatter = new SimpleDateFormat(format.value());

      }

      public Date fromString(String str)

      {

         try

         {

            return formatter.parse(str);

         }

         catch (ParseException e)

         {

            throw new RuntimeException(e);

         }

      }

   }

使用方式:

@Path("/datetest")

   public class Service

   {

      @GET

      @Produces("text/plain")

      @Path("/{date}")

      public String get(@PathParam("date") @DateFormat("MM-dd-yyyy") Date date)

      {

         System.out.println(date);

         Calendar c = Calendar.getInstance();

         c.setTime(date);

         Assert.assertEquals(3, c.get(Calendar.MONTH));

         Assert.assertEquals(23, c.get(Calendar.DAY_OF_MONTH));

         Assert.assertEquals(1977, c.get(Calendar.YEAR));

         return date.toString();

      }

   }

 

在实际使用中,我们有些参数值并不是通过以上方式来传递的,比如说我们要对session进行操作,那么应该怎么办呢,resteasy并没有直接提供使用自定义标注的方法,所以我们可以使用以上的 StringParamUnmarshaller来变通的实现

首先定义自定义标注

@Retention(RetentionPolicy.RUNTIME)

@StringParameterUnmarshallerBinder(SessionOperator.class)

public @interface Session {

public String value();

}

@StringParameterUnmarshallerBinder(SessionOperator.class)是用来指明这个自定义标注是哪个具体的类来处理, SessionOperator这个类就是Session这个自定义标注的处理类

public class SessionOperator implements StringParameterUnmarshaller{

public void setAnnotations(Annotation[] annotations) {

}

public Object fromString(String str) {

return null;

}

}


你可能感兴趣的:(Web)