webservice restful接口跟soap协议的接口实现大同小异,只是在提供服务的类/接口的注解上存在差异,具体看下面的代码,然后自己对比下就可以了。
用到的基础类
User.java
1
|
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
|
@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
1
|
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
|
@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协议的接口一样
1
|
2
3
4
5
6
7
8
9
|
<!-- 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整合配置
1
|
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
|
<? 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}
客户端调用代码如下:
1
|
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
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
1
|
2
3
4
5
6
7
8
9
10
11
12
|
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