Java中高效解析JSON/ndJSON文件：Gson与DTO模型匹配实践 json to java

本文旨在解决java中使用gson库解析json文件时常见的`jsonsyntaxexception: expected begin_array but was begin_object`错误。核心在于强调json数据结构（对象或数组）与java dto（数据传输对象）中对应字段类型必须严格匹配。教程将通过案例分析、正确模型设计、代码示例及ndjson文件处理方法，指导开发者实现高效、无错的json反序列化。

JSON（JavaScript Object Notation）作为一种轻量级的数据交换格式，在现代Web服务和数据处理中扮演着核心角色。在Java应用中，我们经常需要将JSON数据反序列化为Java对象，以便于程序内部处理。Gson是Google提供的一个强大的Java库，用于Java对象和JSON数据之间的序列化和反序列化。然而，在将复杂的JSON结构映射到Java对象时，如果不遵循严格的类型匹配规则，很容易遇到JsonSyntaxException等运行时错误。

当使用Gson解析JSON时，com.google.gson.JsonSyntaxException: java.lang.IllegalStateException: Expected BEGIN_ARRAY but was BEGIN_OBJECT是一个常见的错误。这个异常清晰地指出了问题所在：Gson在解析JSON时，期望遇到一个数组的开始（[），但实际上却遇到了一个对象的开始（{）。这通常意味着您的Java DTO模型与实际的JSON结构不匹配。

让我们来看一个具体的例子。假设有以下JSON数据片段：

{   "Top-level":{      "customer_no":"1",      "created":"2019-03-27 14:24:54"   },   "profile":{      "salutation":"Mr",      "first_name":"Veronica"   },   "phone":{      "home_phone":null   },   "addresses":[      {         "address_id":"1",         "city":"Calder"      }   ],   "orders":{      "placed_orders_count":2,      "0":{         "order_id":"000000001"      }   },   "customs":[   ]}

以及一个尝试解析上述JSON的Java DTO：

立即学习“Java免费学习笔记（深入）”；

public class CustomerFeedDTO {    private ArrayList<?> topLevel;    private ArrayList<?> profile;    private ArrayList<?> phone;    private ArrayList<?> addresses;    private ArrayList<?> orders;    private ArrayList<?> customs;    // Getters and setters}

当尝试使用Gson.fromJson(reader, CustomerFeedDTO.class)进行反序列化时，便会抛出Expected BEGIN_ARRAY but was BEGIN_OBJECT at line 1 column 138 path $.profile异常。

原因分析：仔细比对JSON结构与CustomerFeedDTO会发现：

Gson在解析到"profile"字段时，发现JSON中是一个对象，但DTO中却定义为一个列表，因此抛出了类型不匹配的异常。

解决上述问题的关键在于确保Java DTO的字段类型与JSON数据的结构严格匹配。

根据上述原则，我们可以修正CustomerFeedDTO如下：

import java.util.ArrayList;import java.util.Map; // 需要导入Mappublic class CustomerFeedDTO {    // "Top-level" 在JSON中是对象，应映射为Map或自定义类    private Map<String, ?> topLevel;     // "profile" 在JSON中是对象，应映射为Map或自定义类    private Map<String, ?> profile;    // "phone" 在JSON中是对象，应映射为Map或自定义类    private Map<String, ?> phone;    // "addresses" 在JSON中是数组，映射为ArrayList是正确的    private ArrayList<?> addresses;    // "orders" 在JSON中是对象，应映射为Map或自定义类    private Map<String, ?> orders;    // "customs" 在JSON中是数组，映射为ArrayList是正确的    private ArrayList<?> customs;    // Getters and setters (省略，但实际开发中应包含)    public Map<String, ?> getTopLevel() { return topLevel; }    public void setTopLevel(Map<String, ?> topLevel) { this.topLevel = topLevel; }    public Map<String, ?> getProfile() { return profile; }    public void setProfile(Map<String, ?> profile) { this.profile = profile; }    public Map<String, ?> getPhone() { return phone; }    public void setPhone(Map<String, ?> phone) { this.phone = phone; }    public ArrayList<?> getAddresses() { return addresses; }    public void setAddresses(ArrayList<?> addresses) { this.addresses = addresses; }    public Map<String, ?> getOrders() { return orders; }    public void setOrders(Map<String, ?> orders) { this.orders = orders; }    public ArrayList<?> getCustoms() { return customs; }    public void setCustoms(ArrayList<?> customs) { this.customs = customs; }}

通过将topLevel, profile, phone, orders字段的类型从ArrayList<?>更改为Map<String, ?>，我们使得DTO的结构与JSON数据完全匹配，从而解决了JsonSyntaxException。

对用户最友好的AI写作工具

虽然使用Map<String, ?>可以解决类型匹配问题，但在实际项目中，为每个JSON对象创建具体的Java POJO类是更推荐的做法。这提供了更好的类型安全、代码可读性、IDE自动补全支持以及更强的可维护性。

例如，可以为Top-level、Profile、Phone、Order等创建独立的POJO类：

// TopLevel.javapublic class TopLevel {    private String customer_no;    private String created;    private String last_visited_day_time; // 对应JSON中的null    private String login; // 对应JSON中的email    // Getters and setters}// Profile.javapublic class Profile {    private String salutation;    private String title;    private String company;    private String job_title;    private String first_name;    private String last_name;    private String name_suffix;    private String gender;    private String birthday;    private String email;    private String next_birthday;    private String second_name;    // Getters and setters}// Phone.javapublic class Phone {    private String home_phone;    private String business_phone;    private String mobile_phone;    private String fax_number;    // Getters and setters}// Address.java (用于addresses数组中的元素)public class Address {    private String address_id;    private String title;    // ... 其他地址字段    private String contact_phone;    // Getters and setters}// OrdersContainer.java (因为orders内部有动态键名"0", "1"等，可以灵活处理)public class OrdersContainer {    private int placed_orders_count;    // 如果键名是数字，Gson默认会尝试映射到Map，或者可以自定义反序列化器    // 简便起见，这里仍使用Map，或者如果结构固定，可以定义OrderEntry类    private Map<String, OrderEntry> ordersMap; // 假设0, 1是订单ID    // Getters and setters    // 注意：Gson会尝试将"0"、"1"作为Map的键。    // 如果要更优雅地处理，可能需要自定义反序列化器，或者将这些订单视为List<OrderEntry>    // 但这需要JSON结构是 [{}, {}] 而不是 {"0":{}, "1":{}}    // 对于 {"0":{}, "1":{}} 这种结构，Map<String, OrderEntry> 是最直接的映射}// OrderEntry.javapublic class OrderEntry {    private String order_id;    private String order_date;    // Getters and setters}// 最终的 CustomerFeedDTO 结构将是：public class CustomerFeedDTO {    private TopLevel topLevel;    private Profile profile;    private Phone phone;    private List<Address> addresses; // 使用 List<Address> 更具体    private OrdersContainer orders; // 使用 OrdersContainer    private List<Object> customs; // 如果customs内部结构不确定，可以用List<Object>或List<Map<String, ?>>    // Getters and setters}

这种方法虽然需要定义更多的类，但提供了更清晰、更易于维护的代码结构。

有了正确的DTO模型，使用Gson读取JSON文件就变得非常简单和可靠。

import com.google.gson.Gson;import com.google.gson.JsonReader;import com.google.gson.JsonSyntaxException;import java.io.FileReader;import java.io.IOException;import java.util.ArrayList;import java.util.List;import java.util.Map;public class JsonFileReader {    // 假设这是您的修正后的 CustomerFeedDTO    // 这里使用Map作为内部对象的类型，以简化示例    public static class CustomerFeedDTO {        private Map<String, Object> topLevel; // 使用Object以处理不同类型的值        private Map<String, Object> profile;        private Map<String, Object> phone;        private List<Map<String, Object>> addresses; // 地址是对象数组        private Map<String, Object> orders;        private List<Object> customs;        // Getters and setters        public Map<String, Object> getTopLevel() { return topLevel; }        public void setTopLevel(Map<String, Object> topLevel) { this.topLevel = topLevel; }        public Map<String, Object> getProfile() { return profile; }        public void setProfile(Map<String, Object> profile) { this.profile = profile; }        public Map<String, Object> getPhone() { return phone; }        public void setPhone(Map<String, Object> phone) { this.phone = phone; }        public List<Map<String, Object>> getAddresses() { return addresses; }        public void setAddresses(List<Map<String, Object>> addresses) { this.addresses = addresses; }        public Map<String, Object> getOrders() { return orders; }        public void setOrders(Map<String, Object> orders) { this.orders = orders; }        public List<Object> getCustoms() { return customs; }        public void setCustoms(List<Object> customs) { this.customs = customs; }        @Override        public String toString() {            return "CustomerFeedDTO{" +                   "topLevel=" + topLevel +                   ", profile=" + profile +                   ", phone=" + phone +                   ", addresses=" + addresses +                   ", orders=" + orders +                   ", customs=" + customs +                   '}';        }    }    public static void main(String[] args) {        String filePath = "customer.json"; // 确保此文件存在且路径正确        Gson gson = new Gson();        CustomerFeedDTO customerFeedDTO = null;        try (JsonReader reader = new JsonReader(new FileReader(filePath))) {            customerFeedDTO = gson.fromJson(reader, CustomerFeedDTO.class);            System.out.println("成功读取并解析JSON文件！");            System.out.println("Customer Data: " + customerFeedDTO);            // 示例：访问解析后的数据            if (customerFeedDTO != null && customerFeedDTO.getProfile() != null) {                Map<String, Object> profile = customerFeedDTO.getProfile();                System.out.println("Customer First Name: " + profile.get("first_name"));            }        } catch (IOException e) {            System.err.println("文件读取错误或文件不存在: " + e.getMessage());            e.printStackTrace();        } catch (JsonSyntaxException e) {            System.err.println("JSON解析语法错误: " + e.getMessage());            e.printStackTrace();        } catch (Exception e) {            System.err.println("发生未知错误: " + e.getMessage());            e.printStackTrace();        }    }}

请确保将上述JSON数据保存为customer.json文件，并放置在Java程序能够访问的路径下。

原始问题标题提到了ndJSON文件。虽然我们分析的错误是针对单个JSON对象的结构映射，但ndJSON（Newline Delimited JSON）是一种特殊的文件格式，其中每行包含一个独立的JSON对象。如果您的文件确实是ndJSON格式，那么读取方式会有所不同。

例如，一个ndJSON文件可能看起来像这样：

{"id": 1, "name": "Alice"}{"id": 2, "name": "Bob"}{"id": 3, "name": "Charlie"}

处理ndJSON文件时，需要逐行读取文件，并对每一行进行独立的JSON解析。

import com.google.gson.Gson;import com.google.gson.JsonSyntaxException;import java.io.BufferedReader;import java.io.FileReader;import java.io.IOException;import java.util.ArrayList;import java.util.List;import java.util.Map;public class NdJsonFileReader {

以上就是Java中高效解析JSON/ndJSON文件：Gson与DTO模型匹配实践的详细内容，更多请关注乐哥常识网其它相关文章！