Java國際化之（五）——自定義國際化formatter註解實現

知識 06-18

引言

由於Spring MVC自帶的@NumberFormat和@DateTimeFormat格式化不能很好的支持國際化，在《java國際化之---springMVC+Freemaker demo(三)》http://moon-walker.iteye.com/blog/2379940的demo中我們實現了自定的formatter：MyDateFormatter、MyCurrencyFormatter分別支持國際化的日期、貨幣處理。但有個弊端，表單對象中所有的Date、BigDecimal類型都會進行相同規則的轉換，不能像Spring MVC自帶的@NumberFormat和@DateTimeFormat對指定屬性添加註解，只對指定對象進行轉換。

慶幸的是Spring MVC支持我們對自定義的Formatter添加自己的註解。下面我們進行詳細講解，並附上demo代碼，詳見文章末尾Github地址。

自定義的Formatter註解

要實現自定義的Formatter註解，其實可以參考Spring MVC自帶的@NumberFormat實現方法，這裡我們以上一篇demo中實現的MyDateFormatter為例，進行講解。

創建過程分為三步：

第一步：首先我們看下@DateTimeFormat註解在Spring MVC中的實現，並模擬創建自己的@MyDateFormat註解，內容如下：

/**
* Created by gantianxing on 2017/6/17.
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER, ElementType.ANNOTATION_TYPE})
public @interface MyDateFormat {

}

第二步：仿照Spring MVC中的DateTimeFormatAnnotationFormatterFactory創建自己AnnotationFormatterFactory實現類MyDateFormatAnnotationFormatterFactory，內容如下：

/**
* Created by gantianxing on 2017/6/17.
*/
public class MyDateFormatAnnotationFormatterFactory implements AnnotationFormatterFactory {
private static final Set> FIELD_TYPES;

static {
Set> fieldTypes = new HashSet>(4);
fieldTypes.add(Date.class);//這裡只處理Date類型
FIELD_TYPES = Collections.unmodifiableSet(fieldTypes);
}

@Override
public Set> getFieldTypes {
return FIELD_TYPES;//返回支持的類型列表
}

@Override
public Printer getPrinter(MyDateFormat myDateFormat, Class aClass) {
return getFormatter(myDateFormat, aClass);
}

@Override
public Parser getParser(MyDateFormat myDateFormat, Class aClass) {
return getFormatter(myDateFormat, aClass);
}

protected Formatter getFormatter(MyDateFormat annotation, Class fieldType) {
MyDateFormatter formatter = new MyDateFormatter;
return formatter;
}
}

第三步：將自定義的MyDateFormatAnnotationFormatterFactory注入到spring mvc，在spring-mvc.xml中的配置代碼如下：

為了對比，這裡MyCurrencyFormatter沒有採用自定義註解方式實現，感覺興趣的朋友可以參照上述三個步驟自己實現。

使用自定義註解

為了方便對比，在User類中同時使用自帶的@DateTimeFormat註解、自定義的@MyDateFormat註解。在上一篇代碼的基礎上，對birthday欄位添加@DateTimeFormat註解，新增regTime欄位並添加@DateTimeFormat(pattern="yyyy-MM-dd"),修改後的代碼如下：

/**
* Created by gantianxing on 2017/6/8.
*/
public class User implements Serializable {
private static final long serialVersionUID = 1L;

@NotNull(message="{user.name.null}")
@Size(min=2,max =5,message = "{user.name.error}")
private String name;//姓名

@NotNull(message="{user.birthday.null}")
@Past(message="{user.birthday.error}")
@MyDateFormat
private Date birthday;//生日

@DateTimeFormat(pattern="yyyy-MM-dd")
private Date regDate;//註冊時間

@NotNull(message="{user.money.null}")
@Digits(integer=3,fraction=2,message="{user.money.error}")
@NumberFormat(pattern = "￥#.##")
private BigDecimal money;//資產

@NotNull(message="{user.phoneNum.null}")
@Pattern(regexp="\d{11}",message="{user.phoneNum.error}")
private String phoneNum;//手機號

public String getName {
return name;
}

public void setName(String name) {
this.name = name;
}

public Date getBirthday {
return birthday;
}

public void setBirthday(Date birthday) {
this.birthday = birthday;
}

public BigDecimal getMoney {
return money;
}

public void setMoney(BigDecimal money) {
this.money = money;
}

public String getPhoneNum {
return phoneNum;
}

public void setPhoneNum(String phoneNum) {
this.phoneNum = phoneNum;
}

public Date getRegDate {
return regDate;
}

public void setRegDate(Date regDate) {
this.regDate = regDate;
}
}

啟動tomcat，訪問http://localhost/add頁面，填寫表單，Register Date的格式必須為yyyy-MM-dd，輸入錯誤的情況下，報如下錯誤：