使用 Gson 将 JSON 转换为 POJO 时修复 Null 值问题

本文旨在解决在使用 Gson 库将 JSON 数据转换为 Java POJO (Plain Old Java Object) 时，出现 POJO 字段值为 null 的问题。通过分析 JSON 结构与 POJO 类的对应关系，提供一种有效的解决方案，确保数据正确映射。

在使用 Gson 库将 JSON 数据转换为 Java POJO (Plain Old Java Object) 时，有时会遇到 POJO 类的字段值为 null 的情况，即使 JSON 数据中对应字段明明有值。这通常是由于 JSON 结构与 POJO 类的定义不匹配导致的。本文将详细介绍如何解决此类问题，确保 JSON 数据能够正确映射到 POJO 对象。

问题分析

Gson 在进行 JSON 转换时，依赖于 JSON 数据的键（key）与 POJO 类中的字段名进行匹配。如果两者不一致，或者 JSON 数据的结构与 POJO 类的结构不匹配，就会导致字段值为 null。

解决方案

解决此问题的关键在于确保 JSON 结构与 POJO 类的定义完全一致。以下是一些常用的方法：

1. 检查 JSON 结构与 POJO 类结构是否匹配：

   这是最常见的原因。如果 JSON 数据中存在嵌套结构，而 POJO 类没有相应的嵌套类来对应，就会导致外层 POJO 类的字段值为 null。

   例如，如果 JSON 数据如下：

   {
     "data": {
       "account_number": "1234567890",
       "bank_code": "001",
       "customer": {
         "name": "John Doe",
         "email": "[email protected]"
       }
     },
     "message": "Success",
     "status": true
   }

   登录后复制

   而 POJO 类定义如下：

   @Data
   public class VirtualAccountResponseDto {
       private String account_number;
       private String bank_code;
       private String customerName;
       private String customerEmail;
   }

   登录后复制

   那么 account_number 和 bank_code 会是 null，因为没有匹配的字段。正确的做法是定义一个 DataClass 来对应 data 字段，并在 VirtualAccountResponseDto 中包含该字段。

   @Data
   public class VirtualAccountResponseDto {
       private DataClass data;
       private String message;
       private boolean status;
   }
   
   @Data
   public class DataClass {
       private String account_number;
       private String bank_code;
       private Customer customer;
   }
   
   @Data
   public class Customer {
       private String name;
       private String email;
   }

   登录后复制

2. 使用 @SerializedName 注解：

   如果 JSON 数据的键与 POJO 类的字段名不完全相同，可以使用 @SerializedName 注解来指定 JSON 数据的键与 POJO 类的字段之间的映射关系。

   

   Find JSON Path Online

   Easily find JSON paths within JSON objects using our intuitive Json Path Finder

   30

   查看详情

   例如，如果 JSON 数据中的键为 account_number，而 POJO 类中的字段名为 accountNumber，则可以使用以下注解：

   import com.google.gson.annotations.SerializedName;
   
   @Data
   public class VirtualAccountResponseDto {
       @SerializedName("account_number")
       private String accountNumber;
       private String bankCode;
   }

   登录后复制

3. 检查字段名的大小写：

   Gson 默认是区分大小写的。确保 JSON 数据的键与 POJO 类的字段名的大小写完全一致。如果需要忽略大小写，可以自定义 Gson 的配置。

4. 确保 POJO 类具有无参构造函数：

   Gson 需要使用无参构造函数来创建 POJO 类的实例。如果 POJO 类没有无参构造函数，Gson 将无法创建实例，导致字段值为 null。可以使用 @NoArgsConstructor 注解来生成无参构造函数。

   import lombok.NoArgsConstructor;
   
   @Data
   @NoArgsConstructor
   public class VirtualAccountResponseDto {
       private String accountNumber;
       private String bankCode;
   }

   登录后复制

5. 检查数据类型是否匹配：

   确保 JSON 数据中的值与 POJO 类中的字段的数据类型匹配。例如，如果 JSON 数据中的值为字符串，而 POJO 类中的字段为整数，则会导致类型转换错误，字段值为 null。

示例代码

以下是一个完整的示例代码，演示了如何使用 Gson 将 JSON 数据转换为 POJO 对象，并解决字段值为 null 的问题：

import com.google.gson.Gson;
import com.google.gson.annotations.SerializedName;
import lombok.Data;
import lombok.NoArgsConstructor;

public class GsonExample {

    public static void main(String[] args) {
        String json = "{\n" +
                "  \"data\": {\n" +
                "    \"account_number\": \"1234567890\",\n" +
                "    \"bank_code\": \"001\",\n" +
                "    \"customer\": {\n" +
                "      \"name\": \"John Doe\",\n" +
                "      \"email\": \"[email protected]\"\n" +
                "    }\n" +
                "  },\n" +
                "  \"message\": \"Success\",\n" +
                "  \"status\": true\n" +
                "}";

        Gson gson = new Gson();
        VirtualAccountResponseDto responseDto = gson.fromJson(json, VirtualAccountResponseDto.class);

        System.out.println(responseDto);
    }

    @Data
    @NoArgsConstructor
    public static class VirtualAccountResponseDto {
        private DataClass data;
        private String message;
        private boolean status;
    }

    @Data
    @NoArgsConstructor
    public static class DataClass {
        @SerializedName("account_number")
        private String accountNumber;
        @SerializedName("bank_code")
        private String bankCode;
        private Customer customer;
    }

    @Data
    @NoArgsConstructor
    public static class Customer {
        private String name;
        private String email;
    }
}

注意事项

• 仔细检查 JSON 数据的结构和 POJO 类的定义，确保两者完全匹配。
• 使用 @SerializedName 注解来处理 JSON 数据的键与 POJO 类的字段名不一致的情况。
• 确保 POJO 类具有无参构造函数。
• 检查数据类型是否匹配。
• 在复杂的 JSON 结构中，可以使用嵌套类来对应 JSON 数据的嵌套结构。

总结

通过以上方法，可以有效地解决在使用 Gson 将 JSON 数据转换为 POJO 对象时，出现字段值为 null 的问题。关键在于理解 Gson 的工作原理，并确保 JSON 结构与 POJO 类的定义完全一致。 在实际开发中，仔细分析 JSON 数据和 POJO 类，并结合以上方法进行调试，可以有效地解决此类问题，确保数据的正确映射。

以上就是使用 Gson 将 JSON 转换为 POJO 时修复 Null 值问题的详细内容，更多请关注php中文网其它相关文章！