生成 JAX-RS 2.0 资源的样本客户机代码

您可以从 REST 项目地址生成 Java™ API for RESTful Web Service (JAX-RS) 资源的样本客户机代码。

开始之前

要点: 适用于 Liberty
请完成 WebSphere® Application Server Developer Tools for Eclipse 的以下设置:
  • 将 Liberty 运行时添加至首选项。
  • 在“服务器”视图中创建 Liberty 服务器。
  • 创建一个 Web 项目,并在该项目中定义一个或多个 REST 服务。否则,如果您未定义任何服务,那么 REST 节点将没有子代。

过程

  1. 展开 your_REST_project > 服务 > REST。
  2. 右键单击地址或它的其中一个子代,然后选择生成 > JAX-RS 客户机。 此时将显示“JAX-RS 2.0 客户机”对话框。
    1. 在源文件夹字段中,接受缺省值或指定所生成客户机的目标文件夹。
    2. 在名称字段中,接受缺省值或指定客户机的 Java 类名。
    3. 在包字段中,接受缺省值或指定客户机的 Java 包名。
    4. 选择要用来生成客户机代码的资源。
    5. 生成新的过滤器类。
      1. 选择生成 JAX-RS 客户机过滤器。
      2. 接受缺省值或指定过滤器类的名称。

      此选项将会创建一个基本类,这个类实现 JAX-RS 2.0 javax.ws.rs.client 包中的 ClientRequestFilter 和 ClientResponseFilter 接口。您在生成新的过滤器类后,可以完成接口方法的实现详细信息。

  3. 可选: 要将 JAXB 类和客户机生成到同一项目中,请选择将 XML 模式用于 JAXB 生成。

    JAX-RS 服务的资源方法可能具有 JAXB 类作为方法参数或返回类型。如果您没有 JAXB 源,但具有 XML 模式,那么可以生成 JAXB 类,以便您的客户机代码可以访问这些类。

    1. 单击下一步。

      此时将显示“使用 JAXB 的 JAX-RS 客户机”对话框。

    2. 可选: 在 JAXB 目标 Java 包字段中,提供您想要用于 JAXB 生成的类的 Java 包。

      在指定了 -p 选项的情况下,此值将传递到绑定编译器或 Java XML 绑定体系结构编译器 (XJC) 工具。

    3. 单击浏览... 以浏览到您想要从其生成 JAXB 类的 XSD 文件。

      您还可以将 XSD 文件输入到 XML 模式中。在指定了 -b 选项的情况下,此值将传递到绑定编译器或 XJC 工具。

    4. 可选: 要提供用户定义的 JAXB 绑定文件,请选择指定 JAXB 绑定文件。

      如果您选择此选项,那么可以单击添加以添加定制绑定声明文件。您还可以通过突出显示文件,然后选择除去来除去这些文件。

    5. 可选: 要允许供应商扩展,请选择允许供应商扩展。

      此选择可能是处理某些 XML 模式文档所必需的。在指定了 -extension 选项的情况下,此值将传递到绑定编译器或 XJC 工具。

  4. 单击完成。

结果

您已经生成了 JAX-RS 资源的样本客户机代码。

如果您完成了用于生成 JAXB 类的可选步骤,那么您还在 JAX-RS 客户机所在的项目内生成了 JAXB 类。

您还通过使用可用来访问 JAX-RS 服务的 JAX-RS 2.0 客户机 API 生成了一个新的 Java 类文件。JAX-RS 服务的每个附注释的方法都有一个相应的 JAX-RS 客户机方法,后者是根据 JAX-RS 服务方法中的注释生成的。JAX-RS 服务方法包括 @PathParam、@QueryParam、@Consumes、@Produces、@Path 以及 @GET、@PUT 或 @POST 之类的资源方法。

限制: 所有受 JAX-RS 客户机生成算法影响的类都必须遵循下列限制:
  • 这些类必须是字符串、原语、JAX-RS API 类或由 Java XML 绑定体系结构 (JAXB) 注释的用户类。这些类不能是二进制。
  • 所有类都必须采用源格式,以便算法能够将其找到。如果类不在 JAX-RS 服务所在的项目中,那么将无法生成 JAX-RS 客户机。

下一步做什么

请向样本添加代码,以使客户机代码工作并满足 JAX-RS 2.0 客户机代码需求。要测试样本,请将客户机代码添加至 JSP 或 Servlet。客户机代码必须位于 Servlet 容器中,因为独立 Java 应用程序不受支持。在您具有正常工作的 JAX-RS 2.0 客户机代码后,请使用该客户机代码来启动 JAX-RS 2.0 服务。
Icon that indicates the type of topic Task topic
Timestamp icon Last updated: last_date

File name: t_jaxrs_scc_jaxrs.html