Spring整合CXF webservice restful实例详解
时间:2019-03-31
本文章向大家介绍Spring整合CXF webservice restful实例详解,主要包括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; }
到这里,就介绍完了,大家手动去操作一下吧,有问题大家一块交流。
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。
- Go语言中Socket通信之Tcp客户端
- Oracle 12c PDB迁移及ORA-00600错误分析和解决(r10笔记第72天)
- 【Go 语言社区】epoll详解
- Oracle 12c数据库升级实战(r10笔记第70天)
- Oracle 12c升级检查问题分析(r10笔记第69天)
- 转--使用Revel(go)开发网站
- GoldenGate数据迁移的问题总结(二)(r10笔记第85天)
- Elasticsearch究竟要设置多少分片数?
- 设计模式(1)-使用简单工厂优化代码
- 简单易学的机器学习算法——因子分解机(Factorization Machine)
- Elasticsearch全文检索实战小结——复盘我带的第二个项目
- golang语言是如何处理栈的
- 【Go 语言社区】并发性
- GoldenGate数据迁移的问题总结(一)(r10笔记第84天)
- java教程
- Java快速入门
- Java 开发环境配置
- Java基本语法
- Java 对象和类
- Java 基本数据类型
- Java 变量类型
- Java 修饰符
- Java 运算符
- Java 循环结构
- Java 分支结构
- Java Number类
- Java Character类
- Java String类
- Java StringBuffer和StringBuilder类
- Java 数组
- Java 日期时间
- Java 正则表达式
- Java 方法
- Java 流(Stream)、文件(File)和IO
- Java 异常处理
- Java 继承
- Java 重写(Override)与重载(Overload)
- Java 多态
- Java 抽象类
- Java 封装
- Java 接口
- Java 包(package)
- Java 数据结构
- Java 集合框架
- Java 泛型
- Java 序列化
- Java 网络编程
- Java 发送邮件
- Java 多线程编程
- Java Applet基础
- Java 文档注释
- 不同版本的Google Analytics做跨站跟踪
- 记一次 base64 图片存储引发后端查询接口性能断崖式下降问题全程解析
- JDBC+MySQL实战
- LeetCode 08字符串转整数&&09回文数
- React 17 RC 版发布:无新特性,却有新期待!
- 《剑指offer》第13天:两个数组的交集
- Spring的Controller是单例还是多例?怎么保证并发的安全
- JQUERY获取loaded 宽高这么变态
- 动态规划的楼层算法
- 58.Vue 使用render方法渲染组件
- xinetd被动服务唤醒
- Bash特殊变量:$0, $#, $*, $@, $?, $$实战
- 0799-1.8-CDSW1.8的新功能
- socket.io实践干货
- 0800-5.16.2-如何禁用Hue中Oozie的部分Action