类型转换
基本类型转换
@RequestMapping("primitive")
public @ResponseBody String primitive(@RequestParam Integer value) {
return "Converted primitive " + value;
}
日期类型转换
@RequestMapping("date/{value}")
public @ResponseBody String date(@PathVariable @DateTimeFormat(iso=ISO.DATE) Date value) {
return "Converted date " + value;
}
通过@DateTimeFormat 注解来指定日期转换参数，可以通过pattern属性来指定日期格式，或者设置iso来指定日期格式，内置了两种iso：Date(yyyy-MM-dd),TIME(yyyy-MM-dd HH:mm:ss.SSSZ)。
以上是通过在方法中加注解来转换日期，如果不加注解会报错。可以通过配置自定义日期转换器来全局转换日期。
首先定义自定义日期转换器：
package org.springframework.samples.mvc.convert;
import org.apache.commons.lang3.time.DateUtils;
import org.springframework.core.convert.converter.Converter;
import org.springframework.stereotype.Component;
import java.text.ParseException;
import java.util.Date;
/**
* 自定义日期转换
* @author yg.huang
* @version v1.0
* DATE 2016/11/24
*/
@Component("customDateConverter")
public class CustomDateConverter implements Converter<String,Date>{
@Override
public Date convert(String source) {
try {
Date result= DateUtils.parseDate(source,"yyyy-MM-dd","yyyy-MM-dd HH:mm:ss");
return result;
} catch (ParseException e) {
return null;
}
}
}
配置Spring 文件，指定converters属性后，全局日期转换器即生效
<beans:bean id="conversionService" class="org.springframework.format.support.FormattingConversionServiceFactoryBean">
<beans:property name="formatters">
<beans:bean class="org.springframework.samples.mvc.convert.MaskFormatAnnotationFormatterFactory" />
</beans:property>
<beans:property name="converters">
<beans:ref bean="customDateConverter"/>
</beans:property>
</beans:bean>
也可以使用@InitBinder在Controller中注册PeropertyEditor来指定日期转换格式：
@InitBinder
public void initBinder(WebDataBinder binder) {
SimpleDateFormat simpleDateFormat=new SimpleDateFormat("yyyy@MM@dd@");
//binder.registerCustomEditor(Date.class,new CustomDateEditor(simpleDateFormat,true));
}
上面的代码生效后，全局转换器即失效，当前Controller会使用注册的PorpertyEditor转换日期。注意上述代码在当前Controller每次请求调用一次。
集合类型转换
@RequestMapping("collection")
public @ResponseBody String collection(@RequestParam Collection<Integer> values) {
return "Converted collection " + values;
}
请求url:/convert/collection?values=1&values=2&values=3&values=4&values=5和/convert/collection?values=1&values=2,3,4,5 都 可以转换成Collection
对象类型转换
@RequestMapping("value")
public @ResponseBody String valueObject(@RequestParam SocialSecurityNumber value) {
return "Converted value object " + value;
}
在使用了@RequestParam注解后，如果参数类型不是java基本类型，则会调用对象类型转换器ObjectToObjectConverter将参数转换成对象。参数类SocialSecurityNumber必须有参数为String的构造器，或者包含静态的返回类型为当前参数类型的valueOf方法，或者to+参数类型的方法，否则将会报转换错误。ObjectToObjectConverter的代码如下：
package org.springframework.samples.mvc.convert;
public final class SocialSecurityNumber {
private final String value;
public SocialSecurityNumber(String value) {
this.value = value;
}
@MaskFormat("###-##-####")
public String getValue() {
return value;
}
public static SocialSecurityNumber valueOf(@MaskFormat("###-##-####") String value) {
return new SocialSecurityNumber(value);
}
}
ObjectToObjectConverter首先会判断当前类是否包含toXX方法，XX为参数类型(SocialSecurityNumber)，如果没有toXX方法则去找当前是否有工厂方法valueOf，如果还没有找到，则判断当前类型是否有参数为String的构造器，如果以上都不满足，则抛出转换异常，代码如下：
@Override
public Object convert(Object source, TypeDescriptor sourceType, TypeDescriptor targetType) {
if (source == null) {
return null;
}
Class<?> sourceClass = sourceType.getType();
Class<?> targetClass = targetType.getType();
try {
// Do not invoke a toString() method
if (String.class != targetClass) {
Method method = getToMethod(targetClass, sourceClass);
if (method != null) {
ReflectionUtils.makeAccessible(method);
return method.invoke(source);
}
}
Method method = getFactoryMethod(targetClass, sourceClass);
if (method != null) {
ReflectionUtils.makeAccessible(method);
return method.invoke(null, source);
}
Constructor<?> constructor = getFactoryConstructor(targetClass, sourceClass);
if (constructor != null) {
return constructor.newInstance(source);
}
}
catch (InvocationTargetException ex) {
throw new ConversionFailedException(sourceType, targetType, source, ex.getTargetException());
}
catch (Throwable ex) {
throw new ConversionFailedException(sourceType, targetType, source, ex);
}
// If sourceClass is Number and targetClass is Integer, then the following message
// format should expand to:
// No toInteger() method exists on java.lang.Number, and no static
// valueOf/of/from(java.lang.Number) method or Integer(java.lang.Number)
// constructor exists on java.lang.Integer.
String message = String.format(
"No to%3$s() method exists on %1$s, and no static valueOf/of/from(%1$s) method or %3$s(%1$s) constructor exists on %2$s.",
sourceClass.getName(), targetClass.getName(), targetClass.getSimpleName());
throw new IllegalStateException(message);
}
private static Method getToMethod(Class<?> targetClass, Class<?> sourceClass) {
Method method = ClassUtils.getMethodIfAvailable(sourceClass, "to" + targetClass.getSimpleName());
return (method != null && targetClass.equals(method.getReturnType()) ? method : null);
}
private static Method getFactoryMethod(Class<?> targetClass, Class<?> sourceClass) {
Method method = ClassUtils.getStaticMethod(targetClass, "valueOf", sourceClass);
if (method == null) {
method = ClassUtils.getStaticMethod(targetClass, "of", sourceClass);
if (method == null) {
method = ClassUtils.getStaticMethod(targetClass, "from", sourceClass);
}
}
return method;
}
对象类型转换与数据绑定是区别的。数据绑定是将request参数绑定到javabean的属性上，javabean的属性名必须和参数名一样。对象类型转换必须由@RequestParam触发，加上此注解后则不会触发数据绑定，参数名必须和reqeuest参数一样。
格式化类型转换
SpringMVC允许在类型转换之前先对request参数格式化，格式化完成之后再转换类型。例如可以将千分符字符串格式化数字，1,000,000 ，格式成1000000。
通过向conversionService注册格式化工厂
<!-- Only needed because we install custom converters to support the examples in the org.springframewok.samples.mvc.convert package -->
<beans:bean id="conversionService" class="org.springframework.format.support.FormattingConversionServiceFactoryBean">
<beans:property name="formatters">
<beans:bean class="org.springframework.samples.mvc.convert.MaskFormatAnnotationFormatterFactory" />
</beans:property>
<beans:property name="converters">
<beans:ref bean="customDateConverter"/>
</beans:property>
</beans:bean>
定义格式化工厂，实现AnnotationFormatterFactory指定对使用什么注解的参数生效,实现getParser,getPrinter方法，在这里提供自己的格式处理类。
public class MaskFormatAnnotationFormatterFactory implements AnnotationFormatterFactory<MaskFormat> {
public Set<Class<?>> getFieldTypes() {
Set<Class<?>> fieldTypes = new HashSet<Class<?>>(1, 1);
fieldTypes.add(String.class);
return fieldTypes;
}
public Parser<?> getParser(MaskFormat annotation, Class<?> fieldType) {
return new MaskFormatter(annotation.value());
}
public Printer<?> getPrinter(MaskFormat annotation, Class<?> fieldType) {
return new MaskFormatter(annotation.value());
}
注册完成后，只要对参数使用定义的注解SpringMVC就会自动调用格式化工厂格式化参数，使用方法如下：
@RequestMapping("custom")
public @ResponseBody String customConverter(@RequestParam @MaskFormat("###-##-####") String value) {
return "Converted '" + value + "' with a custom converter";
}
JavaBean 属性绑定
JavaBean属性绑定非常简单，方法中直接定义JavaBean参数即可，只要JavaBean的属性名和request参数名一样，就会进行数据绑定。
@RequestMapping("bean")
public @ResponseBody String bean(JavaBean bean) {
return "Converted " + bean;
}
基本类型绑定
定义对应类型的属性即可
private Integer primitive;
如下代码可以将primitive参数绑定到JavaBean上
<a id="primitiveProp" class="textLink" href="<c:url value="/convert/bean?primitive=3" />">Primitive</a>
日期类型绑定
可@DateTimeFormat指定日期格式，也可以按照上文说的使用全局日期转换器，Controller中的@DataBind也可以转换
@DateTimeFormat(iso=ISO.DATE)
private Date date;
属性格式化
同参数格式一样，注册了参数格式化工厂后，就可以用注解指定需要格式化的属性。SpringMVC会调用格式化工厂先格式化request参数，再转换类型。
@MaskFormat("(###) ###-####")
private String masked;
<a id="maskedProp" class="textLink" href="<c:url value="/convert/bean?masked=(205) 333-3333" />">Masked</a>
集合属性绑定
private List<Integer> list;
可以通过如下方式：
<a id="listProp" class="textLink" href="<c:url value="/convert/bean?list=1&list=2&list=3" />">List Elements</a>
或
<a id="listProp" class="textLink" href="<c:url value="/convert/bean?list[0]=1&list[1]=2&list[2]=3" />">List Elements</a>
或
<a id="listProp" class="textLink" href="<c:url value="/convert/bean?list=1,2,3" />">List Elements</a>
日期集合属性绑定
@DateTimeFormat(iso=ISO.DATE)
private List<Date> formattedList;
<a id="formattedListProp" class="textLink"
href="<c:url value="/convert/bean?formattedList[0]=2010-07-04&formattedList[1]=2011-07-04" />">@Formatted List Elements</a>
Map属性绑定
// map will auto-grow as its dereferenced e.g. map[key]=value
private Map<Integer, String> map;
<a id="mapProp" class="textLink" href="<c:url value="/convert/bean?map[key1]=apple&map[key2]=pear" />">Map Elements</a>
JavaBean属性绑定
// nested will be set when it is referenced e.g. nested.foo=value
private NestedBean nested;
<a id="nestedProp" class="textLink" href="<c:url value="/convert/bean?nested.foo=bar&nested.list[0].foo=baz&nested.map[key].list[0].foo=bip" />">Nested</a>
