Android Gson使用详解，android中级工程师面试题

2023-10-29 09:31:46

例如，修改 User 类，为 name 声明 SerializedName 注解，注解值为 userName

/**

  • 作者：chenZY
  • 时间：2018/3/17 18:32
  • 描述：https://github.com/leavesC
    */
    public class User {

@SerializedName(“userName”)
private String name;

private int age;

private boolean sex;

}

在序列时，Json 格式就会相应改变

public static void main(String[] args) {
//序列化
User user = new User(“leavesC”, 24, true);
Gson gson = new Gson();
System.out.println();
System.out.println(gson.toJson(user));
}

Android Gson使用详解，android中级工程师面试题

在反序列化时也一样，能够解析到正确的属性值

public static void main(String[] args) {
//反序列化
String userJson = "{“userName”:“leavesC”,"a

《Android学习笔记总结+最新移动架构视频+大厂安卓面试真题+项目实战源码讲义》

【docs.qq.com/doc/DSkNLaERkbnFoS0ZF】 完整内容开源分享

ge":24,“sex”:true}";
Gson gson = new Gson();
User user = gson.fromJson(userJson, User.class);
System.out.println();
System.out.println(user);
}

Android Gson使用详解，android中级工程师面试题

还有个问题没解决，为了应对多种属性名不一致的情况，难道我们要声明多个 User 类吗？这显然是不现实的，所以还需要为 User 类设置多个备选属性名，这就需要用到 SerializedName 注解的另一个属性值 alternate 了。

/**

  • 作者：chenZY
  • 时间：2018/3/17 18:32
  • 描述：https://github.com/leavesC
    */
    public class User {

@SerializedName(value = “userName”, alternate = {“user_name”, “Name”})
private String name;

private int age;

private boolean sex;

}

以下几种情况都能够被正确的反序列化

public static void main(String[] args) {
//反序列化
Gson gson = new Gson();
String userJson = “{“userName”:“leavesC”,“age”:24,“sex”:true}”;
User user = gson.fromJson(userJson, User.class);
System.out.println();
System.out.println(user);

userJson = “{“user_name”:“leavesC”,“age”:24,“sex”:true}”;
user = gson.fromJson(userJson, User.class);
System.out.println();
System.out.println(user);

userJson = “{“Name”:“leavesC”,“age”:24,“sex”:true}”;
user = gson.fromJson(userJson, User.class);
System.out.println();
System.out.println(user);
}

Android Gson使用详解，android中级工程师面试题

三、字段过滤

有时候并不是所有的字段都需要进行系列化和反序列化，因此需要对某些字段进行排除，有四种方法可以来实现这种需求。

3.1、基于@Expose注解

Expose 注解包含两个属性值，且均声明了默认值。Expose 的含义即为“暴露”，即用于对外暴露字段，serialize 用于指定是否进行序列化，deserialize 用于指定是否进行反序列化。如果字段不声明 Expose 注解，则意味着不进行序列化和反序列化操作，相当于两个属性值均为 false 。此外，Expose 注解需要和 GsonBuilder 构建的 Gson 对象一起使用才能生效。

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD})
public @interface Expose {
boolean serialize() default true;

boolean deserialize() default true;
}

Expose 注解的注解值声明情况有四种

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

现在来看个例子，修改 User 类

/**

  • 作者：chenZY
  • 时间：2018/3/17 18:32
  • 描述：https://github.com/leavesC
    */
    public class User {

@Expose(serialize = true, deserialize = true) //序列化和反序列化都生效
private String a;

@Expose(serialize = false, deserialize = true) //序列化时不生效，反序列化时生效
private String b;

@Expose(serialize = true, deserialize = false) //序列化时生效，反序列化时不生效
private String c;

@Expose(serialize = false, deserialize = false) //序列化和反序列化都不生效，和不写注解一样
private String d;

private String e;

public User(String a, String b, String c, String d, String e) {
this.a = a;
this.b = b;
this.c = c;
this.d = d;
this.e = e;
}

@Override
public String toString() {
return “User{” +
“a=’” + a + ‘’’ +
“, b=’” + b + ‘’’ +
“, c=’” + c + ‘’’ +
“, d=’” + d + ‘’’ +
“, e=’” + e + ‘’’ +
‘}’;
}

}

