Jackson 学习笔记

﹏ヽ暗。殇╰゛Y 2023-02-19 13:23 9阅读 0赞

### Jackson 学习笔记 ###

*  语法
 *   *  JSON 转 POJO
     *  POJO 转 JSON
     *  JSON 转 list
     *  list 转 JSON
     *  手动构建json对象
     *  按路径取直接目标值 at
     *  取值转类型
 *  注解
 *   *  @JsonProperty
 *  jackson 配置
 *  参考资料

# 语法 #

1.  `com.fasterxml.jackson.databind.ObjectMapper` ObjectMapper mapper; 不要每次都`new`如果在`Spring`中直接注入使用。
2.  `JsonNode`不能`put`可以强转`objectNode`后操作。
3.  `objectNode`添加内容时。基础类型、包装类用 `put`，自定义对象用`set`

<table> 
 <thead> 
  <tr> 
   <th>方法</th> 
   <th>参数</th> 
   <th>返回</th> 
   <th>介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>mapper.writeValueAsString</code></td> 
   <td>对象</td> 
   <td>json字符串</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td><code>mapper.readValue</code></td> 
   <td><code>jsonString</code>, <code>class</code></td> 
   <td>对象</td> 
   <td>用于知晓对象类型的场景</td> 
  </tr> 
  <tr> 
   <td><code>mapper.readValue</code></td> 
   <td><code>jsonString</code>, <code>JavaType</code></td> 
   <td>字符串转集合(结果要强转)</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td><code>mapper.readValue</code></td> 
   <td><code>jsonString</code>, <code>TypeReference&lt;T&gt;</code></td> 
   <td>字符串转集合</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td><code>mapper.readTree</code></td> 
   <td>json字符串</td> 
   <td><code>JsonNode</code></td> 
   <td>用于类型不明的场景</td> 
  </tr> 
 </tbody> 
</table>

测试用对象

public class Npc {  private String name;private Integer age;}

## JSON 转 POJO ##

String jsonStr = "{\"name\":\"张三\", \"age\":18}";
    Npc npc = mapper.readValue(jsonStr, Npc.class);
    
    System.out.print("json2obj：");System.out.println(npc);

## POJO 转 JSON ##

String obj2json = mapper.writeValueAsString(npc);
    
    System.out.print("obj2json：");System.out.println(obj2json);

## JSON 转 list ##

String json2list = "[{\"name\":\"李四\",\"age\":13},{\"name\":\"王五\",\"age\":14},{\"name\":\"赵六\",\"age\":15},{\"name\":\"洪七\",\"age\":16},{\"name\":\"重八\",\"age\":17}]";
    
    // 方案一：有缺陷结果需要强转不好看
    JavaType javaType = mapper.getTypeFactory().constructParametricType(ArrayList.class, Npc.class);
    List<Npc> npcs = (List<Npc>) mapper.readValue(json2list, javaType);
    
    System.out.print("json2list1：");System.out.println(npcs);
    
    // 方案二：无需要强转
    TypeReference<List<Npc>> listTypeReference = new TypeReference<List<Npc>>(){ };
    List<Npc> npcs1 = mapper.readValue(json2list, listTypeReference);
    
    System.out.print("json2list2：");System.out.println(npcs1);

基础类型：

String jsonStr = "[1,2,3,4,5,6]";
    List list = mapper.readValue(jsonStr, List.class);

## list 转 JSON ##

List<Npc> list = new ArrayList<Npc>();
    list.add(new Npc("李四", 13));
    list.add(new Npc("王五", 13));
    list.add(new Npc("赵六", 13));
    list.add(new Npc("洪七", 13));
    list.add(new Npc("重八", 13));
    
    String list2json = mapper.writeValueAsString(list);
    
    System.out.print("list2json：");System.out.println(list2json);

## 手动构建json对象 ##

还可以用 `toPrettyString()`输出`格式化`的`json`

ArrayNode jsonNodes = mapper.createArrayNode(); // 创建json数组
    for (int i = 0; i < 10; i++) { 
       ObjectNode objectNode = mapper.createObjectNode(); // 创建json对象
       objectNode.put("name", "角色" + i);
       jsonNodes.add(objectNode);
    }
    
    System.out.print("手动构建json对象：");
    System.out.println(jsonNodes.toString());

## 按路径取直接目标值 at ##

String jsonStr2 = "[{\"name\":\"张三\",\"age\":13},{\"name\":\"重八\",\"age\":18,\"friend\":{\"name\":\"洪七\",\"age\":17,\"friend\":{\"name\":\"赵六\",\"age\":16,\"friend\":{\"name\":\"王五\",\"age\":15}}}}]";
    ArrayNode jsonNodes1 = mapper.readValue(jsonStr2, ArrayNode.class);
    
    System.out.print("at按路径取直接目标值：");
    System.out.println(jsonNodes1.get(1).at("/friend/friend/friend/name"));

## 取值转类型 ##

jsonNodes1.get(1).at("/friend/name").getNodeType(); // STRING
    jsonNodes1.get(1).at("/friend/agt").getNodeType(); // NUMBER
    String name = jsonNodes1.get(0).get("name").asText(); // 取值并转为字符串类型
    int age = jsonNodes1.get(0).get("age").asInt(); // 取值并转为数字类型

