@Expose注解

赏阳嘉
2023-12-01

之前,我们都是假设model字段都是需要序列化和反序列化的,这是一种最简单的情况,可真实的情况并不是如此,所以我们需要定制我们的解析规则。

注解 @Expose

当你不需要完全序列化model字段时,我们就可以使用 @Expose 来帮我结局。

@Expose 默认有两个属性:serialize 和 deserialize,默认值都为 true,如果你给字段设置了 @Expose 注解,但是没有设置serialize 和 deserialize,那 model 的字段都将会输出。

看例子:

public class UserSimple {  
        @Expose()
        String name; // equals serialize & deserialize

        @Expose(serialize = false, deserialize = false)
        String email; // equals neither serialize nor deserialize

        @Expose(serialize = false)
        int age; // equals only deserialize

        @Expose(deserialize = false)
        boolean isDeveloper; // equals only serialize
}

根据 @Expose 的用法,UserSimple 序列化 JSON 输出只有 name 和 isDeveloper,其他连个字段就不会被输出,因为 serialize 都是 false;

反序列化的话,只有 email 和 isDeveloper 被忽略,因为 deserialize = false

使用 @Expose 的前期是我们也需要使用 GsonBuilder 创建一个 Gson 实例:

GsonBuilder builder = new GsonBuilder();  
builder.excludeFieldsWithoutExposeAnnotation();  
Gson gson = builder.create();  

只有这样 Gson 在解析的时候 @Expose 才会生效。

Transient

使用 transient 来描述字段,将不能被序列化和反序列化

public class UserSimple {  
      String name;
      String email;
      int age;
      transient boolean isDeveloper; // will not be serialized or deserialized
}

总结

了解 @Expose 使用规则,清楚两个参数的含义,根据自己需求来配置 @Expose 属性。

 类似资料: