Gson 深究

本文详细探讨了Gson库的使用,包括依赖添加、优点、基本概念、序列化与反序列化,以及Java泛型对象与Json字符串的互转。介绍了GsonBuilder的定制化选项,如@SerializedName、@Expose、@Since和@Until注解,以及如何通过TypeAdapter自定义序列化和反序列化行为。此外,文章还提到了旧版的JsonSerializer与JsonDeserializer,并指出使用@JsonAdapter注解的便利性。
摘要由CSDN通过智能技术生成

依赖添加

<!-- https://mvnrepository.com/artifact/com.google.code.gson/gson -->
<dependency>
    <groupId>com.google.code.gson</groupId>
    <artifactId>gson</artifactId>
    <version>2.8.0</version>
</dependency>

优点:

允许已经存在的无法改变的对象转换成Json,或者Json转换成已经存在的对象。
允许自定义对象的表现形式
支持任意的复杂对象
能够生成可压缩和可读的Json的字符串输出
依赖包少,只有一个jar核心包,无其他依赖
Gson安全稳定,无漏洞(FastJson 出现过漏洞)

基本概念:

Serialization: 序列化,Java对象转换成Json字符串的过程。生成Json字符串的过程。
Deserialization: 反序列化,字符串转换成Java对象。解析Json字符串,生成Java对象的过程。

主要使用入口与API:

GSON API 提供了一个类 Gson,它的实例化对象被用来处理Java对象和JSON字符串的转换。可以使用默认构造器,或使用GsonBuilder类创建这个类的实例。GsonBuilder类是可以定制化的,并且允许开发者按需求实例化GSON。

Gson的两种实例化方式:
  1. 使用new Gson(); 普通实例化方式,不能配置定制化选项
    Gson gson = new Gson();
  2. ☆通过GsonBuilder 可以配置多种选项
Gson gson = new GsonBuilder().setLenient()// json宽松  
        .enableComplexMapKeySerialization()//支持Map的key为复杂对象的形式  
        .serializeNulls() //智能null,支持输出值为null的属性
        .setPrettyPrinting()//格式化输出(序列化)
        .setDateFormat("yyyy-MM-dd HH:mm:ss") //序列化日期格式化输出 
        .excludeFieldsWithoutExposeAnnotation() //不序列化与反序列化没有@Expose标注的字段
        .disableHtmlEscaping() //默认是Gson把HTML转义的  
        .create();

两种实例化方式,推荐第二种,因为第一种是简单的默认实现,无法定制更多配置。

Gson提供类toJson() 和 fromJson() 两个直接用于生成和解析的方法。其中 toJson() 实现序列化,fromJson() 实现反序列化。同时每个方法都提供了重载方法。
Gson API 入口类是 com.google.gson.Gson, 常用的序列化和反序列化操作都可以在Gson类的实例化对象上完成。

public String toJson(Object src) //序列化,①把Java对象序列化成JSON字符串,如果是泛型对象,该方法会调用方法②
public String toJson(Object src, Type typeOfSrc) //  ② 一般不用
public void toJson(Object src, Appendable writer)) // 比如将序列化后的JSON串写入文件流中保存起来
public <T> T fromJson(String json, Class<T> classOfT) // 反序列化,JavaBean对象
public <T> T fromJson(String json, Type typeOfT) // 反序列化Map<>/List<>等泛型类型,返回的也是泛型

API源码:

public String toJson(Object src) {
   if (src == null) {
     return toJson(JsonNull.INSTANCE);
    }
   return toJson(src, src.getClass()); //调用下面的方法
}

public String toJson(Object src, Type typeOfSrc) {
  StringWriter writer = new StringWriter();
  toJson(src, typeOfSrc, writer);
  return writer.toString();
}

基本使用:

基本数据类型的序列化和反序列化
  1. Java对象的序列化,生成字符串(序列化)
Gson gson = new GsonBuilder().create();
String jsonNumber = gson.toJson(100); // 100"
String jsonBoolean = gson.toJson(false); // false
String jsonString = gson.toJson("String"); //"String"
2、Java对象的生成(反序列化)
Gson gson = new GsonBuilder().create();
int i = gson.fromJson("100", int.class);              //100
double d = gson.fromJson("\"99.99\"", double.class);  //99.99
boolean b = gson.fromJson("true", boolean.class);     // true
String str = gson.fromJson("String", String.class);   // String

注:基本数据类型要小写

简单JavaBean对象的序列化和反序列化
实体类:
public class User {
    private String id;
    private String name;
    private Date birthday;

    public User() {
        super();
    }
    public User(String id, String name, Date birthday) {
        super();
        this.id = id;
        this.name = name;
        this.birthday = birthday;
    }
    //为了代码简洁,这里移除了getter和setter方法等

    @Override
    public String toString() {
        return "User [id=" + id + ", name=" + name + ", birthday=" + birthday + "]";
    }

}

序列化  : Java对象---》JSON字符串
反序列化  : JSON字符串 ---》Java对象

package com.chunlynn.gson;

import java.util.Date;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;

public class GsonTest7 {
    public static void main(String[] args) {
        Gson gson = new GsonBuilder().create();

        /**
         * [1] 简单JavaBean序列化成JSON字符串
         */
        User user = new User("1", "王重阳", new Date());
        String jsonStr = gson.toJson(user);
        System.out.println("简单JavaBean序列化 ==》 " + jsonStr);
        // [1]简单JavaBean序列化成JSON字符串 ==》 {"id":"1","name":"王重阳","birthday":"May 3, 2017 2:02:15 PM"}

        /**
         * [2] JSON字符串反序列化成简单JavaBean
         */
        User u = gson.fromJson(jsonStr, User.class);
        System.out.println("JSON字符串反序列化成简单JavaBean ==》" + u);
        // [2]JSON字符串反序列化成简单JavaBean ==》User [id=1, name=王重阳, birthday=Wed May 03 14:16:04 CST 2017]
    }
}

