gson工具類

maven項目中須要先導入關聯架包

<dependency>
    <groupId>com.google.code.gson</groupId>
    <artifactId>gson</artifactId>
    <version>2.5</version>
</dependency>

實現工具類

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.reflect.TypeToken;
import org.apache.commons.lang.StringUtils;
import org.apache.log4j.Logger;

import javax.servlet.http.HttpServletRequest;
import java.io.BufferedReader;
import java.lang.reflect.Type;
import java.util.Collection;
import java.util.Enumeration;
import java.util.Iterator;

/**
 * Created with IntelliJ IDEA.
 * User: computer
 * Date: 14-8-7
 * Time: 下午3:45
 * To change this template use File | Settings | File Templates.
 */
public class JSONUtils {
    private static final Logger LOGGER = Logger.getLogger(JSONUtils.class);

    /** 空的 {@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} 的 <code>@Since</code> 註解經常使用的版本號常量 - {@code 1.0}。 */
    public static final double SINCE_VERSION_10 = 1.0d;

    /** {@code Google Gson} 的 <code>@Since</code> 註解經常使用的版本號常量 - {@code 1.1}。 */
    public static final double SINCE_VERSION_11 = 1.1d;

    /** {@code Google Gson} 的 <code>@Since</code> 註解經常使用的版本號常量 - {@code 1.2}。 */
    public static final double SINCE_VERSION_12 = 1.2d;

    /** {@code Google Gson} 的 <code>@Until</code> 註解經常使用的版本號常量 - {@code 1.0}。 */
    public static final double UNTIL_VERSION_10 = SINCE_VERSION_10;

    /** {@code Google Gson} 的 <code>@Until</code> 註解經常使用的版本號常量 - {@code 1.1}。 */
    public static final double UNTIL_VERSION_11 = SINCE_VERSION_11;

    /** {@code Google Gson} 的 <code>@Until</code> 註解經常使用的版本號常量 - {@code 1.2}。 */
    public static final double UNTIL_VERSION_12 = SINCE_VERSION_12;

    /**
     * <p>
     * <code>JSONUtils</code> instances should NOT be constructed in standard programming. Instead,
     * the class should be used as <code>JSONUtils.fromJson("foo");</code>.
     * </p>
     * <p>
     * This constructor is public to permit tools that require a JavaBean instance to operate.
     * </p>
     */
    public JSONUtils() {
        super();
    }

