关于REST的JSON格式

在这里简单的说下CXF对REST的支持，先对REST概念说下。

REST 是一种软件架构模式，只是一种风格，不是像SOAP 那样本身承载着一种消息协议，也可以叫做REST 是基于HTTP协议的软件架构。

    REST 中重要的两个概念就是资源定位和资源操作，而HTTP 协议恰好完整的提供了这两个要点，HTTP 协议中的URI 可以完成资源定位，GET、POST、OPTION等方法可以完成资源操作，因此REST 完全依赖HTTP 协议就可以完成Web 服务，而不像SOAP 协议那样只利用HTTP 的传输特性，定位与操作由SOAP 协议自身完成，也正是由于SOAP 消息的存在，使得SOAP 笨重。你也可以说REST 充分利用了HTTP 协议的特性，而不是像SOAP 那样只利用了其传输这一特性（事实上大多数人提到HTTP 协议就只会想到它能用于数据传输）。

REST 是一种软件架构理念，现在被移植到Web 服务上（因此不要提到REST 就马上想到WebService，JAX-RS 只是将REST 设计风格应用到Web 服务开发），那么在开发Web 服务上，偏于面向资源的服务适用于REST，偏于面向活动的服务。另外，REST 简单易用，效率高，SOAP 成熟度较高，安全性较好。REST 提供的网络服务叫做OpenAPI，它不仅把HTTP 作为传输协议，也作为处理数据的工具，可以说对HTTP 协议做了较好的诠释，充分体现了HTTP 技术的网络能力。目前Google、Amazon、淘宝都有基于REST 的OpenAPI 提供调用。

 

 

      WebService中,JAX-RS 只是将REST 设计应用到Web 服务开发.JAX-RS提供对了REST的支持

 

我们先看看具体的例子

1、接口类

 

 

Java代码  收藏代码
  1. <pre class="java" name="code">@Path("/rest_HelloWorld")  
  2. public interface Rest_HelloWorld {  
  3.   
  4.   
  5.     @GET   
  6.     @Produces (MediaType.TEXT_PLAIN)   
  7.     @Path("/say/{name}")   
  8.     public String say(@PathParam("name")String name);  
  9.       
  10.     @GET   
  11.     @Produces (MediaType.TEXT_PLAIN)   
  12.     @Path("/sayHello/{name}")   
  13.     public String sayHello(@PathParam("user")User user);  
  14.       
  15.     @GET   
  16.     @Produces ({MediaType.APPLICATION_JSON,MediaType.APPLICATION_XML})   
  17.     @Path("/getList/{id}")   
  18.     public List<User> getList(@PathParam("id")Long id);  
  19.       
  20. }</pre>  
  21.    

 

 

   CXF的Rest使用的JAX-RS规范。JAX-RS: Java API for RESTful Web Services是一个Java编程语言的应用程序接口,支持按照 表象化状态转变 (REST)架构风格创建Web服务Web服务. JAX-RS使用了Java SE 5引入的Java 标注来简化Web服务客户端和服务端的开发和部署。

 

JAX-RS提供了一些标注将一个资源类，一个POJOJava类，封装为Web资源。标注包括：

（1）、@Path，标注资源类或方法的相对路径

（2）、@GET，@PUT，@POST，@DELETE，标注方法是用的HTTP请求的类型

