Gson教程四(译):Maps的映射

该文章翻译自Gson Tutorial Series系列教程。该篇主要阐述了如何使用Gson映射Maps。

Java Maps的序列化

Java maps是一种非常具有弹性数据类型,它可以用于各种各样的场景。它使得我们开发者运用Java程序语言可以实现很多真实世界的场景。因为Java maps的使用范围如此之广,因此这里可能不会和你的用例相同,但方法时适合所有用例的。

让我们从这样一个场景开始,你的App拥有一个雇员姓名列表。你被要求实现这样一个View,它可以显示所有以某个特定字母开头的雇员。例如,用户可以选择字母A,然后你的应用将会返回三个匹配的雇员Andreas,Aden和Arnold。开始的迭代器仅仅是一个可以显示所有名字列表,性能并不良好。因此,我们将采用HashMap代替,它的key是首字母(比如A),它的值时一个名字列表。

我们的创建HashMap的Java代码如下所示:

HashMap<String, List<String>> employees = new HashMap<>();  
employees.put("A", Arrays.asList("Andreas", "Arnold", "Aden"));  
employees.put("C", Arrays.asList("Christian", "Carter"));  
employees.put("M", Arrays.asList("Marcus", "Mary")); 

maps的序列化和其他类型是一样的。你仅仅需要把它扔给Gson,Gson将会执行一切:

Gson gson = new Gson();  
String employeeJson = gson.toJson(employees);  

返回的JSON结果为:

{
  "M": [
    "Marcus",
    "Mary"
  ],
  "C": [
    "Christian",
    "Carter"
  ],
  "A": [
    "Andreas",
    "Arnold",
    "Aden"
  ]
}

每一个键(A,C和M)都拥有一个名字列表,这正是我们想要的。

反序列化Java Maps

如果你查看之前的JSON结果,或者查看下面的JSON,你可能会提出这样一个问题:你怎样才能发现这是一个集合,还是很多个对象呢?答案是简单粗暴的:你不能。这就是JSON数据的意思是模棱两可的一个例子。让我们看一下下面这个例子:

{
  "1$": {
    "amount": 1,
    "currency": "Dollar"
  },
  "2$": {
    "amount": 2,
    "currency": "Dollar"
  },
  "3€": {
    "amount": 3,
    "currency": "Euro"
  }
}

用户可以把该JSON假设为三个对象,每个对象的名为1$, 2$, 3€。每个对象有一些值。但另一方面,也可以想象成是一个简单的Map,其中1$, 2$和3€是键。

没有任何简便方法可以使你估计出JSON的数据类型。一些要点可能能帮到你:

  • 首要的是:环境信息!如果你由文档或者知道每个对象的描述信息,那么你可能就知道他们是分离的对象,还是一个map数据了。
  • 数据类型是否是一致的?若是则倾向为map。
  • 对象的名称或者是键值是否是动态的并且取名范围较广?这也是倾向为map的。

之前的博客中,我们已经向你展示如何映射常规对象,因此在在这篇博客中,我们假设JSON是map数据。那么我们该如何将上面的JSON映射为Java对象呢?

我们使用在列表对象博客中已经提到过的TypeToken方法。通过创建一个新的TypeToken来获得我们所希望的数据类型的type:

public class AmountWithCurrency {  
    String currency;
    int amount;
}

String dollarJson = "{ '1$': { 'amount': 1, 'currency': 'Dollar'}, '2$': { 'amount': 2, 'currency': 'Dollar'}, '3€': { 'amount': 3, 'currency': 'Euro'} }";

Gson gson = new Gson();

Type amountCurrencyType =  
    new TypeToken<HashMap<String, AmountWithCurrency>>(){}.getType();

HashMap<String, AmountWithCurrency> amountCurrency =  
    gson.fromJson(dollarJson, amountCurrencyType);

amountCurrency变量正确地拥有该集合的所有键值对:


嵌套的Maps

Map数据结构不需要是model或者JSON的根元素。它可以仅仅是一个对象的一个属性。你可以使用和之前序列化和反序列化列表的方法处理。我们已经发布了关于嵌套的处理方式。

推荐阅读更多精彩内容