POM

  1. <!-- Json Begin -->
  2. <dependency>
  3.     <groupId>com.fasterxml.jackson.core</groupId>
  4.     <artifactId>jackson-core</artifactId>
  5.     <version>2.9.5</version>
  6. </dependency>
  7. <dependency>
  8.     <groupId>com.fasterxml.jackson.core</groupId>
  9.     <artifactId>jackson-databind</artifactId>
  10.     <version>2.9.5</version>
  11. </dependency>
  12. <dependency>
  13.     <groupId>com.fasterxml.jackson.core</groupId>
  14.     <artifactId>jackson-annotations</artifactId>
  15.     <version>2.9.5</version>
  16. </dependency>
  17. <!-- Json End -->

注解

@JsonProperty

@JsonProperty 注解指定一个属性用于 JSON 映射，默认情况下映射的 JSON 属性与注解的属性名称相同，不过可以使用该注解的 value 值修改 JSON 属性名，该注解还有一个 index 属性指定生成 JSON 属性的顺序，如果有必要的话。

@JsonIgnore

@JsonIgnore 注解用于排除某个属性，这样该属性就不会被 Jackson 序列化和反序列化。

@JsonIgnoreProperties

@JsonIgnoreProperties 注解是类注解。在序列化为 JSON 的时候，@JsonIgnoreProperties({“prop1”, “prop2”}) 会忽略 pro1 和 pro2 两个属性。在从 JSON 反序列化为 Java 类的时候，@JsonIgnoreProperties(ignoreUnknown=true) 会忽略所有没有 Getter 和 Setter 的属性。该注解在 Java 类和 JSON 不完全匹配的时候很有用。

@JsonIgnoreType

@JsonIgnoreType 也是类注解，会排除所有指定类型的属性。

@JsonPropertyOrder

@JsonPropertyOrder 和 @JsonProperty 的 index 属性类似，指定属性序列化时的顺序。

@JsonRootName

@JsonRootName 注解用于指定 JSON 根属性的名称。

