CXF之八 RESTFul服务

最新推荐文章于 2026-01-09 15:15:24 发布
转载 最新推荐文章于 2026-01-09 15:15:24 发布 · 111 阅读 · 0
文章标签：

#java #web.xml

JAX-RS概述

JAX-RS是Java提供用于开发RESTful Web服务基于注解(annotation)的API。JAX-RS旨在定义一个统一的规范，使得Java程序员可以使用一套固定的接口来开发REST应用，避免了依赖第三方框架。同时JAX-RS使用POJO编程模型和基于注解的配置并集成JAXB，可以有效缩短REST应用的开发周期。JAX-RS只定义RESTful API，具体实现由第三方提供，如Jersey、Apache CXF等。

JAX-RS包含近五十多个接口、注解和抽象类：

  • javax.ws.rs包含用于创建RESTful服务资源的高层次（High-level）接 口和注解。
  • javax.ws.rs.core包含用于创建RESTful服务资源的低层次（Low-level）接口和注解。
  • javax.ws.rs.ext包含用于扩展JAX-RS API支持类型的APIs。

JAX-RS常用注解：

  • @Path：标注资源类或方法的相对路径。
  • @GET、@PUT、@POST、@DELETE：标注方法的HTTP请求类型。
  • @Produces：标注返回的MIME媒体类型。
  • @Consumes：标注可接受请求的MIME媒体类型。
  • @PathParam、@QueryParam、@HeaderParam、@CookieParam、@MatrixParam、@FormParam：标注方法的参数来自于HTTP请求的位置。@PathParam来自于URL的路径，@QueryParam来自于URL的查询参数，@HeaderParam来自于HTTP请求的头信息，@CookieParam来自于HTTP请求的Cookie。

服务端

下面用CXF发布一个图书馆RESTFul服务，实现书籍的查询、添加、删除和修改。CXF发布RESTFul服务需要引入cxf-rt-frontend-jaxrs，pom.xml配置如下。

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>study</groupId>
    <artifactId>cxfrestful</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>cxfrestful</name>
    <url>http://maven.apache.org</url>

    <properties>
        <!-- CXF版本 -->
        <cxf.version>3.1.1</cxf.version>
    </properties>

    <dependencies>
        <!-- CXF -->
        <dependency>
            <groupId>org.apache.cxf</groupId>
            <artifactId>cxf-rt-frontend-jaxrs</artifactId>
            <version>${cxf.version}</version>
        </dependency>
        <dependency>
            <groupId>org.apache.cxf</groupId>
            <artifactId>cxf-rt-transports-http</artifactId>
            <version>${cxf.version}</version>
        </dependency>
        <!-- 如果在tomcat或者其他servlet容器中发布服务，不需要引用cxf-rt-transports-http-jetty -->
        <dependency>
            <groupId>org.apache.cxf</groupId>
            <artifactId>cxf-rt-transports-http-jetty</artifactId>
            <version>${cxf.version}</version>
        </dependency>
        <!-- End CXF -->
    </dependencies>
</project>

书籍XML格式

<Book>
    <author>尼古拉·奥斯特洛夫斯基</author>
    <id>10</id>
    <name>钢铁是怎样炼成的？</name>
    <price>3.0</price>
</Book>

书籍实体类

package com.study.cxfrestful.domain;

import javax.xml.bind.annotation.XmlRootElement;

/**
 * 书籍实体类
 */
@XmlRootElement(name = "Book")
public class Book {
    // id
    private String id;

    // 书名
    private String name;
    // 作者
    private String author;
    // 价格
    private Double price;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getAuthor() {
        return author;
    }

    public void setAuthor(String author) {
        this.author = author;
    }

    public Double getPrice() {
        return price;
    }

    public void setPrice(Double price) {
        this.price = price;
    }

    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }
}

 

图书馆服务类

package com.study.cxfrestful.ws;

import java.util.HashMap;
import java.util.Map;

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 javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;

import com.study.cxfrestful.domain.Book;

/**
 * 图书馆服务
 * 
 */
@Path("/library")
@Produces("text/xml")
public class LibraryService {
    private Map<String, Book> books = new HashMap<String, Book>();

    public LibraryService() {
        init();
    }

    /**
     * 获取
     * 
     * @param id
     *            索引
     * @return 书
     */
    @GET
    @Path("/books/{id}/")
    public Book getBook(@PathParam("id") String id) {
        return books.get(id);
    }

    /**
     * 更新
     * 
     * @param book
     * @return
     */
    @PUT
    @Path("/books/")
    public Response updateBook(Book book) {
        Response r;
        if (book == null) {
            r = Response.noContent().build();
            return r;
        }

        String id = book.getId();
        Book b = books.get(id);
        if (b != null) {
            books.put(id, book);
            r = Response.ok(true, MediaType.TEXT_PLAIN).build();
        } else {
            r = Response.notModified().build();
        }

        return r;
    }

    /**
     * 添加
     * 
     * @param book
     * @return
     */
    @POST
    @Path("/books/")
    public Response addBook(Book book) {
        Response r;
        if (book == null) {
            r = Response.notModified().build();
        } else {
            books.put(book.getId(), book);
            r = Response.ok(true, MediaType.TEXT_PLAIN).build();
        }

        return r;
    }

    /**
     * 删除
     * 
     * @param book
     * @return
     */
    @DELETE
    @Path("/books/{id}/")
    public Response deleteBook(@PathParam("id") String id) {
        Response r;
        Book book = books.get(id);

        if (book == null) {
            r = Response.notModified("id不存在").build();
        } else {
            books.remove(id);
            r = Response.ok(book, MediaType.APPLICATION_XML).build();
        }

        return r;
    }

    /**
     * 初始化，在图书馆里加几本书
     */
    private void init() {
        Book book = null;

        book = new Book();
        book.setAuthor("优快云");
        book.setId("blog");
        book.setName("如何使用博客");
        book.setPrice(3.0);
        books.put(book.getId(), book);

        book = new Book();
        book.setAuthor("优快云");
        book.setId("app");
        book.setName("如何下载优快云移动客户端");
        book.setPrice(30.0);
        books.put(book.getId(), book);

        book = new Book();
        book.setAuthor("优快云");
        book.setId("resource");
        book.setName("如何下载优快云资源");
        book.setPrice(5.0);
        books.put(book.getId(), book);

        book = new Book();
        book.setAuthor("优快云");
        book.setId("rs");
        book.setName("JAX-RS详解");
        book.setPrice(15.0);
        books.put(book.getId(), book);
    }

}

 

客户端

查询书籍信息，在浏览器中输入http://localhost:8280/rest/library/books/app/ 
这里写图片描述

下面用Fiddler模拟POST、DELETE和PUT请求。

添加书籍

<Book>
    <author>鲁迅</author>
    <id>11</id>
    <name>朝花夕拾</name>
    <price>20.0</price>
</Book>

这里写图片描述

添加返回结果

HTTP/1.1 200 OK
Date: Fri, 31 Jul 2015 06:50:30 GMT
Content-Type: text/plain Date: Fri, 31 Jul 2015 06:50:30 GMT Content-Length: 4 Server: Jetty(9.2.10.v20150310) true

修改书籍

<Book>
    <author>鲁迅</author>
    <id>11</id>
    <name>朝花夕拾</name>
    <price>200.0</price>
</Book>

这里写图片描述

返回结果

HTTP/1.1 200 OK
Date: Fri, 31 Jul 2015 06:52:24 GMT
Content-Type: text/plain Date: Fri, 31 Jul 2015 06:52:24 GMT Content-Length: 4 Server: Jetty(9.2.10.v20150310) true

删除书籍

这里写图片描述

返回结果

