使用Apache CXF开发RESTful服务

最新推荐文章于 2023-05-18 14:16:27 发布
最新推荐文章于 2023-05-18 14:16:27 发布
阅读量376 收藏
点赞数
文章标签： spring java http vue python ViewUI

介绍

如您所知，有两种开发Web服务的方法

  1. 简单对象访问协议（SOAP）
  2. 代表性状态转移（REST）

在继续学习如何使用Apache CXF创建基于REST的Web服务之前，我们将了解什么是REST。 REST不是一项技术，当然也不是某种标准。 这只是一种架构风格，它限制了如何以某种方式编写Web服务。 这种样式是由某个Roy Fielding在2000年定义的（您猜对了，是的，他是HTTP的架构师之一）。REST体系结构的主要主角是资源 ，可以由统一资源标识符或URI 。 在任何给定时间点资源的状态由文件表示，称为资源的表示 。 客户端可以通过将表示形式与请求一起传送来更新资源状态。 现在，新的表示形式将与响应一起返回给客户端。 该表示形式包含资源接受的html，xml，JSON等格式的信息。 遵守REST体系结构规则的资源称为RESTfull资源，遵守此规则的Web服务称为RESTfull Web服务。

创建一个项目以包含您的Web服务

我通常使用maven Strut2入门原型在struts2 + spring中进行Web开发，以创建我的Web项目。 要在我的项目中使用CXF，我将以下依赖项添加到我的POM中 

<dependency>
	<groupId>org.apache.cxf</groupId>
	<artifactId>cxf-rt-frontend-jaxws</artifactId>
	<version>${cxf.version}</version>
</dependency>
<dependency>
	<groupId>org.apache.cxf</groupId>
	<artifactId>cxf-rt-transports-http</artifactId>
	<version>${cxf.version}</version>
</dependency>
<dependency>
	<groupId>org.apache.cxf</groupId>
	<artifactId>cxf-rt-transports-http-jetty</artifactId>
	<version>${cxf.version}</version>
</dependency>

非maven用户可以在以下链接中找到要添加的依赖项的详细信息： http : //cxf.apache.org/docs/using-cxf-with-maven.html 。 可以从此处直接下载CXF： http : //cxf.apache.org/download.html

如何创建CXF RESTfull Web服务？

假设您想使用CXF创建RESTfull Web服务来管理个人书架中的书。 您通常需要在书架上执行以下操作

  1. 新增书籍
  2. 更新书籍信息
  3. 从书架上删除一本书
  4. 拿书
  5. 获取图书清单
  6. 按作者姓名获取图书清单

需要执行以下步骤来创建这样的服务

  1. 创建BookVO，BookList（值对象）以在请求和响应中作为表示形式传递。
  2. 将对象与请求和响应绑定。
  3. 创建服务实现类以接受请求并生成响应。
  4. 使用CXF容器注册您的Web服务。
  5. 在Web容器中部署服务。
  6. 创建客户端以调用服务上的方法。

获取本教程的源代码

我已经在SVN中提交了本教程的源文件。

注意：这两个都是ItelliJ maven项目，因此您可以将它们直接导入到intelliJ IDE或手动将文件复制到其他IDE

创建BookVO（值对象）以在请求和响应中作为表示形式传递。

BookVO类 
package com.aranin.weblog4j.vo;

import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
import java.io.Serializable;

@XmlRootElement(name="Book")
public class BookVO implements Serializable{

private long bookId;
private String bookName;
private String author;

public long getBookId() {
return bookId;
}

public void setBookId(long bucketId) {
this.bookId = bookId;
}

public String getBookName() {
return bookName;
}

public void setBookName(String bookName) {
this.bookName = bookName;
}

public String getAuthor() {
return author;
}

public void setAuthor(String author) {
this.author = author;
}
}
图书清单类 
package com.aranin.weblog4j.vo;

import javax.xml.bind.annotation.XmlRootElement;
import java.util.ArrayList;
import java.util.List;

