java - 在 java 中使用 gson 以 pretty-print 格式创建 json 文件 I/O？

Question

• 我已经知道 gson 的工作原理，也知道如何启用 pretty打印。
• 我想使用 gson 而不是 simplejson。
• 我遇到的问题是我无法创建包含 Employee 对象列表的文件。
• 我已经在 stackoverflow、mkyong、google 的 github 和许多其他站点中看到了所有其他 java 线程，但我仍然无法完成这个简单的事情。
• 我已经知道如何读取具有这种特定格式的文件，但我不会写它。
• 问题是我无法将所有这些东西组合在一个程序中。
• 启用 pretty-print 的 gson 中的对象列表必须有正确的缩进，每个对象必须用逗号分隔，并且这些对象必须包含在 [ ] .
• 用代码说明问题

:

public class Employee implements Serializable {

    private String lastName;
    private String address;
    private int id;
    private String name;

}

我想创建一个包含以下内容的 json 文件

 [
            {
                "id":1,
                "name": "John",
                "lastName": "Doe",
                "address": "NY City"
            },
            {
                "id":2,
                "name": "John",
                "lastName": "Doe",
                "address": "Canada"
            },
            {
                "id":3,
                "name": "John",
                "lastName": "Doe",
                "address": "Las Vegas"
            },
    ]

• 我设法创建并编写了一个 Person 对象的 json 文件(作为 gson json Person 对象)，并读取它，但同样只是作为 Person 对象，其中每一行都是一个独立的对象，而不是 List 或 Array 的一部分Person 对象，像这样

  {"id":1,"name": "John","last": "Doe","address": "NY City"}
  {"id":2,"name": "John","last": "Doe","address": "Canada"}
  {"id":3,"name": "John","last": "Doe","address": "Las Vegas"}
  

但这不是我希望我的最终程序做的。

• 我还能够使用以下信息和格式对文件进行硬编码并成功获取 Person 对象

 [
          {
              "id":1,
              "name": "John",
              "lastName": "Doe",
              "address": "NY City"
          },
          {
              "id":2,
              "name": "John",
              "lastName": "Doe",
              "address": "Canada"
          },
          {
              "id":3,
              "name": "John",
              "lastName": "Doe",
              "address": "Las Vegas"
          },
    ]

但我不知道如何用java程序创建和写入这个json文件 作为 Person 对象的数组，其中每个 Person 对象都是此对象的一部分 具有 pretty-print 格式的列表或数组，就像我硬编码的那样 我能够阅读。我怎样才能以优雅的方式做到这一点？

编辑---非常感谢@Shyam!

这是我的最终代码，希望它能帮助别人。

import java.io.BufferedReader;
import java.io.FileReader;
import java.io.FileWriter;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.reflect.TypeToken;

public class TestFileOfGsonWriter {

    Gson gson ;
    String filePath ;
    BufferedReader bufferToReader ;


    public TestFileOfGsonWriter()
    {
        this.filePath = 
                "C:\\FileOfGsonSingleListOfEmployees\\employees.json" ;
    }

    public List<Employee> createEmployees()
    {
        Employee arya = new Employee("Stark", "#81, 2nd main, Winterfell", 2, "Arya");
        Employee jon = new Employee("Snow", "#81, 2nd main, Winterfell", 1, "Jon");
        Employee sansa = new Employee("Stark", "#81, 2nd main, Winterfell", 3, "Sansa");

        List<Employee> employees = new ArrayList<>();
        employees.add(jon);
        employees.add(arya);
        employees.add(sansa);
        return employees ;
    }

    public void jsonWriter(List<Employee> employees, String filePath)
    {
        this.gson = new GsonBuilder().setPrettyPrinting().create();
        try(FileWriter writer = new FileWriter(filePath))
        {
            gson.toJson(employees,writer);
            writer.close();
        }
        catch(IOException e)
        {
            e.printStackTrace();
        }
    }

