`
zzc1684
  • 浏览: 1182948 次
  • 性别: Icon_minigender_1
  • 来自: 广州
文章分类
社区版块
存档分类
最新评论

JAX-RS入门 一 :基础

阅读更多

简介

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。

目前JAX-RS的实现包括:

(以上来自:http://zh.wikipedia.org/wiki/JAX-RS

 

装备

本文使用的工具有:

  • Eclipse-jee-helios
  • Java-1.6.0_26
  • apache-tomcat-6.0.30
  • SoapUI-3.6

使用到的外部jar包有(必须的部分,需要加到Web容器中)

  • neethi-3.0.2.jar
  • jsr311-api-1.1.1.jar
  • cxf-bundle-2.6.0.jar

使用到的外部jar包有(可选的部分,当且仅当作为一个独立的application运行时)

  • jetty-http-7.5.4.v20111024.jar
  • jetty-io-7.5.4.v20111024.jar
  • jetty-server-7.5.4.v20111024.jar
  • jetty-util-7.5.4.v20111024.jar
  • jetty-continuation-7.5.4.v20111024.jar
  • wsdl4j-1.6.2.jar

 准备

 (以下例子来自: Oreilly - RESTful Java with JAX-RS (12-2009) (ATTiCA).pdf)

 

创建工程

为了后续顺利进行,首先在eclipse上先创建一个Dynamic Web Project,完成以后,一个符合war结构的工程目录会自动生成,之后可以很简单的导出为war文件,其中需要把以下jar包放到 /WebContent/WEB-INF/lib 里:

  • neethi-3.0.2.jar
  • jsr311-api-1.1.1.jar
  • cxf-bundle-2.6.0.jar 

另外,在工程目录下,新建一个 lib 文件夹用来存放以下可选的jar包:

 

  • jetty-http-7.5.4.v20111024.jar
  • jetty-io-7.5.4.v20111024.jar
  • jetty-server-7.5.4.v20111024.jar
  • jetty-util-7.5.4.v20111024.jar
  • jetty-continuation-7.5.4.v20111024.jar
  • wsdl4j-1.6.2.jar

最后一步就是把所有这9个jar都加到工程的build path里去,这样工程就准备好了。

 

定义服务

这里要实现一个简单的REST服务用于对客户进行管理,包括:

  • 创建客户
  • 查看客户
  • 更新客户

首先给出对应的于这些操作的服务接口:

Java代码 复制代码 收藏代码
  1. import java.io.InputStream;   
  2.   
  3. import javax.ws.rs.Consumes;   
  4. import javax.ws.rs.GET;   
  5. import javax.ws.rs.POST;   
  6. import javax.ws.rs.PUT;   
  7. import javax.ws.rs.Path;   
  8. import javax.ws.rs.PathParam;   
  9. import javax.ws.rs.Produces;   
  10. import javax.ws.rs.core.Response;   
  11. import javax.ws.rs.core.StreamingOutput;   
  12.   
  13. @Path("/customers")   
  14. public interface CustomerResource {   
  15.   
  16.     @POST  
  17.     @Consumes("application/xml")   
  18.     public Response createCustomer(InputStream is);   
  19.   
  20.     @GET  
  21.     @Path("{id}")   
  22.     @Produces("application/xml")   
  23.     public StreamingOutput getCustomer(@PathParam("id"int id);   
  24.   
  25.     @PUT  
  26.     @Path("{id}")   
  27.     @Consumes("application/xml")   
  28.     public void updateCustomer(@PathParam("id"int id, InputStream is) ;   
  29. }   

 令人惊奇的是,这个接口已经包含了所有实现我们既定目标的关键部分:

  1. @Path: 定义服务路径,接口中定义的整个服务的顶级路径为"/customers ",方法对应的服务路径为接口路径加方法定义的Path值,如果未定义,则用接口路径,例如getCustomer()的服务路径为:" /customers/{id} "。所以此REST对外服务路径都是 服务的上下文路径/customers/ 子级目录,
  2. @POST,@GET,@PUT:标注方法所支持HTTP请求的类型 (参考上面的说明)
  3. @Produces,@Consumes:标注方法支持或返回的请求MIME类型。

由上可以看到,每个方法被调用的条件如下:

  1. createConsumer(): 请求HTTP方法为POST;请求MIME类型为application/xml;请求路径为: 上下文路径/customers
  2. getCustomer(): 请求的HTTP方法为GET;请求的MIME类型为application/xml;请求的路径为: 上下文路径/customers/{id}
    注: {id}为某个存在(或不存在)customer的编号
  3. updateCustomer(): 请求的HTTP方法为PUT;请求的MIME类型为application/xml;请求的路径: 上下文路径/customers/{id}
    注: {id}为某个存在(或不存在)customer的编号

一个好的实现方法是将REST服务的定义和实现分开,这样代码的结构简洁、清晰,在后期也可以很方便的进行实现的替换和服务定义的修改。

 

下面就是添加实现部分:

Java代码 复制代码 收藏代码
  1. public class CustomerResourceService implements CustomerResource{   
  2.     private Map<Integer, Customer> customerDB = new ConcurrentHashMap<Integer, Customer>();   
  3.     private AtomicInteger idCounter = new AtomicInteger();   
  4.   
  5.     public Response createCustomer(InputStream is) {   
  6.         Customer customer = readCustomer(is);   
  7.         customer.setId(idCounter.incrementAndGet());   
  8.         customerDB.put(customer.getId(), customer);   
  9.         System.out.println("Created customer " + customer.getId());   
  10.         return Response.created(URI.create("/customers/" + customer.getId()))   
  11.                 .build();   
  12.     }   
  13.   
  14.     public StreamingOutput getCustomer(int id) {   
  15.         final Customer customer = customerDB.get(id);   
  16.         if (customer == null) {   
  17.             throw new WebApplicationException(Response.Status.NOT_FOUND);   
  18.         }   
  19.         return new StreamingOutput() {   
  20.             public void write(OutputStream outputStream) throws IOException,   
  21.                     WebApplicationException {   
  22.                 outputCustomer(outputStream, customer);   
  23.             }   
  24.         };   
  25.     }   
  26.   
  27.     public void updateCustomer(int id, InputStream is) {   
  28.         Customer update = readCustomer(is);   
  29.         Customer current = customerDB.get(id);   
  30.         if (current == null)   
  31.             throw new WebApplicationException(Response.Status.NOT_FOUND);   
  32.         current.setFirstName(update.getFirstName());   
  33.         current.setLastName(update.getLastName());   
  34.         current.setStreet(update.getStreet());   
  35.         current.setState(update.getState());   
  36.         current.setZip(update.getZip());   
  37.         current.setCountry(update.getCountry());   
  38.     }   
  39.   
  40.     protected void outputCustomer(OutputStream os, Customer cust)   
  41.             throws IOException {   
  42.         PrintStream writer = new PrintStream(os);   
  43.         writer.println("<customer id=\"" + cust.getId() + "\">");   
  44.         writer.println(" <first-name>" + cust.getFirstName() + "</first-name>");   
  45.         writer.println(" <last-name>" + cust.getLastName() + "</last-name>");   
  46.         writer.println(" <street>" + cust.getStreet() + "</street>");   
  47.         writer.println(" <city>" + cust.getCity() + "</city>");   
  48.         writer.println(" <state>" + cust.getState() + "</state>");   
  49.         writer.println(" <zip>" + cust.getZip() + "</zip>");   
  50.         writer.println(" <country>" + cust.getCountry() + "</country>");   
  51.         writer.println("</customer>");   
  52.     }   
  53.   
  54.     protected Customer readCustomer(InputStream is) {   
  55.         try {   
  56.             DocumentBuilder builder = DocumentBuilderFactory.newInstance()   
  57.                     .newDocumentBuilder();   
  58.             Document doc = builder.parse(is);   
  59.             Element root = doc.getDocumentElement();   
  60.             Customer cust = new Customer();   
  61.             if (root.getAttribute("id") != null  
  62.                     && !root.getAttribute("id").trim().equals("")) {   
  63.                 cust.setId(Integer.valueOf(root.getAttribute("id")));   
  64.             }   
  65.             NodeList nodes = root.getChildNodes();   
  66.             for (int i = 0; i < nodes.getLength(); i++) {   
  67.                 Node item = nodes.item(i);   
  68.                 if(!(item instanceof Element)){   
  69.                     continue;   
  70.                 }   
  71.                 Element element = (Element) nodes.item(i);   
  72.                 if (element.getTagName().equals("first-name")) {   
  73.                     cust.setFirstName(element.getTextContent());   
  74.                 } else if (element.getTagName().equals("last-name")) {   
  75.                     cust.setLastName(element.getTextContent());   
  76.                 } else if (element.getTagName().equals("street")) {   
  77.                     cust.setStreet(element.getTextContent());   
  78.                 } else if (element.getTagName().equals("city")) {   
  79.                     cust.setCity(element.getTextContent());   
  80.                 } else if (element.getTagName().equals("state")) {   
  81.                     cust.setState(element.getTextContent());   
  82.                 } else if (element.getTagName().equals("zip")) {   
  83.                     cust.setZip(element.getTextContent());   
  84.                 } else if (element.getTagName().equals("country")) {   
  85.                     cust.setCountry(element.getTextContent());   
  86.                 }   
  87.             }   
  88.             return cust;   
  89.         } catch (Exception e) {   
  90.             throw new WebApplicationException(e, Response.Status.BAD_REQUEST);   
  91.         }   
  92.     }   
  93. }   

这些方法的实现都很直接,不细说,不过有一点需要特别注意的是:

 

最好不要在实现中混杂有服务的定义部分,例如@Path标签,@PathParam标签等等,如果想修改定义,最好是在接口中修改;或者如果想覆盖某个接口方法的某个annotation,则所有该接口方法的annotation定义都需要重写,而不能仅修改变化的。

分享到:
评论

相关推荐

    JAX-RS入门jar包集合

    JAX-RS入门能够用到的jar包集合,全部收纳于此

    starter-web-service:使用JAX-RS和Jersey构建的入门Web服务

    入门Web服务使用JAX-RS和Jersey构建的入门Web服务。 要进行部署,请安装Gradle并从命令行运行gradle jettyRun 。文献资料包含有关JAX-RS和servlet的详细信息。

    jaxs-rs-playground:JAX-RS模板和示例

    #JAX-RS-PLAYGROUND Various JAX-RS templates and examples 专案 kitchensink-angularjs:快速入门项目的副本 ejb-crud:ejb模块上的CRUD操作示例,JAX-RS注释演示,JAX-RS 2.0客户端(在测试用例中使用) war-...

    spring-boot-cxf-jaxrs:使用Spring Boot和CXF JAXRS快速入门

    快速入门使用Spring Boot来配置一个小的应用程序,其中包括启用了Swagger的CXF JAXRS端点。 重要的 该快速入门可以在2种模式下运行:在您的计算机和Kubernetes / OpenShift群集上独立运行 部署选项 您可以在以下...

    CICS-Liberty-JAXRS-Sample:CICS-Liberty-J​​AXRS-Sample 基于 CICS 目录示例

    CICS-Liberty-J​​AXRS-示例CICS-Liberty-J...查询目录项,例如: 参考: 还有其他方法可以转换 JSON 或配置 JAX-RS,请参阅下面的详细信息: 将 Jackson 与普通的旧 Java 对象(PO​​JO)一起使用 IBM JAX-RS 入门:

    jakartaee8-starter-boilerplate:一个样板项目,用于在几秒钟内启动Jakarta EE 8应用程序

    如果要探索基于JSF,JAX-RS和MVC的真实世界的Jakarta EE 8应用程序,请检查从该项目派生的以下项目。建立确保已安装最新的JDK 8和Apache Maven 3.6。 执行以下命令以在本地构建干净的程序包。 mvn clean package ...

    servcie4rhsso:quickstarts_rhsso_based

    service-jee-jaxrs快速入门演示了如何使用受Red Hat SSO保护的JAX-RS编写RESTful服务。 服务公开了3个端点: public -无需身份验证 secured -可以由具有user角色的user调用 admin可以由具有admin角色的用户调用 ...

    generator-japs:Yeoman Generator可以在几秒钟内创建Java(JAX-RS),AngularJS和PostgreSQL项目!

    这是使用AngularJS和PostgreSQL启动Jax-RS项目的简单方法。 您可以在几秒钟内创建一个简单的项目2.使用方法要从npm安装generator-japs,请运行: npm install -g yonpm install -g generator-japs 最后,启动生成器...

    Resteasy:REST和JAXRS

    JAX-RS RESTEasy是一个JBoss项目,它提供各种框架来帮助您构建RESTful Web服务和RESTful Java应用程序。 它是JAX-RS规范的可移植实现。 JAX-RS的全名是Jakarta RESTful Web服务,它通过HTTP协议为RESTful Web服务...

    spring-cxf-jaxrs-dual-api

    一个示例 Spring、CXF、JAX-RS 应用程序,它在不同的 CXFServlet 上加载了两个 API。 一公一私。 主要特征 弹簧注射 JAX-RS CXF 双API 入门 要启动应用程序,请运行以下命令: jetty:run 将有 2 个 API 可用: ...

    hello:在EAP上使用Java JAX-RS的微服务

    在EAP上使用Java EE(JAX-RS)的Hello微服务 可在以下存储库中找到运行Red Hat Helloworld MSA演示的详细说明: : 在本地构建和部署Hello 确保您已经启动了JBoss EAP服务器 打开命令提示符,然后导航到该微服务的...

    Adopt-a-JSR:采用 JSR

    在本文档中,我们整理了一份入门指南,可帮助您快速上手:采用的 JSR 列表JSR-365:CDI 2.0 JSR-367:JSON-P JSR-369:Servlet 4.0 JSR-370:JAX-RS 2.1 JSR-371:MVC 1.0 JSR-372:JSF 2.3如何贡献? glassfish ...

    openshift-jbosseap-sti-rest-example

    Brey 级别:中级技术:CDI,JAX-RS 简介: helloworld-rs快速入门演示了一个简单的Hello World应用程序,该应用程序捆绑并部署为WAR,使用JAX-RS表示Hello。 目标产品:JBoss EAP 资料来源: : 它是什么? hello...

    vertx-jersey-webapp:在 vertx-jersey 之上的引导 WebApp

    jersey-webapp-1.0-SNAPSHOT.jar - 包含 Runner 以启动 JerseyVerticle verticle 和 JAX-RS jersey 资源的存档###启动服务获取部署在JerseyVerticle中的资源Linux:从根文件夹启动“run.sh” Windows:将

    nascimbeni-jaxrs-2.0-starter-project:基于 RESTEasy 3.0.10 和 Java 8 的 Starter RESTful API 项目

    JAXRS 2.0 简单入门项目该项目演示了如何实现一个非常简单的 Web 服务,旨在用作新 RESTful API 的入门项目。系统要求: Maven 2.0.9 或更高版本构建项目: 在根目录mvn码头:运行这将构建一个 WAR 并使用嵌入式 ...

    pandora-rules

    Brey) 级别:中级技术:CDI,JAX-RS 简介: helloworld-rs快速入门演示了一个简单的Hello World应用程序,该应用程序捆绑并部署为WAR,使用JAX-RS表示Hello。 目标产品:JBoss EAP 资料来源: : 它是什么? ...

    task-manager:由Angular和Java编写

    kitchensink-angularjs:使用JAX-RS演示AngularJS 作者:皮特·缪尔(Pete Muir) 级别:中级技术:AngularJS,CDI,JPA,EJB,JPA,JAX-RS,BV 简介: kitchensink-angularjs快速入门演示了将AngularJS与JAX-RS,...

    MicroProfile入门:您需要了解有关MicroProfile的所有信息

    JAX-RS : -- JSON-B : -- JSON-P : -- MicroProfile Config : -- MicroProfile容错能力: -- MicroProfile指标: -- MicroProfile JWT Auth : -- MicroProfile Rest Client : -- MicroProfile OpenAPI...

    showcase-wild-boot:WildFly-BootsFacses-PrimeFaces展示柜

    wildfly 8 BootsFaces + PrimeFaces展示:Pete Muirs Wildfly Quickstarter的扩展作者:Pete Muir的Christian Laboranowitsch原文:中间技术:CDI,JSF,JPA,EJB,JPA,JAX-RS,BV,BootsFaces,Bootstrap,...

Global site tag (gtag.js) - Google Analytics