用MyEclipse开发REST Web Service

文章翻译自Genuitec学习中心
在本例中，将创建一个管理顾客的简单Web Service

1. 创建一个REST Web Service项目

从项目的配置开始REST Web Service：
1. 打开MyEclipse后，依次点击File->New->Web Service Project;或者点击工具条上的新建图标
2. 在Project name框中输入restdemo，WebServices Framework选择REST(JAX-RS)框架，然后点击next进入下一步；

创建Web Service新项目

接受默认的文件夹路径，一路点击下一步；

image.png

在配置web module部分可以根据需要将Generate web.xml deployment descriptor勾选上，建议勾上，点击finish完成项目创建

完成项目

2. 创建一个新的REST Web Service

在创建好的项目中，开始创建Web服务，我们将为管理顾客创建实体类和操作资源的方法类。

2.1 创建顾客的实体类

这个简单的顾客类包含id，name和address三个字段，用来代表Web Service服务的顾客对象。
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;
@XmlRootElement
 
public 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就够了。

2.2创建资源类，Web Service的关键

右键点击restdemo项目，选择New->Other;
在筛选框中输入web service，选中Web Service,然后点击next；

新建web service

3. 在弹出的向导对话框中，Strategy选择Create web service from Java class,同时选中Create new Java bean复选框

image.png

4. 在URL path框中输入customers，Lifecycle选项选择Singleton，从Produces的下拉选项中选择application/xml，点击Java package右侧的Browse选择com.myeclipseide.ws（或者输入），Java Class输入CustomersResource

Web service详细配置

URL路径 - 指示可以到达该资源的路径。在本例中，我们使用customers，因为该资源管理我们的客户列表，顾客资源将被托管在“/ customers”。
Singleton Lifecycle - 确保在单个Web应用程序中此类只会被Jersey创建一个实例。
Consumes and Produces - 用于指定此资源可以接受和生成的默认MIME类型的数据。这些值也可以被类中的各个方法覆盖。如上所述，我们将数据序列化为XML，所以使用application / xml的MIME类型。

点击Add按钮，为Java类添加获取所有顾客的方法；在Method name中输入方法名getCustomers，返回类型输入java.util.List，然后点击finish

添加方法

6. 再次点击Add按钮，为Java类添加一个获取特定顾客信息的方法；方法名输入getCustomer，返回类型输入Customer，URL path输入{id}；

添加第二个方法

然后点击该对话框的Add按钮，为方法添加参数，参数值直接在表格中输入和选择，如下图所示，然后点击finish

为方法添加参数

再添加一个增加顾客的方法，操作如上，具体参数如下图所示；

创建addCustomer方法

9. 在加入三个方法之后，配置页面应该如下图所示

最终web service配置

10. 点击finish生成CustomerResource类，打开文件可以查看生成的方法。

3. 具体实现生成的方法

现在，我们需要为这些方法实现具体的业务逻辑，本例中没有使用数据库来管理顾客列表，为了方便只是使用简单的map来存储。用下面的代码替换CustomersResource类文件中的内容

package com.myeclipseide.ws;

import java.util.ArrayList;
import java.util.List;
import java.util.TreeMap;

import javax.ws.rs.Consumes;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;

import com.sun.jersey.spi.resource.Singleton;

@Produces("application/xml")
@Path("customers")
@Singleton
public class CustomersResource {
    private TreeMap customerMap = new TreeMap();
    public CustomersResource(){
        Customer customer = new Customer();
        customer.setName("Harold Abernathy");
        customer.setAddress("Sheffield, UK");
        addCustomer(customer);
    }
    @GET
    public List getCustomers() {
        List customers = new ArrayList();
        customers.addAll(customerMap.values());
        return customers;
    }

    @GET
    @Path("{id}")
    public Customer getCustomer(@PathParam("id") int cId) {
        return customerMap.get(cId);
    }

    @POST
    @Path("add")
    @Produces(MediaType.TEXT_PLAIN)
    @Consumes(MediaType.APPLICATION_XML)
    public String addCustomer(Customer customer) {
        int id = customerMap.size();
        customer.setId(id);
        customerMap.put(id, customer);
        return "Customer" + customer.getName() + "added with Id" + id;
    }
}

4. 发布 Web Service应用

发布web service最快的方法是使用Run As或者Debug As MyEclipse Server Application.
1. 右键点击项目，选择Debug As(或者Run As)->MyEclipse Server Application.
2. 选择Myeclipse Tomcat(或自己加的Tomcat)，然后点击finish，完成发布