    public void showEmployeeObjects()
    {
        try {
            List<Employee> employees = this.getAllEmployees();
            employees.forEach(e -> Employee.showEmployeeDetails(e));
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    public ArrayList<Employee> getAllEmployees() throws IOException
    {
        FileReader reader = new FileReader(this.filePath);
        this.bufferToReader = new BufferedReader(reader) ;
        ArrayList <Employee> employees = this.gson.fromJson(getJson(), 
                new TypeToken<ArrayList<Employee>>(){}.getType());
        return employees ;
    }

    private String getJson() throws IOException
    {
        StringBuilder serializedEmployee = new StringBuilder();
        String line ;
        while ( (line = this.bufferToReader.readLine()) != null )
        {
            serializedEmployee.append(line);
        }
        this.bufferToReader.close();
        return serializedEmployee.toString();
    }

    public static void main(String[] args) {
        TestFileOfGsonWriter testWriting = new TestFileOfGsonWriter() ;
        List<Employee> employees = testWriting.createEmployees();
        testWriting.jsonWriter(employees, testWriting.filePath);
        testWriting.showEmployeeObjects();
    }
}

我修改了我的 Employee 类，以便它与我认为更好的他的虚拟对象相匹配，这就是它现在的样子。

import java.io.Serializable;

public class Employee implements Serializable {

    private static final long serialVersionUID = 1L;
    String name ;
    String address;
    String lastName ;
    int id ;

    public static void showEmployeeDetails(Employee e)
    {
        System.out.println();
        System.out.println("Employee's name: "+e.name);
        System.out.println("Employee's last name"+e.lastName);
        System.out.println("Employee's address: "+e.address);
        System.out.println("Employee's ID: "+e.id);
    }

    public Employee(String myName, String myAddress, int myId, String myLastName)
    {
        this.name = myName ;
        this.address = myAddress;
        this.lastName = myLastName;
        this.id = myId ;
    }
}

所以，程序创建的 json 文件看起来正是我想要的:

[
  {
    "name": "Snow",
    "address": "#81, 2nd main, Winterfell",
    "lastName": "Jon",
    "id": 1
  },
  {
    "name": "Stark",
    "address": "#81, 2nd main, Winterfell",
    "lastName": "Arya",
    "id": 2
  },
  {
    "name": "Stark",
    "address": "#81, 2nd main, Winterfell",
    "lastName": "Sansa",
    "id": 3
  }
]

最后，这是输出:

Employee's name: Snow
Employee's last nameJon
Employee's address: #81, 2nd main, Winterfell
Employee's ID: 1

Employee's name: Stark
Employee's last nameArya
Employee's address: #81, 2nd main, Winterfell
Employee's ID: 2

Employee's name: Stark
Employee's last nameSansa
Employee's address: #81, 2nd main, Winterfell
Employee's ID: 3

Answer 1

作为新手，我将快速引导您完成编写 List 的过程。的 Employee对象到具有 pretty-print 的 JSON 文件:

第 1 步:创建一个接受列表和 String filePath 的方法:

public void jsonWriter(List<Employee> employees, String filePath)

第 2 步:构建 Gson启用 pretty-print 的对象:

Gson gson = new GsonBuilder().setPrettyPrinting().create();

第 3 步:写下您的 List<Employee>到给定 filePath 中的 JSON 文件使用 FileWriter :

       try(FileWriter writer = new FileWriter(filePath)) {
            gson.toJson(employees, writer);
            writer.close();
        } catch (IOException e) {
            e.printStackTrace();
        }

最后整个方法看起来应该是这样的:

public void jsonWriter(List<Employee> employees, String filePath) {
        Gson gson = new GsonBuilder().setPrettyPrinting().create();
        try(FileWriter writer = new FileWriter(filePath)) {
            gson.toJson(employees, writer);
            writer.close();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

第 4 步:现在，构建您的 Employee对象，将它们添加到 List并使用适当的 filePath 调用此方法

        Employee arya = new Employee("Stark", "#81, 2nd main, Winterfell", 2, "Arya");
        Employee jon = new Employee("Snow", "#81, 2nd main, Winterfell", 1, "Jon");
        Employee sansa = new Employee("Stark", "#81, 2nd main, Winterfell", 3, "Sansa");

        List<Employee> employees = new ArrayList<>();
        employees.add(jon);
        employees.add(arya);
        employees.add(sansa);

        jsonWriter(employees, "C:/downloads/employees.json");

运行此代码后，JSON 文件的内容将如下所示:

[
  {
    "lastName": "Snow",
    "address": "#81, 2nd main, Winterfell",
    "id": 1,
    "name": "Jon"
  },
  {
    "lastName": "Stark",
    "address": "#81, 2nd main, Winterfell",
    "id": 2,
    "name": "Arya"
  },
  {
    "lastName": "Stark",
    "address": "#81, 2nd main, Winterfell",
    "id": 3,
    "name": "Sansa"
  }
]

希望这对您的学习过程有所帮助。

注意:我使用了一些随机的 Employee名称和详细信息。您可以将其替换为所需的详细信息。