Spring整合CXF webservice restful实例详解
作者:汉有游女,君子于役 发布时间:2023-03-20 09:58:21
标签: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;
}
到这里,就介绍完了,大家手动去操作一下吧,有问题大家一块交流。
来源:http://www.cnblogs.com/edi-kai/archive/2017/08/10/CXFwebservicerestful.html
0
投稿
猜你喜欢
- 在实际开发中,我们经常会需要在页面跳转的时候携带路由参数,典型的例子就是从列表到详情页的时候,需要携带详情的 id,以便详情页获取对应的数据
- 复合语句Java的复合语句是以整个区块为单位的语句,由{}以及{}内包含的内容组成对于复合语句来说,复合语句创建了一个局部变量的作用域,该作
- 双向循环链表定义相比于单链表,有两个指针,next指针指向下一个结点,prior指针指向上一个结点,最后一个结点的next指针指向头结点,头
- maven 打包 动态启动脚本介绍如何通过maven的环境变量动态打包, 并动态改变启动脚本中的环境参数之前都是每个环境一个启动脚本, 其实
- MyBatis简介MyBatis是一个支持普通SQL查询,存储过程和高级映射的优秀持久层框架。MyBatis消除了几乎所有的JDBC代码和参
- 报错信息:java.lang.Exception: org.apache.hadoop.mapreduce.task.reduce.Shuf
- 要想使Java运行,我们可以设计一个面向Java语言特性的虚拟机,并通过编译器将Java程序转换为它可以识别的指令序列,也称为Java字节码
- Maven搭建springboot项目本文是基于Windows 10系统环境,使用Maven搭建springboot项目Windows 10
- 背景大家在使用Selenium + Chromedriver爬取网站信息的时候,以为这样就能做到不被网站的反爬虫机制发现。但是实际上很多参数
- 【前言】面向资源的 Restful 风格的 api 接口本着简洁,资源,便于扩展,便于理解等等各项优势,在如今的系统服务中越来越受欢迎。.n
- 一:什么是SparkSQL?(一)SparkSQL简介Spark SQL是Spark的一个模块,用于处理结构化的数据,它提供了一个数据抽象D
- 引言当我们通过@ConfigurationProperties注解实现配置 bean的时候,如果默认的配置属性转换无法满足我们的需求的时候,
- 1、Jetbrains官网下载IntelliJ IDEA1.1 官方网站http://www.jetbrains.com/idea/&nbs
- 本文实例为大家分享了java利用udp实现发送数据的具体代码,供大家参考,具体内容如下1.udp的特点数据以包的形式发送数据udp是面向无连
- 写在前面之前想尝试把JWT和Shiro结合到一起,但是在网上查了些博客,也没太有看懂,所以就自己重新研究了一下Shiro的工作机制,然后自己
- Java continue break 制作简单聊天室程序,屏蔽不文明语言,显示每句话聊天时间package com.swift;impor
- 实际需求<if test="computationRule == '1'"> F
- springboot启动失败的问题springboot版本是1.3.0.M1,连接的mysql版本为8,用spring-boot-start
- 原因分析使用ajax从前台页面传输数据到后台controller控制器的时候,出现中文乱码其实乱码问题出现的原因,就是由于默认的tomcat
- 在前后端分离的项目中后端返回的格式一定要友好,不然会对前端的开发人员带来很多的工作量。那么SpringBoot如何做到统一的后端返回格式呢?