用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新项目
  1. 接受默认的文件夹路径,一路点击下一步;
image.png
  1. 在配置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的关键

  1. 右键点击restdemo项目,选择New->Other;
  2. 在筛选框中输入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类型。

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

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

添加第二个方法
  1. 然后点击该对话框的Add按钮,为方法添加参数,参数值直接在表格中输入和选择,如下图所示,然后点击finish
为方法添加参数
  1. 再添加一个增加顾客的方法,操作如上,具体参数如下图所示;
创建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<Integer, Customer> customerMap = new TreeMap<Integer, Customer>();
    public CustomersResource(){
        Customer customer = new Customer();
        customer.setName("Harold Abernathy");
        customer.setAddress("Sheffield, UK");
        addCustomer(customer);
    }
    @GET
    public List<Customer> getCustomers() {
        List<Customer> customers = new ArrayList<Customer>();
        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,完成发布

选择发布服务器

5. 浏览器中测试REST Web Service

到这步咱们的web service基本完成了,现在在浏览器中测试下。
1. 打开浏览器,在地址栏中输入http://localhost:<port>/<project name>/jaxrs/<your url path>/0
返回如下图的信息,表明成功。

查询一个顾客信息

2. 再测试下Add操作是否正常,使用chrome浏览器的Postman插件。

  • 输入http://localhost:8080/restdemo/jaxrs/customers/add
  • 选择POST方法
  • 在Headers中Key选择Content-Type,Value选择application/xml
  • 在Body中输入需要增加的顾客信息xml形式
  • 点击Send按钮,完成添加

测试Add方法

3.在浏览器中输入http://localhost:8080/restdemo/jaxrs/customers/,得到下图结果,看到添加成功

查询所有顾客
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,332评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,508评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,812评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,607评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,728评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,919评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,071评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,802评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,256评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,576评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,712评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,389评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,032评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,798评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,026评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,473评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,606评论 2 350

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,637评论 18 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,834评论 25 707
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,778评论 6 342
  • title: JavaScript兼容性date: 2016-11-22 20:56:06tags: JavaSc...
    刘刀文阅读 621评论 0 4
  • 直到今天,一丹采访放羊娃的那篇报道给我的印象还是那么的那么的深刻。虽然是在假TS里面听到的,但对我的影响非常深远。...
    模糊的雪铁龙阅读 188评论 0 0