工具类

  1. import com.fasterxml.jackson.annotation.JsonInclude;
  2. import com.fasterxml.jackson.core.type.TypeReference;
  3. import com.fasterxml.jackson.databind.DeserializationFeature;
  4. import com.fasterxml.jackson.databind.JavaType;
  5. import com.fasterxml.jackson.databind.ObjectMapper;
  7. import java.util.ArrayList;
  8. import java.util.HashMap;
  9. import java.util.List;
  10. import java.util.Map;
  12. /**
  13.  * Jackson 工具类
  14.  * <p>Title: MapperUtils</p>
  15.  * <p>Description: </p>
  16.  *
  17.  */
  18. public class MapperUtils {
  19.     private final static ObjectMapper objectMapper = new ObjectMapper();
  21.     public static ObjectMapper getInstance() {
  22.         return objectMapper;
  23.     }
  25.     /**
  26.      * 转换为 JSON 字符串
  27.      *
  28.      * @param obj
  29.      * @return
  30.      * @throws Exception
  31.      */
  32.     public static String obj2json(Object obj) throws Exception {
  33.         return objectMapper.writeValueAsString(obj);
  34.     }
  36.     /**
  37.      * 转换为 JSON 字符串，忽略空值
  38.      *
  39.      * @param obj
  40.      * @return
  41.      * @throws Exception
  42.      */
  43.     public static String obj2jsonIgnoreNull(Object obj) throws Exception {
  44.         ObjectMapper mapper = new ObjectMapper();
  45.         mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
  46.         return mapper.writeValueAsString(obj);
  47.     }
  49.     /**
  50.      * 转换为 JavaBean
  51.      *
  52.      * @param jsonString
  53.      * @param clazz
  54.      * @return
  55.      * @throws Exception
  56.      */
  57.     public static <T> T json2pojo(String jsonString, Class<T> clazz) throws Exception {
  58.         objectMapper.configure(DeserializationFeature.ACCEPT_SINGLE_VALUE_AS_ARRAY, true);
  59.         return objectMapper.readValue(jsonString, clazz);
  60.     }
  62.     /**
  63.      * 字符串转换为 Map<String, Object>
  64.      *
  65.      * @param jsonString
  66.      * @return
  67.      * @throws Exception
  68.      */
  69.     public static <T> Map<String, Object> json2map(String jsonString) throws Exception {
  70.         ObjectMapper mapper = new ObjectMapper();
  71.         mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
  72.         return mapper.readValue(jsonString, Map.class);
  73.     }
  75.     /**
  76.      * 字符串转换为 Map<String, T>
  77.      */
  78.     public static <T> Map<String, T> json2map(String jsonString, Class<T> clazz) throws Exception {
  79.         Map<String, Map<String, Object>> map = objectMapper.readValue(jsonString, new TypeReference<Map<String, T>>() {
  80.         });
  81.         Map<String, T> result = new HashMap<String, T>();
  82.         for (Map.Entry<String, Map<String, Object>> entry : map.entrySet()) {
  83.             result.put(entry.getKey(), map2pojo(entry.getValue(), clazz));
  84.         }
  85.         return result;
  86.     }
  88.     /**
  89.      * 深度转换 JSON 成 Map
  90.      *
  91.      * @param json
  92.      * @return
  93.      */
  94.     public static Map<String, Object> json2mapDeeply(String json) throws Exception {
  95.         return json2MapRecursion(json, objectMapper);
  96.     }
  98.     /**
  99.      * 把 JSON 解析成 List，如果 List 内部的元素存在 jsonString，继续解析
  100.      *
  101.      * @param json
  102.      * @param mapper 解析工具
  103.      * @return
  104.      * @throws Exception
  105.      */
  106.     private static List<Object> json2ListRecursion(String json, ObjectMapper mapper) throws Exception {
  107.         if (json == null) {
  108.             return null;
  109.         }
  111.         List<Object> list = mapper.readValue(json, List.class);
  113.         for (Object obj : list) {
  114.             if (obj != null && obj instanceof String) {
  115.                 String str = (String) obj;
  116.                 if (str.startsWith("[")) {
  117.                     obj = json2ListRecursion(str, mapper);
  118.                 } else if (obj.toString().startsWith("{")) {
  119.                     obj = json2MapRecursion(str, mapper);
  120.                 }
  121.             }
  122.         }
  124.         return list;
  125.     }
  127.     /**
  128.      * 把 JSON 解析成 Map，如果 Map 内部的 Value 存在 jsonString，继续解析
  129.      *
  130.      * @param json
  131.      * @param mapper
  132.      * @return
  133.      * @throws Exception
  134.      */
  135.     private static Map<String, Object> json2MapRecursion(String json, ObjectMapper mapper) throws Exception {
  136.         if (json == null) {
  137.             return null;
  138.         }
  140.         Map<String, Object> map = mapper.readValue(json, Map.class);
  142.         for (Map.Entry<String, Object> entry : map.entrySet()) {
  143.             Object obj = entry.getValue();
  144.             if (obj != null && obj instanceof String) {
  145.                 String str = ((String) obj);
  147.                 if (str.startsWith("[")) {
  148.                     List<?> list = json2ListRecursion(str, mapper);
  149.                     map.put(entry.getKey(), list);
  150.                 } else if (str.startsWith("{")) {
  151.                     Map<String, Object> mapRecursion = json2MapRecursion(str, mapper);
  152.                     map.put(entry.getKey(), mapRecursion);
  153.                 }
  154.             }
  155.         }
  157.         return map;
  158.     }
  160.     /**
  161.      * 将 JSON 数组转换为集合
  162.      *
  163.      * @param jsonArrayStr
  164.      * @param clazz
  165.      * @return
  166.      * @throws Exception
  167.      */
  168.     public static <T> List<T> json2list(String jsonArrayStr, Class<T> clazz) throws Exception {
  169.         JavaType javaType = getCollectionType(ArrayList.class, clazz);
  170.         List<T> list = (List<T>) objectMapper.readValue(jsonArrayStr, javaType);
  171.         return list;
  172.     }
  175.     /**
  176.      * 获取泛型的 Collection Type
  177.      *
  178.      * @param collectionClass 泛型的Collection
  179.      * @param elementClasses  元素类
  180.      * @return JavaType Java类型
  181.      * @since 1.0
  182.      */
  183.     public static JavaType getCollectionType(Class<?> collectionClass, Class<?>... elementClasses) {
  184.         return objectMapper.getTypeFactory().constructParametricType(collectionClass, elementClasses);
  185.     }
  187.     /**
  188.      * 将 Map 转换为 JavaBean
  189.      *
  190.      * @param map
  191.      * @param clazz
  192.      * @return
  193.      */
  194.     public static <T> T map2pojo(Map map, Class<T> clazz) {
  195.         return objectMapper.convertValue(map, clazz);
  196.     }
  198.     /**
  199.      * 将 Map 转换为 JSON
  200.      *
  201.      * @param map
  202.      * @return
  203.      */
  204.     public static String mapToJson(Map map) {
  205.         try {
  206.             return objectMapper.writeValueAsString(map);
  207.         } catch (Exception e) {
  208.             e.printStackTrace();
  209.         }
  210.         return "";
  211.     }
  213.     /**
  214.      * 将 JSON 对象转换为 JavaBean
  215.      *
  216.      * @param obj
  217.      * @param clazz
  218.      * @return
  219.      */
  220.     public static <T> T obj2pojo(Object obj, Class<T> clazz) {
  221.         return objectMapper.convertValue(obj, clazz);
  222.     }
  224.       /**
  225.      * 将指定节点的 JSON 数据转换为 JavaBean
  226.      *
  227.      * @param jsonString
  228.      * @param clazz
  229.      * @return
  230.      * @throws Exception
  231.      */
  232.     public static <T> T json2pojoByTree(String jsonString, String treeNode, Class<T> clazz) throws Exception {
  233.         JsonNode jsonNode = objectMapper.readTree(jsonString);
  234.         JsonNode data = jsonNode.findPath(treeNode);
  235.         return json2pojo(data.toString(), clazz);
  236.     }
  237.     /**
  238.      * 将指定节点的 JSON 数组转换为集合
  239.      *
  240.      * @param jsonStr  JSON 字符串
  241.      * @param treeNode 查找 JSON 中的节点
  242.      * @return
  243.      * @throws Exception
  244.      */
  245.     public static <T> List<T> json2listByTree(String jsonStr, String treeNode, Class<T> clazz) throws Exception {
  246.         JsonNode jsonNode = objectMapper.readTree(jsonStr);
  247.         JsonNode data = jsonNode.findPath(treeNode);
  248.         return json2list(data.toString(), clazz);
  249.     }
  250. }