BeanUtils で独自のコンバーターを使用する

BeanUtils で JavaBeans のプロパティを一気にコピーする で作成したサンプルでは、 java.util.Date を String にコピーした時に “yyyy/MM/dd HH:mm:ss” というような任意のフォーマットへの変換は出来ませんでした。 これは BeanUtils のデフォルトの振る舞いが java.util.Date#toString() の値を使用して String へ変換するようになっている為です。 まずその仕組みを少し調べ、独自の変換を行うにはどうすれば良いかを試してみます。

BeanUtils が型の違うプロパティを変換する仕組み

BeanUtils ではコピー元とコピー先のオブジェクトを比較して、 同じ名前のプロパティがあれば、 その型が違っても自動で変換してくれます。 例えば下図において、 コピー元の UserModel#getLoginDate() が java.util.Date を返すのに対し、 コピー先の UserForm#setLoginDate(String) は String を設定するメソッドになっています。

このように型が違うものを自動変換する仕組みとして、 BeanUtils は Converter インターフェースを用意しています。 デフォルトで表１のコンバーターが登録されているため、 プリミティブ型や基本クラスに関しては自動変換できるようになっています。

BeanUtils でコンバーターが使用される手順

では、 java.util.Date 型 → String 型 と変換する際、 BeanUtils#copyProperties(Object, Object) ではどのような処理を行っているのでしょうか？ 前述の loginDate というプロパティをコピーする際の処理を下記に示します。 （下の例では実際の処理内容を単純化しています。）

1. UserModel（コピー元）#getLoginDate() の値を取得
2. UserForm（コピー先）の loginDate という名前のプロパティに関する PropertyDescripter を取得
3. 取得した PropertyDescripter で、コピー先プロパティの型（この場合は String）を取得
4. 取得した型に対応するコンバーターを ConvertUtils から取得（この場合は StringConverter）
5. Converter#convert(Class, Object) メソッドを使用して 1 で取得した値を変換
6. 変換済みの値を UserForm（コピー先）の setter メソッドを使用して設定

つまり、 UserModel の loginDate は Date 型ですが、これを変換する際には、 UserForm の loginDate が String である為、 あらかじめ ConvertUtils に登録されている StringConverter が使用されています。 StringConverter の実装はというと…

public final class StringConverter implements Converter {

    public Object convert(Class type, Object value) {
        if (value == null) {
            return ((String) null);
        } else {
            return (value.toString());
        }
    }
}

…となっています。 第１引数の type には、この場合、常に String.class という値が渡されます。 第２引数の value が変換前の値で、 実際に UserModel#getLoginDate() で取得した java.util.Date 型の値が渡されます。 これで BeanUtils#copyProperties(Object, Object) を使用した際に java.util.Date#toString() の値がコピー先に設定された理由が分かりました。

独自のコンバーターを作成・登録

BeanUtils がコンバーターを使用している仕組みが分かったところで、 loginDate を “yyyy/MM/dd HH:mm:ss” 形式で変換できるように、 独自のコンバーターを作成してみます。

public final class CustomStringConverter implements Converter {

    public Object convert(Class type, Object value) {
        if (value == null) {
            return ((String) null);
        } else {
            if (value instanceof java.util.Date) {
                SimpleDateFormat sdf = new SimpleDateFormat("yyyy/MM/dd HH:mm:ss");
                return sdf.format((java.util.Date)value);
            }
            return (value.toString());
        }
    }
}

-+-+-+-+-+-+-+-+-+-+-
Main.java
-+-+-+-+-+-+-+-+-+-+-
package jp.javable.sample.beanutils;

import org.apache.commons.beanutils.BeanUtils;
import org.apache.commons.beanutils.ConvertUtils;

public class Main {

    public static void main(String[] args) throws Exception {
        
        ConvertUtils.register(new CustomStringConverter(), String.class);
        
        UserModel model = new UserModel();
        model.setName("溝口");
        model.setLoginDate(new java.util.Date());

        UserForm form = new UserForm();
        BeanUtils.copyProperties(form, model);

        System.out.println(form);
    }
}

実行してみます。

D:\eclipse_workspace\test> java -classpath bin;lib\commons-beanutils.jar;
lib\commons-collections.jar;
lib\commons-logging.jar jp.javable.sample.beanutils.Main
（↑実際には１行です）

jp.javable.sample.beanutils.UserForm@145d068[name=溝口,
            loginDate=2005/05/20 23:24:12]

ちゃんとフォーマットされていました(T^T)。[ サンプルソース ]