让JSONObject支持json字符串转换为java.sql.Date(使用json-lib-2.4)

最近写案例使用到了json-lib中的JSONObject，将JavaBean转换为json字符串，以及将json字符串转换为JavaBean对象。

但是JSONObject只支持java.util.Date，而我们在JavaBean中存在java.sql.Date的属性时，会抛出异常（日志警告）：

Can't transform property 'xxx' from java.lang.String into java.sql.Date. Will register a default Morpher

因此，查阅网上很多资料，有自己写一个JSONUtil类，来自己手动解析的；也有仿照源码，仿照JsonConfig的“jConfig.registerJavaPropertyNameProcessor(...)”方法，自己添加一个registerJavaValueProcessor()的方法，以在解析java.sql.Date时，自己new一个java.sql.Date返回去。

上面的方法都比较繁琐，我换了一种思路，既然JsonConfig支持设置“DateMorpher”来支持将“1997-7-1”此种字符串转换为标准的java.util.Date对象。

用于测试的Man类：

public class Man{
	private String name;
	private java.util.Date birthday;
	public String getName() {
		return name;
	}
	public void setName(String name) {
		this.name = name;
	}
	public java.util.Date getBirthday() {
		return birthday;
	}
	public void setBirthday(java.util.Date birthday) {
		this.birthday = birthday;
	}
}

测试类：

public class Test {
	public static void main(String[] args) {		
		String jsonStr = "{\"person\" : {\"name\" : \"张三\", \"birthday\" : \"1997-7-1\"}}";
		
		JSONObject obj = JSONObject.fromObject(jsonStr);
		
		String[] formats = {"yyyy-MM-dd"};
		
		JSONUtils.getMorpherRegistry().registerMorpher(new DateMorpher(formats));//关键之处，通过它就能够解析“1997-7-1”
		
		Man person = (Man) JSONObject.toBean(obj.getJSONObject("person"), Man.class);
		
		System.out.println("姓名：" + person.getName() + "，生日：" + person.getBirthday());
	}
}

运行后，输出结果为：姓名：张三，生日：Tue Jul 01 00:00:00 CST 1997，日期格式我们没有格式化，但证明标准的java.util.Date是能转换的！

但我们把Man中的生日修改为java.sql.Date，在运行就会报错！

public class Man{
	//......
	private java.util.Date birthday;
	//......
}

运行后报错为：

警告: Can't transform property 'birthday' from java.lang.String into java.sql.Date. Will register a default Morpher

Exception in thread "main" net.sf.json.JSONException: Error while setting property=birthday type class java.lang.String

............

然后突然想到，那么我们能不能模仿"DateMorpher"自己写一个"SqlDateMorpher"来解析为java.sql.Date呢？

最终全部代码如下：

Main.java

public class Man{
	private String name;
	private java.sql.Date birthday;
	public String getName() {
		return name;
	}
	public void setName(String name) {
		this.name = name;
	}
	public java.sql.Date getBirthday() {
		return birthday;
	}
	public void setBirthday(java.sql.Date birthday) {
		this.birthday = birthday;
	}
}

SqlDateMorpher.java

import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.sql.Date;
import java.util.Locale;

import org.apache.commons.lang.builder.EqualsBuilder;
import org.apache.commons.lang.builder.HashCodeBuilder;

import net.sf.ezmorph.MorphException;
import net.sf.ezmorph.object.AbstractObjectMorpher;

/**
 * 本类是为了让JSONObject支持将日期字符串（如1997-6-1）转换为java.sql.Date（官方版本只支持java.util.Date）。<br>
 * 我们主要修改了原有ezmorph-1.0.6.jar包中，的“public Object morph(Object value)”方法。<br>
 * 让它在其中将解析字符串准备返回的util.Date转换为sql.Date。<br>
 * 另外，我们把本类中原有导入的“java.util.Date”修改为了“java.sql.Date”！
 * @author Administrator
 *
 */
public final class SqlDateMorpher extends AbstractObjectMorpher {
	private Date defaultValue;
	private String[] formats;
	private boolean lenient;
	private Locale locale;

	/**
	 * @param formats
	 *            a list of formats this morpher supports.
	 */
	public SqlDateMorpher(String[] formats) {
		this(formats, Locale.getDefault(), false);
	}

	/**
	 * @param formats
	 *            a list of formats this morpher supports.
	 * @param lenient
	 *            if the parsing should be lenient or not.
	 */
	public SqlDateMorpher(String[] formats, boolean lenient) {
		this(formats, Locale.getDefault(), lenient);
	}

	/**
	 * @param formats
	 *            a list of formats this morpher supports.
	 * @param defaultValue
	 *            return value if the value to be morphed is null.
	 */
	public SqlDateMorpher(String[] formats, Date defaultValue) {
		this(formats, defaultValue, Locale.getDefault(), false);
	}

