使用 Spring 3 MVC HttpMessageConverter 功能构建 RESTful web 服务（3）

look_w

构建 RESTful web 服务在此部分中，学习构建可生成多个具象的简单 RESTful web 服务。示例应用程序中使用的一些资源在 “使用 Spring 3 构建 RESTful web 服务”（参见 ）中构建。还可以 示例代码。
首先，您必须配置 HttpMessageConverter。要生成多个具象，自定义几个 HttpMessageConverter 实例，以将对象转换为不同的媒体类型。此部分包括 JSON、ATOM 和 XML 媒体类型。
JSON从最简单的示例开始。JSON 是一个轻量型的数据交换格式，人们可轻松地进行读取和编写。清单 1 显示了配置 JSON converter 的代码。
清单 1. 配置 rest-servlet.xml 中的 HttpMessageConverter

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16

<bean class="org.springframework.web.servlet.mvc.annotation .AnnotationMethodHandlerAdapter">    <property name="messageConverters">        <list>            <ref bean="jsonConverter" />    <ref bean="marshallingConverter" />    <ref bean="atomConverter" />        </list>    </property> </bean> <bean id="jsonConverter"             class="org.springframework.http.converter.json .MappingJacksonHttpMessageConverter">    <property name="supportedMediaTypes" value="application/json" /> </bean>

在配置中，注册了 3 个转换程序。MappingJacksonHttpMessageConverter 用于将对象转换为 JSON，反之亦然。此内置转换程序使用 Jackson 的 ObjectMapper 将 JSON 映射到 JavaBean，因此您必须将下列 Jackson JAR 文件添加到类路径。

• org.codehaus.jackson.jar
• org.codehaus.jackson.mapper.jar

下一步是编写一个方法，处理请求 JSON 具象的请求。清单 2 显示了详细信息。
清单 2. 处理在 EmployeeController 中定义的 JSON 请求

1 2 3 4 5 6 7 8 9 10 11 12 13 14

@RequestMapping(method=RequestMethod.GET, value="/emp/{id}",         headers="Accept=application/json") public @ResponseBody Employee getEmp(@PathVariable String id) { Employee e = employeeDS.get(Long.parseLong(id)); return e; }       @RequestMapping(method=RequestMethod.GET, value="/emps",         headers="Accept=application/json") public @ResponseBody EmployeeListinggetAllEmp() { List<Employee> employees = employeeDS.getAll(); EmployeeListinglist = new EmployeeList(employees); return list; }

@ResponseBody 注释用于将返回对象（Employee 或 EmployeeList）变为响应的正文内容，将使用 MappingJacksonHttpMessageConverter  将其映射到 JSON。
使用 HttpMessageConverter 和 @ResponseBody，您可以实现多个具象，而无需包含 Spring 的视图技术 — 这是使用 ContentNegotiatingViewResolver 所不具有的一个优势。
现在您可以使用 CURL 或 REST Client Firefox 插件调用请求。记住添加一个 HTTP 头：Accept=application/json。清单 3 以 JSON 格式显示了所需的响应。
清单 3. getEmp() 和 getAllEmp() 的 JSON 结果

1 2 3 4 5 6 7 8 9

Response for /rest/service/emp/1 {"id":1,"name":"Huang Yi Ming","email":"huangyim@cn.ibm.com"} Response for /rest/service/emps {"count":2, "employees":[ {"id":1,"name":"Huang Yi Ming","email":"huangyim@cn.ibm.com"}, {"id":2,"name":"Wu Dong Fei","email":"wudongf@cn.ibm.com"} ]}

XMLSpring 的内置转换程序 MarshallingHttpMessageConverter 用于在对象和 XML (OXM) 之间进行映射。本示例使用 JAXB 2 作为转换程序的 marshaller/un-marshaller。清单 4 显示了配置。
清单 4. 配置 MarshallingHttpMessageConverter

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18

<bean id="marshallingConverter" class="org.springframework.http.converter.xml         .MarshallingHttpMessageConverter"> <constructor-arg ref="jaxbMarshaller" />     <property name="supportedMediaTypes" value="application/xml"/>       </bean>       <bean id="jaxbMarshaller"       class="org.springframework.oxm.jaxb.Jaxb2Marshaller">            <property name="classesToBeBound">       <list>         <value>dw.spring3.rest.bean.Employee</value>         <value>dw.spring3.rest.bean.EmployeeList</value>       </list>     </property>       </bean>

了解 JAXB 2 不能很好地支持 java.util.List<T> 到 XML 的映射很重要。常用实践是为对象集添加一个包装类。参见 “使用 Spring 3 构建 RESTful web 服务”（参见 ）或  源代码，了解此 JAXB 注释类的详细信息。
在处理请求的控制器中的方法如何？回顾一下  中的代码。发现在此处不需要添加任何代码一点也不奇怪。您只需要在 Accept 头中添加另一个支持的媒体类型，如下所示。

1	headers=”Accept=application/json, application/xml”

转换程序将对象正确地映射到请求的类型（JSON 或 XML）。清单 5 显示了请求 application/xml 具象的理想结果。
清单 5. getEmp() 和 getAllEmp() 的 XML 结果

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21

Response for /rest/service/emp/1 <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <employee>    <email>huangyim@cn.ibm.com</email>    <id>1</id>    <name>Huang Yi Ming</name> </employee> Response for /rest/service/emps <?xml version="1.0" encoding="UTF-8" standalone="yes"?>   <employees>   <count>2</count>     <employee>       <email>huangyim@cn.ibm.com</email>       <id>1</id>       <name>Huang Yi Ming</name>     </employee>     <employee>       <email>wudongf@cn.ibm.com</email>       <id>2</id><name>Wu Dong Fei</name>     </employee> </employees>