SpringMVC4.x源码分析（七）：使用XStream处理xml请求和响应消息实战

最新推荐文章于 2023-01-17 21:04:26 发布

weixin_33817333

最新推荐文章于 2023-01-17 21:04:26 发布

阅读量266

点赞数

文章标签： java python postman

原文链接：https://my.oschina.net/zudajun/blog/1833033

版权

2019独角兽企业重金招聘Python工程师标准>>>

本节使用MarshallingHttpMessageConverter+xstream来处理xml请求和响应消息，首先加入spring-oxm和xstream的依赖包。

<dependencies>
<dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.12</version>
    <scope>test</scope>
</dependency>

<dependency>
    <groupId>javax.servlet</groupId>
    <artifactId>javax.servlet-api</artifactId>
    <version>3.0.1</version>
    <scope>provided</scope>
</dependency>

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-oxm</artifactId>
    <version>4.3.17.RELEASE</version>
</dependency>

<dependency>
    <groupId>com.thoughtworks.xstream</groupId>
    <artifactId>xstream</artifactId>
    <version>1.4.10</version>
</dependency>

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-webmvc</artifactId>
    <version>4.3.17.RELEASE</version>
</dependency>
</dependencies>

接着配置springmvc-config.xml：

<context:component-scan base-package="com.spring"/>                                                    
<mvc:annotation-driven/>                                                                               
                                                                                                       
<bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter"       
      p:messageConverters-ref="messageConverters" p:order="0"/>                                       
<util:list id="messageConverters">                                                                     
    <bean class="org.springframework.http.converter.ByteArrayHttpMessageConverter" />                  
    <bean class="org.springframework.http.converter.StringHttpMessageConverter" />                     
    <bean class="org.springframework.http.converter.xml.SourceHttpMessageConverter" />                 
    <bean class="org.springframework.http.converter.support.AllEncompassingFormHttpMessageConverter" />
    <bean class="org.springframework.http.converter.xml.MarshallingHttpMessageConverter">              
        <property name="marshaller" ref="marshaller" />                                                
        <property name="unmarshaller" ref="marshaller" />                                              
    </bean>                                                                                            
</util:list>                                                                                           
                                                                                                       
<bean id="marshaller" class="org.springframework.oxm.xstream.XStreamMarshaller">                       
    <property name="annotatedClasses">                                                                 
        <list>                                                                                         
            <value>com.spring.model.User</value>                                                       
        </list>                                                                                        
    </property>                                                                                        
</bean>                                                                                                
                                                                                                       
<bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">     
    <property name="prefix" value="/WEB-INF/jsp/" />                                                   
    <property name="suffix" value=".jsp" />                                                            
</bean>

由于我们同时配置了<mvc:annotation-driven />和自定义的RequestMappingHandlerAdapter，容器中就存在2个RequestMappingHandlerAdapter实例，为了保证自定义的生效（优先级最高），于是配置自定义的order值为0，保证其具有最高优先级。

其次，配置了XStreamMarshaller的annotatedClasses，那么User对象就可以使用XStream的注解进行精细控制xml的样式。

@XStreamAlias("user")
public class User {

    private String name;

    private Integer age;

    @XStreamConverter(DateConvertor.class)
    private Date date;
//...
}

在进行日期格式转换时，如果要处理形如yyyy-MM-dd这样的格式，我们需要自定义xstream的属性转换器。

public class DateConvertor implements Converter {

    @Override
    public boolean canConvert(Class type) {
        return Date.class == type;
    }

    @Override
    public void marshal(Object value, HierarchicalStreamWriter writer, MarshallingContext context) {
        SimpleDateFormat dateFm = new SimpleDateFormat("yyyy-MM-dd");
        writer.setValue(dateFm.format(value));
    }

    @Override
    public Object unmarshal(HierarchicalStreamReader reader, UnmarshallingContext context) {
        GregorianCalendar calendar = new GregorianCalendar();
        SimpleDateFormat dateFm = new SimpleDateFormat("yyyy-MM-dd");
        try {
            calendar.setTime(dateFm.parse(reader.getValue()));
        } catch (ParseException e) {
            throw new ConversionException(e.getMessage(), e);
        }
        return calendar.getTime();
    }
}

Controllor:

@RequestMapping(path = {"/jsonOrXml"})          
@ResponseBody                                   
public User jsonOrXml(@RequestBody User user) { 
    System.out.println(user);                   
    return user;                                
}

启动服务，使用Postman模拟发送xml数据：

如果我们不用@XStreamAlias("user")来给User取别名，那么，需要使用类的全限名。

中文乱码问题：

XStreamMarshaller可以指定一个streamDriver，可能有人使用的下面的配置指定了StaxDriver：

<bean id="xStreamMarshaller" class="org.springframework.oxm.xstream.XStreamMarshaller">
    <property name="streamDriver">                                                     
        <bean class="com.thoughtworks.xstream.io.xml.StaxDriver" />                    
    </property>                                                                        
    <property name="annotatedClasses">                                                 
        <list>                                                                         
            <value>com.spring.model.User</value>                                       
        </list>                                                                        
    </property>                                                                        
</bean>

此时，笔者实验时发生了中文乱码，且带有xml声明，但是声明又缺少encoding属性：

网上说的通过指定supportedMediaTypes，并在后面追加字符集(application/xml;charset=UTF-8)的办法，并不能解决StaxDriver产生的中文乱码问题。

两种解决办法：

1、不要使用StaxDriver，保持默认。

2、使用其他的streamDriver，比如DomDriver

<bean id="xStreamMarshaller" class="org.springframework.oxm.xstream.XStreamMarshaller">
    <property name="streamDriver">                                                     
        <bean class="com.thoughtworks.xstream.io.xml.DomDriver">                       
            <constructor-arg name="encoding" value="UTF-8" />                          
        </bean>                                                                        
    </property>                                                                        
</bean>

-----------------

Spring在处理O/X相互转换时，抽象出了Marshaller和Unmarshaller统一的接口，Spring提供了多种策略实现类，用来分别支持JAXB、Castor、JiBX和XStream等这些第三方O/X处理技术，本例使用的是XStream。

-----------------

总结：本文演练了<mvc:annotation-driven />和自定义SpringMVC组件共存时的处理办法，也演练了如何配置消息转换器列表，以代替默认的消息转换器列表，当自定义web组件和默认组件同时存在时，并非完全覆盖，而是共存，需要通过配置顺序，或者直接指定order值来确保自定义组件优先级更高，使其生效。

原文出处：http://my.oschina.net/zudajun

转载于:https://my.oschina.net/zudajun/blog/1833033