创建 JAX-RS Web Service

开始之前

要部署该 Web Service,您需要具有一个已定义和已启动 Java™ 5.0 或更高版本 JVM 支持的服务器。其中包括:
  • WebSphere® Application Server V7.0 或 V8.0,选择以安装 Feature Pack for Web 2.0 AND MOBILE 以及用于 WebSphere Application Server 开发的工具
缺省情况下,当您安装 WebSphere Application Server 时就为您创建了服务器。在“服务器”视图中可以看到此服务器。

如果您选择部署到 WebSphere Application Server 以外的服务器,那么您不能使用 IBM® JAX-RS 库,并且必须通过“项目构面 > JAX-RS 首选项”页面安装和配置自己的 JAX-RS 库。

有关在 WebSphere Application Server 上使用 JAX-RS Web Service 的详细信息,请参阅:WebSphere Application Server 信息中心

创建支持 JAX-RS 的 Web 项目

关于此任务

JAX-RS Web Service 需要存在于已启用 JAX-RS 构面的项目中。
限制: [Liberty]要使用 JAX-RS 2.0 API,请创建用户库,并添加位于 Liberty 运行时的 dev/api/spec 文件夹中的 com.ibm.ws.javaee.jaxrs.2.0_1.0.0.jar。将此用户库移动到项目的 Java 构建路径中 Liberty 服务器类路径容器前。

[WebSphere Application Server 传统版] WebSphere Application Server V9 传统版支持 JAX-RS 1.1 和 2.0.项目中使用的 JAX-RS 的版本必须与 WebSphere Application Server V9 传统版的安装中使用的 JAX-RS 的版本匹配。如果这些版本都不匹配,那么在将项目部署到服务器时,工具会显示警告。如果创建 JAX-RS 项目而不指定构面级别,那么缺省情况下工具会使用 JAX-RS 2.0。

[WebSphere Application Server 传统版]将 JAX-RS 1.1 模块添加到 Web 项目时,工具会将以下文件添加到类路径容器中:
com.ibm.ws.jaxrs.jar
com.ibm.ws.prereq.jaxrs.jar
javax.j2ee.jaxrs.jar
[WebSphere Application Server 传统版]将 JAX-RS 2.0 模块添加到 Web 项目时,工具会将以下文件添加到类路径容器中:
com.ibm.ws.jaxrs20.jar
com.ibm.ws.prereq.jaxrs20.jar
javax.ws.rs-api-2.0.jar

