解决Gson将JSON转换为POJO时出现空值问题的实用指南

本文旨在帮助开发者解决在使用gson库将json数据转换为java pojo（plain old java object）时遇到的空值问题。通过分析json结构与pojo类的对应关系，并提供修改pojo结构的示例代码，帮助读者理解并解决数据映射不匹配导致的空值问题，确保json数据能够正确地映射到pojo对象中。

在使用Gson库进行JSON到POJO的转换时，如果POJO类的字段值为null，通常是因为JSON数据的结构与POJO类的结构不匹配，或者字段名称不一致。以下将详细介绍如何诊断并解决此类问题。

1. 检查JSON结构与POJO类的对应关系

这是最常见的原因。Gson需要POJO类的字段与JSON的键值对精确匹配（大小写敏感，除非使用@SerializedName注解）。仔细检查你的JSON数据和POJO类的结构是否一致。如果JSON数据包含嵌套对象，那么POJO类也应该包含相应的嵌套类。

例如，如果JSON数据如下：

{
  "data": {
    "account_number": "1110006278",
    "bank_code": "000",
    "unique_id": "KPY-VA-NEBOrKvKCmTSOJe",
    "account_name": "James Bond",
    "account_reference": "xyz163ath285",
    "bank_name": "test",
    "created_at": "2022-11-27T23:38:36.449Z",
    "currency": "NGN",
    "id": 6268,
    "account_status": "active",
    "customer": {
      "name": "James Bond",
      "email": "[email protected]"
    }
  },
  "message": "Virtual bank account created successfully",
  "status": true
}

而你的POJO类如下：

@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class VirtualAccountResponseDto {
    @SerializedName("account_number")
    private String account_number;
    @SerializedName("bank_code")
    private String bank_code;
    private String unique_id;

    private String account_name;
    private String account_reference;

    private String bank_name;
    private String created_at;
    private String currency;
    private String id;
    private String account_status;
    private Customer customer;
}

@Data
class Customer {
  private String email;
  private String name;
}

你会发现VirtualAccountResponseDto 类直接对应了data里面的内容，因此需要添加一个DataClass来对应data，正确的POJO结构应该是：

@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class VirtualAccountResponseDto {
    DataClass data; // <-- Added this class to match the JSON structure
}

@Data
class DataClass {
    private String account_number;
    private String bank_code;
    private String unique_id;

    private String account_name;
    private String account_reference;

    private String bank_name;
    private String created_at;
    private String currency;
    private String id;
    private String account_status;
    private Customer customer;
}

@Data
class Customer {
  private String email;
  private String name;
}

2. 使用@SerializedName注解

如果JSON中的键名与POJO类的字段名不完全相同，可以使用@SerializedName注解来指定JSON键名对应的POJO字段。

例如，如果JSON中的键名为accountNumber，而POJO字段名为account_number，则可以这样注解：

@SerializedName("accountNumber")
private String account_number;

3. 检查字段类型是否匹配

LobeHub

LobeChat brings you the best user experience of ChatGPT, OLLaMA, Gemini, Claude

下载

确保POJO类的字段类型与JSON值的类型匹配。例如，如果JSON中的值为数字，POJO字段应该是int、double或String类型，而不是boolean类型。

4. 确保POJO类有默认构造函数

Gson需要POJO类有一个无参数的默认构造函数才能正确创建对象。如果你的POJO类只有带参数的构造函数，请添加一个无参数的构造函数。可以使用@NoArgsConstructor注解（如果使用了Lombok库）。

5. 检查Getter和Setter方法

虽然Lombok的@Data注解会自动生成Getter和Setter方法，但如果手动编写了Getter和Setter方法，请确保它们正确实现。

6. 完整的示例代码

以下是一个完整的示例，展示了如何使用Gson将JSON数据转换为POJO，并解决了空值问题：

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

public class GsonExample {

    public static void main(String[] args) {
        String json = "{\n" +
                "  \"data\": {\n" +
                "    \"account_number\": \"1110006278\",\n" +
                "    \"bank_code\": \"000\",\n" +
                "    \"unique_id\": \"KPY-VA-NEBOrKvKCmTSOJe\",\n" +
                "    \"account_name\": \"James Bond\",\n" +
                "    \"account_reference\": \"xyz163ath285\",\n" +
                "    \"bank_name\": \"test\",\n" +
                "    \"created_at\": \"2022-11-27T23:38:36.449Z\",\n" +
                "    \"currency\": \"NGN\",\n" +
                "    \"id\": 6268,\n" +
                "    \"account_status\": \"active\",\n" +
                "    \"customer\": {\n" +
                "      \"name\": \"James Bond\",\n" +
                "      \"email\": \"[email protected]\"\n" +
                "    }\n" +
                "  },\n" +
                "  \"message\": \"Virtual bank account created successfully\",\n" +
                "  \"status\": true\n" +
                "}";

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

        System.out.println("Response DTO: " + responseDTO);
    }

    @Data
    @Builder
    @AllArgsConstructor
    @NoArgsConstructor
    public static class VirtualAccountResponseDto {
        DataClass data;
    }

    @Data
    static class DataClass {
        private String account_number;
        private String bank_code;
        private String unique_id;
        private String account_name;
        private String account_reference;
        private String bank_name;
        private String created_at;
        private String currency;
        private String id;
        private String account_status;
        private Customer customer;
    }

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

7. 总结

解决Gson转换JSON到POJO时出现空值问题的关键在于确保JSON数据的结构与POJO类的结构完全匹配。仔细检查字段名称、字段类型以及JSON数据的嵌套结构，并使用@SerializedName注解进行必要的映射。通过以上步骤，可以有效地解决Gson转换过程中的空值问题，确保数据的正确解析。