第10章 JAX-RS概述

资源类和资源方法的注解
@javax.ws.rs.Path 标注资源类的URI，该注解也可以用于类中的资源方法。 @javax.ws.rs.GET 标注该资源类中处理HTTP协议中GET请求的资源方法，经 常用于查询。该资源方法应做到幂等。 @javax.ws.rs.POST 标注该资源类中处理HTTP协议中POST请求的资源方法， 通常用于资源的创建，资源标识由服务器端产生。 @javax.ws.rs.PUT 标注该资源类中处理HTTP协议中PUT请求的资源方法，经 常用于更新，有时也用于资源的创建，但创建资源所需的标 识应由客户端提供。该资源方法应做到幂等。
单例模式的Application示例
/* 该示例实现了getClasses抽象方法的同时，改写了 getSingletons方法，将Hello资源类设置为单例模式。 ---------------------------------------------------------------------------------*/ @javax.ws.rs.ApplicationPath("/singletonres") public class ApplicationConfig extends Application{ Set<Object> singletons= new java.util.HashSet(); public Set<Class<?>> getClasses(){ return Collections.emptySet(); } @Override public Set<Object> getSingletons() { return singletons.add(new Hello()); } }
路径模板和@PathParam注解
用@Path定义资源的URI时，可以利用"{模板名}"定义路径模 板，匹配任意字符形成的路径信息。模板名的实际值可通过 @PathParam注入给资源方法的对应参数。 @Path("/hello") @Path定义了参数name，该参数名 称可以传递给@PathParam注解 public class Hello{ @GET @Path("{name}") public String sayHello(@PathParam("name") String name){ return "hello,"+name; } }
请求实例模式的Application示例
/* ApplicationConfig继承Application类，实现了getClasses抽象 方法，将Hello资源类设置为请求实例化方式。 另外，可以使用类级注解ApplicationPath设置该Web程序中 Web服务资源的URL模式，此示例中设置为/resource。 ---------------------------------------------------------------------------------*/ @javax.ws.rs.ApplicationPath("/resource") public class ApplicationConfig extends Application{ Set<Class<?>> prototypes= new java.util.HashSet(); @Override public Set<Class<?>> getClasses(){ prototypes.add(Hello.class); return prototypes; } }
}
getClasses和getSingletons方法
public abstract Set<Class<?>> getClasses() 此方法返回java.util.Set类型的一个集合，该集合中存储的是 以请求实例化模式的资源类的Class对象，Class对象的获取 可以通过表达式"类名.class"获取。 public Set<Object> getSingletons() 此方法返回的是以需要以单例模式建立实例的资源类的具体 实例的java.util.Set类型的集合。在该方法中，可以直接建立 对应资源类的实例，然后将这些实例加入到Set集合中，返回 该Set集合即可。
//GET标注的资源方法必须也是公开的，处理GET请求 @GET public String sayHello(){ return "hello,world!"; } }
资源类的实例化
如前所述，JAX-RS服务是Web程序的一部分，当用户请求到来 的时候，容器将建立资源类的实例，建立的方式有两种： 请求实例 这种方式是每接到用户请求，都将建立对应的资源类的实例。 单例模式 所有请求都使用同一个资源类的实例
Jersey服务的web.xml配置示例
<servlet> <servlet-name>ServletAdaptor</servlet-name> <servlet-class> org.glassfish.jersey.servlet.ServletContainer </servlet-class> <init-param> <param-name>javax.ws.rs.Application</param-name> <param-value>rs.ApplicationConfig</param-value> </init-param> </servlet> <servlet-mapping> <servlet-name>ServletAdaptor</servlet-name> <url-pattern>/resource/*</url-pattern> </servlet-mapping>
基于JAX-RS的RESTful Web 服务的构建
REST风格Web服务的构建框架
建立基于REST风格的Web服务可以采用一些技术框架简化构 建过程，常用的技术框架包括： WCF 微软提供的基于.NET技术的RESTful Web服务构架的框架 ，可以使用.NET支持的各种语言编写服务实现代码。 JAX-RS规范 由Java标准化组织JCP（）制定的构建 RESTful风格的Web服务的技术规范，目前最新的规范版本是 2.1(JSR370)。 SpringFramework 是Spring的生态圈中对REST风格Web服务的实现。
在web.xml中设置资源类
使用@ApplicationPath设置服务资源的URL模式适用于直接 支持JAX-RS规范的容器或者实现了Servlet3.0及以上的规范 Servlet/JSP容器（如Tomcat7.x及以上版本）中部署时可用。 对于仅支持Servlet2.5规范的容器（如Tomcat6.x），JAX-RS 的实现类库一般会提供在web.xml中利用类似Servlet的配置 方式配置服务资源的URL模式。 例如，org.glassfish.jersey.servlet.ServletContainer是Jersey 提供的配置Servlet，它有一个名为"javax.ws.rs.Application" 的起始参数，用于设定Web服务中继承Application的子类类 名，配置该Servlet的url-pattern，就可设置Web程序中的 JAX-RS服务的URL模式。
资源类和资源方法的注解
@javax.ws.rs.DELETE 标注该资源类中处理HTTP协议中DELETE请求的资源方法 ，通常用于资源删除。该资源方法应做到幂等。 @javax.ws.rs.HEAD 标注该资源类中处理HTTP协议中HEAD请求的资源方法， 通常用于资源中元数据的获取。 @javax.ws.rs.OPTIONS 标注该资源类型中处理HTTP协议中OPTIONS请求的资源 方法，通常用于查询可用于资源的操作。
JAX-RS服务的部署
利用JAX-RS规范开发的Web服务是Java Web程序 （WAR文件）的一部分，可以直接部署在支持JavaEE6 或者JavaEE7全部功能的服务器中（例如GlassFish3.x或 者4.x版本），也可以部署在仅支持Servlet/JSP及规范的 服务器中（例如Tomcat）。 当在Servlet/JSP容器中部署时，需要在Web程序中添加 对应的JAX-RS实现类库（例如Jersey）。如果需要使用 JAX-RS的服务端事件（SSE）,则要求容器必须支持 Servlet3.0规范（例如，Tomcat7.x及以上版本）;否则只 要求容器支持Servlet2.5规范即可（例如，Tomcat6.x版 本）。
资源类示例
import javax.ws.rs.PATH; import javax.ws.rs.GET; //PATH注解使用String类型的value参数，设定资源类的URI @Path("/hello") //value参数名可以省略 public class Hello{//资源类必须是公开的
@QueryParam示例
@Path("/cal") public class CalReSource{ @GET public int add(@QueryParam("n") int n, @QueryParam("m") int m){ return n+m; } }
资源类和资源方法
如前所述，ROA中的资源就是可以用URI描述的信息，在 JAX-RS中，资源就是部署在Web程序中，可通过URI请求到 的资源类实例。 资源类 使用@javax.ws.rs.Path注解定义其URI的公开类，JAX-RS 也允许使用接口（interface）的实例作为资源。 资源方法 资源类或接口中能够处理诸如GET、POST等不同请求方式 的公开方法。