你真的会用Gson吗?Gson使用指南（三）

本文为作者根据日常使用结合Gson源码注释及wiki所作的原创内容，转载请注明出处。

该系列其它文章

你真的会用Gson吗?Gson使用指南（一）
你真的会用Gson吗?Gson使用指南（二）
你真的会用Gson吗?Gson使用指南（三）
你真的会用Gson吗?Gson使用指南（四）

注：此系列基于Gson 2.4。

本次的主要内容：

字段过滤的几种方法
- 基于 @Expose 注解
- 基于版本
- 基于访问修饰符
- 基于策略（作者最常用）
POJO与JSON的字段映射规则

一、字段过滤的几种方法

字段过滤Gson中比较常用的技巧，特别是在Android中，在处理业务逻辑时可能需要在设置的POJO中加入一些字段，但显然在序列化的过程中是不需要的，并且如果序列化还可能带来一个问题就是循环引用，那么在用Gson序列化之前为不防止这样的事件情发生，你不得不作另外的处理。

以一个商品分类

Category

为例。

{
  "id": 1,
  "name": "电脑",
  "children": [
    {
      "id": 100,
      "name": "笔记本"
    },
    {
      "id": 101,
      "name": "台式机"
    }
  ]
}

一个大分类，可以有很多小分类，那么显然我们在设计

Category

类时

Category

本身既可以是大分类，也可以是小分类。

public class Category {
    public int id;
    public String name;
    public List<Category> children;
}

但是为了处理业务，我们还需要在子分类中保存父分类，最终会变成下面的情况

public class Category {
    public int id;
    public String name;
    public List<Category> children;
    //因业务需要增加，但并不需要序列化
    public Category parent; 
}

但是上面的

parent

字段是因业务需要增加的，那么在序列化是并不需要，所以在序列化时就必须将其排除，那么在

Gson

中如何排除符合条件的字段呢?下面提供4种方法，大家可根据需要自行选择合适的方式。

基于@Expose注解

@Expose提供了两个属性，且都有默认值，开发者可以根据需要设置不同的值。

你真的会用Gson吗?Gson使用指南（三）

@Expose

@Expose 注解从名字上就可以看出是暴露的意思，所以该注解是用于对处暴露字段的。可是我们以前用Gson的时候也没有@Expose 注解还是不正确的序列化为JSON了么?是的，所以该注解在使用

new Gson()

时是不会发生作用。毕竟最常用的API要最简单，所以该注解必须和

GsonBuilder

配合使用。

使用方法：简单说来就是需要导出的字段上加上@Expose 注解，不导出的字段不加。注意是不导出的不加。

@Expose //
@Expose(deserialize = true,serialize = true) //序列化和反序列化都都生效
@Expose(deserialize = true,serialize = false) //反序列化时生效
@Expose(deserialize = false,serialize = true) //序列化时生效
@Expose(deserialize = false,serialize = false) // 和不写一样

注：根据上面的图片可以得出，所有值为

true

的属性都是可以不写的。

拿上面的例子来说就是

public class Category {
    @Expose public int id;
    @Expose public String name;
    @Expose public List<Category> children;
    //不需要序列化,所以不加 @Expose 注解，
    //等价于 @Expose(deserialize = false,serialize = false)
    public Category parent; 
}

在使用Gson时也不能只是简单的

new Gson()

了。

Gson gson = new GsonBuilder()
        .excludeFieldsWithoutExposeAnnotation()
        .create();
gson.toJson(category);

基于版本

Gson在对基于版本的字段导出提供了两个注解

@Since

和

@Until

,和

GsonBuilder.setVersion(Double)

配合使用。

@Since

和

@Until

都接收一个

Double

值。

你真的会用Gson吗?Gson使用指南（三）

Since和Until注解

使用方法：当前版本(GsonBuilder中设置的版本) 大于等于Since的值时该字段导出，小于Until的值时该该字段导出。

class SinceUntilSample {
    @Since(4)
    public String since;
    @Until(5)
    public String until;
}

public void sineUtilTest(double version){
        SinceUntilSample sinceUntilSample = new SinceUntilSample();
        sinceUntilSample.since = "since";
        sinceUntilSample.until = "until";
        Gson gson = new GsonBuilder().setVersion(version).create();
        System.out.println(gson.toJson(sinceUntilSample));
}
//当version <4时，结果：{"until":"until"}
//当version >=4 && version <5时，结果：{"since":"since","until":"until"}
//当version >=5时，结果：{"since":"since"}

注：当一个字段被同时注解时，需两者同时满足条件。

基于访问修饰符

什么是修饰符?

public

、

static

、

final

、

private

、

protected

这些就是，所以这种方式也是比较特殊的。

使用方式：

class ModifierSample {
    final String finalField = "final";
    static String staticField = "static";
    public String publicField = "public";
    protected String protectedField = "protected";
    String defaultField = "default";
    private String privateField = "private";
}

使用

GsonBuilder.excludeFieldsWithModifiers

构建gson,支持

int

形的可变参数，值由

java.lang.reflect.Modifier

提供，下面的程序排除了

privateField

、

finalField