HTTP/1.1 200 OK
Date: Fri, 31 Jul 2015 06:54:36 GMT
Content-Type: application/xml Date: Fri, 31 Jul 2015 06:54:36 GMT Content-Length: 147 Server: Jetty(9.2.10.v20150310) <?xml version="1.0" encoding="UTF-8" standalone="yes"?><Book><author>鲁迅</author><id>11</id><name>朝花夕拾</name><price>200.0</price></Book>

Tomcat中发布RESTful

CXF在Tomcat中发布服务，需要spring-Web支持，pom.xml配置如下。

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>study</groupId>
    <artifactId>cxfrestful</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>cxfrestful</name>
    <url>http://maven.apache.org</url>

    <properties>
        <!-- CXF版本 -->
        <cxf.version>3.1.1</cxf.version>
        <!-- Spring版本 -->
        <spring.version>4.1.7.RELEASE</spring.version>
    </properties>

    <dependencies>
        <!-- Spring -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-aop</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-aspects</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-beans</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-core</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-web</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <!-- End Spring -->
        <!-- CXF -->
        <dependency>
            <groupId>org.apache.cxf</groupId>
            <artifactId>cxf-rt-frontend-jaxrs</artifactId>
            <version>${cxf.version}</version>
        </dependency>
        <dependency>
            <groupId>org.apache.cxf</groupId>
            <artifactId>cxf-rt-frontend-jaxrs</artifactId>
            <version>${cxf.version}</version>
        </dependency>
        <dependency>
            <groupId>org.apache.cxf</groupId>
            <artifactId>cxf-rt-transports-http</artifactId>
            <version>${cxf.version}</version>
        </dependency>
        <!-- 如果在tomcat或者其他servlet容器中发布服务，不需要引用cxf-rt-transports-http-jetty -->
        <dependency>
            <groupId>org.apache.cxf</groupId>
            <artifactId>cxf-rt-transports-http-jetty</artifactId>
            <version>${cxf.version}</version>
        </dependency>
        <!-- End CXF -->
    </dependencies>
</project>