    /**
     * 將給定的目標對象根據指定的條件參數轉換成 {@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} 格式的字符串。
     * @since 1.0
     */
    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 (StringUtils.isBlank(datePattern)) datePattern = DEFAULT_DATE_PATTERN;
        builder.setDateFormat(datePattern);
        if (excludesFieldsWithoutExpose) builder.excludeFieldsWithoutExposeAnnotation();
        return toJson(target, targetType, builder);
    }

    /**
     * 將給定的目標對象轉換成 {@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} 格式的字符串。
     * @since 1.0
     */
    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} 格式的字符串。
     * @since 1.0
     */
    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} 格式的字符串。
     * @since 1.0
     */
    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} 格式的字符串。
     * @since 1.0
     */
    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} 格式的字符串。
     * @since 1.0
     */
    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} 格式的字符串。
     * @since 1.0
     */
    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} 格式的字符串。
     * @since 1.0
     */
    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} 格式的字符串。
     * @since 1.0
     */
    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} 格式的字符串。
     * @since 1.0
     */
    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} 字符串表示的指定的類型對象。
     * @since 1.0
     */
    public static <T> T fromJson(String json, TypeToken<T> token, String datePattern) {
        if (StringUtils.isBlank(json)) {
            return null;
        }
        GsonBuilder builder = new GsonBuilder();
        if (StringUtils.isBlank(datePattern)) {
            datePattern = DEFAULT_DATE_PATTERN;
        }
        Gson gson = builder.create();
        try {
            return (T)gson.fromJson(json, token.getType());
        } catch (Exception ex) {
            LOGGER.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} 字符串表示的指定的類型對象。
     * @since 1.0
     */
    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} 字符串表示的指定的類型對象。
     * @since 1.0
     */
    public static <T> T fromJson(String json, Class<T> clazz, String datePattern) {
        if (StringUtils.isBlank(json)) {
            return null;
        }
        GsonBuilder builder = new GsonBuilder();
        if (StringUtils.isBlank(datePattern)) {
            datePattern = DEFAULT_DATE_PATTERN;
        }
        Gson gson = builder.create();
        try {
            return gson.fromJson(json, clazz);
        } catch (Exception ex) {
            LOGGER.error(json + " 沒法轉換爲 " + clazz.getName() + " 對象!", ex);
            return null;
        }
    }

    /**
     * 將給定的 {@code JSON} 字符串轉換成指定的類型對象。<strong>此方法一般用來轉換普通的 {@code JavaBean} 對象。</strong>
     *
     * @param <T> 要轉換的目標類型。
     * @param json 給定的 {@code JSON} 字符串。
     * @param clazz 要轉換的目標類。
     * @return 給定的 {@code JSON} 字符串表示的指定的類型對象。
     * @since 1.0
     */
    public static <T> T fromJson(String json, Class<T> clazz) {
        return fromJson(json, clazz, null);
    }

    /**
     * 將給定的目標對象根據{@code GsonBuilder} 所指定的條件參數轉換成 {@code JSON} 格式的字符串。
     * <p />
     * 該方法轉換髮生錯誤時，不會拋出任何異常。若發生錯誤時，{@code JavaBean} 對象返回 <code>"{}"</code>； 集合或數組對象返回
     * <code>"[]"</code>。 其本基本類型，返回相應的基本值。
     *
     * @param target 目標對象。
     * @param targetType 目標對象的類型。
     * @param builder 可定製的{@code Gson} 構建器。
     * @return 目標對象的 {@code JSON} 格式的字符串。
     * @since 1.1
     */
    public static String toJson(Object target, Type targetType, GsonBuilder builder) {
        if (target == null) return EMPTY_JSON;
        Gson gson = null;
        if (builder == null) {
            gson = new Gson();
        } else {
            gson = builder.create();
        }
        String result = EMPTY_JSON;
        try {
            if (targetType == null) {
                result = gson.toJson(target);
            } else {
                result = gson.toJson(target, targetType);
            }
        } catch (Exception ex) {
            LOGGER.warn("目標對象 " + target.getClass().getName() + " 轉換 JSON 字符串時，發生異常！", ex);
            if (target instanceof Collection<?> || target instanceof Iterator<?> || target instanceof Enumeration<?>
                    || target.getClass().isArray()) {
                result = EMPTY_JSON_ARRAY;
            }
        }
        return result;
    }

    /**
     * 讀取字符流
     * @param request
     * @return
     */
    public static  String readJSONString(HttpServletRequest request) {
        StringBuffer json = new StringBuffer();
        String line = null;
        try {
            BufferedReader reader =request.getReader();// new BufferedReader(new InputStreamReader(request.getInputStream(),"utf-8")); //request.getReader();
            while ((line = reader.readLine()) != null) {
                json.append(line);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
        return json.toString();
    }

    private static final String[] REPLACEMENT_CHARS;
    private static final String[] HTML_SAFE_REPLACEMENT_CHARS;

    static {
        REPLACEMENT_CHARS = new String[128];
        for (int i = 0; i <= 0x1f; i++) {
            REPLACEMENT_CHARS[i] = String.format("\\u%04x", (int) i);
        }
        REPLACEMENT_CHARS['"'] = "\\\"";
        REPLACEMENT_CHARS['\\'] = "\\\\";
        REPLACEMENT_CHARS['\t'] = "\\t";
        REPLACEMENT_CHARS['\b'] = "\\b";
        REPLACEMENT_CHARS['\n'] = "\\n";
        REPLACEMENT_CHARS['\r'] = "\\r";
        REPLACEMENT_CHARS['\f'] = "\\f";
        HTML_SAFE_REPLACEMENT_CHARS = REPLACEMENT_CHARS.clone();
        HTML_SAFE_REPLACEMENT_CHARS['<'] = "\\u003c";
        HTML_SAFE_REPLACEMENT_CHARS['>'] = "\\u003e";
        HTML_SAFE_REPLACEMENT_CHARS['&'] = "\\u0026";
        HTML_SAFE_REPLACEMENT_CHARS['='] = "\\u003d";
        HTML_SAFE_REPLACEMENT_CHARS['\''] = "\\u0027";
    }


    public static String escapeJson(String value, boolean htmlSafe) {
        if(value==null){
            return "";
        }
        StringBuffer sb = new StringBuffer();
        String[] replacements = htmlSafe ? HTML_SAFE_REPLACEMENT_CHARS : REPLACEMENT_CHARS;
        //標記
        int last = 0;
        //總長度
        int length = value.length();
        for (int i = 0; i < length; i++) {
            char c = value.charAt(i);//獲取字符
            String replacement;//聲明字符
            if (c < 128) {
                replacement = replacements[c];//是否128內的特殊字符
                if (replacement == null) {
                    continue;
                }
            } else if (c == '\u2028') {
                replacement = "\\u2028";
            } else if (c == '\u2029') {
                replacement = "\\u2029";
            } else {
                continue;
            }
            if (last < i) {
                sb.append(value, last, i);
            }
            sb.append(replacement);
            last = i + 1;
        }
        if (last < length) {
            sb.append(value, last, length);
        }
        return sb.toString();
    }

    public static String escapeJson(String value) {
        return escapeJson(value, false);
    }
}