（3）、@Produces，标注返回的MIME媒体类型，（ 注解标注，这个注解可以包含一组字符串，默认值是*/*，它指定REST 服务的响应结果的MIME 类型，例如：application/xml、application/json、image/jpeg 等），你                     也可以同时返回多种类型，但具体生成结果时使用哪种格式取决于ContentType。CXF 默认返回的是JSON 字符串。

（4）、 @PathParam，@QueryParam，@HeaderParam，@CookieParam，@MatrixParam，@FormParam, 分别标注方法的参数来自于HTTP请求的不同位置，例如@PathParam来自于URL的路径，@QueryParam来自于URL的查询参 数，@HeaderParam来自于HTTP请求的头信息，@CookieParam来自于HTTP请求的Cookie。

 

 

注意：前两章说的CXF与spring整合及  都是使用JAX-WS规范。JAX-WS规范是一组XML web services的JAVA API。jaxws 是配置SOAP 方式的Web 服务

 

 

Spring中引入了两个新的名称空间jaxws、jaxrs，因为CXF 实现了Spring 的NamespaceHandler 接口，实现这个接口可以在Spring 中增加额外的配置。那么jaxws 自然是配置SOAP 方式的Web 服务，你可以看到有jaxws:server、jaxws:endpoint、jaxws:client 三个元素，jaxws:server 和jaxws:endpoint 是等效的，都用于发布Web 服务，出现jaxws:endpoint 的原因是JAX-WS 规范中使用EndPoint 发布Web 服务（前面使用过这种

方式），CXF 为了和JAX-WS 对应，提供了这个与jaxws:server 功能一样的配置元素；

jaxrs是REST 方式的Web 服务，有jaxrs:server、jaxrs:client 两个元素。

 

2、接口实现类

 

 

Java代码  收藏代码
  1. @Service("rest_HelloWorldImpl")  
  2. public class Rest_HelloWorldImpl implements Rest_HelloWorld {  
  3.   
  4.     public String say(String name) {  
  5.             return name+"，您好！";  
  6.     }  
  7.   
  8.     public String sayHello(User user) {  
  9.         return user.getName()+"，您好！";  
  10.     }  
  11.       
  12.     public List<User> getList(Long id){  
  13.         List<User> list = new ArrayList<User>();  
  14.           
  15.         Long sid=1L;  
  16.         User user = new User(sid,"张三"+sid,21);  
  17.         list.add(user);  
  18.           
  19.         sid=2L;  
  20.         user = new User(sid,"张三"+sid,21);  
  21.         list.add(user);  
  22.           
  23.         sid=3L;  
  24.         user = new User(sid,"张三"+sid,21);  
  25.         list.add(user);  
  26.         return list;  
  27.     }  
  28. }  

 

 

3、CXF在Spring中的配置

 

 

Java代码  收藏代码
  1. <?xml version="1.0" encoding="UTF-8"?>  
  2. <beans xmlns="http://www.springframework.org/schema/beans"  
  3.     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
  4.     xmlns:jaxws="http://cxf.apache.org/jaxws"  
  5.     xmlns:jaxrs="http://cxf.apache.org/jaxrs"  
  6.     xsi:schemaLocation=" http://www.springframework.org/schema/beans                       
  7.                     http://www.springframework.org/schema/beans/spring-beans.xsd                         
  8.                     http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd  
  9.                     http://cxf.apache.org/jaxrs http://cxf.apache.org/schemas/jaxrs.xsd">  
  10.     <import resource="classpath:META-INF/cxf/cxf.xml" />  
  11.     <import resource="classpath:META-INF/cxf/cxf-extension-soap.xml" />  
  12.     <import resource="classpath:META-INF/cxf/cxf-servlet.xml" />  
  13.       
  14.   
  15.     <bean id="inMessageInterceptor" class="org.apache.cxf.interceptor.LoggingInInterceptor" />  
  16.     <bean id="outMessageInterceptor" class="org.apache.cxf.interceptor.LoggingOutInterceptor"/>  
  17.   
  18.    <!--id:名称(随意配)，implementor:指定接口具体实现类，address:随意配-->  
  19.     <jaxws:endpoint id="helloWorld"  implementor="#HelloWorldImpl" address="/HelloWorld"  >  
  20.         <!-- 输入日志拦截器 -->  
  21.        <jaxws:inInterceptors>  
  22.             <ref bean="inMessageInterceptor"/>  
  23.        </jaxws:inInterceptors>  
  24.        <!-- 输出日志拦截器 -->  
  25.        <jaxws:outInterceptors>  
  26.           <ref bean="outMessageInterceptor"/>  
  27.        </jaxws:outInterceptors>  
  28.        <jaxws:properties>  
  29.           <entry key="mtom_enabled" value="true"></entry>  
  30.        </jaxws:properties>  
  31.     </jaxws:endpoint>  
  32.       
  33.     <jaxrs:server id="rest_HelloWorld" address="/">  
  34.         <jaxrs:inInterceptors>  
  35.            <ref bean="inMessageInterceptor"/>  
  36.         </jaxrs:inInterceptors>  
  37.         <jaxrs:outInterceptors>  
  38.             <ref bean="outMessageInterceptor"/>  
  39.         </jaxrs:outInterceptors>  
  40.         <jaxrs:serviceBeans>  
  41.             <ref bean="rest_HelloWorldImpl" />  
  42.         </jaxrs:serviceBeans>  
  43.         <jaxrs:extensionMappings>  
  44.             <entry key="json" value="application/json" />  
  45.             <entry key="xml" value="application/xml" />  
  46.         </jaxrs:extensionMappings>  
  47.         <jaxrs:languageMappings>  
  48.             <entry key="en" value="en-gb" />  
  49.         </jaxrs:languageMappings>  
  50.     </jaxrs:server>  
  51.   
  52.     <!-- WebService 客户端 spring 配置文件cxf与Spring集成，cxf里提供了一个工厂类org.apache.cxf.jaxws.JaxWsProxyFactoryBean，  
  53.     可以方便实现的调用WebService。serviceClass属性是接口类，address是webService的路径在其他bean里如果要调用webservice，  
  54.     只要将client这个bean注入到需要使用的bean里。-->  
  55.     <bean id="client" class="com.exp.service.outer.HelloWorld" factory-bean="clientFactory" factory-method="create" />  
  56.     <bean id="clientFactory" class="org.apache.cxf.jaxws.JaxWsProxyFactoryBean">  
  57.         <property name="serviceClass" value="com.exp.service.outer.HelloWorld" />  
  58.         <property name="address" value="http://localhost:8080/demo/webservice/HelloWorld" />  
  59.     </bean>  
  60. </beans>  

 

 

 

注意：以下代码是新增加代码

      xmlns:jaxrs="http://cxf.apache.org/jaxrs"

 

       http://cxf.apache.org/jaxrs http://cxf.apache.org/schemas/jaxrs.xsd

 

 

Java代码  收藏代码
  1. <jaxrs:server id="rest_HelloWorld" address="/">  
  2.         <jaxrs:inInterceptors>  
  3.            <ref bean="inMessageInterceptor"/>  
  4.         </jaxrs:inInterceptors>  
  5.         <jaxrs:outInterceptors>  
  6.             <ref bean="outMessageInterceptor"/>  
  7.         </jaxrs:outInterceptors>  
  8.         <jaxrs:serviceBeans>  
  9.             <ref bean="rest_HelloWorldImpl" />  
  10.         </jaxrs:serviceBeans>  
  11.         <jaxrs:extensionMappings>  
  12.             <entry key="json" value="application/json" />  
  13.             <entry key="xml" value="application/xml" />  
  14.         </jaxrs:extensionMappings>  
  15.         <jaxrs:languageMappings>  
  16.             <entry key="en" value="en-gb" />  
  17.         </jaxrs:languageMappings>  
  18.     </jaxrs:server>  

 

 

4、访问

    http://localhost:8080/demo/webservice/rest_HelloWorld/getList/1

 

返回JSON格式： http://localhost:8080/demo/webservice/rest_HelloWorld/getList/1?_type=json

返回XML格式： http://localhost:8080/demo/webservice/rest_HelloWorld/getList/1?_type=xml

 

得到结果

 

Java代码  收藏代码
    1. <Users>  
    2. <User>  
    3. <id>1</id>  
    4. <name>张三1</name>  
    5. <age>21</age>  
    6. </User>  
    7. <User>  
    8. <id>2</id>  
    9. <name>张三2</name>  
    10. <age>21</age>  
    11. </User>  
    12. <User>  
    13. <id>3</id>  
    14. <name>张三3</name>  
    15. <age>21</age>  
    16. </User>  
    17. </Users> 
posted @ 2014-03-14 08:51  菜鸟搞IT  阅读(3737)  评论(0)  编辑  收藏  举报