按照如上的注解值，只有声明了 Expose 注解且 serialize 值为 true 的字段才能被序列化，只有声明了 Expose 注解且 deserialize 值为 true 的字段才能被反序列化

public static void main(String[] args) {
Gson gson = new GsonBuilder().excludeFieldsWithoutExposeAnnotation().create();
User user = new User(“A”, “B”, “C”, “D”, “E”);
System.out.println();
System.out.println(gson.toJson(user));

String json = “{“a”:“A”,“b”:“B”,“c”:“C”,“d”:“D”,“e”:“E”}”;
user = gson.fromJson(json, User.class);
System.out.println();
System.out.println(user.toString());
}

Android Gson使用详解，android中级工程师面试题

3.2、基于版本

Gson 提供了 @Since 和 @Until 两个注解基于版本对字段进行过滤，@Since 和 @Until 都包含一个 Double 属性值，用于设置版本号。Since 的意思是“自……开始”，Until 的意思是“到……为止”，一样要和 GsonBuilder 配合使用。

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.TYPE})
public @interface Since {
double value();
}

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.TYPE})
public @interface Until {
double value();
}

当版本( GsonBuilder 设置的版本) 大于或等于 Since 属性值或小于 Until 属性值时字段会进行序列化和反序列化操作，而没有声明注解的字段都会加入序列化和反序列操作

现在来看个例子，修改 User 类

/**

  • 作者：chenZY
  • 时间：2018/3/17 18:32
  • 描述：https://github.com/leavesC
    */
    public class User {

@Since(1.4)
private String a;

@Since(1.6)
private String b;

@Since(1.8)
private String c;

@Until(1.6)
private String d;

@Until(2.0)
private String e;

public User(String a, String b, String c, String d, String e) {
this.a = a;
this.b = b;
this.c = c;
this.d = d;
this.e = e;
}

@Override
public String toString() {
return “User{” +
“a=’” + a + ‘’’ +
“, b=’” + b + ‘’’ +
“, c=’” + c + ‘’’ +
“, d=’” + d + ‘’’ +
“, e=’” + e + ‘’’ +
‘}’;
}

}

public static void main(String[] args) {
Gson gson = new GsonBuilder().setVersion(1.6).create();
User user = new User(“A”, “B”, “C”, “D”, “E”);
System.out.println();
System.out.println(gson.toJson(user));

String json = “{“a”:“A”,“b”:“B”,“c”:“C”,“d”:“D”,“e”:“E”}”;
user = gson.fromJson(json, User.class);
System.out.println();
System.out.println(user.toString());
}

Android Gson使用详解，android中级工程师面试题

3.3、基于访问修饰符

访问修饰符由 java.lang.reflect.Modifier 提供 int 类型的定义，而 GsonBuilder 对象的 excludeFieldsWithModifiers方法接收一个 int 类型可变参数，指定不进行序列化和反序列化操作的访问修饰符字段 看个例子

/**

  • 作者：chenZY
  • 时间：2018/3/17 18:32
  • 描述：https://github.com/leavesC
    */
    public class ModifierSample {

public String publicField = “public”;

protected String protectedField = “protected”;

private String privateField = “private”;

String defaultField = “default”;

final String finalField = “final”;

static String staticField = “static”;

}

public static void main(String[] args) {
Gson gson = new GsonBuilder().excludeFieldsWithModifiers(Modifier.PRIVATE, Modifier.STATIC).create();
ModifierSample modifierSample = new ModifierSample();
System.out.println(gson.toJson(modifierSample));
}

Android Gson使用详解，android中级工程师面试题

3.4、基于策略

GsonBuilder 类包含 setExclusionStrategies(ExclusionStrategy... strategies)方法用于传入不定长参数的策略方法，用于直接排除指定字段名或者指定字段类型 看个例子

/**

  • 作者：chenZY
  • 时间：2018/3/17 18:32
  • 描述：https://github.com/leavesC
    */
    public class Strategies {

private String stringField;

private int intField;

private double doubleField;

public Strategies(String stringField, int intField, double doubleField) {
this.stringField = stringField;
this.intField = intField;
this.doubleField = doubleField;
}

@Override
public String toString() {
return “Strategies{” +
“stringField=’” + stringField + ‘’’ +
“, intField=” + intField +
“, doubleField=” + doubleField +
‘}’;
}

}

