JAVA JSON databinding 的多态

JSON 在 REST API 的调用中越来越多的应用,如何表达多态是经常碰到的一个问题。

有三种方式解决这个问题

  • PROPERTYEXISTING_PROPERTY, POJO 映射为 JSON Object ,某一个字段表示类型。
  • WRAPPER_OBJECT POJO 映射为只有一个字段的 JSON Object ,字段名表示类型。
  • WRAPPER_ARRAY POJO 映射为两个元素的数组 ,前面的表示类型,后面的表示指值。

背景

@Data
static class  Zoo {
    private Animal leader;
    private Animal[] followers;
}

假设有一个 Zoo 类,里面包含了一个特殊的动物 leader,和一些动物 followers。下面的代码试图转换 JSON

public static void main(String[] args) throws IOException {
    Zoo zoo = new Zoo();
    zoo.setLeader(new Dog());
    zoo.setFollowers(new Animal[]{new Dog(), new Cat()});
    final ObjectMapper mapper = new ObjectMapper();
    final String json = mapper.writeValueAsString(zoo);
    System.out.println(json);
    final Zoo zoo2 = mapper.readValue(json, Zoo.class);
    System.out.println(zoo2);
}

例子 DogCat

static class Dog implements Animal {
    private String name = "wangwang";
    @Override
    public String getAnimalType() {
        return "dog";
    }

    @Override
    public String getName() {
        return name;
    }
    @Override
    public void setName(String name) {
        this.name = name;
    }
}
static class Cat implements Animal {
    private String name = "miao";

    @Override
    public String getAnimalType() {
        return "cat";
    }

    @Override
    public String getName() {
        return name;
    }
    @Override
    public void setName(String name) {
        this.name = name;
    }
}

把 POJO 映射称为 JSON Object , include = JsonTypeInfo.As.EXISTING_PROPERTY

include = JsonTypeInfo.As.PROPERTY 也类似,区别不大。

用字段 animalType 来表示类型信息。

{
  "leader": {
    "name": "wangwang",
    "animalType": "dog"
  },
  "followers": [
    {
      "name": "wangwang",
      "animalType": "dog"
    },
    {
      "name": "miao",
      "animalType": "cat"
    }
  ]
}
@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.EXISTING_PROPERTY,
        property = "animalType")
@JsonSubTypes({
        @JsonSubTypes.Type(value = Dog.class, name = "dog"),
        @JsonSubTypes.Type(value = Cat.class, name = "cat")})
@JsonIgnoreProperties(ignoreUnknown = true)
public interface Animal {
    String getAnimalType();
    String getName();
    void setName(String name);
}

这种类型还有很多变种。例如 use 可以选择 JsonTypeInfo.Id.CLASS 之类的。

把 POJO 映射称为数组 , include = JsonTypeInfo.As.WRAPPER_ARRAY

{
  "leader": [
    "dog",
    {
      "name": "wangwang",
      "animalType": "dog"
    }
  ],
  "followers": [
    [
      "dog",
      {
        "name": "wangwang",
        "animalType": "dog"
      }
    ],
    [
      "cat",
      {
        "name": "miao",
        "animalType": "cat"
      }
    ]
  ]
}

每个POJO 映射为一个两个元素的 JSON 数组,第一个元素表示类型,第二个元素表示真正的内容。

把 POJO 映射称为包装对象 nclude = JsonTypeInfo.As.WRAPPER_OBJECT

{
  "leader": {
    "dog": {
      "name": "wangwang",
      "animalType": "dog"
    }
  },
  "followers": [
    {
      "dog": {
        "name": "wangwang",
        "animalType": "dog"
      }
    },
    {
      "cat": {
        "name": "miao",
        "animalType": "cat"
      }
    }
  ]
}
{
  "leader": {
    "dog": {
      "name": "wangwang",
      "animalType": "dog"
    }
  },
  "followers": [
    {
      "dog": {
        "name": "wangwang",
        "animalType": "dog"
      }
    },
    {
      "cat": {
        "name": "miao",
        "animalType": "cat"
      }
    }
  ]
}

每个 POJO 映射为一个 只有一个 property 的 POJO Object ,这个 property name 表示类型信息。 property value 是 POJO 真正的内容。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,456评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,370评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,337评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,583评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,596评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,572评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,936评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,595评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,850评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,601评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,685评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,371评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,951评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,934评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,167评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,636评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,411评论 2 342

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,585评论 18 139
  • 1. 简介 1.1 什么是 MyBatis ? MyBatis 是支持定制化 SQL、存储过程以及高级映射的优秀的...
    笨鸟慢飞阅读 5,422评论 0 4
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,560评论 18 399
  • 作者: weiyf时间: 2016-10-31 21:35:33原文链接:https://developer.an...
    卫裕发阅读 4,634评论 2 15
  • 我羡慕你有爱情,她对你百依百顺,你们有车有房有存款,你的生活有她打理,你的脾气有她安慰。我真的很羡慕那些情侣,可是...
    回首的背叛阅读 160评论 0 2