Spring整合CXF webservice restful实例详解

发布时间 - 2026-01-11 02:43:48    点击率:

webservice restful接口跟soap协议的接口实现大同小异,只是在提供服务的类/接口的注解上存在差异,具体看下面的代码,然后自己对比下就可以了。

用到的基础类

User.java

@XmlRootElement(name="User")
public class User {

  private String userName;
  private String sex;
  private int age;
  
  public User(String userName, String sex, int age) {
    super();
    this.userName = userName;
    this.sex = sex;
    this.age = age;
  }
  
  public User() {
    super();
  }

  public String getUserName() {
    return userName;
  }
  public void setUserName(String userName) {
    this.userName = userName;
  }
  public String getSex() {
    return sex;
  }
  public void setSex(String sex) {
    this.sex = sex;
  }
  public int getAge() {
    return age;
  }
  public void setAge(int age) {
    this.age = age;
  }
  
  public static void main(String[] args) throws IOException {
    System.setProperty("http.proxySet", "true"); 

    System.setProperty("http.proxyHost", "192.168.1.20"); 

    System.setProperty("http.proxyPort", "8080");
    
    URL url = new URL("http://www.baidu.com"); 

    URLConnection con =url.openConnection(); 
    
    System.out.println(con);
  }
}

接下来是服务提供类,PhopuRestfulService.java

@Path("/phopuService")
public class PhopuRestfulService {


  Logger logger = Logger.getLogger(PhopuRestfulServiceImpl.class);

  @GET
  @Produces(MediaType.APPLICATION_JSON) //指定返回数据的类型 json字符串
  //@Consumes(MediaType.TEXT_PLAIN) //指定请求数据的类型 文本字符串
  @Path("/getUser/{userId}")
  public User getUser(@PathParam("userId")String userId) {
    this.logger.info("Call getUser() method...."+userId);
    User user = new User();
    user.setUserName("中文");
    user.setAge(26);
    user.setSex("m");
    return user;
  }

  @POST
  @Produces(MediaType.APPLICATION_JSON) //指定返回数据的类型 json字符串
  //@Consumes(MediaType.TEXT_PLAIN) //指定请求数据的类型 文本字符串
  @Path("/getUserPost")
  public User getUserPost(String userId) {
    this.logger.info("Call getUserPost() method...."+userId);
    User user = new User();
    user.setUserName("中文");
    user.setAge(26);
    user.setSex("m");
    return user;
  }
}

web.xml配置,跟soap协议的接口一样

