Jackson-annotations常用注解

原文鏈接:https://www.dubby.cn/detail.html?id=9071

字段命名

  • @JsonProperty

    可以指定字段的命名(還可以指定這個(gè)字段需要參與序列化和反序列化)默责。

    • @JsonProperty.value:指定的字段名字
    • @JsonProperty.index:指定順序多艇,默寫數(shù)據(jù)格式是基于順序(JSON不是這種數(shù)據(jù)格式)蚁堤。
    • @JsonProperty.defaultValue:默認(rèn)值幔戏。注意:這個(gè)屬性目前為止并沒有被core和data-bind使用;制備一些擴(kuò)展模塊使用攘烛。

字段包含

  • @JsonAutoDetect:定義默認(rèn)的字段包含規(guī)則
  • @JsonIgnore:忽略某個(gè)指定的字段:
    • 修飾字段魏滚,setter和getter中的任何一個(gè),相當(dāng)于所有都加了
      • 除非使用@JsonProperty修飾坟漱,可以實(shí)現(xiàn)只忽略序列化或者反序列化
  • @JsonIgnoreProperties:修飾類鼠次,指定忽略一個(gè)字段列表,或者忽略那些未知的字段
  • @JsonIgnoreType:修飾類,忽略指定的類型的字段
  • @JsonInclude:可以定義空值是否參與(反)序列化

字段文檔腥寇,元數(shù)據(jù)

  • @JsonPropertyDescription:2.3支持成翩,給字段配置人類閱讀的解釋
    • core和data-bind不會(huì)使用這個(gè)注解,主要是被JSON Schema generator這個(gè)模塊使用

反序列化和序列化的細(xì)節(jié)

  • @JsonFormat:對(duì)于Date/Time字段赦役,可以指定格式化格式
  • @JsonUnwrapped:指定某個(gè)字段(類型是POJO)序列化成扁平化麻敌,而不是嵌套對(duì)象,在反序列化時(shí)再包裝成對(duì)象
  • @JsonView:可以定義視圖

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

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

序列化結(jié)果:

{"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 + '\'' +
                '}';
    }
}

反序列化細(xì)節(jié)

  • @JacksonInject:指示某個(gè)字段的值是注入的,而不是從JSON中取出的
  • @JsonAnySetter:修飾一個(gè)2個(gè)參數(shù)的方法乙漓,任何JSON中有级历,而對(duì)象中沒有的字段都會(huì)以(key,value)的形式傳給這個(gè)方法
  • @JsonCreator:上篇文章自定義構(gòu)造方法介紹過了
  • @JsonSetter:是@JsonProperty的替代注解
  • @JsonEnumDefaultValue:反序列化時(shí),如果遇到未定義的枚舉值時(shí)叭披,賦值為默認(rèn)枚舉

@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}

序列化細(xì)節(jié)

  • @JsonAnyGetter:修飾一個(gè)方法寥殖,返回Map,這個(gè)方法的返回值會(huì)被序列化成(key,value)形式
  • @JsonGetter:@JsonPropert的替代注解
  • @JsonPropertyOrder:注定序列化的順序
  • @JsonRawValue:被修飾的字段“準(zhǔn)確”的顯示出來涩蜘,沒有轉(zhuǎn)義或裝飾嚼贡,雙引號(hào)都不加
  • @JsonValue:指定序列化輸出的值
  • @JsonRootName:使用這個(gè)指定的值作為JSON的根,前提是SerializationFeature.WRAP_ROOT_VALUE已經(jīng)打開了

@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"}}

關(guān)注我的微信公眾號(hào):FramePower
我會(huì)不定期發(fā)布相關(guān)技術(shù)積累同诫,歡迎對(duì)技術(shù)有追求粤策、志同道合的朋友加入,一起學(xué)習(xí)成長误窖!


微信公眾號(hào)
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末掐场,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子贩猎,更是在濱河造成了極大的恐慌,老刑警劉巖萍膛,帶你破解...
    沈念sama閱讀 211,290評(píng)論 6 491
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件吭服,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡蝗罗,警方通過查閱死者的電腦和手機(jī)艇棕,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,107評(píng)論 2 385
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來串塑,“玉大人沼琉,你說我怎么就攤上這事∽耍” “怎么了打瘪?”我有些...
    開封第一講書人閱讀 156,872評(píng)論 0 347
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經(jīng)常有香客問我闺骚,道長彩扔,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 56,415評(píng)論 1 283
  • 正文 為了忘掉前任僻爽,我火速辦了婚禮虫碉,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘胸梆。我一直安慰自己敦捧,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,453評(píng)論 6 385
  • 文/花漫 我一把揭開白布碰镜。 她就那樣靜靜地躺著兢卵,像睡著了一般。 火紅的嫁衣襯著肌膚如雪洋措。 梳的紋絲不亂的頭發(fā)上济蝉,一...
    開封第一講書人閱讀 49,784評(píng)論 1 290
  • 那天,我揣著相機(jī)與錄音菠发,去河邊找鬼王滤。 笑死,一個(gè)胖子當(dāng)著我的面吹牛滓鸠,可吹牛的內(nèi)容都是我干的雁乡。 我是一名探鬼主播,決...
    沈念sama閱讀 38,927評(píng)論 3 406
  • 文/蒼蘭香墨 我猛地睜開眼糜俗,長吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼踱稍!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起悠抹,我...
    開封第一講書人閱讀 37,691評(píng)論 0 266
  • 序言:老撾萬榮一對(duì)情侶失蹤珠月,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后楔敌,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體啤挎,經(jīng)...
    沈念sama閱讀 44,137評(píng)論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,472評(píng)論 2 326
  • 正文 我和宋清朗相戀三年卵凑,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了庆聘。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 38,622評(píng)論 1 340
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡勺卢,死狀恐怖伙判,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情黑忱,我是刑警寧澤宴抚,帶...
    沈念sama閱讀 34,289評(píng)論 4 329
  • 正文 年R本政府宣布勒魔,位于F島的核電站,受9級(jí)特大地震影響酱塔,放射性物質(zhì)發(fā)生泄漏沥邻。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,887評(píng)論 3 312
  • 文/蒙蒙 一羊娃、第九天 我趴在偏房一處隱蔽的房頂上張望唐全。 院中可真熱鬧,春花似錦蕊玷、人聲如沸邮利。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,741評(píng)論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽延届。三九已至,卻和暖如春贸诚,著一層夾襖步出監(jiān)牢的瞬間方庭,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,977評(píng)論 1 265
  • 我被黑心中介騙來泰國打工酱固, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留械念,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 46,316評(píng)論 2 360
  • 正文 我出身青樓运悲,卻偏偏與公主長得像龄减,于是被迫代替她去往敵國和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子班眯,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,490評(píng)論 2 348

推薦閱讀更多精彩內(nèi)容