CXF发布restful WebService的入门例子(服务器端)

最新推荐文章于 2021-01-14 00:43:22 发布
最新推荐文章于 2021-01-14 00:43:22 发布
阅读量182 收藏
点赞数
CXF发布restful WebService的入门例子(服务器端)

研究了两天CXF对restful的支持。 
  现在，想实现一个以 
http://localhost:9999/roomservice 为入口， 
http://localhost:9999/roomservice/room为房间列表, 
http://localhost:9999/roomservice/room/001/ 为001号房间的信息， 
http://localhost:9999/roomservice/room/001/person 为在001号房间主的人的列表 

实现用HTTP请求对以上资源的CRUD。 

首先建立room,person的POJO，这里只有一点需要注意：

复制代码 
package com.DAO;  
  
import javax.xml.bind.annotation.XmlRootElement;  
  
@XmlRootElement(name="Person")  
public class Person {  
    private String name;  
    private String sex;  
    public String getName() {  
        return name;  
    }  
    public void setName(String name) {  
        this.name = name;  
    }  
    public String getSex() {  
        return sex;  
    }  
    public void setSex(String sex) {  
        this.sex = sex;  
    }  
      
}
复制代码

一定要在类的前边加上annotation ，这样才能让这个person的信息在POJO和XML之间转换。Room同理: 

复制代码 
import java.util.Map;  
  
import javax.xml.bind.annotation.XmlRootElement;  
  
@XmlRootElement(name="Room")  
public class Room {  
    public Room()  
    {  
        persons=new HashMap<String,Person>();  
    }  
    String id;  
    Map<String,Person> persons;  
      
    public String getId() {  
        return id;  
    }  
    public void setId(String id) {  
        this.id = id;  
    }  
    public Map<String, Person> getPersons() {  
        return persons;  
    }  
    public void setPersons(Map<String, Person> persons) {  
        this.persons = persons;  
    }  
}
复制代码

POJO有了，接下来要写DAO，由于主要是为了学习restful，为了方便，不必要将数据持久化到数据库，而是存在一个静态的HashMap中： 

复制代码 
package com.DAO;  
  
import java.util.HashMap;  
import java.util.Map;  
  
public class RoomDAO {  
    private static Map<String, Room> rooms;  
    static {  
        rooms = new HashMap<String, Room>();  
          
        Person p1=new Person();  
        p1.setName("Boris");  
        p1.setSex("male");  
          
          
          
        Room r=new Room();  
        r.setId("001");  
        r.getPersons().put(p1.getName(), p1);  
        rooms.put("001", r);  
    }  
  
    public static void addRoom(Room room) {  
        rooms.put(room.getId(), room);  
    }  
  
    public static void deleteRoom(String id) {  
        if (rooms.containsKey(id)) {  
            rooms.remove(id);  
        }  
  
    }  
  
    public static void updateRoom(String id,Room room) {  
        rooms.remove(id);  
        rooms.put(room.getId(), room);  
    }  
  
    public static Room getRoom(String id) {  
        if (rooms.containsKey(id)) {  
            return rooms.get(id);  
        } else {  
            return null;  
        }  
    }  
    /*operations to persons*/  
    public static void addPerson(String id_room,Person person) {  
        if(rooms.containsKey(id_room))  
        {  
            Room room=rooms.get(id_room);  
            room.getPersons().put(person.getName(), person);  
        }  
    }  
      
    public static Rooms getRooms()  
    {  
        return new Rooms();  
    }  
      
    public static void deletePerson(String id_room,String name)  
    {  
        if(rooms.containsKey(id_room))  
        {  
            Room room=rooms.get(id_room);  
            room.getPersons().remove(name);  
        }  
    }  
      
    public static Map<String, Room> getMapOfRooms()  
    {  
        return rooms;  
    }  
}
复制代码

接下来是重点，如果想发布restful webservice，要通过一个叫JAXRSServerFactoryBean的类来发布。这个类有几个方法是要了解的： 

public void setResourceClasses(Class... classes); 
那一系列的Class类型的参数，是告诉这个类，发布服务时，会用到的POJO（就像上边写的Room,Person）。 

public void setAddress(String address)； 
这个方法是告诉这个类，服务的地址，比如"http://localhost:9999" 

