Gson教程八（译）：GsonBuilder基础和命名策略

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

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

GsonBuilder基础

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

// previouslyGson gson = new Gson();// now using GsonBuilderGsonBuilder 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", "[e-mail]", true, 26);  String usersJson = gson.toJson(user);  

usersJSON内容为：

{  "Name": "Norman",  "_ageOfDeveloper": 26,  "email_of_developer": "[e-mail]",  "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", "[e-mail]", true, 26);  String usersJson = gson.toJson(user); 

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

{  "name": "Norman",  "_age_of_developer": 26,  "email_of_developer": "[e-mail]",  "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", "[e-mail]", true, 26);  String usersJson = gson.toJson(user);  

usersJson的内容如下：

{  "name": "Norman",  "_age-of-developer": 26,  "email_of_developer": "[e-mail]",  "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", "[e-mail]", true, 26);  String usersJson = gson.toJson(user); 

usersJson的结果为：

{  "Name": "Norman",  "_AgeOfDeveloper": 26,  "Email_of_developer": "[e-mail]",  "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", "[e-mail]", true, 26);  String usersJson = gson.toJson(user);  

让我们看看usersJson的结果：

{  "Name": "Norman",  "_Age Of Developer": 26,  "Email_of_developer": "[e-mail]",  "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": "[e-mail]",  "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", "[e-mail]", true, 26);  String usersJson = gson.toJson(user);  

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

{  "Name": "Norman",  "ageOfDeveloper": 26,  "emailOfDeveloper": "[e-mail]",  "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值。