Google Gson 快速使用入门，Spring boot 切换为 Gson_com.google.code.gson

目录

Gson 概述与下载

Gson (反)序列化 Java 对象

JsonElement  Json 元素

JsonObject Json 对象

JsonArray Json 数组

JsonParser Json 解析

GsonBuilder 构建 Gson

Spring Boot 使用 Gson 替换 Jackson

---

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

4、注意事项：Gson 将 Map 序列化为 Json 字符串时，默认原本的整型会加上 .0 而变成浮点型，比如 0 -> 0.0，1 -> 1.0 。​​​​​​​

二进制开发包下载：gson 二进制开发包下载地址：Maven Central Repository Search

 gson-2.8.4.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  等

API 演示源码：src/main/java/com/wmx/gson/GsonTest.java · 汪少棠/apache-study - Gitee.com

JsonElement  Json 元素

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

    /**
     * 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 演示源码：src/main/java/com/wmx/gson/JsonObjectTest.java · 汪少棠/apache-study - Gitee.com

src/main/java/com/wmx/gson/JsonArrayTest.java · 汪少棠/apache-study - Gitee.com

JsonObject Json 对象

    /**
     * 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 演示源码：src/main/java/com/wmx/gson/JsonObjectTest.java · 汪少棠/apache-study - Gitee.com

JsonArray Json 数组

    @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 演示源码：src/main/java/com/wmx/gson/JsonArrayTest.java · 汪少棠/apache-study - Gitee.com

JsonParser Json 解析

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

    @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 演示源码：src/main/java/com/wmx/gson/JsonParserTest.java · 汪少棠/apache-study - Gitee.com

GsonBuilder 构建 Gson

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

    @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 演示源码：src/main/java/com/wmx/gson/GsonBuilderTest.java · 汪少棠/apache-study - Gitee.com

Spring Boot 使用 Gson 替换 Jackson

1、Spring Boot 提供了三个 JSON 库的集成：Gson、Jackson、JSON-B， 默认使用 jackson。

第一步：排除 jackson 依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <exclusions>
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-json</artifactId>
        </exclusion>
    </exclusions>
</dependency>

在启动类 @SpringBootApplication 注解中，排除掉 Jackson 的自动装配：

@SpringBootApplication(exclude = { JacksonAutoConfiguration.class })

 第二步：添加 Gson 依赖

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

第三步：配置属性

1、在全局配置文件中添加如下配置，指定 Spirng MVC 使用 Gson 的 HttpMessageConverter 实现，GsonHttpMessageConverter：

spring.mvc.converters.preferred-json-mapper=gson

2、Spring Boot 为 Gson 预定义了很多配置属性，可以通过它们来自定义 Gson 的特性：

完整配置：https://springdoc.cn/spring-boot/application-properties.html#appendix.application-properties.json/

spring.gson.date-format=  # Date 对象序列化时使用的格式。
spring.gson.disable-html-escaping= # 是否禁止转义 HTML 字符，如 "<"、">" 等。
spring.gson.disable-inner-class-serialization= # 序列化时是否排除内部类。
# 是否启用复杂 map key（即非基础类型）的序列化。
spring.gson.enable-complex-map-key-serialization=
# 是否将所有没有 @Expose 注解的字段排除在序列化或反序列化之外。
spring.gson.exclude-fields-without-expose-annotation=
spring.gson.field-naming-policy=  # 在序列化和反序列化时应用于对象字段的命名策略。
# 是否通过在输出前添加一些特殊文本来生成不可执行的 JSON。
spring.gson.generate-non-executable-json=
spring.gson.lenient=  # 是否对不符合 RFC 4627 的 JSON 进行宽松解析。
spring.gson.long-serialization-policy=  # Long 和 long 类型的序列化策略。
spring.gson.pretty-printing=  # 是否输出格式化后的 JSON 字符串。
spring.gson.serialize-nulls=  # 是否输出格式化后的 JSON 字符串。

自定义配置

1、如果全局配置属性不满足需求，那么也可以通过在配置类中自定义 GsonBuilder Bean 来对 Gson 进行自定义配置。

2、例如，自定义 Gson 对 LocalDateTime 类型的格式化：

@Configuration
public class GsonConfig {
    @Bean
    public GsonBuilder gsonBuilder(List<GsonBuilderCustomizer> customizers) {
        // 创建 GsonBuilder
        GsonBuilder builder = new GsonBuilder();
        // 序列化空字段，默认情况下，Gson 序列化期间会忽略所有为 null 的字段
        builder.serializeNulls();
        // 加载配置文件中的配置属性。customizers 是读取到的配置文件中关于 Gson 的配置
        customizers.forEach((c) -> c.customize(builder));
        // 编程式自定义
        DateTimeFormatter DATE_TIME_FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");
        // LocalDateTime 类型的格式化
        builder.registerTypeHierarchyAdapter(LocalDateTime.class, new JsonSerializer<LocalDateTime>() {
            @Override
            public JsonElement serialize(LocalDateTime src, Type typeOfSrc, JsonSerializationContext context) {
                return new JsonPrimitive(DATE_TIME_FORMATTER.format(src));
            }
        });
        return builder;
    }
}

3、然后可以在任意地方注入 com.google.gson.Gson 对象使用。

    @Autowired
    private Gson gson;