# 注解 #

<table> 
 <thead> 
  <tr> 
   <th align="left">注解</th> 
   <th align="left">说明</th> 
   <th>用于</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left"><code>@JsonInclude(JsonInclude.Include.NON_EMPTY)</code></td> 
   <td align="left">字段为<code>null</code>或<code>空字符串</code>不序列化。<br>也可以在配置中全局设置：<br><code>spring.jackson.default-property-inclusion: non_empty</code> 参数介绍看此枚举类</td> 
   <td>字段</td> 
  </tr> 
  <tr> 
   <td align="left"><code>@JsonIgnore</code></td> 
   <td align="left">序列化时忽略此字段。</td> 
   <td>字段</td> 
  </tr> 
  <tr> 
   <td align="left"><code>@JsonProperty(value = "name")</code></td> 
   <td align="left">序列化、反序列化时默认使用属性名。<br>此注解修改<code>序列化</code>/<code>反序列化</code>的名字。(原属性名<code>失效</code>)</td> 
   <td>字段</td> 
  </tr> 
  <tr> 
   <td align="left"><code>@JsonAlias({"user_name", "userName"})</code></td> 
   <td align="left">为属性添加别名，可用于兼容前端传来的不同格式的参数。别名可以多个，只影响<code>反序列化</code>。(原属性名<code>有效</code>)</td> 
   <td>字段</td> 
  </tr> 
  <tr> 
   <td align="left"><code>@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")</code></td> 
   <td align="left">设置时间格式。</td> 
   <td>字段</td> 
  </tr> 
  <tr> 
   <td align="left"><code>@JsonUnwrapped</code></td> 
   <td align="left">把对象展平（消除层级放到同一级）</td> 
   <td>字段</td> 
  </tr> 
  <tr> 
   <td align="left"><code>@JsonIgnoreType</code></td> 
   <td align="left">类注解，序列化时忽略此类。</td> 
   <td>类</td> 
  </tr> 
  <tr> 
   <td align="left"><code>@JsonIdentityInfo(generator = ObjectIdGenerators.PropertyGenerator.class,property = "id")</code></td> 
   <td align="left">用于指示在序列化/反序列化值时可以正确地反序列化对单个Java对象的多个引用。用于处理循环对象引用。</td> 
   <td>类</td> 
  </tr> 
  <tr> 
   <td align="left"><code>@JsonPropertyOrder({"field1", "field2", "field2"})</code></td> 
   <td align="left">设置字段顺序</td> 
   <td>类</td> 
  </tr> 
  <tr> 
   <td align="left"><code>@JsonIgnoreProperties({"prop1", "prop2"})</code><br><code>@JsonIgnoreProperties(ignoreUnknown=true)</code></td> 
   <td align="left">序列化时忽略指定的“prop1”, “prop2” 两个属性。<br>反序列化时忽略无Getter 和 Setter 的属性。（忽略未知属性）</td> 
   <td>类</td> 
  </tr> 
  <tr> 
   <td align="left"><code>@JsonRootName</code></td> 
   <td align="left">类注释， 指定JSON 根属性的名称（如果启用了根包装）</td> 
   <td>类</td> 
  </tr> 
 </tbody> 
</table>

## @JsonProperty ##

*  支持枚举，但尽量别用。

public enum Status { 
        @JsonProperty("ok") STATUS_OK,
        @JsonProperty("error") STATUS_ERROR;
    }

# jackson 配置 #

`MapperFeature.ACCEPT_CASE_INSENSITIVE_PROPERTIES` 大小写敏感

import com.fasterxml.jackson.core.JsonProcessingException;
    import com.fasterxml.jackson.databind.MapperFeature;
    import com.fasterxml.jackson.databind.ObjectMapper;
    import lombok.Data;
    
    @Data
    public class Npc { 
        private String username;
    
        public static void main(String[] args) throws JsonProcessingException { 
            ObjectMapper mapper = new ObjectMapper();
            mapper.configure(MapperFeature.ACCEPT_CASE_INSENSITIVE_PROPERTIES, true);
    
            Npc npc = new Npc();
            npc.setUsername("笨笨");
            System.out.println(mapper.writeValueAsString(npc));
    
            String json = "{\"UserName\":\"耀眼的笨笨\"}";
            npc = mapper.readValue(json, Npc.class);
            System.out.println(npc.toString());
        }
    }

结果：

{ "username":"笨笨"}
    Npc(username=耀眼的笨笨)

# 参考资料 #

[github: jackson-databind][github_ jackson-databind]  
[github: jackson-annotations][github_ jackson-annotations]  
[MapperFeature][]

[github_ jackson-databind]: https://github.com/FasterXML/jackson-databind
[github_ jackson-annotations]: https://github.com/FasterXML/jackson-annotations/wiki/Jackson-Annotations
[MapperFeature]: https://fasterxml.github.io/jackson-databind/javadoc/2.5/com/fasterxml/jackson/databind/MapperFeature.html