Gson教程八(译):GsonBuilder基础以及命名策略

该文章翻译自Gson Tutorial Series系列教程。该篇主要阐述了如何使用GsonBuilder以及命名策略。

在这一系列之前发布的博客中,你已经学会了使用Gson将Java对象转换为JSON或与之相反。到目前为止,我们已经向你展示如何建构一个模型,对于得到正确的映射来说什么是重要的。从这篇博客开始,我们将会发表这一系列教程中的多篇博客,这会使你知道如何使用GsonBuilder去自定义Gson行为的多个方面。

GsonBuilder基础

在之前所有发表的博客中,仅仅使用了Gson gson = new Gson()方式得到Gson的实例;这在你仅仅需要Gson的基础配置时是完全有效的。然而,你可以改变Gson的设置细节。如果你需要使用Gson的方式和基础配置有略微的不同,那么这将是非常方便的。为了改变某一确定的配置,你可以使用GsonBuilder创建Gson实例,并自定义你的配置。

// previously
Gson gson = new Gson();

// now using GsonBuilder
GsonBuilder gsonBuilder = new GsonBuilder();  
Gson gson = gsonBuilder.create();  

GsonBuilder类提供了.Create()方法,该方法会返回一个Gson实例。该Gson实例可以做任何之前已经向你展示的功能:映射任何从JSON来或者到JSON去的数据。

命名策略

我们想为你展示的第一个GsonBuilder的可选项是命名策略。我们经常想象Java模型文件和从API发送请求然后响应回来的JSON拥有一样的命名机制。我们已经向你展示了如何使用@SerializedName在序列化时改变一个单独的属性。然而,如果你的API和Java模型不同意对它进行命名,那么使用@SerializedName为100多个属性添加注解将是非常繁琐的。

因此,Gson提供了配置的和自定义的FieldNamingPolicy。为了完成指定的目标,我们调整了UserSimple模型,并且为某些属性给定了新名称:

public class UserNaming {  
    String Name;
    String email_of_developer;
    boolean isDeveloper;
    int _ageOfDeveloper;
}

正如你所看到的,我们将所有命名标准都统一在了一个模型里面。这将导致它的JSON结果看起来很滑稽,但是,这很容易使我们发现多钟命名策略是如何影响它们的。你可以在GsonBuilder中添加策略:

GsonBuilder gsonBuilder = new GsonBuilder();  
gsonBuilder.setFieldNamingPolicy(FieldNamingPolicy.IDENTITY);  
Gson gson = gsonBuilder.create();  

所有用到以上Gson实例的转换,都将会遵循此处的域命名策略FieldNamingPolicy.IDENTITY。在下一部分,我们将会探索这究竟是什么意思,以及该预定义的域命名策略是如何起作用的。让我们先从简单的IDENTITY开始吧。

FieldNamingPolicy - IDENTITY

在序列化一个对象时,IDENTITY域命名策略将会使用和Java模型完全一样的名称。不论你使用什么样的命名标准设置你的Java模型,JSON会使用相同的。我们上面那个命名奇怪的模型的结果如下:

GsonBuilder gsonBuilder = new GsonBuilder();  
gsonBuilder.setFieldNamingPolicy(FieldNamingPolicy.IDENTITY);  
Gson gson = gsonBuilder.create();

UserNaming user = new UserNaming("Norman", "norman@futurestud.io", true, 26);  
String usersJson = gson.toJson(user);  

usersJSON内容为:

{
  "Name": "Norman",
  "_ageOfDeveloper": 26,
  "email_of_developer": "norman@futurestud.io",
  "isDeveloper": true
}

正如你所看到的,任何域名都没有改变。它从Java模型那里复制了所有名称。如果你没有为GsonBuilder设置命名策略或者直接使用new Gson()来实例化,它将会默认采用此策略。

FieldNamingPolicy - LOWER_CASE_WITH_UNDERSCORES

我们为您展示的第二个策略将是LOWER_CASE_WITH_UNDERSCORES。看名字已经非常清晰了,但还是让我们运用在我们的简单模型中:

GsonBuilder gsonBuilder = new GsonBuilder();  
gsonBuilder.setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES);  
Gson gson = gsonBuilder.create();

UserNaming user = new UserNaming("Norman", "norman@futurestud.io", true, 26);  
String usersJson = gson.toJson(user); 

LOWER_CASE_WITH_UNDERSCORES将会按照大写字母分离每一个属性名称,并且使用一个对应的小写字母和一个_符号代替。我们的模型中,有两个属性受到影响:

{
  "name": "Norman",
  "_age_of_developer": 26,
  "email_of_developer": "norman@futurestud.io",
  "is_developer": true
}

isDeveloper_ageOfDeveloper属性被_分开了。注意,_ageOfDeveloper的起始_依然还在。如果你不想使用下划线,而是更偏好短划线,下面的章节可能是你想要的。

FieldNamingPolicy - LOWER_CASE_WITH_DASHES

第三个可选项是LOWER_CASE_WITH_DASHES。这和LOWER_CASE_WITH_UNDERSCORES的机制是相同的,但是域名的分隔符为-。让我们执行下列代码:

GsonBuilder gsonBuilder = new GsonBuilder();  
gsonBuilder.setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_DASHES);  
Gson gson = gsonBuilder.create();

UserNaming user = new UserNaming("Norman", "norman@futurestud.io", true, 26);  
String usersJson = gson.toJson(user);  

usersJson的内容如下:

{
  "name": "Norman",
  "_age-of-developer": 26,
  "email_of_developer": "norman@futurestud.io",
  "is-developer": true
}