@XmlRootElement(name="BookList")
public class BookList {
private List<BookVO> bookList;

public List<BookVO> getBookList() {
if(bookList == null){
bookList = new ArrayList<BookVO>();
}
return bookList;
}

public void setBookList(List<BookVO> bookList) {
this.bookList = bookList;
}
}

将数据对象（即BookVO）与请求和响应绑定

要将BookVO与请求或响应绑定，需要将其序列化为XML或JSON流。 序列化需要使用数据绑定组件之一来完成。 CXF使用JAXB作为默认数据绑定组件。 JaXB使用@XmlRootElement批注将数据对象映射到xml。 您可以在上面的代码中看到XmlRootElement批注的使用。

创建服务实现类以接受请求并生成响应

让我们看看CXF RestFull Web服务的外观。 我们将创建一个BookService类，该类将对BookSelf执行添加，更新，删除和获取操作。

BookService类别 
package com.aranin.weblog4j.services.rest;

import com.aranin.weblog4j.hashdb.HashDB;
import com.aranin.weblog4j.vo.BookVO;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.ws.rs.*;
import javax.ws.rs.core.Response;
import java.io.UnsupportedEncodingException;
import java.net.URLDecoder;

/**
 * Created by IntelliJ IDEA.
 * User: Niraj Singh
 * Date: 3/13/13
 * Time: 3:58 PM
 * To change this template use File | Settings | File Templates.
 */
public class BookService {

protected final Logger log = LoggerFactory.getLogger(BookService.class);

    @POST
    @Path("/getbook/{name}")
    @Produces({"application/xml","application/json"})
    @Consumes({"application/xml","application/json","application/x-www-form-urlencoded"})
    public Response getBucket(@PathParam("name") String name) {
        log.debug("name : " + name);
        BookVO bookVO = null;
        try {
            bookVO = HashDB.getBook(URLDecoder.decode(name, "UTF-8"));
        } catch (UnsupportedEncodingException e) {
            e.printStackTrace();  //To change body of catch statement use File | Settings | File Templates.
        }

        if(bookVO == null){
            return Response.status(Response.Status.BAD_REQUEST).build();
        }else{
            return Response.ok(bookVO).build();
        }
    }

    @POST
    @Path("/addbook")
    @Produces({"application/xml","application/json"})
    @Consumes({"application/xml","application/json","application/x-www-form-urlencoded"})
    public Response addBook(@FormParam("name") String bookName,
                            @FormParam("author") String author) {
        log.debug("inside addBook");
        BookVO bookVO = new BookVO();
        bookVO.setBookName(bookName);
        bookVO.setAuthor(author);
        HashDB.insertBook(bookVO);
        if(HashDB.getBook(bookName) == null){
            return Response.status(Response.Status.BAD_REQUEST).build();
        }else{
            return Response.ok(bookVO).build();
        }

    }
}

您可以在BookService类的getBook和addBook中看到两个方法。 它们是获取和添加书籍的服务方法。 其余的更新删除等方法可以用相同的方式编写。 现在，让我们看看各种注释和方法调用的含义。

  • @POST –表示服务仅接收POST请求。
  • @Path –这是Web服务的路径。 因此，可以使用以下URL <base_url> / bookservice / getbook / {name}进行获取，使用<base_url> / bookservice / addbook进行添加来调用Web服务。
  • @Produces –指示生成的响应的MIME类型。 在我们的例子中，它既是application / xml也是application / json。
  • @Consumes –指示此服务可以使用的请求的MIME类型。

使用CXF容器注册您的Web服务。

CXF的一件很酷的事情是，它使用基于Spring的配置来注册其Web服务端点，因此让我们在WEB-INF中创建beans.xml并在web.xml中配置CXF。 首先，我们需要连接beans.xml以通过spring容器加载。 

<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>/WEB-INF/beans.xml,/WEB-INF/applicationContext.xml</param-value>
</context-param>

其次，将注册CXFServlet加载到web.xml中。 

<servlet>
<servlet-name>CXFServlet</servlet-name>
<display-name>CXF Servlet</display-name>
<servlet-class>
org.apache.cxf.transport.servlet.CXFServlet
</servlet-class>
<load-on-startup>2</load-on-startup>
</servlet>

<servlet-mapping>
<servlet-name>CXFServlet</servlet-name>
<url-pattern>/*</url-pattern>
</servlet-mapping>

现在打开bean.xml并注册bookservice端点。 

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:jaxws="http://cxf.apache.org/jaxws"
    xmlns:jaxrs="http://cxf.apache.org/jaxrs"
	xsi:schemaLocation="

http://www.springframework.org/schema/beans

http://www.springframework.org/schema/beans/spring-beans.xsd

http://cxf.apache.org/jaxrs

http://cxf.apache.org/schemas/jaxrs.xsd

http://cxf.apache.org/jaxws

http://cxf.apache.org/schemas/jaxws.xsd">

	<import resource="classpath:META-INF/cxf/cxf.xml" />
	<import resource="classpath:META-INF/cxf/cxf-extension-soap.xml" />
	<import resource="classpath:META-INF/cxf/cxf-servlet.xml" />

	<jaxws:endpoint
	  id="bookShelfService"
	  implementor="com.aranin.weblog4j.services.BookShelfServiceImpl"
	  address="/bookshelfservice" />

    <bean id="bookserviceclass" class="com.aranin.weblog4j.services.rest.BookService"/>

    <jaxrs:server id="bookservice" address="/bookservice">
        <jaxrs:serviceBeans>
        <ref bean="bookserviceclass" />
        </jaxrs:serviceBeans>
    </jaxrs:server>

</beans>

现在您的Web服务已准备就绪。 构建您的Web应用程序并将其部署在任何servlet容器中。

为您的Web服务创建客户端

可以通过多种方式创建客户端，我已经使用apache Http Components编写了客户端。 这些库可以在http://hc.apache.org/httpclient-3.x/中找到。

Maven用户可以使用以下命令拉动Http组件jar 

<dependency>
<groupId>commons-httpclient</groupId>
<artifactId>commons-httpclient</artifactId>
<version>3.1</version>
</dependency>

<dependency>
<groupId>org.apache.httpcomponents</groupId>
<artifactId>httpclient</artifactId>
<version>4.1.3</version>
<scope>compile</scope>
</dependency>

<dependency>
<groupId>org.apache.httpcomponents</groupId>
<artifactId>httpmime</artifactId>
<version>4.1.3</version>
<scope>compile</scope>
</dependency>

现在调用Web服务，我创建了一个名为DemoRestClient的util类。 

package com.aranin.weblog4j.client;

import com.aranin.weblog4j.vo.BookVO;
import org.apache.commons.httpclient.Header;
import org.apache.commons.httpclient.HttpClient;
import org.apache.commons.httpclient.methods.PostMethod;

import java.net.URLEncoder;

/**
 * Created by IntelliJ IDEA.
 * User: Niraj Singh
 * Date: 3/13/13
 * Time: 4:15 PM
 * To change this template use File | Settings | File Templates.
 */
public class DemoRestClient {
    public static void main(String[] args){
        DemoRestClient restClient = new DemoRestClient();
        try {
            //restClient.addBook("Naked Sun", "Issac Asimov");
            restClient.getBook("Naked Sun");
        } catch (Exception e) {
            e.printStackTrace(); //To change body of catch statement use File | Settings | File Templates.
        }

    }

    public BookVO getBook(String bookName) throws Exception {

        String output = null;
        try{
            String url = "http://localhost:8080/weblog4jdemo/bookservice/getbook/";

            url = url + URLEncoder.encode(bookName, "UTF-8");

            HttpClient client = new HttpClient();
            PostMethod mPost = new PostMethod(url);
            client.executeMethod( mPost );
            Header mtHeader = new Header();
            mtHeader.setName("content-type");
            mtHeader.setValue("application/x-www-form-urlencoded");
            mtHeader.setName("accept");
            mtHeader.setValue("application/xml");
            mPost.addRequestHeader(mtHeader);
            client.executeMethod(mPost);
            output = mPost.getResponseBodyAsString( );
            mPost.releaseConnection( );
            System.out.println("out : " + output);
        }catch(Exception e){
            throw new Exception("Exception in retriving group page info : " + e);
        }
        return null;
    }

    public void addBook(String bookName, String author) throws Exception {

        String output = null;
        try{
            String url = "http://localhost:8080/weblog4jdemo/bookservice/addbook";
            HttpClient client = new HttpClient();
            PostMethod mPost = new PostMethod(url);
            mPost.addParameter("name", "Naked Sun");
            mPost.addParameter("author", "Issac Asimov");
            Header mtHeader = new Header();
            mtHeader.setName("content-type");
            mtHeader.setValue("application/x-www-form-urlencoded");
            mtHeader.setName("accept");
            mtHeader.setValue("application/xml");
            //mtHeader.setValue("application/json");
            mPost.addRequestHeader(mtHeader);
            client.executeMethod(mPost);
            output = mPost.getResponseBodyAsString( );
            mPost.releaseConnection( );
            System.out.println("output : " + output);
        }catch(Exception e){
        throw new Exception("Exception in adding bucket : " + e);
        }

    }

}

运行此客户端以查看Web服务的输出。 现在，它将发送xmloutput，因为响应接受标头为“ application / xml”。 您可以将其更改为application / json以获得json输出。

多数民众赞成。 这是使用apache CXF开发RestFull Web服务的非常基本的介绍，还有很多要探索的内容。 愉快的探索，直到那再见。 如果您阅读了此文章，请留下一些评论，以使我不断受到启发。

参考： Weblog4j博客上的JCG合作伙伴 Niraj Singh 使用Apache CXF开发RESTful服务 。

翻译自: https://www.javacodegeeks.com/2013/07/developing-restful-services-using-apache-cxf.html

dnc8371
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
SpringBoot整合CXF发布WebService接口，及动态调用（用户名和密码验证）
SuperSunnyBoy的博客
03-25 7356
服务端继承AbstractPhaseInterceptor<T>，来实现AuthInterceptor的权限控制功能
用cxf框架搭建webservice服务（spring的xml方式和springboot方式）
csdnbeyoung的博客
07-12 2117
一、基于cxf框架，在spring框架中搭建webservice服务 步骤1，创建一个maven项目，首先导入spring相关依赖,再导入cxf依赖，配置tomcat插件等相关插件 <properties> <spring.version>4.2.4.RELEASE</spring.version> </properties> ...
使用CXF开发RESTFul服务
夺宝奇兵的专栏
05-11 211
 相信大家在阅读 CXF官方文档（http://cxf.apache.org/docs/index.html）时，总是一知半解。这里向大家推荐一本PacktPub.Apache.CXF.Web.Service.Development。目前，这本书是没有中文版的，为此笔者简单的写了一些经验总结。 CXF官方文档（http://cxf.apache.org/docs/index.html）时，...