public static void main(String[] args) {
Gson gson = new GsonBuilder().setExclusionStrategies(new ExclusionStrategy() {
@Override
public boolean shouldSkipField(FieldAttributes fieldAttributes) {
//排除指定字段名
return fieldAttributes.getName().equals(“intField”);
}

@Override
public boolean shouldSkipClass(Class<?> aClass) {
//排除指定字段类型
return aClass.getName().equals(double.class.getName());
}
}).create();

Strategies strategies = new Strategies(“stringField”, 111, 11.22);
System.out.println();
System.out.println(gson.toJson(strategies));

String json = “{“stringField”:“stringField”,“intField”:111,“doubleField”:11.22}”;
strategies = gson.fromJson(json, Strategies.class);
System.out.println();
System.out.println(strategies);
}

字段名为 “intField” 和字段类型为 double 的字段都会被排除掉 Android Gson使用详解，android中级工程师面试题

setExclusionStrategies 方法在序列化和反序列化时都会生效，如果只是想指定其中一种情况下的排除策略或分别指定排除策略，可以改为使用以下两个方法

addSerializationExclusionStrategy(ExclusionStrategy strategy);

addDeserializationExclusionStrategy(ExclusionStrategy strategy);

四、个性化配置

4.1、输出 null

对于 Gson 而言，在序列化时如果某个属性值为 null 的话，那么在序列化时该字段不会参与进来，如果想要显示输出该字段的话，可以通过 GsonBuilder 进行配置

/**

  • 作者：chenZY
  • 时间：2018/3/17 18:32
  • 描述：https://github.com/leavesC
    */
    public class Strategies {

private String stringField;

private int intField;

private double doubleField;

}

public static void main(String[] args) {
Gson gson = new GsonBuilder()
.serializeNulls() //输出null
.create();
Strategies strategies = new Strategies(null, 24, 22.333);
System.out.println();
System.out.println(gson.toJson(strategies));
}

Android Gson使用详解，android中级工程师面试题

4.2、格式化输出Json

默认的序列化后的 Josn 字符串并不太直观，可以选择格式化输出

public static void main(String[] args) {
Gson gson = new GsonBuilder()
.serializeNulls() //输出null
.setPrettyPrinting()//格式化输出
.create();
Strategies strategies = new Strategies(null, 24, 22.333);
System.out.println();
System.out.println(gson.toJson(strategies));
}

Android Gson使用详解，android中级工程师面试题

4.3、格式化时间

Gson 也可以对时间值进行格式化

/**

  • 作者：chenZY
  • 时间：2018/3/17 18:32
  • 描述：https://github.com/leavesC
    */
    public class Strategies {

private Date date;

private Date date2;

public Strategies(Date date, Date date2) {
this.date = date;
this.date2 = date2;
}

@Override
public String toString() {
SimpleDateFormat simpleDateFormat = new SimpleDateFormat(“yyyy-MM-dd HH:mm:ss:SSS”, Locale.CHINA);
return “Strategies{” +
“date=” + simpleDateFormat.format(date) +
“, date2=” + simpleDateFormat.format(date2) +
‘}’;
}

}

public static void main(String[] args) {
Gson gson = new GsonBuilder()
.setPrettyPrinting()//格式化输出
.setDateFormat(“yyyy-MM-dd HH:mm:ss:SSS”)//格式
化时间
.create();
Date date = new Date();
Strategies strategies = new Strategies(date, new Date(date.getTime() + 1000000));
System.out.println();
System.out.println(gson.toJson(strategies));

String json = “{\n” +
" “date”: “2018-03-17 19:38:50:033”,\n" +
" “date2”: “2018-03-17 19:55:30:033”\n" +
“}”;
System.out.println();
System.out.println(gson.fromJson(json, Strategies.class));
}

Android Gson使用详解，android中级工程师面试题

五、TypeAdapter

TypeAdapter 是一个泛型抽象类，用于接管某种类型的序列化和反序列化过程，包含两个抽象方法，分别用于自定义序列化和反序列化过程

public abstract void write(JsonWriter var1, T var2) throws IOException;

public abstract T read(JsonReader var1) throws IOException;

下面看个简单的例子

/**

  • 作者：chenZY
  • 时间：2018/3/17 18:32
  • 描述：https://github.com/leavesC
    */
    public class User {

private String name;

private int age;

private boolean sex;

public User() {
}

public User(String name, int age, boolean sex) {
this.name = name;
this.age = age;
this.sex = sex;
}

@Override
public String toString() {
return “User{” +
“name=’” + name + ‘’’ +
“, age=” + age +
“, sex=” + sex +
‘}’;
}

}

