轉JSON 工具類

/***

• Copyright (c) 2005, 2014 springside.github.io
• Licensed under the Apache License, Version 2.0 (the "License");
  ***/
  package com.amway.common.util;

import java.io.IOException;
import java.util.Collection;
import java.util.Map;

import org.apache.commons.lang.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.fasterxml.jackson.annotation.JsonInclude.Include;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.JavaType;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.databind.util.JSONPObject;

/**

• 簡單封裝Jackson，實現JSON String<->Java Object的Mapper.
• 封裝不同的輸出風格, 使用不同的builder函數創建實例.

• @author tony.he
  */
  public class JsonMapper {

  private static Logger logger = LoggerFactory.getLogger(JsonMapper.class);

  private ObjectMapper mapper;

  public JsonMapper() {
  this(null);
  }

  public JsonMapper(Include include) {
  mapper = new ObjectMapper();
  // 設置輸出時包含屬性的風格
  if (include != null) {
  mapper.setSerializationInclusion(include);
  }
  // 設置輸入時忽略在JSON字符串中存在但Java對象實際沒有的屬性
  mapper.disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);
  }

  /**

  • 創建只輸出非Null且非Empty(如List.isEmpty)的屬性到Json字符串的Mapper,建議在外部接口中使用.
    */
    public static JsonMapper nonEmptyMapper() {
    return new JsonMapper(Include.NON_EMPTY);
    }

  /**

  • 創建只輸出初始值被改變的屬性到Json字符串的Mapper, 最節約的存儲方式，建議在內部接口中使用。
    */
    public static JsonMapper nonDefaultMapper() {
    return new JsonMapper(Include.NON_DEFAULT);
    }

  /**

  • Object可以是POJO，也可以是Collection或數組。
  • 如果對象爲Null, 返回"null".

  • 如果集合爲空集合, 返回"[]".
    */
    public String toJson(Object object) {

    try {
    return mapper.writeValueAsString(object);
    } catch (IOException e) {
    logger.warn("write to json string error:" + object, e);
    return null;
    }
    }

  /**

  • 反序列化POJO或簡單Collection如List<String>.
  • 如果JSON字符串爲Null或"null"字符串, 返回Null.
  • 如果JSON字符串爲"[]", 返回空集合.
  • 如需反序列化複雜Collection如List<MyBean>, 請使用fromJson(String, JavaType)

  • @see #fromJson(String, JavaType)
    */
    public <T> T fromJson(String jsonString, Class<T> clazz) {
    if (StringUtils.isEmpty(jsonString)) {
    return null;
    }

    try {
    return mapper.readValue(jsonString, clazz);
    } catch (IOException e) {
    logger.warn("parse json string error:" + jsonString, e);
    return null;
    }
    }

  /**

  • 反序列化複雜Collection如List<Bean>, 先使用createCollectionType()或contructMapType()構造類型, 然後調用本函數.

  • @see #createCollectionType(Class, Class...)br/>*/
    @SuppressWarnings("unchecked")
    public <T> T fromJson(String jsonString, JavaType javaType) {
    if (StringUtils.isEmpty(jsonString)) {
    return null;
    }

    try {
    return (T) mapper.readValue(jsonString, javaType);
    } catch (IOException e) {
    logger.warn("parse json string error:" + jsonString, e);
    return null;
    }
    }

  /**

  • 構造Collection類型.br/>*/
    @SuppressWarnings("rawtypes")
    public JavaType contructCollectionType(Class<? extends Collection> collectionClass, Class<?> elementClass) {
    return mapper.getTypeFactory().constructCollectionType(collectionClass, elementClass);
    }

  /**

  • 構造Map類型.br/>*/
    @SuppressWarnings("rawtypes")
    public JavaType contructMapType(Class<? extends Map> mapClass, Class<?> keyClass, Class<?> valueClass) {
    return mapper.getTypeFactory().constructMapType(mapClass, keyClass, valueClass);
    }

  /**

  • 當JSON裏只含有Bean的部分屬性時，更新一個已存在Bean，只覆蓋該部分的屬性.
    */
    public void update(String jsonString, Object object) {
    try {
    mapper.readerForUpdating(object).readValue(jsonString);
    } catch (JsonProcessingException e) {
    logger.warn("update json string:" + jsonString + " to object:" + object + " error.", e);
    } catch (IOException e) {
    logger.warn("update json string:" + jsonString + " to object:" + object + " error.", e);
    }
    }

  /**

  • 輸出JSONP格式數據.
    */
    public String toJsonP(String functionName, Object object) {
    return toJson(new JSONPObject(functionName, object));
    }

  /**

  • 設定是否使用Enum的toString函數來讀寫Enum,
  • 為False時時使用Enum的name()函數來讀寫Enum, 默認為False.
  • 注意本函數一定要在Mapper創建後, 所有的讀寫動作之前調用.
    */
    public void enableEnumUseToString() {
    mapper.enable(SerializationFeature.WRITE_ENUMS_USING_TO_STRING);
    mapper.enable(DeserializationFeature.READ_ENUMS_USING_TO_STRING);
    }

  /**

  • 支持使用Jaxb的Annotation，使得POJO上的annotation不用與Jackson耦合。
  • 默認會先查找jaxb的annotation，如果找不到再找jackson的。
    /
    /public void enableJaxbAnnotation() {
    JaxbAnnotationModule module = new JaxbAnnotationModule();
    mapper.registerModule(module);
    }*/

  /**

  • 取出Mapper做進一步的設置或使用其他序列化API.
    */
    public ObjectMapper getMapper() {
    return mapper;
    }
    }