Google Gson API 介绍与使用

￡神魔★判官ぃ 2022-04-14 02:39 274阅读 0赞

**目录**

Gson 概述与下载

Gson (反)序列化 Java 对象

JsonElement  Json 元素

JsonObject Json 对象

JsonArray Json 数组

JsonParser Json 解析

GsonBuilder 构建 Gson

--------------------

# Gson 概述与下载 #

1、Java 解析 Json 最常用的类库有：google 的 Gson、阿里巴巴的 FastJson、以及 Jackson。这些都是非常优秀而且常用的库。

2、GSON 是 Google 提供的用来在 Java 对象和 JSON 数据之间进行映射的 Java 类库，可以快速的将一个 Json 字符转成一个 Java 对象，或者将一个 Java 对象转化为 Json 字符串。

3、gson 在 github 上开源地址：[https://github.com/google/gson][https_github.com_google_gson]

**二进制开发包下载**：gson 二进制开发包下载地址：[https://search.maven.org/artifact/com.google.code.gson/gson/2.8.5/jar][https_search.maven.org_artifact_com.google.code.gson_gson_2.8.5_jar]

[gson-2.8.4.jar下载][gson-2.8.4.jar]、[gson-2.8.5.jar下载][gson-2.8.5.jar]

**Maven 依赖**：gson 在 Maven 仓库地址：[https://mvnrepository.com/artifact/com.google.code.gson/gson][https_mvnrepository.com_artifact_com.google.code.gson_gson]

<dependency>
      <groupId>com.google.code.gson</groupId>
      <artifactId>gson</artifactId>
      <version>2.8.5</version>
    </dependency>

# Gson (反)序列化 Java 对象 #

1、com.google.gson.Gson 提供 toJson() 和 fromJson() 方法用于序列化与反序列化  Java 对象。

2、Gson 对象的 toJson 方法可以将 Java 基本数据类型、以及 POJO 对象、List、Map 、JsonElement  等转为 json 格式的字符串，

3、Gson 对象的 fromJson 方法做与 toJson 相反的操作，将 json 格式的字符串转为基本数据类型、 POJO 对象、List、Map 、JsonElement  等

<table> 
 <tbody> 
  <tr> 
   <td colspan="2" style="text-align:center;width:347px;"><strong>对象序列化</strong></td> 
  </tr> 
  <tr> 
   <td style="width:347px;">&nbsp;T fromJson(String json, Class&lt;T&gt; classOfT)</td> 
   <td style="width:555px;">将指定的 Json 反序列化为指定类的对象，如果指定的类是泛型类型，则使用 fromJson(String, Type)方法。</td> 
  </tr> 
  <tr> 
   <td style="width:347px;">T fromJson(String json, Type typeOfT)</td> 
   <td style="width:555px;">将指定的 Json 反序列化为指定类型的对象，如果指定的对象是泛型类型，则此方法很有用，对于非泛型对象，请改用 fromJson(String json, Class&lt;T&gt; classOfT)</td> 
  </tr> 
  <tr> 
   <td style="width:347px;">T fromJson(JsonElement json, Class&lt;T&gt; classOfT)</td> 
   <td style="width:555px;">将指定的 json 元素反序列化为指定类型的对象，如果指定的类是泛型类型，则使用 fromJson(JsonElement, Type) 方法。</td> 
  </tr> 
  <tr> 
   <td style="width:347px;">T fromJson(JsonElement json, Type typeOfT)</td> 
   <td style="width:555px;">&nbsp;</td> 
  </tr> 
  <tr> 
   <td style="width:347px;">T fromJson(Reader json, Class&lt;T&gt; classOfT)<br> T fromJson(Reader json, Type typeOfT)</td> 
   <td style="width:555px;">将从指定字符输入流读取的Json反序列化为指定类的对象，如果指定的类是泛型类型，则调用 {@link#fromJson（Reader，type）}</td> 
  </tr> 
  <tr> 
   <td colspan="2" style="text-align:center;width:347px;"><strong>序列化为对象</strong></td> 
  </tr> 
  <tr> 
   <td style="width:347px;">String toJson(Object src)</td> 
   <td style="width:555px;">将指定的对象序列化为其等效的Json表示形式，当指定的对象不是泛型类型时，应使用此方法，如果对象是泛型类型，请改用 toJson(object,type).</td> 
  </tr> 
  <tr> 
   <td style="width:347px;">String toJson(Object src, Type typeOfSrc)</td> 
   <td style="width:555px;">将指定的对象（包括泛型类型的对象）序列化为其等效的Json表示形式,对于非泛型对象，请改用{@link#toJson（Object）}</td> 
  </tr> 
  <tr> 
   <td style="width:347px;">String toJson(JsonElement jsonElement)</td> 
   <td style="width:555px;">将 JsonElement 转换为其等效的JSON表示形式。</td> 
  </tr> 
  <tr> 
   <td style="width:347px;">JsonElement toJsonTree(Object src)</td> 
   <td style="width:555px;">将指定的对象序列化为 JsonElement 的等效表示形式,当指定的对象不是泛型类型时，应使用此方法;如果对象是泛型类型，请改用{@link#toJsonTree（object，type）}</td> 
  </tr> 
  <tr> 
   <td style="width:347px;">JsonElement toJsonTree(Object src, Type typeOfSrc)</td> 
   <td style="width:555px;">&nbsp;</td> 
  </tr> 
 </tbody> 
</table>

API 演示源码：[https://github.com/wangmaoxiong/apache-study/blob/master/src/main/java/com/wmx/gson/GsonTest.java][https_github.com_wangmaoxiong_apache-study_blob_master_src_main_java_com_wmx_gson_GsonTest.java]

# JsonElement  Json 元素 #

1、JsonObject、JsonArray、JsonPrimitive、JsonNull 都是 JsonElement 的子类，JsonElement  常用方法：

<table> 
 <tbody> 
  <tr> 
   <td>JsonElement deepCopy()</td> 
   <td>返回此元素的深层副本，克隆。</td> 
  </tr> 
  <tr> 
   <td>&nbsp;BigDecimal getAsBigDecimal()</td> 
   <td>将此元素作为 BigDecimal 类型获取，如果元素不是 JsonPrimitive，则引发 ClassCastException，<br> 如果元素不是有效的 BigDecimate，则 @throws NumberFormatException。<br> 如果元素属于 JsonArray 类型，但包含多个元素，则引发 IllegalStateException。</td> 
  </tr> 
  <tr> 
   <td>BigInteger getAsBigInteger()</td> 
   <td>将此元素作为 BigInteger&nbsp; 类型获取，如果元素不是 JsonPrimitive，则引发 ClassCastException，<br> 如果元素不是有效的 BigInteger ，则 @throws NumberFormatException。<br> 如果元素属于 JsonArray 类型，但包含多个元素，则引发 IllegalStateException。</td> 
  </tr> 
  <tr> 
   <td>boolean getAsBoolean()</td> 
   <td>将此元素作为原始布尔值获取，如果元素不是 JsonPrimitive 并且不是有效的布尔值，则引发 ClassCastException，<br> 如果元素属于 JsonArray 类型，但包含多个元素，则引发IllegalStateException</td> 
  </tr> 
  <tr> 
   <td>byte getAsByte()</td> 
   <td>将此元素作为原始 byte&nbsp; 值获取，如果元素不是 JsonPrimitive 并且不是有效的布尔值，则引发 ClassCastException，<br> 如果元素属于 JsonArray 类型，但包含多个元素，则引发IllegalStateException</td> 
  </tr> 
  <tr> 
   <td colspan="2"> <p>其它 Java 基本数据类型也是同理：</p> <p>double getAsDouble()、char getAsCharacter()、float getAsFloat()、int getAsInt()、long getAsLong()、short getAsShort()</p> </td> 
  </tr> 
  <tr> 
   <td>JsonArray getAsJsonArray()</td> 
   <td>将此元素作为 JsonArray 获取,如果元素是其他类型的元素，则会生成 IlleglastateException 异常，<br> 因此最好先调用 isJsonArray() 方法确保该元素是所需的类型，然后再使用此方法。</td> 
  </tr> 
  <tr> 
   <td>JsonObject getAsJsonObject()</td> 
   <td>将此元素作为 JsonObject 获取,如果元素是其他类型的元素，则会引发 IlleglastateException 异常,<br> 因此最好先通过调用 isJsonObject() 方法来确保该元素是所需类型之后使用此方法。</td> 
  </tr> 
  <tr> 
   <td>JsonPrimitive getAsJsonPrimitive()</td> 
   <td> <p>将此元素作为 JsonPrimitive 获取，如果元素是其他类型的元素，则会引发 IlleglastateException 异常，<br> 因此最好先通过调用 isJsonPrimitive() 方法来确保该元素是所需的类型之后再使用此方法。</p> <p><span style="color:#f33b45;">JsonPrimitive 值可以是 Java 字符串、Java 基本数据类型及其包装器类型。</span></p> </td> 
  </tr> 
  <tr> 
   <td> <p>boolean isJsonArray()</p> </td> 
   <td>验证此元素是否为数组，如果此元素属于 JsonArray 类型，则返回 true，否则返回 false。</td> 
  </tr> 
  <tr> 
   <td> <p>boolean isJsonNull()</p> </td> 
   <td>验证此元素是否表示 null 值，如果此元素的类型为 JsonNull，则返回 true，否则返回 false。</td> 
  </tr> 
  <tr> 
   <td> <p>boolean isJsonObject()</p> </td> 
   <td>验证此元素是否为 JsonObject 对象。</td> 
  </tr> 
  <tr> 
   <td> <p>boolean isJsonPrimitive()</p> </td> 
   <td>以验证此元素是否为 Java 数据类型。</td> 
  </tr> 
 </tbody> 
</table>

/**
         * JsonPrimitive getAsJsonPrimitive():
         * 将此元素作为 JsonPrimitive 获取，如果元素是其他类型的元素，则会引发 IlleglastateException 异常，
         * 因此最好先通过调用 isJsonPrimitive() 方法来确保该元素是所需的类型之后再使用此方法。JsonPrimitive 值可以是 Java 字符串、Java 基本数据类型及其包装器类型。
         */
        @Test
        public void test12() {
            String json = "[\"本级小计\",368.00,328.00,]";
            JsonElement sourceJsonElement = new JsonParser().parse(json);
            JsonArray jsonArray = sourceJsonElement.getAsJsonArray();
            for (int i = 0; i < jsonArray.size(); i++) {
                JsonElement jsonElement = jsonArray.get(i);
                if (jsonElement.isJsonPrimitive()) {
                    JsonPrimitive jsonPrimitive = jsonElement.getAsJsonPrimitive();
                    if (jsonPrimitive.isString()) {
                        System.out.println(jsonPrimitive.getAsString());
                    } else if (jsonPrimitive.isNumber()) {
                        System.out.println(jsonPrimitive.getAsDouble());
                    }
                }
            }
        }

API 演示源码：

[https://github.com/wangmaoxiong/apache-study/blob/master/src/main/java/com/wmx/gson/JsonObjectTest.java][https_github.com_wangmaoxiong_apache-study_blob_master_src_main_java_com_wmx_gson_JsonObjectTest.java]

[https://github.com/wangmaoxiong/apache-study/blob/master/src/main/java/com/wmx/gson/JsonArrayTest.java][https_github.com_wangmaoxiong_apache-study_blob_master_src_main_java_com_wmx_gson_JsonArrayTest.java]

# JsonObject Json 对象 #

<table> 
 <tbody> 
  <tr> 
   <td>add(String property, JsonElement value)</td> 
   <td>添加一个健-值对的成员，名称必须是字符串，但值可以是任意的 JsonElement 类型。</td> 
  </tr> 
  <tr> 
   <td>addProperty(String property, Boolean value)</td> 
   <td>添加布尔成员的便利方法，指定的值将转换为布尔值的 JsonPrimitive。</td> 
  </tr> 
  <tr> 
   <td>addProperty(String property, Character value)</td> 
   <td>添加 char 成员的便利方法，指定的值将转换为字符的 JsonPrimitive。</td> 
  </tr> 
  <tr> 
   <td>addProperty(String property, Number value)</td> 
   <td>添加 Number&nbsp; 成员的便利方法，指定的值将转换为数字的 JsonPrimitive。</td> 
  </tr> 
  <tr> 
   <td>addProperty(String property, String value)</td> 
   <td>添加 String 成员的便利方法，指定的值将转换为数字的 JsonPrimitive。</td> 
  </tr> 
  <tr> 
   <td>Set&lt;Map.Entry&lt;String, JsonElement&gt;&gt; entrySet()</td> 
   <td>返回此对象的所有成员，集合是有序的，与元素的添加顺序相同。</td> 
  </tr> 
  <tr> 
   <td>JsonElement get(String memberName)</td> 
   <td>返回具有指定名称的成员。</td> 
  </tr> 
  <tr> 
   <td>JsonArray getAsJsonArray(String memberName)</td> 
   <td>获取指定成员作为 JsonArray 的便利方法。</td> 
  </tr> 
  <tr> 
   <td>JsonObject getAsJsonObject(String memberName)</td> 
   <td>获取指定成员作为 JsonObject 的便利方法。</td> 
  </tr> 
  <tr> 
   <td>JsonPrimitive getAsJsonPrimitive(String memberName)</td> 
   <td>获取指定成员作为 JsonPrimitive&nbsp; 的便利方法。</td> 
  </tr> 
  <tr> 
   <td>boolean has(String memberName)</td> 
   <td>检查此对象中是否存在具有指定名称的成员的便利方法。</td> 
  </tr> 
  <tr> 
   <td>Set&lt;String&gt; keySet()</td> 
   <td>返回所有成员的 key 值。</td> 
  </tr> 
  <tr> 
   <td>JsonElement remove(String property)</td> 
   <td>从此 JsonObject 中删除指定的属性，返回被删除的属性。</td> 
  </tr> 
  <tr> 
   <td>int size()</td> 
   <td>返回对象中键/值对的数目。</td> 
  </tr> 
 </tbody> 
</table>

/**
         * int size():返回对象中键/值对的数目。
         * Set<String> keySet():返回所有成员的键值
         */
        @Test
        public void jsonObject7() {
            String json = "{\"pId\":9527,\"pName\":\"华安\",\"isMarry\":true}";
            JsonObject jsonObject = new JsonParser().parse(json).getAsJsonObject();
            System.out.println(jsonObject.size());
            Set<String> keySet = jsonObject.keySet();//3
            System.out.println(keySet);//[pId, pName, isMarry]
        }

API 演示源码：[https://github.com/wangmaoxiong/apache-study/blob/master/src/main/java/com/wmx/gson/JsonObjectTest.java][https_github.com_wangmaoxiong_apache-study_blob_master_src_main_java_com_wmx_gson_JsonObjectTest.java]

# JsonArray Json 数组 #

<table> 
 <tbody> 
  <tr> 
   <td> <p>JsonArray()</p> <p>JsonArray(int capacity)</p> </td> 
   <td>两个构造器，一个是创建空的 Json 数组，一个是指定初始容量。</td> 
  </tr> 
  <tr> 
   <td>add( Boolean value)</td> 
   <td>将指定的布尔值添加到 json 数组，如 value 为 null，则添加 JsonNull。</td> 
  </tr> 
  <tr> 
   <td>add(Character value)</td> 
   <td>将指定的 Character&nbsp; 值添加到 json 数组，如 value 为 null，则添加 JsonNull。</td> 
  </tr> 
  <tr> 
   <td>add(Number value)</td> 
   <td>将指定的 Number&nbsp; 值添加到 json 数组，如 value 为 null，则添加 JsonNull。</td> 
  </tr> 
  <tr> 
   <td>add(String value)</td> 
   <td>将指定的 String&nbsp; 值添加到 json 数组，如 value 为 null，则添加 JsonNull。</td> 
  </tr> 
  <tr> 
   <td>add(JsonElement value)</td> 
   <td>将指定的 JsonElement&nbsp; 值添加到 json 数组，如 value 为 null，则添加 JsonNull。</td> 
  </tr> 
  <tr> 
   <td>addAll(JsonArray array)</td> 
   <td>将指定数组中的所有元素添加到此 json 数组。</td> 
  </tr> 
  <tr> 
   <td>boolean contains(JsonElement element)</td> 
   <td>如果此数组包含指定的元素，则返回true。</td> 
  </tr> 
  <tr> 
   <td>JsonElement get(int i)</td> 
   <td>返回数组的第 i 个元素，如果下标越界，则抛异常</td> 
  </tr> 
  <tr> 
   <td>Iterator&lt;JsonElement&gt; iterator()</td> 
   <td>返回一个迭代器来导航数组的元，由于数组是一个有序列表，迭代器按照元素插入的顺序导航元素。</td> 
  </tr> 
  <tr> 
   <td>JsonElement remove(int index)</td> 
   <td>删除此数组中指定位置的元素，向左移动任何后续元素（从其索引中减去一个），返回从数组中删除的元素。</td> 
  </tr> 
  <tr> 
   <td>boolean remove(JsonElement element)</td> 
   <td>从该数组中删除第一个出现的指定元素（如果存在）。如果数组不包含元素，则它将保持不变。</td> 
  </tr> 
  <tr> 
   <td>JsonElement set(int index, JsonElement element)</td> 
   <td>将此数组中指定位置的元素替换为指定元素，元素不能为null。</td> 
  </tr> 
  <tr> 
   <td>int size()</td> 
   <td>返回数组的大小。</td> 
  </tr> 
 </tbody> 
</table>

@Test
        public void test4() {
            JsonArray jsonArray = new JsonParser().parse("[{\"code\":200,\"msg\":\"成功\"}]").getAsJsonArray();
            JsonArray deepCopy = jsonArray.deepCopy();
            deepCopy.add("Yes");
            System.out.println(jsonArray);//[{"code":200,"msg":"成功"}]
            System.out.println(deepCopy);//[{"code":200,"msg":"成功"},"Yes"]
        }

API 演示源码：[https://github.com/wangmaoxiong/apache-study/blob/master/src/main/java/com/wmx/gson/JsonArrayTest.java][https_github.com_wangmaoxiong_apache-study_blob_master_src_main_java_com_wmx_gson_JsonArrayTest.java]

# JsonParser Json 解析 #

1、JsonParser 用于将 Json 字符内容解析为  json 元素 JsonElement。

<table> 
 <tbody> 
  <tr> 
   <td style="width:303px;">JsonElement parse(Reader json)</td> 
   <td style="width:598px;">将指定的 JSON 字符串字符输入流解析为 Json 元素，如果指定的文本不是有效的 JSON 字符串，则抛出 JsonParseException 异常。</td> 
  </tr> 
  <tr> 
   <td style="width:303px;">JsonElement parse(String json)</td> 
   <td style="width:598px;">将指定的 JSON 字符串解析为 Json 元素，如果指定的文本不是有效的 JSON 字符串，则抛出 JsonParseException 异常。</td> 
  </tr> 
 </tbody> 
</table>

@Test
        public void test1() {
            String json = "{\"id\":1000,\"name\":\"华安\",\"birthday\":\"Jul 13, 2020 8:46:42 PM\",\"marry\":true}";
            JsonParser jsonParser = new JsonParser();
            JsonElement jsonElement = jsonParser.parse(json);
            JsonObject jsonObject = jsonElement.getAsJsonObject();
            System.out.println(jsonObject);//{"id":1000,"name":"华安","birthday":"Jul 13, 2020 8:46:42 PM","marry":true}
        }

API 演示源码：[https://github.com/wangmaoxiong/apache-study/blob/master/src/main/java/com/wmx/gson/JsonParserTest.java][https_github.com_wangmaoxiong_apache-study_blob_master_src_main_java_com_wmx_gson_JsonParserTest.java]

# GsonBuilder 构建 Gson #

1、对于默认配置的 Gson，直接使用 new Gson 更简单，当需要设置默认值以外的配置选项时，使用 GsonBuilder 构建器，调用它的各种配置方法，最后调用 create 方法创建 Gson 对象。

<table> 
 <tbody> 
  <tr> 
   <td>GsonBuilder serializeNulls()</td> 
   <td>序列化空字段，默认情况下，Gson 序列化期间会忽略所有为 null 的字段</td> 
  </tr> 
  <tr> 
   <td>GsonBuilder setDateFormat(String pattern)</td> 
   <td>根据提供的模式序列化 Date 日期对象，可以多次调用，但只有最后一次调用将用于决定序列化格式。</td> 
  </tr> 
  <tr> 
   <td colspan="2"> <p>&nbsp;GsonBuilder setFieldNamingPolicy(FieldNamingPolicy namingConvention)</p> <p>1、配置为在序列化和反序列化期间将特定命名策略应用于对象的字段。</p> <p>2、namingConvention：用于序列化和反序列化的 JSON 字段命名约定/策略，可选值如下：</p> <p>IDENTITY：使用对象默认的字段名称<br> UPPER_CAMEL_CASE：使用驼峰命名<br> UPPER_CAMEL_CASE_WITH_SPACES：将 Java 字段名的第一个'字母'在序列化为JSON格式时大写，单词之间用空格隔开<br> LOWER_CASE_WITH_UNDERSCORES：使用此命名策略将把 Java 字段名从大小写形式修改为全小写字段名，其中单词之间由下划线分隔<br> LOWER_CASE_WITH_DASHES：使用此命名策略将把 Java 字段名从大小写形式修改为全小写字段名，其中单词之间用破折号（-）分隔<br> LOWER_CASE_WITH_DOTS：使用此命名策略将 Java 字段名从大小写形式修改为全小写字段名，其中每个单词用点（.）分隔。</p> </td> 
  </tr> 
 </tbody> 
</table>

@Test
        public void test1() {
            Gson gson = new GsonBuilder()
                    .serializeNulls()
                    .setDateFormat("yyyy-MM-dd HH:mm:ss")
                    .setFieldNamingPolicy(FieldNamingPolicy.IDENTITY)
                    .create();
    
            Person person = new Person();
            person.setId(100);
            person.setBirthday(new Date());
    
            String toJson = gson.toJson(person);
            //{"id":100,"name":null,"birthday":"2020-07-19 11:37:35","marry":null}
            System.out.println(toJson);
    
            Person person1 = gson.fromJson(toJson, Person.class);
            //Person{id=100, name='null', birthday=Sun Jul 19 11:37:35 CST 2020, marry=null}
            System.out.println(person1);
        }

API 演示源码：[https://github.com/wangmaoxiong/apache-study/blob/master/src/main/java/com/wmx/gson/GsonBuilderTest.java][https_github.com_wangmaoxiong_apache-study_blob_master_src_main_java_com_wmx_gson_GsonBuilderTest.java]

[https_github.com_google_gson]: https://github.com/google/gson
[https_search.maven.org_artifact_com.google.code.gson_gson_2.8.5_jar]: https://search.maven.org/artifact/com.google.code.gson/gson/2.8.5/jar
[gson-2.8.4.jar]: https://search.maven.org/remotecontent?filepath=com/google/code/gson/gson/2.8.4/gson-2.8.4.jar
[gson-2.8.5.jar]: https://search.maven.org/remotecontent?filepath=com/google/code/gson/gson/2.8.5/gson-2.8.5.jar
[https_mvnrepository.com_artifact_com.google.code.gson_gson]: https://mvnrepository.com/artifact/com.google.code.gson/gson
[https_github.com_wangmaoxiong_apache-study_blob_master_src_main_java_com_wmx_gson_GsonTest.java]: https://github.com/wangmaoxiong/apache-study/blob/master/src/main/java/com/wmx/gson/GsonTest.java
[https_github.com_wangmaoxiong_apache-study_blob_master_src_main_java_com_wmx_gson_JsonObjectTest.java]: https://github.com/wangmaoxiong/apache-study/blob/master/src/main/java/com/wmx/gson/JsonObjectTest.java
[https_github.com_wangmaoxiong_apache-study_blob_master_src_main_java_com_wmx_gson_JsonArrayTest.java]: https://github.com/wangmaoxiong/apache-study/blob/master/src/main/java/com/wmx/gson/JsonArrayTest.java
[https_github.com_wangmaoxiong_apache-study_blob_master_src_main_java_com_wmx_gson_JsonParserTest.java]: https://github.com/wangmaoxiong/apache-study/blob/master/src/main/java/com/wmx/gson/JsonParserTest.java
[https_github.com_wangmaoxiong_apache-study_blob_master_src_main_java_com_wmx_gson_GsonBuilderTest.java]: https://github.com/wangmaoxiong/apache-study/blob/master/src/main/java/com/wmx/gson/GsonBuilderTest.java