public void setServiceBeans(Object... beans) 
这里是重点，这个方法，要给这个用来发布服务的类一个Service bean.这个Bean是我们要手动编写的，作用是告诉服务，收到什么样的请求，应该怎么样处理。 

现在，先来编写这个Service bean： 

复制代码 
package com.server;  
  
import javax.ws.rs.Consumes;  
import javax.ws.rs.DELETE;  
import javax.ws.rs.GET;  
import javax.ws.rs.POST;  
import javax.ws.rs.PUT;  
import javax.ws.rs.Path;  
import javax.ws.rs.PathParam;  
import javax.ws.rs.Produces;  
  
import com.DAO.Person;  
import com.DAO.Room;  
import com.DAO.RoomDAO;  
import com.DAO.Rooms;  
  
@Path("/roomservice")  
@Produces("application/xml")  
public class RoomService {  
      
    @GET  
    @Path("/room/{id}")  
    @Consumes("application/xml")  
    public Room getRoom(@PathParam("id")String id )  
    {  
        System.out.println("get room by id= "+id);  
        Room room=RoomDAO.getRoom(id);  
        return room;  
    }  
    @GET  
    @Path("/room")  
    @Consumes("application/xml")  
    public Rooms getAllRoom()  
    {  
        System.out.println("get all room");  
        Rooms rooms=RoomDAO.getRooms();  
        return rooms;  
    }  
      
    @POST  
    @Path("/room")  
    @Consumes("application/xml")  
    public void addRoom(Room room)  
    {  
        System.out.println("add room which id is:"+room.getId());  
        RoomDAO.addRoom(room);  
    }  
    @PUT  
    @Path("/room/{id}")  
    @Consumes("application/xml")  
    public void updateRoom(@PathParam("id")String id,Room room)  
    {  
        System.out.println("update room which original id is:"+room.getId());  
        RoomDAO.updateRoom(id,room);  
    }  
    @DELETE  
    @Path("/room/{id}")  
    @Consumes("application/xml")  
    public void deleteRoom(@PathParam("id")String id)  
    {  
        System.out.println("remove room by id= "+id);  
        RoomDAO.deleteRoom(id);  
    }  
    @POST  
    @Path("/room/{id}")  
    @Consumes("application/xml")  
    public void addPerson(@PathParam("id") String id,Person person)  
    {  
        System.out.println("add person who's name is:"+person.getName());  
        RoomDAO.addPerson(id, person);  
    }  
    @DELETE  
    @Path("/room/{id}/{name}")  
    @Consumes("application/xml")  
    public void deletePerson(@PathParam("id")String id,@PathParam("name")String name)  
    {  
        System.out.println("remove person who's name is: "+name);  
        RoomDAO.deletePerson(id, name);  
    }  
}
复制代码

需要注意：每个方法之前，要用annotation声明http请求的method类型，比如GET,DELETE,POST, PUT. 
@Produces("application/xml")我还没弄清楚到底是声明的接受格式还是返回格式，还是其他。 

@Path("/room/{id}")中的id是一个参数，应该在方法的参数列表中声明： 
public void deletePerson(@PathParam("id")String id,@PathParam("name")String name) 
这样就能得到URL中的id了。 

现在，这些房间被资源化了，id为001的房间被资源化为一个URL，那地址应该是 
http:{服务器地址}:{端口}/roomservice/rrom/001   

现在，创建一个Server： 

复制代码 
package com.server;  
  
import org.apache.cxf.jaxrs.JAXRSServerFactoryBean;  
  
import com.DAO.Person;  
import com.DAO.Room;  
import com.DAO.Rooms;  
  
public class Server {  
  
    public static void main(String[] args) {  
        RoomService service = new RoomService();  
  
        // Service instance  
        JAXRSServerFactoryBean restServer = new JAXRSServerFactoryBean();  
        restServer.setResourceClasses(Room.class,Person.class,Rooms.class);  
        restServer.setServiceBeans(service);  
        restServer.setAddress("http://localhost:9999/");  
        restServer.create();  
    }  
}
复制代码

现在，服务已经发布成功了，在浏览器输入http://localhost:9999/roomservice/room/001  得到结果： 

复制代码 
<room>  
<id>001</id>  
−  
<persons>  
−  
<entry>  
<key>Boris</key>  
−  
<value>  
<name>Boris</name>  
<sex>male</sex>  
</value>  
</entry>  
</persons>  
</room>
复制代码

