REST Web 服务(二)----JAX-RS 介绍
1. 什么是JAX-RS?
JAX-RS——Java API for RESTful Web Services,是为 Java 程序员提供的一套固定的接口(Java API),用于开发表述性状态转移(REST)架构风格的 WEB 服务应用,避免了依赖第三方框架。同时,JAX-RS 使用 POJO 编程模型和基于标注(标签)的配置,并集成了 JAXB,从而可以有效缩短 REST 应用的开发周期。REST 作为一种轻量级的 Web 服务架构被原来越多的开发者所使用,JAX-RS 的发布则规范了 REST 应用开发的接口。
常见的 JAX-RS 实现方法有:
1)Jersey——伴随 JSR311的发布,SUN 公司发布的 JSR311的参考实现;
2)CXF——XFire 与 Celtix 的合并;
3)RESTEasy——JBoss 的 JAX-RS 项目。
2. JAX-RS注解有哪些?
JAX-RS提供了一些标注将一个资源类,一个POJO Java类,封装为Web资源。标注包括:
@Path,标注资源类或者方法的相对路径
1 @Path("/") 2 public class Bookstore {} 3 4 @Path("items/{itemid}/") 5 public Item getItem(@PathParam("itemid") String itemid) {}
@GET,@PUT,@POST,@DELETE,标注方法是HTTP请求的类型。
1 @GET 2 public Bookstore getXml() { 3 return this; 4 }
@Produces,标注返回的MIME媒体类型
1 @Produces("text/html;qs=5") 2 public class Bookstore {} 3 4 @Produces({MediaType.APPLICATION_XML, MediaType.TEXT_XML, MediaType.APPLICATION_JSON}) 5 public Bookstore getXml() { 6 return this; 7 }
@Consumes,标注可接受请求的MIME媒体类型
1 @Consumes(MediaType.APPLICATION_XML) 2 public Response putTodo(JAXBElement<Todo> todo) { 3 Todo c = todo.getValue(); 4 return putAndGetResponse(c); 5 }
@PathParam, @QueryParam, @HeaderParam, @CookieParam, @MatrixParam, @FormParam, 分别标注方法的参数来自于HTTP请求的不同位置,例如@PathParam来自于URL的路径,@QueryParam来自于URL的查询参数,@HeaderParam来自于HTTP请求的头信息,@CookieParam来自于HTTP请求的Cookie。
例子:
1 @Path("items/{itemid}/") 2 public Item getItem(@PathParam("itemid") String itemid) {
@Context: 使用该注释注入上下文对象,比如 Request、Response、UriInfo、ServletContext 等。
3. JAX-RS例子
REST with Java (JAX-RS) using Jersey - Tutorial
另外还可以从(Jersey,CXF,RESTEasy)包中找到大量的例子。