【淺度渣文】Jackson之jackson-annotations

我是賣報滴小行家?發表於2018-10-17

原文連結：http://www.dubby.cn/detail.html?id=9071

欄位命名

  • @JsonProperty可以指定欄位的命名（還可以指定這個欄位需要參與序列化和反序列化）。
    • @JsonProperty.value:指定的欄位名字
    • @JsonProperty.index:指定順序，默寫資料格式是基於順序(JSON不是這種資料格式)
    • @JsonProperty.defaultValue:預設值。注意：這個屬性目前為止並沒有被core和data-bind使用；製備一些擴充套件模組使用。

欄位包含

  • @JsonAutoDetect:定義預設的欄位包含規則
  • @JsonIgnore:忽略某個指定的欄位:
    • 修飾欄位，setter和getter中的任何一個，相當於所有都加了
      • 除非使用@JsonProperty修飾，可以實現只忽略序列化或者反序列化
  • @JsonIgnoreProperties:修飾類，指定忽略一個欄位列表，或者忽略那些未知的欄位
  • @JsonIgnoreType:修飾類，忽略指定的型別的欄位
  • @JsonInclude:可以定義空值是否參與(反)序列化

欄位文件，後設資料

  • @JsonPropertyDescription:2.3支援，給欄位配置人類閱讀的解釋

反序列化和序列化的細節

  • @JsonFormat:對於Date/Time欄位，可以指定格式化格式
  • @JsonUnwrapped:指定某個欄位(型別是POJO)序列化成扁平化，而不是巢狀物件，在反序列化時再包裝成物件
  • @JsonView:可以定義檢視

@JsonUnwrapped(prefix = "pre")簡單解釋:

public class MyValue {
    public String name;
    JsonUnwrapped(prefix = "pre_", suffix = "_suf")
    public MyValue myValue;
    public int age;
    public Date date;
}
複製程式碼

序列化結果:

{"name":"楊正","pre_name_suf":null,"pre_age_suf":0,"pre_date_suf":null,"age":24,"date":"2017-12-09"}
複製程式碼

@JsonView簡單解釋:

public class JsonViewTest {

    public static void main(String[] args) throws IOException {
        ObjectMapper objectMapper = new ObjectMapper();

        String json = "{\"username\":\"dubby.cn\",\"password\":\"123456\"}";
        //反序列化，使用檢視
        User user = objectMapper.readerWithView(User.UserWithoutPassword.class).forType(User.class).readValue(json);
        System.out.println(user);
        user.password = "xxxx";
        //序列化，使用檢視
        String result1 = objectMapper.writerWithView(User.UserWithoutPassword.class).writeValueAsString(user);
        System.out.println(result1);
        String result2 = objectMapper.writerWithView(User.UserWithPassword.class).writeValueAsString(user);
        System.out.println(result2);
    }

}

class User {
    @JsonView({UserWithoutPassword.class})
    public String username;
    @JsonView({UserWithPassword.class})
    public String password;

    public interface UserWithPassword extends UserWithoutPassword {
    }

    public interface UserWithoutPassword {
    }

    @Override
    public String toString() {
        return "User{" +
                "username='" + username + '\'' +
                ", password='" + password + '\'' +
                '}';
    }
}
複製程式碼

反序列化細節

  • @JacksonInject:指示某個欄位的值是注入的，而不是從JSON中取出的
  • @JsonAnySetter:修飾一個2個引數的方法，任何JSON中有，而物件中沒有的欄位都會以(key,value)的形式傳給這個方法
  • @JsonCreator:上篇文章自定義構造方法介紹過了
  • @JsonSetter:是@JsonProperty的替代註解
  • @JsonEnumDefaultValue:反序列化時，如果遇到未定義的列舉值時，賦值為預設列舉

@JsonAnySetter簡單解釋:

public class JsonAnySetterTest {

    public static void main(String[] args) throws IOException {
        String json = "{\"username\":\"dubby.cn\",\"password\":\"123456\",\"x-key\":\"xxx-value\",\"y-key\":\"yyy-value\"}";
        ObjectMapper objectMapper = new ObjectMapper();
        Data data = objectMapper.readValue(json, Data.class);
        System.out.println(data);
    }

}

class Data {

    public String username;

    public String password;

    public String other;

    @JsonAnySetter
    public void anySetter(String a, String b) {
        if (other == null) {
            other = "";
        }

        other += a;
        other += ",";
        other += b;
        other += ";";
    }

    @Override
    public String toString() {
        return "Data{" +
                "username='" + username + '\'' +
                ", password='" + password + '\'' +
                ", other='" + other + '\'' +
                '}';
    }
}
複製程式碼

輸出:

Data{username='dubby.cn', password='123456', other='x-key,xxx-value;y-key,yyy-value;'}
複製程式碼

@JsonEnumDefaultValue簡單解釋:

public class EnumTest {

    public static void main(String[] args) throws IOException {
        ObjectMapper objectMapper = new ObjectMapper();
        objectMapper.configure(DeserializationFeature.READ_UNKNOWN_ENUM_VALUES_USING_DEFAULT_VALUE, true);

        String json = "{\"myEnum\":\"V4\"}";
        EnumData enumData = objectMapper.readValue(json, EnumData.class);
        System.out.println(enumData);
    }

}

class EnumData {
    public MyEnum myEnum;
    @Override
    public String toString() {
        return "EnumData{" +
                "myEnum=" + myEnum +
                '}';
    }
}

enum MyEnum {
    V1, V2, V3, @JsonEnumDefaultValue Default;
}
複製程式碼

輸出:

EnumData{myEnum=Default}
複製程式碼

序列化細節

  • @JsonAnyGetter:修飾一個方法，返回Map，這個方法的返回值會被序列化成(key,value)形式
  • @JsonGetter:@JsonPropert的替代註解
  • @JsonPropertyOrder:註定序列化的順序
  • @JsonRawValue:被修飾的欄位“準確”的顯示出來，沒有轉義或裝飾，雙引號都不加
  • @JsonValue:指定序列化輸出的值
  • @JsonRootName:使用這個指定的值作為JSON的根，前提是SerializationFeature.WRAP_ROOT_VALUE已經開啟了

@JsonAnyGetter簡單解釋:

public class JsonAnyGetterTest {
    public static void main(String[] args) throws JsonProcessingException {
        ObjectMapper objectMapper = new ObjectMapper();
        AnyGetterData data = new AnyGetterData();
        data.data = "http://dubby.cn";
        System.out.println(objectMapper.writeValueAsString(data));
    }
}

class AnyGetterData {

    public String data;

    @JsonAnyGetter
    public Map other() {
        Map<String, String> map = new HashMap<>();
        map.put("key1", "value1");
        map.put("key2", "value2");
        map.put("key3", "value3");
        return map;
    }
}
複製程式碼

輸出:

{"data":"http://dubby.cn","key1":"value1","key2":"value2","key3":"value3"}
複製程式碼

@JsonPropertyOrder簡單解釋:

public class JsonPropertyOrderTest {
    public static void main(String[] args) throws JsonProcessingException {
        ObjectMapper objectMapper = new ObjectMapper();
        JsonPropertyOrderData data = new JsonPropertyOrderData();
        data.name1 = "value1";
        data.name2 = "value3";
        data.name3 = "value4";
        System.out.println(objectMapper.writeValueAsString(data));
    }
}

@JsonPropertyOrder(value = {"name2", "name3", "name1"})
class JsonPropertyOrderData {
    public String name1;
    public String name2;
    public String name3;
}
複製程式碼

輸出:

{"name2":"value3","name3":"value4","name1":"value1"}
複製程式碼

@JsonValue簡單解釋:

public class JsonValueTest {
    public static void main(String[] args) throws IOException {
        ObjectMapper objectMapper = new ObjectMapper();
        String json ="{\"name2\":\"value3\",\"name3\":\"value4\",\"name1\":\"value1\"}";
        JsonValueData data = objectMapper.readValue(json, JsonValueData.class);
        System.out.println(data.toString());
        System.out.println(objectMapper.writeValueAsString(data));
    }
}
class JsonValueData {
    public String name1;
    public String name2;
    public String name3;
    @JsonValue
    public String other() {
        return name1+name2+name3;
    }

    @Override
    public String toString() {
        return "JsonValueData{" +
                "name1='" + name1 + '\'' +
                ", name2='" + name2 + '\'' +
                ", name3='" + name3 + '\'' +
                '}';
    }
}
複製程式碼

輸出:

JsonValueData{name1='value1', name2='value3', name3='value4'}
"value1value3value4"
複製程式碼

@JsonRootName簡單解釋:

public class JsonRootNameTest {
    public static void main(String[] args) throws JsonProcessingException {
        ObjectMapper objectMapper = new ObjectMapper();
        objectMapper.configure(SerializationFeature.WRAP_ROOT_VALUE, true);
        RootData data = new RootData();
        data.name1 = "value1";
        data.name2 = "value2";
        data.name3 = "value3";
        System.out.println(objectMapper.writeValueAsString(data));
    }
}
@JsonRootName(value = "root")
class RootData {
    public String name1;
    public String name2;
    public String name3;
}
複製程式碼

輸出:

{"root":{"name1":"value1","name2":"value2","name3":"value3"}}
複製程式碼

相關文章