如果用浏览器去访问，发送的http请求只能所GET,因此如果想对数据进行操作，必须写一个客户端。 
在写客户端之前，有一个问题： 
在浏览器输入http://localhost:9999/roomservice/room/ 
什么都看不到，可是，我想要得到房间列表。但是，cxf发布restful只认你给他的类的class。所以你想让服务器返回一个room的列表给客户端，是不行的。所以，必须想别的办法，我是又写了一个POJO，这个POJO里只有一个属性，就是一个存放所有room的Map： 
package com.DAO; 

复制代码 
import java.util.Map;  
  
import javax.xml.bind.annotation.XmlRootElement;  
@XmlRootElement(name="rooms")  
public class Rooms {  
    Map<String,Room> rooms;  
    public Rooms()  
    {  
        rooms=RoomDAO.getMapOfRooms();  
    }  
    public Map<String, Room> getRooms() {  
        return rooms;  
    }  
    public void setRooms(Map<String, Room> rooms) {  
        this.rooms = rooms;  
    }  
}
复制代码

这样，然后再把DAO的方法加上： 

复制代码 
@GET  
    @Path("/room")  
    @Consumes("application/xml")  
    public Rooms getAllRoom()  
    {  
        System.out.println("get all room");  
        Rooms rooms=RoomDAO.getRooms();  
        return rooms;  
    }
复制代码

这样就能以list的形式显示出所有room了。 
访问http://localhost:9999/roomservice/room/ 
结果如下： 

复制代码 
<rooms>  
−  
<rooms>  
−  
<entry>  
<key>006</key>  
−  
<value>  
<id>006</id>  
<persons/>  
</value>  
</entry>  
−  
<entry>  
<key>001</key>  
−  
<value>  
<id>001</id>  
−  
<persons>  
−  
<entry>  
<key>Boris</key>  
−  
<value>  
<name>Boris</name>  
<sex>male</sex>  
</value>  
</entry>  
</persons>  
</value>  
</entry>  
</rooms>  
</rooms>
复制代码

 

转自 http://borissun.iteye.com/blog/765869