过程

  1. 在 Java EE 透视图中,右键单击企业应用程序项目并选择新建 > Web 项目以打开“Web 项目”向导。
  2. 在名称字段中,为新的 Web 项目输入名称。
  3. 在“项目模板”部分中,选择您想使用的 Web 模板的类型:选择简单以创建简单 Web 项目。
  4. 在“编程模型”部分中,选择要使用的编程模型:选择 Java EE 编程模型。单击下一步配置新的 Web 项目。
  5. 在“部署”页面上,从可用的配置选项列表中,单击部署打开“部署配置”页面。
    • 您可以通过从下拉框中选择其他项来更改目标运行时。单击更改功能部件以打开“项目构面”窗口。在“项目构面”页面上,选择 JAX-RS (REST Web Service),然后单击确定。
    • 单击添加对 WebSphere 绑定和扩展的支持或清除该字段。
    • 在 Web 模块版本字段中,选择要使用的 Web 模块版本。
    • 如果您想要包含 EAR 成员资格,请在 EAR 成员资格字段中单击将项目添加至 EAR;如果您不想将 Web 项目添加至 EAR 文件,请清除此字段。
    • 在 EAR 项目名称字段中会出现现有的 EAR 文件名。您可以单击浏览选择不同的 EAR 文件。
    注: 如果已为新的 Web 项目选择了仅适用于客户端的编程模型,那么部署选项将不可用。
  6. 从可用配置选项的列表中,单击 REST 服务。
    1. 在 JAX-RS 实现库字段中,选择服务器版本的库,例如,IBM WebSphere Application Server V8.0 JAX-RS 库或 IBM WebSphere Application Server V8.5 JAX-RS 库。
      了解有关库的更多信息: 您已为每个 WebSphere 测试环境安装的 JAX-RS 库都将列示在此下拉框中。如果要使用非 WebSphere 库,那么可以使用“用户库首选项”页面进行导入。如果您选择用户库,那么可以启动“用户库首选项”页面并添加库。一旦创建项目之后,您可以通过右键单击项目并选择首选项 > 项目构面 > JAX-RS 来更改库。您还可以选择不让向导为您配置库,这样您就必须手动配置类路径。
    2. 如果您正在使用低于 V8 的 WebSphere Application Server 版本,请选中将库包括在此应用程序中并选择将其作为共享库来包括。这会将 JAX-RS JAR 添加至类路径,还会在增强型 EAR 中添加一个共享库条目。
    3. 缺省情况下会选中更新部署描述符,因为您将需要使用 web.xml 来配置安全性约束和其他行为。将生成 web.xml 并使用 JAX-RS servlet 信息对其进行更新,即使您先前在向导中已选择不生成部署描述符。仅当选择的 Web 模块构面为 V3.0 或更高版本时,此选项才可用。
    4. 如果您已选择更新部署描述符,那么您将能够更改 servlet 名称和 servlet 类名,以及更改 URL 映射模式。
  7. 从可用的配置选项列表中,单击 Java 打开“Java 配置”页面。
    • 在构建路径上的源文件夹字段中,接受缺省的 src 目录,或单击添加文件夹、编辑... 或除去为源文件指定文件夹。
    • 在缺省输出文件夹:字段中,为输出文件指定文件夹或接受缺省值 (WebContent\WEB-INF\classes)。
  8. 从可用配置选项的列表中,单击 Web 模块。在“Web 模块配置”页面上,执行下列操作:
    • 在上下文根字段中,输入 Web 项目根的名称,或接受缺省值(即 Web 项目的名称)。
    • 在内容目录字段中,输入内容目录的名称,或接受缺省值 (WebContent)。
    • 如果您想创建部署描述符,那么选择生成 web.xml 部署描述符。您也可以稍后向 Web 模块添加部署描述符。
  9. 单击完成。

创建 JAX-RS Web Service

过程

  1. 在您的 Web 项目中,创建软件包(右键单击 Java 资源 > 源,然后选择新建 > 软件包)。将 Web Service 的类导入到软件包中。
  2. 打开 WebContent/WEB-INF/web.xml。在“设计”视图中,选择 Servlet JAX-RS Servlet,然后单击添加并将初始化参数添加到 JAX-RS servlet,将名称和值字段留空。保存 web.xml 并忽略可能显示的任何错误。
  3. 在“标记”视图中,选择有关参数名的 web.xml 错误,右键单击并选择“快速修复”。浏览至应用程序并选择。
  4. 将包含 JAX-RS 项目的 EAR 添加到服务器并启动服务器。

结果

要使 Web 应用程序能够成功部署,每个 Web 应用程序都必须具有上下文根。在应用程序组装或应用程序部署期间,将在应用程序部署描述符中为每个 Web 模块定义上下文根。上下文根与 WAR 文件中定义的 Servlet 映射共同组成用户访问该 Servlet 时需要输入的完整 URL。每个已部署 Web 应用程序的上下文根在服务器上必须唯一。上下文根也可以为空。

例如,如果 Web 应用程序使用上下文根 sample/application/,那么 Web 应用程序请求 URL 以 http://<hostname>:<port>/sample/application/ 开头。Servlet 的 URL 模式将被追加到 Web 应用程序的上下文根。例如,如果上下文根为 sample/application/ 且 servlet URL 映射为 rest/api/*,那么 JAX-RS Web 应用程序的基本 URI 为 http://<hostname>:<port>/sample/application/rest/api。

编辑 JAX-RS 项目

创建 JAX-RS Web Service 之后,您可以通过右键单击项目并选择属性 > 项目构面 > JAX-RS 来对其进行编辑。从此页面中,您可以更改:
  • 库类型
  • JAX-RS servlet 名称
  • JAX-RS servlet 类名
  • URL 映射模式
例如,如果您将项目迁移到其他服务器,那么您可以将库提供程序更改为新服务器支持的库提供程序。
Icon that indicates the type of topic Task topic
Timestamp icon Last updated: last_date

File name: tjaxrswebservcreate.html