和

staticField

三个字段。

ModifierSample modifierSample = new ModifierSample();
Gson gson = new GsonBuilder()
        .excludeFieldsWithModifiers(Modifier.FINAL, Modifier.STATIC, Modifier.PRIVATE)
        .create();
System.out.println(gson.toJson(modifierSample));
// 结果：{"publicField":"public","protectedField":"protected","defaultField":"default"}

到此为止，Gson提供的所有注解就还有一个

@JsonAdapter

没有介绍了，而

@JsonAdapter

将和

TypeAdapter

将作为该系列第4篇也是最后一篇文章的主要内容。

基于策略（自定义规则）

上面介绍的了3种排除字段的方法，说实话我除了@Expose以外，其它的都是只在Demo用上过，用得最多的就是马上要介绍的自定义规则，好处是功能强大、灵活，缺点是相比其它3种方法稍麻烦一点，但也仅仅只是想对其它3种稍麻烦一点而已。

基于策略是利用Gson提供的

ExclusionStrategy

接口，同样需要使用

GsonBuilder

,相关API 2个，分别是

addSerializationExclusionStrategy

和

addDeserializationExclusionStrategy

分别针对序列化和反序化时。这里以序列化为例。

例如：

Gson gson = new GsonBuilder()
        .addSerializationExclusionStrategy(new ExclusionStrategy() {
            @Override
            public boolean shouldSkipField(FieldAttributes f) {
                // 这里作判断，决定要不要排除该字段,return true为排除
                if ("finalField".equals(f.getName())) return true; //按字段名排除
                Expose expose = f.getAnnotation(Expose.class); 
                if (expose != null && expose.deserialize() == false) return true; //按注解排除
                return false;
            }
            @Override
            public boolean shouldSkipClass(Class<?> clazz) {
                // 直接排除某个类 ，return true为排除
                return (clazz == int.class || clazz == Integer.class);
            }
        })
        .create();

有没有很强大?

二、 POJO与JSON的字段映射规则

之前在你真的会用Gson吗?Gson使用指南（二）属性重命名时介绍了

@SerializedName

这个注解的使用，本节的内容与上一次差不多的，但既然叫映射规则那么说的自然是有规律的情况。

还是之前User的例子，已经去除所有注解：

User user = new User("怪盗kidou", 24);
user.emailAddress = "[email protected]";

GsonBuilder

提供了

FieldNamingStrategy

接口和

setFieldNamingPolicy

和

setFieldNamingStrategy

两个方法。

默认实现

GsonBuilder.setFieldNamingPolicy

方法与Gson提供的另一个枚举类

FieldNamingPolicy

配合使用，该枚举类提供了5种实现方式分别为：

FieldNamingPolicy	结果（仅输出emailAddress字段）
IDENTITY	{"emailAddress":"[email protected]"}
LOWER_CASE_WITH_DASHES	{"email-address":"[email protected]"}
LOWER_CASE_WITH_UNDERSCORES	{"email_address":"[email protected]"}
UPPER_CAMEL_CASE	{"EmailAddress":"[email protected]"}
UPPER_CAMEL_CASE_WITH_SPACES	{"Email Address":"[email protected]"}

自定义实现

GsonBuilder.setFieldNamingStrategy

方法需要与Gson提供的

FieldNamingStrategy

接口配合使用，用于实现将POJO的字段与JSON的字段相对应。上面的

FieldNamingPolicy

实际上也实现了

FieldNamingStrategy

接口，也就是说

FieldNamingPolicy

也可以使用

setFieldNamingStrategy

方法。

用法：

Gson gson = new GsonBuilder()
        .setFieldNamingStrategy(new FieldNamingStrategy() {
            @Override
            public String translateName(Field f) {
                //实现自己的规则
                return null;
            }
        })
        .create();

注意：

@SerializedName

注解拥有最高优先级，在加有

@SerializedName

注解的字段上

FieldNamingStrategy

不生效！

本文完

下期预告（本系列最终篇）：

无所不能的TypeAdapter

原文链接：https://blog.csdn.net/weixin_34081595/article/details/91935214

你真的会用Gson吗?Gson使用指南（三）

一、字段过滤的几种方法

二、 POJO与JSON的字段映射规则

继续阅读

libsvm for python 安装

2021年危险化学品经营单位安全管理人员考试题库及危险化学品经营单位安全管理人员考试技巧

学习软件测试基础测试第七天

Zeppelin 配置访问 REST APIApache Zeppelin Configuration REST API

【Torch】最简洁logging使用指南

27. Remove Element(列表)题目代码

无人机--飞控科普

Cloud Studio初体验

使用 ctypes 进行 Python 和 C 的混合编程

【python】【数据处理】画多维数据分布图

vue-cli简介（中文翻译）

Ajax发送和获取json数据到Spring mvc 1.spring mvc后端2.web前段

【python】netconf协议对接管理设备

「Python 网络自动化」NETCONF —— Python 使用 NETCONF 管理配置 H3C 网络设备

JSONObject包导入异常 java.lang.NoClassDefFoundErrorweb项目的导入包的问题

在python中创建excel并写入