孙_小生
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
CXF发布restful WebService的入门例子.pdf
10-25
CXF发布restful WebService的入门例子.pdfCXF发布restful WebService的入门例子.pdf
通过CXF，开发rest协议接口（简单明了）
Alan_319的博客
09-25 746
1. 引入cxf的jar包   pom文件里面直接增加依赖                 junit           junit           4.11           test                       org.springframework           spring- webmvc           4.0.0.
使用cxf开发restful接口
Min_Monk的博客
11-02 765
新建maven工程 新建maven工程 添加pom依赖 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.ap...
用CXF来发布一个REST服务（服务端）
鸭梨山大山大的博客
03-13 260
** 一、创建pojo类 ** 添加注解@XmlRootElement ** 二、创建SEI和SEI实现类 ** Service Endpoint Interface 发布的服务接口： 在接口名上面声明@WebService和@Path 在接口方法名上面声明@GET/@POST、@Path、@Produces 实现类： ** 三、服务发布 ** ** 四、数据类型的切换 ** 方法一：...
使用cxf发布rest服务接口,和spring的整合
m0_37357607的博客
04-27 679
1.导入cxf和spring包,在webxml中配置 org.apache.cxf.transport.servlet.CXFServlet         CXFServlet         org.apache.cxf.transport.servlet.CXFServlet         1                   CXFServlet         
利用CXF发布restful WebService的注意事项（服务器端）
sunbo1591的专栏
09-17 242
研究了两天CXF对restful的支持。 现在，想实现一个以 http://localhost:9999/roomservice 为入口， http://localhost:9999/roomservice/room为房间列表, http://localhost:9999/roomservice/room/001/ 为001号房间的信息， http://localhost:9999/...
利用CXF发布restful WebService 研究
04-05
NULL 博文链接：https://zfms.iteye.com/blog/1526829
SpringBoot+Mybatis+CXF框架，实现Restful api与 WebService api接口的大实验
04-07
SpringBoot+Mybatis+CXF框架，实现Restful api与 WebService api接口的大实验
利用spring整合cxf，实现restful webservice接口，以及接口测试
混子
05-07 2179
第一步，肯定是导入cxf相关的jar包，自行去pom.xml里面添加依赖吧，因为我的项目他们已经搭好环境了，而且就是jar包引入的，没用maven。 第二布，配置web.xml，因为需要在项目启动时就加载 第三步，编写接口和实现类 实现类也很简单，就是一个简单的查询，然后将查询结果用GSON转成JSON字符串，然后封装在ResponseModel中 public class...
使用cxf开发REST服务
lizhao007
04-26 1756
什么是RESTREST是继SOAP以后，另一种广泛使用的Web服务。与SOAP不同，REST没有WSDL概念，也没有叫“信封”的东西，因为REST主张用一种简单粗暴的方式来表达数据，传递的数据格式可以使JSON格式也可以是XML格式，完全由用户决定。REST全称是表达性状态转移，源于REST之父的一篇论文，论文中提出REST6个特点，分别是：客户端-服务器的，无状态的，可缓存的，统一接口，分层系统和
CXF Restful服务简单例子
10-29
CXF Restful服务简单例子
WebService小白学习 之 使用CXF工具暴露接口 (2)
Lover
07-31 743
接着上篇  WebService小白学习 之 使用jdk实现暴露接口 本篇介绍使用CXF工具暴露接口，不过多介绍，主要看代码。 实现过程： 1、在pom.xml添加CXF需要jar包： &lt;dependencies&gt; &lt;!-- https://mvnrepository.com/artifact/org.apache.cxf/cxf-core --&gt; &lt...
Spring整合CXF开发基于rest的服务
高毅的博客
09-26 431
使用Spring整合CXF，开发rest的服务 一、服务端开发 1、创建Dynamic Web Project，具体略 2、创建pojo类 package com.xxx.cxf.pojo; import javax.xml.bind.annotation.XmlRootElement; @XmlRootElement(name = "student") public clas
使用Apache cxf 开发restful webservice 服务的实例
曾先森的专栏
11-07 1365
目前由于最近的项目使用的交互
CXF整合Spring发布Rest接口服务，以及客户端如何调用服务端接口
qq_37306041的博客
08-14 1499
1.创建web工程 2.导入jar包 3.编写接口以及实现类 3.1在编写接口之前需要注意一下这里用到的实体类 需要特别注意：需要在实体类前面添加注解 （XmlRootElement） package com.zit.entity; import java.io.Serializable; import javax.xml.bind.annotation.XmlRootElemen...
使用Spring与CXF编写rest服务
秀秀的博客
10-10 486
CXF与Rest服务 REST 是英文 Representational State Transfer 的缩写，有中文翻译为“具象状态传输”。REST 这个术语是由 Roy Fielding 在他的博士论文 《 Architectural Styles and the Design of Network-based Software Architectures 》中提出的。REST 并非标准，
使用CXF开发RESTFul服务
热门推荐
rockiecxh的专栏
02-26 1万+
使用CXF开发RESTFul服务 在各个系统交互领域，Web services逐渐成为主流。有两种主要方式来开发Web Services：Simple Object Access Protocol (SOAP)和Representational State Transfer (REST)   开发基于SOAP的Web Services需要很多的约束， 以便客户端和服务端交互信息，例如，使用W
CXF实现webService之restful风格的RS模式
xiaochao_bos的博客
12-28 597
以spring boot来整合jersey的restful风格是webservice
cxf调用接口的几种方式_cxf+spring发布webservice接口及接口的调用
weixin_28726671的博客
01-14 381
一、CXF介绍ApacheCXF=Celtix+XFire，ApacheCXF的前身叫ApacheCeltiXfire。CXF继承了Celtix和XFire两大开源项目的精华，提供了对JAX-WS全面的支持，并且提供了多种Binding、DataBinding、Transport以及各种Format的支持，并且可以根据实际项目的需要，采用代码优先(CodeFirst)或者WSDL优先(WSDLFi...
springboot整合cxf实现webservice
最新发布
08-25
CXF是一个开源的Web服务框架，它支持SOAP和RESTful风格的Web服务。将Spring Boot和CXF整合起来，可以方便地实现基于CXF的Web服务。 要实现Spring Boot整合CXF，首先需要添加相应的依赖。在pom.xml文件中，引入...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值