java cxf服务端_使用Apache CXF开发WebServices服务端
weixin_39564755的博客
03-06 252
在前一篇的博客中，我使用Xfire1.x来开发了WebServies的服务端。但是如果你访问Apache的官网，可以看到xfire已经被合并了。最新的框架叫做CXF。Apache CXF = Celtix + XFire。CXF 继承了 Celtix 和 XFire 两大开源项目的精华，提供了对 JAX-WS 全面的支持，并且提供了多种 Binding 、DataBinding、Transport...
彻底了解｜利用Apache CXF框架开发WebService
浅羽技术
11-04 431
前言WebService是为了支持网络的机器间操作交互而设计用来开发分布式的交互操作的应用程序组件，通常被定义为一组模块化的API，他们可以通过网络进行调用，来执行远程系统的请求服务，而...
RestClient:使用Apache CXF http的RESTful Web服务客户端的示例
05-20
RestClient 使用Apache CXF的RESTful Web服务客户端示例
ApacheCXF:Apache CXF Web服务开发代码
05-14
的ApacheCXF Apache CXF Web服务开发 第1章-熟悉CXF 第2章-使用CXF开发Web服务 第3章-使用CXF前端 第4章-了解服务传输 第5章-实现高级功能 第6章-使用CXF开发RESTful服务 第7章-使用CXF部署RESTful服务 第8章-使用...
SpringCxfRestDemo:这将包含使用 Apache CXF 和 Spring 的 Restful 服务的演示项目
06-16
SpringCxfRestDemo 这将包含使用 Apache CXF 和 Spring 以及 IBatis 的 Restful 服务的演示项目。
基于Apache CXF构建SOA应用
04-29
应用、 传输协议 （Transports） 应用， 并隆重推出了 Apache CXF框架如何实现 RESTful 服务、如何支持动态语言和 WS-* 规范 等，另外，还包括 Apache CXF 框架一些高级功能的用法。最后，本书还描述了 Apache CXF ...
Restful Web Services with Apache CXF
06-02
Restful Web Service开发可供参考
cxf webservice restful实现
08-08
spring整合cxf实现restful的webservice服务，代码分为服务端和客户端两个模块；服务端为接口，客户端为接口调用。
schema_reference.4: 无法读取方案文档 'http://cxf.apache.org/schema/jaxws.xsd', 原因为 1) 无法找到文档; 2) 无法读取文档; 3)
桃欢李笑
07-21 1万+
CXF配置是出现错误：schema_reference.4: 无法读取方案文档 'http://cxf.apache.org/schema/jaxws.xsd', 原因为 1) 无法找到文档; 2) 无法读取文档; 3)
Java 使用CXF自动发布WebService服务
Wcybaonier
05-18 467
description：自动发布接口地址注解*/@Component/***description：发布地址功能描述:CXF配置类
使用apache.cxf调用webservice接口
qq_28326501的博客
11-05 947
1.引入jar包 <dependency> <groupId>org.apache.cxf</groupId> <artifactId>cxf-rt-frontend-jaxws</artifactId> <version>3.3.4</version> </dependency> <dependency> <groupId>org.apache
CXF发布restful接口
个人新博客: https://cbbfcd.github.io/
06-30 1757
其实发布一个webService接口，除了soap技术，cxf结合spring开发restful接口是很方便的，十分钟就可以搞定。 话不多说，步骤：
CXF创建webservice客户端和服务端
热门推荐
永恒の_☆
07-13 4万+
一、CXF的介绍 Apache CXF是一个开源的WebService框架，CXF大大简化了Webservice的创建，同时它继承了XFire的传统，一样可以和spring天然的进行无缝的集成。CXF框架是一种基于servlet技术的SOA应用开发框架，要正常运用基于CXF应用框架开发的企业应用，除了CXF应用本身之外，还需要JDK和servlet容器的支持。 二、CXF的准备条件 所需要的
spring整合cxf实现restful webservice
Code-Create-World
08-08 691
WebService入门 WebService(注解),CXF框架(jax-ws,Jax-rs,与spring整合)       研究webservice也好几天了，百度上纷繁错杂的文章令人眼花缭乱，看着都头疼，有的文章讲的更不知从何说起；好在终于找到上面两份连贯性的文章，就此让我对webservice有了系统的认识，也知道如何去进行代码的实现；       那么既然已经了解的差不多了，
apache-cxf4
最新发布
02-03
总的来说，Apache CXF是一个功能强大、高度可扩展、易于使用的WebService框架。它提供了丰富的功能和工具，使得开发者可以轻松地构建各种类型的WebService应用程序，并且易于集成与其他框架和组件。它的广泛应用于...

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值