Gson的基本使用：解析Json格式数据序列化与反序列化

Gson是Google发布的一个Java库，可以用来将Java对象转换为Json字符串表示，或者将Json字符串转换为等效的Java对象；

IH_LZH

1997人浏览 · 2024-07-22 20:41:51

IH_LZH · 2024-07-22 20:41:51 发布

一，Gson和Json

1，Gson

Gson是Google发布的一个Java库，可以用来将Java对象转换为Json字符串表示，或者将Json字符串转换为等效的Java对象；

2，Json

Json（JavaScript Object Notation），一种轻量级的数据交换格式，应用于不同平台间的数据传递，例如服务端和客户端的交互，数据在两端以Json格式传递；

Json格式为字符串格式，基本格式为大括号括起的键值对形式：

{
    "name": "zhangsan",
    "sex": "man",
    "age": 18
}

3，Gson处理对象的几个重要点

（1）推荐将成员变量都声明为private；

（2）所有包含在当前类（包括父类）中的字段都默认被序列化或者反序列化，即实现了Serializable接口；

（3）被transient和static关键词修饰的字段不会被序列化或反序列化；

4，序列化和反序列化

序列化：将Java对象转化为字节序列的过程；

反序列化：将字节序列恢复为Java对象的过程；

二，Gson的使用

在Android中使用Gson需要先添加依赖：

implementation 'com.google.code.gson:gson:2.10.1'

1，Gson的创建

Gson可以通过调用new Gson（）来创建它的对象，或者通过GsonBuilder类来创建Gson实例，它具有各种设置，如版本控制，格式化输出，设置日期输出格式等；

（1）通过构造器实例化：

Gson gson = new Gson();

（2）通过GsonBuilder类实例化：

Gson gson = new GsonBuilder()
                .serializeNulls() //允许导出null值
                .setPrettyPrinting() //格式化输出
                .setDateFormat("yyyy/mm/dd") //日期输出格式
                .create();

当序列化时，如果对象的某个字段为null，是不会输出到Json字符串中的。如果想要输出null值的话，需要用GsonBuilder类来创建Gson对象，并设置允许导出null值；

2，简单对象序列化

创建一个简单的Student类：

public class Student implements Serializable {
    private String name;
    private int id;

    //getter setter方法，构造器
}

使用toJson（）方法对Java对象序列化：

private void objToJson() {
    Student student = new Student(null, 114514);
    String jsonStr = gson.toJson(student);
    edt_json.setText(jsonStr);
}

使用fromJson（）方法反序列化，fromJson方法需要提供Json字符串和对象的class类：

private void jsonToObj() {
    String jsonStr = edt_json.getText().toString();
    Student student = gson.fromJson(jsonStr, Student.class);
    edt_obj.setText(student.toString());
}

运行结果如下：

3，对象序列化，格式化输出日期

想要格式化输出日期，需要通过GsonBuilder类创建Gson对象并设置日期输出格式：

Gson gson = new GsonBuilder()
                .setDateFormat("yyyy/mm/dd") //日期输出格式
                .create();

（1）对象序列化：

private void formatObjToJson() {
    Student student = new Student("喜多郁代", 114514);
    SimpleDateFormat format = new SimpleDateFormat("yyyy/mm/dd");
    Date date = null;
    try {
        date = format.parse("1999/9/9");
    } catch (ParseException e) {
        throw new RuntimeException(e);
    }
    student.setDate(date);

    String jsonStr = gson.toJson(student);
    edt_json.setText(jsonStr);
}

（2）反序列化：

private void formatJsonToObj() {
    String jsonStr = edt_json.getText().toString();
    Student student = gson.fromJson(jsonStr, Student.class);
    edt_obj.setText(student.toString());
}

运行结果如下：

4，嵌套对象序列化

当类中具有内部类时，Json数据形式为：

{"name":"John", 
"age":20,
"grade":{"course":"English",
         "score":100,
         "level":"A"
        }
}

定义含有内部类的类：

public class Student implements Serializable {
    private String name;
    private int id;
    private Date date;
    private Grade grade;

    //getter，setter，构造器
}

public class Grade implements Serializable {
    private int math;
    private int code;

    //getter，setter，构造器
}

（1）序列化：

private void complexObjToJson() {
    Student student = new Student("喜多郁代", 114514);
    Grade grade = new Grade(99, 100);
    student.setGrade(grade);
    String jsonStr = gson.toJson(student);
    edt_json.setText(jsonStr);
}

（2）反序列化：

private void complexJsonToObj() {
    String jsonStr = edt_json.getText().toString();
    Student student = gson.fromJson(jsonStr, Student.class);
    edt_obj.setText(student.toString());
}

运行结果如下：

5，对象数组序列化

（1）序列化：

private void arrayObjToJson() {
    Student[] students = new Student[2];
    students[0] = new Student("喜多郁代", 1);
    students[1] = new Student("山田凉", 2);
    String jsonStr = gson.toJson(students);
    edt_json.setText(jsonStr);
}

（2）反序列化：

private void arrayJsonToObj() {
    String jsonStr = edt_json.getText().toString();
    Student[] students = gson.fromJson(jsonStr, Student[].class);
    edt_obj.setText(Arrays.asList(students).toString());
}

运行结果如下：

6，对象集合序列化

对于List这种泛型信息的类，在反序列时需要使用TypeToken类来指明具体的类型；

（1）序列化与之前一致：

private void collectionObjToJson() {
    List<Student> studentList = new ArrayList<>();
    studentList.add(new Student("喜多郁代", 1));
    studentList.add(new Student("山田凉", 2));
    String jsonStr = gson.toJson(studentList);
    edt_json.setText(jsonStr);
}

（2）反序列化时使用TypeToken类来指明List泛型具体的类型：

private void collectionJsonToObj() {
    String jsonStr = edt_json.getText().toString();
    Type collectionType = new TypeToken<List<Student>>(){}.getType();//泛型为List<Student>
    List<Student> studentList = gson.fromJson(jsonStr, collectionType);
    edt_obj.setText(studentList.toString());
}

运行结果如下：