在web.xml中添加CXFServlet

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://java.sun.com/xml/ns/javaee"
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
    id="WebApp_ID" version="3.0">
    <display-name>cxfserver</display-name>

    <!-- Spring配置 -->   
    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath:beans.xml</param-value>
    </context-param>
    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>
    <!-- End Spring配置 -->

    <!-- CXF Servlet -->
    <servlet>
        <servlet-name>cxfservlet</servlet-name>
        <servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>cxfservlet</servlet-name>     
        <url-pattern>/rest/*</url-pattern>
    </servlet-mapping>
    <!-- End CXF Servlet -->    

    <welcome-file-list>
        <welcome-file>index.html</welcome-file>
        <welcome-file>index.jsp</welcome-file>
    </welcome-file-list>
</web-app>

在WEB-INF文件夹下创建cxf-servlet.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans" 
    xmlns:aop="http://www.springframework.org/schema/aop" 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns:jaxrs="http://cxf.apache.org/jaxrs" 
    xsi:schemaLocation="
        http://www.springframework.org/schema/aop  
        http://www.springframework.org/schema/aop/spring-aop.xsd 
        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">
    <bean id="libraryServiceBean" class="com.study.cxfrestful.ws.LibraryService"></bean>
    
    <jaxrs:server id="libraryServer" address="/">
        <jaxrs:serviceBeans>
            <ref bean="libraryServiceBean"/>
        </jaxrs:serviceBeans>       
    </jaxrs:server>
</beans>

 

Spring上下文配置beans.xml

<?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:aop="http://www.springframework.org/schema/aop" 
    xmlns:p="http://www.springframework.org/schema/p" xmlns:context="http://www.springframework.org/schema/context" 
    xmlns:tx="http://www.springframework.org/schema/tx" 
    xsi:schemaLocation="
    http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.0.xsd  
    http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.0.xsd  
    http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd  
    http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.0.xsd">

    <!-- <context:annotation-config /> -->

    <!-- 使Spring支持自动检测组件，如注解的Repository、Service、Controller -->
    <context:component-scan base-package="com.study" />
</beans>

启动Tomcat，在浏览器中输入http://<地址>/cxfrestserver/rest即可看到服务 
这里写图片描述

 

CXF实战之RESTFul服务(七)
达拉斯母牛
08-01 4213
JAX-RS是Java提供用于开发RESTful Web服务基于注解(annotation)的API。JAX-RS旨在定义一个统一的规范，使得Java程序员可以使用一套固定的接口来开发REST应用，避免了依赖第三方框架。JAX-RS只定义RESTful API，具体实现由第三方提供，如Jersey、Apache CXF等。
CXF+Spring搭建Restful接口服务
黄自豪的笔记本
05-13 982
之前项目中用CXF+Spring可以搭建WebService服务，后面发现cxf可以支持Restful规范的接口。于是，在接下去的练手项目中，打算用cxf+spring来搭建一个Restful接口服务。
java解析xml文件(dom)
weixin_30376509的博客
03-06 91
package com.xt.xmltest; import javax.xml.parsers.DocumentBuilder; import javax.xml.parsers.DocumentBuilderFactory; import javax.xml.parsers.ParserConfigurationException; import org.w3c....
使用cxf开发restful接口
Min_Monk的博客
11-02 966
新建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 restful_使用Apache CXF开发RESTful服务
最佳 Java 编程
06-09 528
cxf restful 介绍 如您所知，有两种开发Web服务的方法 简单对象访问协议（SOAP） 代表性状态转移（REST） 在继续学习如何使用Apache CXF创建基于REST的Web服务之前，我们将了解什么是REST。 REST不是一种技术，当然也不是某种标准。 它只是一种架构风格，它限制了如何以某种方式编写Web服务。 这种样式是由某个Roy Fielding定义的（您...
java cxf restful_基于cxf开发restful风格的Web Service
weixin_33603405的博客
02-13 385
一、写在前面webservice一些简单的其他用法和概念，就不在这里赘述了，相信大家都可以在网上查到，我也是一个新手，写这篇文章的目的一方面是想记录自己成长的历程，另一方面是因为学习这个的时候花了点时间，希望本文章能为大家节约点时间。当然描述的可能不到位，望谅解。二、创建项目2.1、创建公用接口project为了方便服务端和客户端调用接口可以先创建一个接口java project，单独建一个接口p...
Spring整合cxf发布restful服务
qq_32470379的博客
01-28 550
本文非原创，转载自 https://my.oschina.net/huangyong/blog/294324  ，对于作者表示感谢！ 现在您已经学会了如何使用 CXF 开发基于 SOAP 的 Web 服务，也领略了 Spring + CXF 这个强大的组合，如果您错过了这精彩的一幕，请回头看看这篇吧： Web Service 那点事儿（2） —— 使用 CXF 开发 SOAP 服务 今天我们
使用CXF开发RESTFul服务
夺宝奇兵的专栏
07-20 361
相信大家在阅读 CXF官方文档（http://cxf.apache.org/docs/index.html）时，总是一知半解。这里向大家推荐一本PacktPub.Apache.CXF.Web.Service.Development。目前，这本书是没有中文版的，为此笔者简单的写了一些经验总结。 CXF官方文档（http://cxf.apache.org/docs/index.html）时，总是一
blueprint整合cxf提供restful服务
u012734441的专栏
08-24 7596
blueprint整合cxf提供restful服务前段时间太过繁忙，一直没有抽出时间来继续更新博客，最近几天抽出时间开始重新开始osgi的专栏，在前几篇文章中一直写的是osgi相关知识中的基础篇，从今天开始编写osgi中的一些高级篇，如osgi相关的web服务，mybatis的引入、如何将osgi项目中的基础模块抽离出来等等。今天就从如何整合cxf开始。在这里整合cxf并不是使用cxf的webser
cxf 开发restful服务
05-31
Apache CXF是一个开源的服务框架，它允许开发者轻松地创建和消费Web服务，包括RESTful服务。本文将详细介绍如何使用CXF和Maven来开发RESTful服务。 首先，我们需要理解REST（Representational State Transfer）的...
基于ApacheCXF框架实现RESTful风格Web服务的Java企业级应用项目_采用Spring328集成CXF2712构建RESTfulAPI接口并部署于Tomc.zip
12-23
同时，Spring与CXF的结合使得开发者可以更轻松地创建RESTful风格的服务接口，管理服务生命周期，并处理客户端与服务端的交互。 RESTful API接口的设计遵循了HTTP协议的基本原则，如使用GET、POST、PUT、DELETE等...
SpringBoot+Mybatis+CXF框架，实现Restful api与 WebService api接口的大实验
04-07
SpringBoot+Mybatis+CXF框架，实现Restful api与 WebService api接口的大实验 本实验的主要目标是使用SpringBoot、Mybatis和CXF框架来实现Restful API和WebService API接口的大实验。下面是实验的详细介绍： 标题...
CXF Restful服务简单例子
10-29
【CXF Restful服务简单例子】\n\n在IT行业中，Apache CXF是一个广泛使用的开源框架，它允许开发人员创建和消费Web服务。RESTful（Representational State Transfer）是一种网络应用程序的设计风格和开发方式，基于...
Java 并发编程：JUC 包中原子操作类的原理和用法
m0_69632475的博客
01-09 345
通过上一部分的分析，我们应该基本理解了 CAS 的无锁思想，并对“魔法类” Unsafe 有了更全面的了解。这也是我们分析原子包的前提。接下来，让我们一步步分析 CAS 在 Java 中的应用。JDK5 之后，JUC 包提供了包，该包下提供了大量基于 CAS 的原子操作类。如果在未来你不希望对程序代码加锁，但又想避免线程安全问题，那么可以使用该包下提供的类。Atomic 包提供的操作类主要可以分为以下四种类型：基本类型原子操作类引用类型原子操作类数组类型原子操作类属性更新原子操作类。
面向微服务事件驱动与异步消息可靠处理的互联网系统高可用设计与多语言工程实践分享
2501_94180531的博客
01-05 540
事件驱动解耦服务，提高吞吐可靠投递与幂等消费保证消息一致性监控、重试与顺序控制是稳定性的关键微服务事件驱动与异步消息可靠处理，使系统在高并发和复杂业务场景下保持稳定与可控。通过在多语言系统中统一幂等语义、结合可靠投递、顺序控制和监控策略，互联网系统能够在异步流程中实现高可用和长期可维护性。这篇关于事件驱动与异步消息可靠处理的工程实践分享，希望为你在微服务高可用设计中提供可落地、长期有效的参考思路。
Java 25 switch - 表达式多条件判断
最新发布
java界的小学生
01-09 116
Java 25 switch - 表达式多条件判断 记录模式‌：支持复杂对象的模式匹配。
windows下的守护进程|nssm
slongzhang的博客
01-06 1194
NSSM（Non-Sucking Service Manager）是Windows系统中将普通程序封装为系统服务的工具。使用步骤包括：下载解压NSSM，以管理员身份运行CMD/PowerShell；通过图形界面或命令行安装服务，配置可执行文件路径、参数等；使用start/stop/restart命令管理服务；支持通过edit命令修改配置或remove删除服务；建议配置日志功能方便排查问题。核心功能是实现进程守护，确保程序异常退出后自动重启。
Web开发者进阶AI：Agent技能设计模式之迭代分析与上下文聚合实战
沛哥儿的专栏
01-09 633
迭代有界：必须设置maxDepth（如同Web分页的maxPage） 上下文隔离：按会话ID分区存储（Redis key前缀隔离） 技能自治：每个Skill保持无状态（如同RESTful原则）
Apache CXF架构下Restful服务实现详解
Apache CXF 是一个开源的服务框架，它帮助开发者构建和开发Web服务，特别是SOAP和RESTful Web服务。RESTful是一种架构风格，它利用HTTP协议本身的特性来设计Web服务，强调资源的无状态访问和统一接口。在本案例中，...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值