定义 TypeAdapter 的子类 UserTypeAdapter 来接管 User 类的序列化和反序列化过程 这里设定当 User 类序列化时 Json 中的Key值都是大写字母开头，反序列化时支持“name”和“Name”两种不同的 Json 风格

public class UserTypeAdapter extends TypeAdapter {

@Override
public void write(JsonWriter jsonWriter, User user) throws IOException {
//流式序列化成对象开始
jsonWriter.beginObject();
//将Json的Key值都指定为大写字母开头
jsonWriter.name(“Name”).value(user.getName());
jsonWriter.name(“Age”).value(user.getAge());
jsonWriter.name(“Sex”).value(user.isSex());
//流式序列化结束
jsonWriter.endObject();
}

@Override
public User read(JsonReader jsonReader) throws IOException {
User user = new User();
//流式反序列化开始
jsonReader.beginObject();
while (jsonReader.hasNext()) {
switch (jsonReader.nextName()) {
//首字母大小写均合法
case “name”:
case “Name”:
user.setName(jsonReader.nextString());
break;
case “age”:
user.setAge(jsonReader.nextInt());
break;
case “sex”:
user.setSex(jsonReader.nextBoolean());
break;
}

}
//流式反序列化结束
jsonReader.endObject();
return user;
}

}

public static void main(String[] args) {
Gson gson = new GsonBuilder().registerTypeAdapter(User.class, new UserTypeAdapter()).create();
User user = new User(“leavesC”, 24, true);
System.out.println();
System.out.println(gson.toJson(user));

String json = “{“Name”:“leavesC”,“age”:24,“sex”:true}”;
user = gson.fromJson(json, User.class);
System.out.println();
System.out.println(user);
}

可以看到 User 类按照预定义的策略来完成序列化和反序列化了 Android Gson使用详解，android中级工程师面试题

六、JsonSerializer 和 JsonDeserializer

TypeAdapter 将序列化和反序列操作都接管了过来，其实 Gson 还提供了只接管序列化过程的接口，即 JsonSerializer 看个例子

public static void main(String[] args) {
Gson gson = new GsonBuilder().registerTypeAdapter(User.class, new JsonSerializer() {
@Override
public JsonElement serialize(User user, Type type, JsonSerializationContext jsonSerializationContext) {
JsonObject jsonObject = new JsonObject();
jsonObject.addProperty(“NameHi”, user.getName());
jsonObject.addProperty(“Sex”, user.isSex());
jsonObject.addProperty(“Age”, user.getAge());
return jsonObject;
}
}).create();
User user = new User(“leavesC”, 24, true);
System.out.println();
System.out.println(gson.toJson(user));
}

Android Gson使用详解，android中级工程师面试题

相对应的，JsonDeserializer 接口提供了反序列化的接口

public static void main(String[] args) {
Gson gson = new GsonBuilder().registerTypeAdapter(User.class, new JsonDeserializer() {
@Override
public User deserialize(JsonElement jsonElement, Type type, JsonDeserializationContext jsonDeserializationContext) throws JsonParseException {
JsonObject jsonObject = jsonElement.getAsJsonObject();
String name = null;
//同时支持 userName 和 name 两种情况
if (jsonObject.has(“userName”)) {
name = jsonObject.get(“userName”).getAsString();
} else if (jsonObject.has(“name”)) {
gson.toJson(user));
}

[外链图片转存中…(img-EYiGqzNb-1639535130539)]

相对应的，JsonDeserializer 接口提供了反序列化的接口

public static void main(String[] args) {
Gson gson = new GsonBuilder().registerTypeAdapter(User.class, new JsonDeserializer() {
@Override
public User deserialize(JsonElement jsonElement, Type type, JsonDeserializationContext jsonDeserializationContext) throws JsonParseException {
JsonObject jsonObject = jsonElement.getAsJsonObject();
String name = null;
//同时支持 userName 和 name 两种情况
if (jsonObject.has(“userName”)) {
name = jsonObject.get(“userName”).getAsString();
} else if (jsonObject.has(“name”)) {

上一篇：Gson 实体类解析问题


下一篇：使用GSON解析JSON数据