上面的序列化结果JSON字符串不美观,且日期不是我们想要的格式,那么我们可以使用GsonBuilder类创建的Gson实例的配置选项。GsonBuilder类是可定制化的,并且允许开发者按需实例化Gson。

定制化JSON输出:

package com.chunlynn.gson;

import java.util.Date;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;

public class GsonTest7 {
    public static void main(String[] args) {
        Gson gson = new GsonBuilder()
                .setPrettyPrinting()//格式化输出(序列化)
                .setDateFormat("yyyy-MM-dd HH:mm:ss") //序列化日期格式化输出
                .create();

        /**
         * [1] 简单JavaBean序列化成JSON字符串
         */
        User user = new User("1", "王重阳", new Date());
        String jsonStr = gson.toJson(user);
        System.out.println("简单JavaBean序列化 ==》 " + jsonStr);
        /*简单JavaBean序列化 ==》 {
              "id": "1",
              "name": "王重阳",
              "birthday": "2017-05-03 14:24:32"
            }
        */

        /**
         * [2] JSON字符串反序列化成简单JavaBean
         */
        User u = gson.fromJson(jsonStr, User.class);
        System.out.println("JSON字符串反序列化成简单JavaBean ==》" + u);
        // [2]JSON字符串反序列化成简单JavaBean ==》User [id=1, name=王重阳, birthday=Wed May 03 14:16:04 CST 2017]

    }
}

从上面可以看出,在用用GsonBuilder类创建的Gson实例的时候,可以定制可以需要的配置,这些对我们的JSON序列化和反序列化非常有用。

稍微复杂一点的JavaBean对象的序列化与反序列化

实体类:

public class Dept {
    private String id;
    private String deptName;
    private List<User> users;

    //为了代码简洁,这里移除了getter和setter方法、toString方法等
 }

测试类:

package com.chunlynn.gson;

import java.util.ArrayList;
import java.util.Date;
import java.util.List;

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;

public class GsonTest8 {
    public static void main(String[] args) {
        Gson gson = new GsonBuilder()//
                .setPrettyPrinting()//格式化输出(序列化)
                .setDateFormat("yyyy-MM-dd HH:mm:ss") //序列化日期格式化输出
                .create();

        User user1 = new User("1", "王重阳", new Date());
        User user2 = new User("2", "郭靖", new Date());
        User user3 = new User("3", "黄蓉", new Date());

        List<User> userList = new ArrayList<User>();
        userList.add(user1);
        userList.add(user2);
        userList.add(user3);

        Dept dept = new Dept();
        dept.setId("A001");
        dept.setDeptName("研发部");
        dept.setUsers(userList);

        /**
         * [3] 包含其他对象的JavaBean序列化成JSON字符串
         */
        String jsonStr = gson.toJson(dept);
        System.out.println("包含其他对象的JavaBean序列化成JSON字符串 ==》 " + jsonStr);
        /*包含其他对象的JavaBean序列化成JSON字符串 ==》 {
          "id": "A001",
          "deptName": "研发部",
          "users": [
            {
              "id": "1",
              "name": "王重阳",
              "birthday": "2017-05-03 14:52:11"
            },
            {
              "id": "2",
              "name": "郭靖",
              "birthday": "2017-05-03 14:52:11"
            },
            {
              "id": "3",
              "name": "黄蓉",
              "birthday": "2017-05-03 14:52:11"
            }
          ]
        }
        */

        /**
         * [4] JSON字符串反序列化成包含其他对象的JavaBean
         */
        Dept d = gson.fromJson(jsonStr, Dept.class);
        List<User> deptUsers = d.getUsers();
        System.out.println("Dept对象的users属性  ==》 " + deptUsers);
        //Dept对象的users属性  ==》 [User [id=1, name=王重阳, birthday=Wed May 03 14:57:33 CST 2017], User [id=2, name=郭靖, birthday=Wed May 03 14:57:33 CST 2017], User [id=3, name=黄蓉, birthday=Wed May 03 14:57:33 CST 2017]]
        System.out.println("JSON字符串反序列化成简单JavaBean ==》" + d);
        //[4]JSON字符串反序列化成简单JavaBean ==》Dept [id=A001, deptName=研发部, users=[User [id=1, name=王重阳, birthday=Wed May 03 14:54:25 CST 2017], User [id=2, name=郭靖, birthday=Wed May 03 14:54:25 CST 2017], User [id=3, name=黄蓉, birthday=Wed May 03 14:54:25 CST 2017]]]
    }
}

Java 泛型对象与Json字符串的互转

1. 非泛型-- Java数组的序列化与反序列化

数组与泛型不同,数组不是泛型

Gson gson = new GsonBuilder()//
        .setPrettyPrinting()//格式化输出(序列化)
        .setDateFormat("yyyy-MM-dd HH:mm:ss") //序列化日期格式化输出
        .create();

User user1 = new User("1", "王重阳", new Date());
User user2 = new User("2", "郭靖", new Date());
User user3 = new User("3", "黄蓉", new Date());

User[] usersArray = { user1, user2, user3 }; //数组对象

/**
 * 序列化数组
 */
String jsonArrString = gson.toJson(usersArray)
  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

杨愁心

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值