	/**
	 * @param formats
	 *            a list of formats this morpher supports.
	 * @param defaultValue
	 *            return value if the value to be morphed is null.
	 * @param locale
	 *            the Locale used to parse each format.
	 * @param lenient
	 *            if the parsing should be lenient or not.
	 */
	public SqlDateMorpher(String[] formats, Date defaultValue, Locale locale, boolean lenient) {
		super(true);
		if (formats == null || formats.length == 0) {
			throw new MorphException("invalid array of formats");
		}
		// should use defensive copying ?
		this.formats = formats;

		if (locale == null) {
			this.locale = Locale.getDefault();
		} else {
			this.locale = locale;
		}

		this.lenient = lenient;
		setDefaultValue(defaultValue);
	}

	/**
	 * @param formats
	 *            a list of formats this morpher supports.
	 * @param locale
	 *            the Locale used to parse each format.
	 */
	public SqlDateMorpher(String[] formats, Locale locale) {
		this(formats, locale, false);
	}

	/**
	 * @param formats
	 *            a list of formats this morpher supports.
	 * @param locale
	 *            the Locale used to parse each format.
	 * @param lenient
	 *            if the parsing should be lenient or not.
	 */
	public SqlDateMorpher(String[] formats, Locale locale, boolean lenient) {
		if (formats == null || formats.length == 0) {
			throw new MorphException("invalid array of formats");
		}
		// should use defensive copying ?
		this.formats = formats;

		if (locale == null) {
			this.locale = Locale.getDefault();
		} else {
			this.locale = locale;
		}

		this.lenient = lenient;
	}

	public boolean equals(Object obj) {
		if (this == obj) {
			return true;
		}
		if (obj == null) {
			return false;
		}

		if (!(obj instanceof SqlDateMorpher)) {
			return false;
		}

		SqlDateMorpher other = (SqlDateMorpher) obj;
		EqualsBuilder builder = new EqualsBuilder();
		builder.append(formats, other.formats);
		builder.append(locale, other.locale);
		builder.append(lenient, other.lenient);
		if (isUseDefault() && other.isUseDefault()) {
			builder.append(getDefaultValue(), other.getDefaultValue());
			return builder.isEquals();
		} else if (!isUseDefault() && !other.isUseDefault()) {
			return builder.isEquals();
		} else {
			return false;
		}
	}

	/**
	 * Returns the default value for this Morpher.
	 */
	public Date getDefaultValue() {
		return (Date) defaultValue.clone();
	}

	public int hashCode() {
		HashCodeBuilder builder = new HashCodeBuilder();
		builder.append(formats);
		builder.append(locale);
		builder.append(lenient);
		if (isUseDefault()) {
			builder.append(getDefaultValue());
		}
		return builder.toHashCode();
	}

	//我们主要修改了此方法，以支持sql.Date
	@Override
	public Object morph(Object value) {
		if (value == null) {
			return null;
		}

		//准确匹配要转换的类型为java.sql.Date
//		if (Date.class.isAssignableFrom(value.getClass()))
		if (Date.class == value.getClass())
		{
			return (Date) value;
		}

		if (!supports(value.getClass())) {
			throw new MorphException(value.getClass() + " is not supported");
		}

		String strValue = (String) value;
		SimpleDateFormat dateParser = null;

		for (int i = 0; i < formats.length; i++) {
			if (dateParser == null) {
				dateParser = new SimpleDateFormat(formats[i], locale);
			} else {
				dateParser.applyPattern(formats[i]);
			}
			dateParser.setLenient(lenient);
			try {
				//return new dateParser.parse(strValue.toLowerCase());//原有代码返回java.util.Date
				//我们在此将它包装为java.sql.Date
				return new Date(dateParser.parse(strValue.toLowerCase()).getTime());
			} catch (ParseException pe) {
				// ignore exception, try the next format
			}
		}

		// unable to parse the date
		if (isUseDefault()) {
			return defaultValue;
		} else {
			throw new MorphException("Unable to parse the date " + value);
		}
	}

	public Class morphsTo() {
		return Date.class;
	}

	/**
	 * Sets the defaultValue to use if the value to be morphed is null.
	 *
	 * @param defaultValue
	 *            return value if the value to be morphed is null
	 */
	public void setDefaultValue(Date defaultValue) {
		this.defaultValue = (Date) defaultValue.clone();
	}

	public boolean supports(Class clazz) {
		return String.class.isAssignableFrom(clazz);
	}
} 

上面类中，全部为复制官方的DateMorpher.java，修改了构造方法的名称、java.util.Date包改为java.sql.Date，以及public Object morph(Object value)方法的局部代码（看注释），其余内容没变！

测试类Test.java

public class Test {
	public static void main(String[] args) {		
		String jsonStr = "{\"person\" : {\"name\" : \"张三\", \"birthday\" : \"1997-7-1\"}}";
		
		JSONObject obj = JSONObject.fromObject(jsonStr);
		
		String[] formats = {"yyyy-MM-dd"};
		
		JSONUtils.getMorpherRegistry().registerMorpher(new SqlDateMorpher(formats));
		
		Man person = (Man) JSONObject.toBean(obj.getJSONObject("person"), Man.class);
		
		System.out.println("姓名：" + person.getName() + "，生日：" + person.getBirthday());
	}
} 

运行结果为：“姓名：张三，生日：1997-07-01”，结果正确！