10分钟学会SpringMVC数据转换和格式化

一、转换器

Spring有两种自动类型转换器，一种是Converter,一种是propertyEditor。

两者的区别：Converter是类型转换成类型，Editor:从string类型转换为其他类型。

某种程度上，Converter包含Editor。如果出现需要从string转换到其他类型。首选Editor。

使用内置的CustomDateEditor

在需要使用转换器的controller中使用内置的CustomDateEditor

@InitBinder
public void init (WebDataBinder binder) {
    CustomDateEditor dateEditor = new CustomDateEditor(new SimpleDateFormat("yyyy-MM-dd"), true);
    binder.registerCustomEditor(Date.class, dateEditor);
}

实现自定义Converter

public class StringToDateConverter implements Converter<String, Date> {
    public Date convert(String dateStr) {
        // 实例方法，实际在该方法里面实现更多代码
        return new SimpleDateFormat("yyyy-MM-dd").parse(dateStr);
    }
}

上面是我们简单的定义了一个从字符串到日期的转换器，定义完之后我们需要注册一下它。

<mvc:annotation-driven conversion-service="conversionService" />

<bean name="conversionService" class="org.springframework.context.support.ConversionServiceFactoryBean">
  <property name="converters">
    <list>
      <bean class="com.lzx.converter.StringToDateConverter" />
    </list>
  </property>
</bean>

二、格式化（Formatter）

在spring中我们用到的最多的格式器是@DateTimeFormat和@NumberFormat。

使用格式化器的原因是：前台传过来的数据是个字符串，我们要把它转换成我们想要的数据格式。

使用格式化转换器

该注解使用到实体类中的字段上面。

public class FormatDemo{

	// @DateTimeFormat(iso = DateTimeFormat.ISO.DATE)
	@DateTimeFormat(pattern = "yyyy-MM-dd")
	Date date;
	
	@NumberFormat(pattern = "##,###.00")
	BigDecimal price;
	
}

自定义格式化转换器

在实现自定义格式化转换器前，我们可以去看一下@DateTimeFormat注解的源码，便于我们理解spring mvc是如何实现数据转换的。

主要是以下三个类，可以去ide中查找看一下：

• DateTimeFormat(注解)
• DateTimeFormatAnnotationFormatterFactory
  
• DateFormatter

下面我们来定义一个身份证号的转化器，改转换器具有以下功能：

• 判断身份证号是否正确
• 通过身份证号读取籍贯、年龄和性别，返回一个字符串

定义IdNumberFormat注解

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER, ElementType.ANNOTATION_TYPE})
public @interface IdNumberFormat {

}

定义IdNumberFormatter转化器

/**
 * 本类是转换身份证号的详细实现
 * Formatter<T>也可以注入一个对象，返回一个从身份证号提取出详细信息的对象
 */
@Component
public class IdNumberFormatter implements Formatter<String> {

    static Map<Integer, String> map = null;

    static {
        map = new HashMap<>();
        map.put(11, "北京市");
        map.put(12, "天津市");
        map.put(13, "河北省");
        map.put(14, "山西省");
        map.put(15, "内蒙古自治区");
        map.put(21, "辽宁省");
        map.put(22, "吉林省");
        map.put(23, "黑龙江省");
        map.put(31, "上海市");
        map.put(32, "江苏省");
        map.put(33, "浙江省");
        map.put(34, "安徽省");
        map.put(35, "福建省");
        map.put(36, "江西省");
        map.put(37, "山东省");
        map.put(41, "河南省");
        map.put(42, "湖北省");
        map.put(43, "湖南省");
        map.put(44, "广东省");
        map.put(45, "广西壮族自治区");
        map.put(46, "海南省");
        map.put(50, "重庆市");
        map.put(51, "四川省");
        map.put(52, "贵州省");
        map.put(53, "云南省");
        map.put(54, "西藏自治区");
        map.put(61, "陕西省");
        map.put(62, "甘肃省");
        map.put(63, "青海省");
        map.put(64, "宁夏回族自治区");
        map.put(65, "新疆维吾尔自治区");
        map.put(71, "台湾省");
        map.put(81, "香港特别行政区");
        map.put(82, "澳门特别行政区");
        map.put(91, "海外");
    }

    /**
     * 判断身份证号是否正确
     * @param id
     * @return
     */
    public boolean isIdNum(String id) {

        int[] w = {7, 9, 10, 5, 8, 4, 2, 1, 6, 3, 7, 9, 10, 5, 8, 4, 2};

        char[] c = id.toCharArray();
        int sum = 0;
        for (int i = 0; i < w.length; i++) {
            sum += (c[i] - '0') * w[i];
        }

        char[] verifyCode = "10X98765432".toCharArray();
        char ch = verifyCode[sum % 11];

        return c[17] == ch;

    }

    /**
     * 获得地址
     * @param code
     * @return
     */
    public String getPlace(int code) {
        String place = map.get(code);
        return place;
    }

    /**
     * 获得年龄
     * @param date
     * @return
     */
    public int getAge(String date) {
        int old = Integer.parseInt(date.substring(0, 4));
        SimpleDateFormat df = new SimpleDateFormat("yyyy");
        int now = Integer.parseInt(df.format(new Date()));
        return now - old;
    }

    /**
     * 获得性别
     * @param nums
     * @return
     */
    public String getSex(String nums) {
        int num = Integer.parseInt(nums);
        if (num % 2 == 0) {
            return "woman";
        } else {
            return "man";
        }
    }

    /**
     * 返回一个新的身份信息的字符串
     * @param text
     * @return
     */
    public String returnNewNum(String text) {
        if (Pattern.matches("^[0-9]{17}[0-9xX]{1}$", text)) {
            if (text.substring(17, 18) == "x") {
                text = text.substring(0, 17) + text.substring(17, 18).toUpperCase();
            }

            if (isIdNum(text)) {
                String place = getPlace(Integer.parseInt(text.substring(0, 2)));
                int age = getAge(text.substring(6, 14));
                String sex = getSex(text.substring(16, 17));
                return place + age + sex;
            }
        }
        return "";
    }

    @Override
    public String print(String object, Locale locale) {
        // 如果注入的是对象这里应该返回一个对象
        return returnNewNum(object);
    }

    @Override
    public String parse(String text, Locale locale) throws ParseException {
        // 如果注入的是对象这里应该返回一个对象
        String s = returnNewNum(text);
        return s;
    }

}

创建IdNumberFormatAnnotationFormatterFactory

public class IdNumberFormatAnnotationFormatterFactory
        implements AnnotationFormatterFactory<IdNumberFormat> {

    private static final Set<Class<?>> FIELD_TYPES;
    static {
        Set<Class<?>> fieldTypes = new HashSet<Class<?>>(4);
        fieldTypes.add(String.class);
        FIELD_TYPES = Collections.unmodifiableSet(fieldTypes);
    }


    @Override
    public Set<Class<?>> getFieldTypes() {
        // 返回支持的类型列表
        return FIELD_TYPES;
    }

    @Override
    public Printer<?> getPrinter(IdNumberFormat idNumberFormat, Class<?> aClass) {
        return this.getFormatter(idNumberFormat, aClass);
    }

    @Override
    public Parser<?> getParser(IdNumberFormat idNumberFormat, Class<?> aClass) {
        return this.getFormatter(idNumberFormat, aClass);
    }


    protected Formatter<String> getFormatter(IdNumberFormat annotation, Class<?> fieldType) {
        IdNumberFormatter idNumberFormatter = new IdNumberFormatter();
        return idNumberFormatter;
    }
}