【淺度渣文】Jackson之jackson-annotations

原文連接：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支持，給字段配置人類閱讀的解釋
  • core和data-bind不會使用這個註解，主要是被JSON Schema generator這個模塊使用

反序列化和序列化的細節

• @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"}}
複製代碼