<!-- CXF webservice 配置 -->
  <servlet>
    <servlet-name>cxf-phopu</servlet-name>
    <servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class>
  </servlet>
  <servlet-mapping>
    <servlet-name>cxf-phopu</servlet-name>
    <url-pattern>/services/*</url-pattern>
  </servlet-mapping>

Spring整合配置

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
  xmlns:p="http://www.springframework.org/schema/p"
  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-3.0.xsd
    http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd
    http://cxf.apache.org/jaxrs http://cxf.apache.org/schemas/jaxrs.xsd">
  <import resource="classpath:/META-INF/cxf/cxf.xml" />
  <import resource="classpath:/META-INF/cxf/cxf-servlet.xml" />
  <import resource="classpath:/META-INF/cxf/cxf-extension-soap.xml" />

  <!-- 配置restful json 解析器 , 用CXF自带的JSONProvider需要注意以下几点
  -1、dropRootElement 默认为false,则Json格式会将类名作为第一个节点,如{Customer:{"id":123,"name":"John"}},如果配置为true,则Json格式为{"id":123,"name":"John"}。
  -2、dropCollectionWrapperElement属性默认为false,则当遇到Collection时,Json会在集合中将容器中类名作为一个节点,比如{"Customer":{{"id":123,"name":"John"}}},而设置为false,则JSon格式为{{"id":123,"name":"John"}}
  -3、serializeAsArray属性默认为false,则当遇到Collecion时,格式为{{"id":123,"name":"John"}},如果设置为true,则格式为[{"id":123,"name":"john"}],而Gson等解析为后者
  
  <bean id="jsonProviders" class="org.apache.cxf.jaxrs.provider.json.JSONProvider">
    <property name="dropRootElement" value="true" />
    <property name="dropCollectionWrapperElement" value="true" />
    <property name="serializeAsArray" value="true" />
  </bean>
 -->
  <!-- 服务类 -->
  <bean id="phopuService" class="com.phopu.service.PhopuRestfulService" />
  <jaxrs:server id="service" address="/">
    <jaxrs:inInterceptors>
      <bean class="org.apache.cxf.interceptor.LoggingInInterceptor" />
    </jaxrs:inInterceptors>
    <!--serviceBeans:暴露的WebService服务类-->
    <jaxrs:serviceBeans>
      <ref bean="phopuService" />
    </jaxrs:serviceBeans>
    <!--支持的协议-->
    <jaxrs:extensionMappings>
      <entry key="json" value="application/json"/>
      <entry key="xml" value="application/xml" />
      <entry key="text" value="text/plain" />
    </jaxrs:extensionMappings>
    <!--对象转换-->
    <jaxrs:providers>
      <!-- <ref bean="jsonProviders" /> 这个地方直接用CXF的对象转换器会存在问题,当接口发布,第一次访问没问题,但是在访问服务就会报错,等后续在研究下 -->
      <bean class="org.codehaus.jackson.jaxrs.JacksonJaxbJsonProvider" />
    </jaxrs:providers>
  </jaxrs:server>
  
</beans>

客户端调用示例:

对于get方式的服务,直接在浏览器中输入http://localhost:8080/phopu/services/phopuService/getUser/101010500 就可以直接看到返回的json字符串

{"userName":"中文","sex":"m","age":26} 

客户端调用代码如下:

public static void getWeatherPostTest() throws Exception{
    String url = "http://localhost:8080/phopu/services/phopuService/getUserPost";
    HttpClient httpClient = HttpClients.createSystem();
    //HttpGet httpGet = new HttpGet(url); //接口get请求,post not allowed
    HttpPost httpPost = new HttpPost(url);
    httpPost.addHeader(CONTENT_TYPE_NAME, "text/plain");
    StringEntity se = new StringEntity("101010500");
    se.setContentType("text/plain");
    httpPost.setEntity(se);
    HttpResponse response = httpClient.execute(httpPost);

    int status = response.getStatusLine().getStatusCode();
    log.info("[接口返回状态吗] : " + status);

    String weatherInfo = ClientUtil.getReturnStr(response);

    log.info("[接口返回信息] : " + weatherInfo);
  }

客户端调用返回信息如下:

ClientUtil类是我自己封装的一个读取response返回信息的类,encoding是UTF-8

public static String getReturnStr(HttpResponse response) throws Exception {
    String result = null;
    BufferedInputStream buffer = new BufferedInputStream(response.getEntity().getContent());
    byte[] bytes = new byte[1024];
    int line = 0;
    StringBuilder builder = new StringBuilder();
    while ((line = buffer.read(bytes)) != -1) {
      builder.append(new String(bytes, 0, line, HTTP_SERVER_ENCODING));
    }
    result = builder.toString();
    return result;
  }

到这里,就介绍完了,大家手动去操作一下吧,有问题大家一块交流。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。


# Spring  # CXF  # webservice  # restful  # 详解Spring boot+CXF开发WebService Demo  # Spring boot 整合CXF开发web service示例  # spring整合cxf框架实例  # Spring Boot 实现Restful webservice服务端示例代码  # spring如何集成cxf实现webservice接口功能详解  # 格式为  # 默认为  # 客户端  # 设置为  # 就可以  # 就会  # 第一个  # 会在  # 作为一个  # 几点  # 大同小异  # 自带  # 报错  # 会将  # 需要注意  # 大家多多  # 存在问题  # 器中  # 但是在  # 只是在 


相关栏目: 【 网站优化151355 】 【 网络推广146373 】 【 网络技术251813 】 【 AI营销90571


相关推荐: Laravel如何实现多表关联模型定义_Laravel多对多关系及中间表数据存取【方法】  Laravel如何使用Eloquent ORM进行数据库操作?(CRUD示例)  Laravel如何使用.env文件管理环境变量?(最佳实践)  如何用免费手机建站系统零基础打造专业网站?  如何在浏览器中启用Flash_2025年继续使用Flash Player的方法【过时】  免费网站制作appp,免费制作app哪个平台好?  常州企业网站制作公司,全国继续教育网怎么登录?  如何快速使用云服务器搭建个人网站?  Java类加载基本过程详细介绍  详解Nginx + Tomcat 反向代理 负载均衡 集群 部署指南  laravel怎么在请求结束后执行任务(Terminable Middleware)_laravel Terminable Middleware请求结束任务执行方法  Android滚轮选择时间控件使用详解  制作ppt免费网站有哪些,有哪些比较好的ppt模板下载网站?  怎样使用JSON进行数据交换_它有什么限制  Laravel Vite是做什么的_Laravel前端资源打包工具Vite配置与使用  如何在阿里云购买域名并搭建网站?  如何基于云服务器快速搭建个人网站?  移动端脚本框架Hammer.js  Laravel如何设置自定义的日志文件名_Laravel根据日期或用户ID生成动态日志【技巧】  怎么用AI帮你为初创公司进行市场定位分析?  Laravel中Service Container是做什么的_Laravel服务容器与依赖注入核心概念解析  Laravel如何使用API Resources格式化JSON响应_Laravel数据资源封装与格式化输出  如何批量查询域名的建站时间记录?  高防服务器租用指南:配置选择与快速部署攻略  Laravel 419 page expired怎么解决_Laravel CSRF令牌过期处理  微信小程序 canvas开发实例及注意事项  北京的网站制作公司有哪些,哪个视频网站最好?  Laravel Livewire是什么_使用Laravel Livewire构建动态前端界面  Android okhttputils现在进度显示实例代码  如何用wdcp快速搭建高效网站?  惠州网站建设制作推广,惠州市华视达文化传媒有限公司怎么样?  lovemo网页版地址 lovemo官网手机登录  JavaScript Ajax实现异步通信  Laravel怎么配置自定义表前缀_Laravel数据库迁移与Eloquent表名映射【步骤】  如何用好域名打造高点击率的自主建站?  大连网站制作公司哪家好一点,大连买房网站哪个好?  智能起名网站制作软件有哪些,制作logo的软件?  如何在宝塔面板创建新站点?  怎么制作一个起泡网,水泡粪全漏粪育肥舍冬季氨气超过25ppm,可以有哪些措施降低舍内氨气水平?  详解Android图表 MPAndroidChart折线图  Win11怎么设置默认图片查看器_Windows11照片应用关联设置  胶州企业网站制作公司,青岛石头网络科技有限公司怎么样?  Laravel如何优化应用性能?(缓存和优化命令)  北京网站制作费用多少,建立一个公司网站的费用.有哪些部分,分别要多少钱?  bootstrap日历插件datetimepicker使用方法  Windows家庭版如何开启组策略(gpedit.msc)?(安装方法)  Java遍历集合的三种方式  html5audio标签播放结束怎么触发事件_onended回调方法【教程】  如何用JavaScript实现文本编辑器_光标和选区怎么处理  edge浏览器无法安装扩展 edge浏览器插件安装失败【解决方法】