请注意,此处也仅仅改变了拥有大写字母的两个属性。以下划线开头的_ageOfDeveloper以及以下划线命名规则命名的email_of_developer并没有被影响。如果你需要更严格的策略,你需要实现你自己的逻辑,我们很快就会向你展示方法。但是在转到自定义策略之前,还有两个预定义策略需要介绍。

FieldNamingPolicy - UPPER_CAMEL_CASE

第四个策略是UPPER_CAMEL_CASE,这会使第一个字母大写。你现在应该已经完全懂得如何为GsonBuilder申请命名策略了:

GsonBuilder gsonBuilder = new GsonBuilder();  
gsonBuilder.setFieldNamingPolicy(FieldNamingPolicy.UPPER_CAMEL_CASE);  
Gson gson = gsonBuilder.create();

UserNaming user = new UserNaming("Norman", "norman@futurestud.io", true, 26);  
String usersJson = gson.toJson(user); 

usersJson的结果为:

{
  "Name": "Norman",
  "_AgeOfDeveloper": 26,
  "Email_of_developer": "norman@futurestud.io",
  "IsDeveloper": true
}

你能看到这是第一个改变了所有属性的策略。它使得它们均以大写字母开头,即使是以_开头的属性名。尽管该策略并没有改变分隔符。它保留了下划线。下面的那个稍微改变了分隔符:

FieldNamingPolicy - UPPER_CAMEL_CASE_WITH_SPACESThe last policy

最后一个策略为UPPER_CAMEL_CASE_WITH_SPACES,它几乎和UPPER_CAMEL_CASE一样。代码也是非常雷同的:

GsonBuilder gsonBuilder = new GsonBuilder();  
gsonBuilder.setFieldNamingPolicy(FieldNamingPolicy.UPPER_CAMEL_CASE_WITH_SPACES);  
Gson gson = gsonBuilder.create();

UserNaming user = new UserNaming("Norman", "norman@futurestud.io", true, 26);  
String usersJson = gson.toJson(user);  

让我们看看usersJson的结果:

{
  "Name": "Norman",
  "_Age Of Developer": 26,
  "Email_of_developer": "norman@futurestud.io",
  "Is Developer": true
}

正如你看到的,和UPPER_CAMEL_CASE并没有打的不同。唯一的不同是有两个域名,在它们拥有两个大写字母的单词之间加了多了空格。

与@SerializedName进行交互

你可能会好奇,策略是如何和@SerializedName进行交互的呢?我们在更早的博客中已经阐述过@SerializedName的用法。现在我们将其应用在我们的UserNaming模型中:

public class UserNaming {  
    String Name;

    @SerializedName("emailOfDeveloper")
    String email_of_developer;

    boolean isDeveloper;
    int _ageOfDeveloper;
}

如果你现在申请命名策略会发生什么呢?答案是,它将不会应用到@SerializedName注解的属性上。例如,我们使用UPPER_CAMEL_CASE,JSON结果将会:

{
  "Name": "Norman",
  "_AgeOfDeveloper": 26,
  "emailOfDeveloper": "norman@futurestud.io",
  "IsDeveloper": true
}

emailOfDeveloper@SerializedName注解的完全一样,而不会使起始字母大写。

自定义域名

已有的策略以及@SerializedName可能还不能满足你的用例的需求。你可以使用FieldNamingPolicy实现你自己的版本。因为你只能为.setFieldNamingPolicy传递已经预定义的枚举值,因此,Gson为你提供了另一个方法.setFieldNamingStrategy()

你可以传递FieldNamingStrategy的实例给相应的方法。FieldNamingStrategy类仅仅只有一个方法。例如,如果你想要移除所有的下划线,这没有任何预定义的策略做得到。下面的代码可以帮我们做到这点:

FieldNamingStrategy customPolicy = new FieldNamingStrategy() {  
    @Override
    public String translateName(Field f) {
        return f.getName().replace("_", "");
    }
};

GsonBuilder gsonBuilder = new GsonBuilder();  
gsonBuilder.setFieldNamingStrategy(customPolicy);  
Gson gson = gsonBuilder.create();

UserNaming user = new UserNaming("Norman", "norman@futurestud.io", true, 26);  
String usersJson = gson.toJson(user);  

结果就不会包含任何下划线了:

{
  "Name": "Norman",
  "ageOfDeveloper": 26,
  "emailOfDeveloper": "norman@futurestud.io",
  "isDeveloper": true
}

Gson仅仅只能接受一种策略(Strategy)。因此,你必须使用在单一的FieldNamingStrategy实现类中实现你的逻辑。如果你多次调用了以上我们所展示的方法,那么后面的将会覆盖前面的。

反序列化

在这篇博客中,我们仅仅探讨了序列化。在另一方面,由Java对象转换成的JSON将会是什么样子的呢?所有这些策略在反序列化过程中同样有效。大体上,如果你拥有一个API,它返回的所有值都是以小写字母组成并且以下划线分隔单词的,那么你可以使用LOWER_CASE_WITH_UNDERSCORES作为策略,而在Java命名上可以遵循通常的习惯。

例如,你有一下JSON:

{
  "reviewer_name": "Marcus"
}

得到的模型为:

public class PostReviewer {  
    String reviewerName;
}

你如果你使用了正确的命名策略,那么即使名称不同,Gson也会很好的映射。

前瞻

在本篇博客中,你已经学习了GsonBuilder的基本用法。我们探讨了第一个自定义Gson行为的选项。特别是,我们向你展示了一系列策略,这些策略使你在序列化和反序列化Java对象的过程中可以自定义属性名称。

在下一篇博客,我们将继续向你展示更多的GsonBuilder的功能。明确来说,我们将向你展示如何强制Gson可以序列化null值。

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

推荐阅读更多精彩内容