json-lib反序列化時(JSONObject.toBean)，時間類型為空的處理

需求：

在我們的項目里希望JsonString傳入日期類型值為空時，JSONObject.toBean時可以將Java對象的該日期屬性設為null。

解決過程：

json-lib反序列化Json字符串為Java對象，可以通過以下代碼處理日期字段：

    public static <T> T JsonToBean(Class<T> clazz, String JsonString) {
        JSONUtils.getMorpherRegistry().registerMorpher(
                new DateMorpher(new String[] { "yyyy-MM-dd HH:mm:ss",
                        "yyyy-MM-dd", "yyyy-MM-dd't'HH:mm:ss" }));
        JSONObject jsonObject = JSONObject.fromObject(JsonString);
        T entity = (T) JSONObject.toBean(jsonObject, clazz);
        return entity;
    }

但如果JsonString傳入{"createDate":""}時,則會在“T entity = (T) JSONObject.toBean(jsonObject, clazz)”時報以下錯誤：

net.sf.json.JSONException: Error while setting property=createDate type class java.lang.String

 

查看net.sf.ezmorph.object.DateMorpher方法的源碼，關於字符串轉時間的代碼如下：

      public Object morph(Object value)
      {
        if (value == null) {
          return null;
        }

        if (Date.class.isAssignableFrom(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 < this.formats.length; ++i) {
          if (dateParser == null)
            dateParser = new SimpleDateFormat(this.formats[i], this.locale);
          else {
            dateParser.applyPattern(this.formats[i]);
          }
          dateParser.setLenient(this.lenient);
          try {
            return dateParser.parse(strValue.toLowerCase());
          }
          catch (ParseException localParseException)
          {
          }

        }

        if (super.isUseDefault()) {
          return this.defaultValue;
        }
        throw new MorphException("Unable to parse the date " + value);
      }

可以看到，在18~32行會使用我們傳入的formats循環進行字符串轉換，如果轉換成功則返回Date，如果全部失敗則在37行處拋出異常，最后導致toBean方法失敗。

可以看到DateMorpher類有這個構造函數可以傳入Date defaultValue，在morph方法的第34行如果之前的轉換均失敗即返回defaultValue。但使用(Date)null作為defaultValue，在初始化DateMorpher對象時會報空指針異常，原因是DateMorpher類中有如下方法：

      public void setDefaultValue(Date defaultValue)
      {
          this.defaultValue = ((Date)defaultValue.clone());
      }

      public Date getDefaultValue()
      {
          return (Date)this.defaultValue.clone();
      }

“this.defaultValue.clone();”中defaultValue 為null所以報異常。

解決方法：

重新實現DateMorpher方法，修改setDefaultValue(Date defaultValue)和getDefaultValue()方法，對null進行處理

（當然也可是修改net.sf.ezmorph.object.DateMorpher方法，重新打包ezmorph-1.0.6.jar）。

以下是重新實現的DateMorpherEx方法：

import net.sf.ezmorph.object.AbstractObjectMorpher;
import java.text.DateFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Locale;
import net.sf.ezmorph.MorphException;
import org.apache.commons.lang.builder.EqualsBuilder;
import org.apache.commons.lang.builder.HashCodeBuilder;

public class DateMorpherEx extends AbstractObjectMorpher {

    private Date defaultValue;
      private String[] formats;
      private boolean lenient;
      private Locale locale;

      public DateMorpherEx(String[] formats)
      {
        this(formats, Locale.getDefault(), false);
      }

      public DateMorpherEx(String[] formats, boolean lenient)
      {
        this(formats, Locale.getDefault(), lenient);
      }

      public DateMorpherEx(String[] formats, Date defaultValue)
      {
        this(formats, defaultValue, Locale.getDefault(), false);
      }

      public DateMorpherEx(String[] formats, Date defaultValue, Locale locale, boolean lenient)
      {
        super(true);
        if ((formats == null) || (formats.length == 0)) {
          throw new MorphException("invalid array of formats");
        }

        this.formats = formats;

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

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

      public DateMorpherEx(String[] formats, Locale locale)
      {
        this(formats, locale, false);
      }

      public DateMorpherEx(String[] formats, Locale locale, boolean lenient)
      {
        if ((formats == null) || (formats.length == 0)) {
          throw new MorphException("invalid array of formats");
        }

        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 DateMorpherEx)) {
          return false;
        }

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

      public Date getDefaultValue()
      {
          if(this.defaultValue!=null)
              return (Date)this.defaultValue.clone();
          else
              return this.defaultValue;
      }

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

      public Object morph(Object value)
      {
        if (value == null) {
          return null;
        }

        if (Date.class.isAssignableFrom(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 < this.formats.length; ++i) {
          if (dateParser == null)
            dateParser = new SimpleDateFormat(this.formats[i], this.locale);
          else {
            dateParser.applyPattern(this.formats[i]);
          }
          dateParser.setLenient(this.lenient);
          try {
            return dateParser.parse(strValue.toLowerCase());
          }
          catch (ParseException localParseException)
          {
          }

        }

        if (super.isUseDefault()) {
          return this.defaultValue;
        }
        throw new MorphException("Unable to parse the date " + value);
      }

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

      public void setDefaultValue(Date defaultValue)
      {
          if(defaultValue!=null)
              this.defaultValue = ((Date)defaultValue.clone());
          else
              this.defaultValue = null;
      }

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

修改原 JsonToBean 方法，調用DateMorpherEx：

    public static <T> T JsonToBean(Class<T> clazz, String JsonString) {
        JSONUtils.getMorpherRegistry().registerMorpher(
                new DateMorpherEx(new String[] { "yyyy-MM-dd HH:mm:ss",
                        "yyyy-MM-dd", "yyyy-MM-dd't'HH:mm:ss" }, (Date) null));//調用DateMorpherEx，defaultValue為null
        JSONObject jsonObject = JSONObject.fromObject(JsonString);
        T entity = (T) JSONObject.toBean(jsonObject, clazz);
        return entity;
    }