实用的Json工具类(Gson)
jopen
12年前
<p><span style="font-size:medium;"><strong><em>涉及到的jar包主要是gson-2.0.jar（必须,google做了封装所以是gson），log4j.jar(可选)</em></strong></span></p> <p> </p> <p><span style="font-size:medium;">使用范围：<strong>所有对象</strong></span></p> <p> </p> <p><span style="font-size:medium;">使用方法：</span></p> <p><span style="font-size:medium;">1，对象转json</span></p> <p><span><span style="font-size:medium;">String <span style="color:#ff0000;">aStr</span> = JsonUtils.<span style="color:#ff0000;">toJson</span>(A, false);</span></span></p> <p><span style="font-size:medium;">参数1具体对象(A代表任何对象,可以使集合类型也可以是普通类型)，</span></p> <p><span style="font-size:medium;">参数2：是否转换只标注有@Expose的属性，比如说在A中有下列属性：</span></p> <p> <span style="font-size:small;">private String resultCode;<br /> </span><span style="font-size:small;"><strong>@Expose<br /> </strong> private String exception;<br /> private String startTime;</span></p> <p><span style="font-size:small;">......get...</span></p> <p><span style="font-size:small;">......set...</span></p> <p><span style="font-size:small;">那么在做转换的时候只有属性exception才会被转换，并且不能为null<span style="color:#ff0000;">(即使参数2设置为false,为null的属性也不做转换)</span></span></p> <p> </p> <p> </p> <p><span style="font-size:medium;">2，json转对象</span></p> <p><span style="font-size:medium;"> A a = JsonUtils.fromJson(<span style="color:#ff0000;">aStr</span>, A.calss);//参数1是通过json转后的string，参数2：目标对象</span></p> <p> </p> <p><span><span style="font-size:medium;"><span style="font-size:large;"><span style="color:#ff0000;"><strong>注意</strong></span>：</span>如果是把List转Json String，在取出的时候不能直接用foreach循环取出</span></span></p> <p><span style="font-size:medium;">平常我们可能就用如下方式就可以了</span></p> <p><span style="font-size:medium;"><span style="color:#ff0000;"><strong>① </strong></span><span style="color:#000000;">for (Person person: personList) <strong>{</strong></span></span></p> <p><span style="font-size:medium;"><span style="color:#ff0000;"><strong>②</strong></span>Student stu = person.getStudent();<br /> }</span></p> <p><span style="font-size:medium;">而通过json转之后这样就不可以了，<span style="color:#ff0000;"><strong>①</strong></span>会抛出<span style="color:#ff0000;">java.util.LinkedHashMap cannot be cast to Person </span></span></p> <p> </p> <p><span style="font-size:medium;">可以采用如下方式</span></p> <p><span style="font-size:medium;">List personList= JsonUtils.fromJson(str,List.class); //str是List转为的string类型，上面有说怎么转。</span></p> <p><span style="font-size:medium;"><strong>personList</strong>：我里面装的虽然是人，但要采用正确的方式把他们放出来，要不然就不是人了</span></p> <p><span style="font-size:medium;">for (int i = 0; i < personList.size(); i++) {</span></p> <p><span style="font-size:medium;"><span style="color:#ff0000;"><strong> ③</strong>请先把我转为String吧，要不然我就回不去了</span></span></p> <p><span style="font-size:medium;"> String <span style="color:#008000;">personStr</span> = JsonUtils.toJson(<span style="color:#ff0000;">personList.get(i),</span> false);</span></p> <p><span style="font-size:medium;"> <span style="color:#ff0000;"><strong>④</strong></span> <span style="color:#ff0000;">哈哈，我可以变成人了</span></span></p> <p><span style="font-size:medium;"> <span><span style="color:#ff0000;"><span style="color:#800000;">Person</span> </span>person= JsonUtils.fromJson(<span style="color:#008000;">personStr</span> ,</span><span><span style="color:#ff0000;">Person</span>.class);</span></span></p> <p><span style="font-size:medium;"> <span style="color:#ff0000;"><strong>⑤good，</strong></span><span style="color:#ff0000;">还可以取到钱</span></span></p> <p><span style="font-size:medium;"> <span style="text-decoration:line-through;">Money money = <strong><span style="color:#ff0000;">person.getMoney()</span></strong></span> </span></p> <p> <span style="color:#ff0000;"><strong>⑥:你醒醒吧⑤，像我这样才可以取到钱</strong></span></p> <p><span style="color:#ff0000;"><strong> </strong></span><span style="color:#000000;">String moneyStr = JsonUtils.toJson(<strong><span style="color:#ff0000;">person.getMoney()</span></strong>);</span></p> <p></p> <p><span style="color:#000000;"> <span style="color:#ff0000;"><strong>⑦有钱了\(0^◇^0)/<br /> </strong></span> Money money = JsonUtils.fromJson(moneyStr , Money.class);</span></p> <p> </p> <p> </p> <p> </p> <p><span style="font-size:medium;"> </span><span style="font-size:medium;">｝</span></p> <p> </p> <p><span style="font-size:small;"><span style="color:#ff0000;">PS</span>:对象中的int,Integer,Long long..等数字类型属性，通过json转回来时会多出<span style="color:#ff0000;"><strong> .0</strong></span>，</span></p> <p> </p> <p> <span style="font-size:medium;"><strong><em>工具类代码如下：</em></strong></span></p> <pre class="brush:java; toolbar: true; auto-links: false;">import java.lang.reflect.Type; import java.util.Collection; import java.util.Enumeration; import java.util.Iterator; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import com.google.gson.Gson; import com.google.gson.GsonBuilder; import com.google.gson.reflect.TypeToken; public class JsonUtils { private static final Log log = LogFactory.getLog(JsonUtils.class); public static final String EMPTY = ""; /** 空的 {@code JSON} 数据 - <code>"{}"</code>。 */ public static final String EMPTY_JSON = "{}"; /** 空的 {@code JSON} 数组(集合)数据 - {@code "[]"}。 */ public static final String EMPTY_JSON_ARRAY = "[]"; /** 默认的 {@code JSON} 日期/时间字段的格式化模式。 */ public static final String DEFAULT_DATE_PATTERN = "yyyy-MM-dd HH:mm:ss SSS"; /** {@code Google Gson} 的 {@literal @Since} 注解常用的版本号常量 - {@code 1.0}。 */ public static final Double SINCE_VERSION_10 = 1.0d; /** {@code Google Gson} 的 {@literal @Since} 注解常用的版本号常量 - {@code 1.1}。 */ public static final Double SINCE_VERSION_11 = 1.1d; /** {@code Google Gson} 的 {@literal @Since} 注解常用的版本号常量 - {@code 1.2}。 */ public static final Double SINCE_VERSION_12 = 1.2d; /** * 将给定的目标对象根据指定的条件参数转换成 {@code JSON} 格式的字符串。 * <p /> * <strong>该方法转换发生错误时，不会抛出任何异常。若发生错误时，曾通对象返回 <code>"{}"</code>； 集合或数组对象返回 * <code>"[]"</code></strong> * * @param target * 目标对象。 * @param targetType * 目标对象的类型。 * @param isSerializeNulls * 是否序列化 {@code null} 值字段。 * @param version * 字段的版本号注解。 * @param datePattern * 日期字段的格式化模式。 * @param excludesFieldsWithoutExpose * 是否排除未标注 {@literal @Expose} 注解的字段。 * @return 目标对象的 {@code JSON} 格式的字符串。 */ public static String toJson(Object target, Type targetType, boolean isSerializeNulls, Double version, String datePattern, boolean excludesFieldsWithoutExpose) { if (target == null) return EMPTY_JSON; GsonBuilder builder = new GsonBuilder(); if (isSerializeNulls) builder.serializeNulls(); if (version != null) builder.setVersion(version.doubleValue()); if (isEmpty(datePattern)) datePattern = DEFAULT_DATE_PATTERN; builder.setDateFormat(datePattern); if (excludesFieldsWithoutExpose) builder.excludeFieldsWithoutExposeAnnotation(); String result = EMPTY; Gson gson = builder.create(); try { if (targetType != null) { result = gson.toJson(target, targetType); } else { result = gson.toJson(target); } } catch (Exception ex) { log.warn("目标对象 " + target.getClass().getName() + " 转换 JSON 字符串时，发生异常！", ex); if (target instanceof Collection || target instanceof Iterator || target instanceof Enumeration || target.getClass().isArray()) { result = EMPTY_JSON_ARRAY; } else result = EMPTY_JSON; } return result; } /** * 将给定的目标对象转换成 {@code JSON} 格式的字符串。<strong>此方法只用来转换普通的 {@code JavaBean} * 对象。</strong> * <ul> * <li>该方法只会转换标有 {@literal @Expose} 注解的字段；</li> * <li>该方法不会转换 {@code null} 值字段；</li> * <li>该方法会转换所有未标注或已标注 {@literal @Since} 的字段；</li> * <li>该方法转换时使用默认的 日期/时间 格式化模式 - {@code yyyy-MM-dd HH:mm:ss SSS}；</li> * </ul> * * @param target * 要转换成 {@code JSON} 的目标对象。 * @return 目标对象的 {@code JSON} 格式的字符串。 */ public static String toJson(Object target) { return toJson(target, null, false, null, null, true); } /** * 将给定的目标对象转换成 {@code JSON} 格式的字符串。<strong>此方法只用来转换普通的 {@code JavaBean} * 对象。</strong> * <ul> * <li>该方法只会转换标有 {@literal @Expose} 注解的字段；</li> * <li>该方法不会转换 {@code null} 值字段；</li> * <li>该方法会转换所有未标注或已标注 {@literal @Since} 的字段；</li> * </ul> * * @param target * 要转换成 {@code JSON} 的目标对象。 * @param datePattern * 日期字段的格式化模式。 * @return 目标对象的 {@code JSON} 格式的字符串。 */ public static String toJson(Object target, String datePattern) { return toJson(target, null, false, null, datePattern, true); } /** * 将给定的目标对象转换成 {@code JSON} 格式的字符串。<strong>此方法只用来转换普通的 {@code JavaBean} * 对象。</strong> * <ul> * <li>该方法只会转换标有 {@literal @Expose} 注解的字段；</li> * <li>该方法不会转换 {@code null} 值字段；</li> * <li>该方法转换时使用默认的 日期/时间 格式化模式 - {@code yyyy-MM-dd HH:mm:ss SSS}；</li> * </ul> * * @param target * 要转换成 {@code JSON} 的目标对象。 * @param version * 字段的版本号注解({@literal @Since})。 * @return 目标对象的 {@code JSON} 格式的字符串。 */ public static String toJson(Object target, Double version) { return toJson(target, null, false, version, null, true); } /** * 将给定的目标对象转换成 {@code JSON} 格式的字符串。<strong>此方法只用来转换普通的 {@code JavaBean} * 对象。</strong> * <ul> * <li>该方法不会转换 {@code null} 值字段；</li> * <li>该方法会转换所有未标注或已标注 {@literal @Since} 的字段；</li> * <li>该方法转换时使用默认的 日期/时间 格式化模式 - {@code yyyy-MM-dd HH:mm:ss SSS}；</li> * </ul> * * @param target * 要转换成 {@code JSON} 的目标对象。 * @param excludesFieldsWithoutExpose * 是否排除未标注 {@literal @Expose} 注解的字段。 * @return 目标对象的 {@code JSON} 格式的字符串。 */ public static String toJson(Object target, boolean excludesFieldsWithoutExpose) { return toJson(target, null, false, null, null, excludesFieldsWithoutExpose); } /** * 将给定的目标对象转换成 {@code JSON} 格式的字符串。<strong>此方法只用来转换普通的 {@code JavaBean} * 对象。</strong> * <ul> * <li>该方法不会转换 {@code null} 值字段；</li> * <li>该方法转换时使用默认的 日期/时间 格式化模式 - {@code yyyy-MM-dd HH:mm:ss SSS}；</li> * </ul> * * @param target * 要转换成 {@code JSON} 的目标对象。 * @param version * 字段的版本号注解({@literal @Since})。 * @param excludesFieldsWithoutExpose * 是否排除未标注 {@literal @Expose} 注解的字段。 * @return 目标对象的 {@code JSON} 格式的字符串。 */ public static String toJson(Object target, Double version, boolean excludesFieldsWithoutExpose) { return toJson(target, null, false, version, null, excludesFieldsWithoutExpose); } /** * 将给定的目标对象转换成 {@code JSON} 格式的字符串。<strong>此方法通常用来转换使用泛型的对象。</strong> * <ul> * <li>该方法只会转换标有 {@literal @Expose} 注解的字段；</li> * <li>该方法不会转换 {@code null} 值字段；</li> * <li>该方法会转换所有未标注或已标注 {@literal @Since} 的字段；</li> * <li>该方法转换时使用默认的 日期/时间 格式化模式 - {@code yyyy-MM-dd HH:mm:ss SSSS}；</li> * </ul> * * @param target * 要转换成 {@code JSON} 的目标对象。 * @param targetType * 目标对象的类型。 * @return 目标对象的 {@code JSON} 格式的字符串。 */ public static String toJson(Object target, Type targetType) { return toJson(target, targetType, false, null, null, true); } /** * 将给定的目标对象转换成 {@code JSON} 格式的字符串。<strong>此方法通常用来转换使用泛型的对象。</strong> * <ul> * <li>该方法只会转换标有 {@literal @Expose} 注解的字段；</li> * <li>该方法不会转换 {@code null} 值字段；</li> * <li>该方法转换时使用默认的 日期/时间 格式化模式 - {@code yyyy-MM-dd HH:mm:ss SSSS}；</li> * </ul> * * @param target * 要转换成 {@code JSON} 的目标对象。 * @param targetType * 目标对象的类型。 * @param version * 字段的版本号注解({@literal @Since})。 * @return 目标对象的 {@code JSON} 格式的字符串。 */ public static String toJson(Object target, Type targetType, Double version) { return toJson(target, targetType, false, version, null, true); } /** * 将给定的目标对象转换成 {@code JSON} 格式的字符串。<strong>此方法通常用来转换使用泛型的对象。</strong> * <ul> * <li>该方法不会转换 {@code null} 值字段；</li> * <li>该方法会转换所有未标注或已标注 {@literal @Since} 的字段；</li> * <li>该方法转换时使用默认的 日期/时间 格式化模式 - {@code yyyy-MM-dd HH:mm:ss SSS}；</li> * </ul> * * @param target * 要转换成 {@code JSON} 的目标对象。 * @param targetType * 目标对象的类型。 * @param excludesFieldsWithoutExpose * 是否排除未标注 {@literal @Expose} 注解的字段。 * @return 目标对象的 {@code JSON} 格式的字符串。 */ public static String toJson(Object target, Type targetType, boolean excludesFieldsWithoutExpose) { return toJson(target, targetType, false, null, null, excludesFieldsWithoutExpose); } /** * 将给定的目标对象转换成 {@code JSON} 格式的字符串。<strong>此方法通常用来转换使用泛型的对象。</strong> * <ul> * <li>该方法不会转换 {@code null} 值字段；</li> * <li>该方法转换时使用默认的 日期/时间 格式化模式 - {@code yyyy-MM-dd HH:mm:ss SSS}；</li> * </ul> * * @param target * 要转换成 {@code JSON} 的目标对象。 * @param targetType * 目标对象的类型。 * @param version * 字段的版本号注解({@literal @Since})。 * @param excludesFieldsWithoutExpose * 是否排除未标注 {@literal @Expose} 注解的字段。 * @return 目标对象的 {@code JSON} 格式的字符串。 */ public static String toJson(Object target, Type targetType, Double version, boolean excludesFieldsWithoutExpose) { return toJson(target, targetType, false, version, null, excludesFieldsWithoutExpose); } /** * 将给定的 {@code JSON} 字符串转换成指定的类型对象。 * * @param <T> * 要转换的目标类型。 * @param json * 给定的 {@code JSON} 字符串。 * @param token * {@code com.google.gson.reflect.TypeToken} 的类型指示类对象。 * @param datePattern * 日期格式模式。 * @return 给定的 {@code JSON} 字符串表示的指定的类型对象。 */ public static <T> T fromJson(String json, TypeToken<T> token, String datePattern) { if (isEmpty(json)) { return null; } GsonBuilder builder = new GsonBuilder(); if (isEmpty(datePattern)) { datePattern = DEFAULT_DATE_PATTERN; } Gson gson = builder.create(); try { return gson.fromJson(json, token.getType()); } catch (Exception ex) { log.error(json + " 无法转换为 " + token.getRawType().getName() + " 对象!", ex); return null; } } /** * 将给定的 {@code JSON} 字符串转换成指定的类型对象。 * * @param <T> * 要转换的目标类型。 * @param json * 给定的 {@code JSON} 字符串。 * @param token * {@code com.google.gson.reflect.TypeToken} 的类型指示类对象。 * @return 给定的 {@code JSON} 字符串表示的指定的类型对象。 */ public static <T> T fromJson(String json, TypeToken<T> token) { return fromJson(json, token, null); } /** * 将给定的 {@code JSON} 字符串转换成指定的类型对象。<strong>此方法通常用来转换普通的 {@code JavaBean} * 对象。</strong> * * @param <T> * 要转换的目标类型。 * @param json * 给定的 {@code JSON} 字符串。 * @param clazz * 要转换的目标类。 * @param datePattern * 日期格式模式。 * @return 给定的 {@code JSON} 字符串表示的指定的类型对象。 */ public static <T> T fromJson(String json, Class<T> clazz, String datePattern) { if (isEmpty(json)) { return null; } GsonBuilder builder = new GsonBuilder(); if (isEmpty(datePattern)) { datePattern = DEFAULT_DATE_PATTERN; } Gson gson = builder.create(); try { return gson.fromJson(json, clazz); } catch (Exception ex) { log.error(json + " 无法转换为 " + clazz.getName() + " 对象!", ex); return null; } } /** * 将给定的 {@code JSON} 字符串转换成指定的类型对象。<strong>此方法通常用来转换普通的 {@code JavaBean} * 对象。</strong> * * @param <T> * 要转换的目标类型。 * @param json * 给定的 {@code JSON} 字符串。 * @param clazz * 要转换的目标类。 * @return 给定的 {@code JSON} 字符串表示的指定的类型对象。 */ public static <T> T fromJson(String json, Class<T> clazz) { return fromJson(json, clazz, null); } public static boolean isEmpty(String inStr) { boolean reTag = false; if (inStr == null || "".equals(inStr)) { reTag = true; } return reTag; } }</pre>转自： <a href="/misc/goto?guid=4959499861412357188" target="_blank">http://learning.iteye.com/blog/1322972</a>