Spring整合CXF webservice restful实例详解

 更新时间:2017年08月10日 10:52:15   作者:汉有游女,君子于役  
这篇文章主要为大家详细介绍了Spring整合CXF webservice restful的实例,具有一定的参考价值,感兴趣的小伙伴们可以参考一下

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;
  }

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

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

相关文章

  • Java CompletableFuture使用方式

    Java CompletableFuture使用方式

    这篇文章主要介绍了Java CompletableFuture使用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-07-07
  • Spring的事务管理你了解吗

    Spring的事务管理你了解吗

    这篇文章主要为大家介绍了Spring的事务管理,具有一定的参考价值,感兴趣的小伙伴们可以参考一下,希望能够给你带来帮助
    2022-01-01
  • Java泛型之类型擦除实例详解

    Java泛型之类型擦除实例详解

    Java泛型在使用过程有诸多的问题,如不存在List<String>.class,List<Integer>不能赋值给List<Number>(不可协变),奇怪的ClassCastException等,这篇文章主要给大家介绍了关于Java泛型之类型擦除的相关资料,需要的朋友可以参考下
    2022-01-01
  • 精通Java List 按字段提取对象

    精通Java List 按字段提取对象

    这篇文章主要介绍了精通Java List 按字段提取对象的相关资料,需要的朋友可以参考下
    2023-11-11
  • Spring boot实现应用打包部署的示例

    Spring boot实现应用打包部署的示例

    本篇文章主要介绍了Spring boot实现应用打包部署的示例,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-11-11
  • 最优雅地整合 Spring & Spring MVC & MyBatis 搭建 Java 企业级应用(附源码)

    最优雅地整合 Spring & Spring MVC & MyBatis 搭建 Java 企业级应用(附源码)

    这篇文章主要介绍了最优雅地整合 Spring & Spring MVC & MyBatis 搭建 Java 企业级应用(附源码),本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-01-01
  • Java报错org.hibernate.TypeMismatchException的解决方法

    Java报错org.hibernate.TypeMismatchException的解决方法

    在Java开发领域,尤其是涉及到数据持久化的项目中,Hibernate是一款广泛使用的强大工具,然而,可能会在使用过程中遭遇各种报错,其中org.hibernate.TypeMismatchException就是一个让人头疼的问题,下面我们一起深入剖析这个报错信息
    2024-11-11
  • Sentinel熔断规则原理示例详解分析

    Sentinel熔断规则原理示例详解分析

    这篇文章主要介绍了Sentinel熔断规则,采用了示例代码的方式对Sentinel熔断规则进行了详细的分析,以便广大读者朋友们更易理解,有需要的朋友可以参考下
    2021-09-09
  • Mybatis insert方法主键回填和自定义操作

    Mybatis insert方法主键回填和自定义操作

    这篇文章主要介绍了Mybatis insert方法主键回填和自定义操作,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-07-07
  • java如何将可运行jar打包成exe可执行文件

    java如何将可运行jar打包成exe可执行文件

    Java程序完成以后,对于Windows操作系统习惯总是想双击某个exe文件就可以直接运行程序,这篇文章主要给大家介绍了关于java如何将可运行jar打包成exe可执行文件的相关资料,需要的朋友可以参考下
    2023-11-11

最新评论