Java IDE MyEclipse 使用教程：创建一个新的 REST Web 服务（一）

在MyEclipse中开发 REST Web 服务以增强您的 Web 应用程序。在本教程示例中，您将创建一个简单的 Web 服务来维护客户列表。

本教程需要下载

在MyEclipse中开发 REST Web 服务以增强您的 Web 应用程序。在本教程示例中，您将创建一个简单的 Web 服务来维护客户列表。您将学会：

• 开发 REST Web 服务
• 部署到 Tomcat 服务器
• 使用 REST Web 服务资源管理器进行测试

从 REST Web 服务项目开始

REST Web 服务项目向导让您开始进行项目配置。

1. 选择文件>新建>Web 服务项目。
2. 在 Project Name 字段中输入restdemo，选择 JAX-RS (REST Web Services) 框架选项，然后单击 Next。

创建 Web 服务项目


3. 接受默认源文件夹，然后单击下一步。
4. 出于本示例的目的，单击 Finish 接受默认值。

创建一个新的 REST Web 服务

项目到位后，您可以创建 Web 服务。您将创建管理客户实体所需的类和资源方法的类。

创建客户实体

这个简单的 Customer 类包含 id、name 和 address 字段，并表示您使用 Web 服务管理的 Customer 实体。

1. 右键单击restdemo项目，然后选择New>Class。
2. 在 Package 字段中键入com.myeclipseide.ws ，在 Name 字段中键入Customer ，如果选中则清除Public Static Void Main复选框，然后单击 Finish。

创建 Java 类


3. 将生成的类的默认内容替换为以下代码，并保存文件。

package com.myeclipseide.ws;import javax.xml.bind.annotation.XmlRootElement;@XmlRootElementpublic class Customer {  private int id;  private String name;  private String address;  public int getId() {     return id;  }  public void setId(int id) {    this.id = id;  }  public String getName() {     return name;  }  public void setName(String name) {     this.name = name;  }  public String getAddress() {     return address;  }  public void setAddress(String address) {    this.address = address;  }}

您使用 XML 作为序列化格式，即您使用 XML 从 Web 服务发送和接收客户实体。

Customer 类中的 @XMLRootElement 注释是一个 JAXB 注释，它允许 JAXB 将此实体从 Java 转换为 XML 并返回。可以在类中注释字段和方法以自定义序列化，但对于本教程，JAXB 默认值很好。

创建资源类，Web服务的核心

1. 右键单击restdemo项目，然后选择New>Other。
2. 在过滤器字段中键入Web 服务，选择 Web 服务，然后单击下一步。

3. 选择Create web service from Java class选项，选择Create new Java bean复选框，然后单击 Next。

4. 在 URL 路径字段中输入customers，选择 Singleton Lifecycle 选项，从 Produces 下拉列表中选择application/xml ，在 Java Package 字段中输入com.myeclipseide.ws ，然后在 Java 类字段中输入CustomersResource。


URL 路径— 指示可以访问此资源的路径。对于本教程，您使用客户，因为此资源管理我们的客户列表。该资源将托管在“/customers”。

单例生命周期——确保 Jersey 每个 Web 应用程序只创建一个此类的实例。

消费和生产— 可用于指定此资源可以接受和生成的默认 mime 类型的数据。这些值可以被类中的各个方法覆盖。如上所述，您正在序列化为 XML，因此您使用 application/xml mime 类型。

5. 单击添加按钮以添加获取客户列表的方法。
6. 单击添加按钮以添加获取客户列表的方法。在 Method name 字段中键入getCustomers ，在 Return type 字段中键入java.util.List<Customer>，然后单击 Finish。


HTTP 方法- 在这种情况下，可用于指定此方法响应的 HTTP 请求的类型。

方法签名预览——在您对页面进行更改时更新，让您了解生成的方法的外观。

7. 再次单击“添加”按钮以添加返回特定客户详细信息的方法。
8. 在方法名称字段中键入getCustomer ，在返回类型字段中键入Customer ，在 URL 路径字段中键入{id} 。

9. 单击添加按钮以添加方法参数。在 Java Type 字段中键入int ，在 Java Name 字段中键入 cId，从 Param Type 下拉列表中选择PathParam，然后在Param Name 字段中键入id，单击完成。


URL Path — 指定可以到达此方法的路径，相对于包含资源。

在这种情况下，您指定 {id}，这意味着可以在 /customers/{id} 访问此资源方法。花括号表示一个 URI 变量。这些变量在运行时被替换为资源以响应基于替换的 URI 的请求。

参数— 直接在表格中编辑参数。因为需要 id 变量的值，所以使用 PathParam 注解将其映射到 cId 参数。

10. 添加一个允许您将新客户添加到列表的方法。填写如下所示的字段，然后单击完成。


在这种情况下，您正在响应一个 POST 请求并期望应用程序/xml 输入，该输入将被反序列化为 customer 参数。客户参数是一个实体参数（未注释），直接从传入请求的消息体映射。您还可以覆盖由 CustomersResource 类指定的默认应用程序/xml 输出，并改为指定 text/html。

添加这三个方法后，配置应如下所示：


11. 单击 Finish 生成CustomersResource类。打开文件以查看已存根的资源方法。

本次MyEclipse使用教程介绍了创建一个新的 REST Web 服务的相关内容，想要了解全部教程

MyEclipse V2022.1正式发布，大家可以下载MyEclipse官方正版试用，更多MyEclipse价格咨询可联系在线客服。

MyEclipse | 下载试用

MyEclipse是功能最全面、性价比最高的企业级Java IDE之一。

MyEclipse

标签：

来源：慧都