Kể từ phiên bản Google Gson 1.6, hai lớp mới JsonReader và JsonWriter được giới thiệu và cung cấp các phương thức xử lý luồng (streaming) trên dữ liệu JSON.
Trong bài viết này, tôi sẽ hướng dẫn về việc sử dụng các Gson streaming API:
- JsonWriter : Luồng ghi sang chuỗi JSON.
- JsonReader : Luồng đọc từ chuỗi JSON.
Quá trình xử lý luồng Gson rất nhanh nhưng rất khó code vì bạn cần phải xử lý từng chi tiết của dữ liệu JSON đang xử lý.
Streaming API hữu ích chỉ trong một vài trường hợp:
- Khi không thể hoặc không mong muốn tải toàn bộ dữ liệu vào bộ nhớ. Điều này phù hợp nhất trên các nền tảng di động, nơi bộ nhớ còn hạn chế.
- Khi cần đọc hoặc ghi một tài liệu trước khi nó hoàn toàn có sẵn.
- Khi cần đọc hoặc ghi một lượng dữ liệu lớn.
Ghi chuỗi JSON sử dụng JsonWriter
Trong ví dụ này, tôi sẽ sử dụng JsonWriter để ghi dữ liệu JSON vào một file result.json. Về cơ bản trong cách tiếp cận này, bạn sẽ tự xây dựng cấu trúc chuỗi JSON từ đối tượng java.
- Sử dụng phương thức beginObject() và endObject() trong lớp JsonWriter để biểu diễn cho các phần tử kiểu object {}.
- Sử dụng phương thức beginArray() và endArray() trong lớp JsonWriter để biểu diễn cho các phần tử kiểu array [].
- Sử dụng phương thức name(key) và value(value) để gán các giá trị cho key và value của chuỗi json.
package com.gpcoder.gson;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import com.google.gson.stream.JsonWriter;
public class GsonStreamingWriterExample {
public static void main(String args[]) throws IOException {
OutputStream out = new FileOutputStream("data/result.json");
JsonWriter writer = new JsonWriter(new OutputStreamWriter(out, "UTF-8"));
writer.beginObject(); // {
writer.name("name").value("GP Coder"); // "name" : "gpcoder"
writer.name("website").value("https://gpcoder.com"); // "website" : "https://gpcoder.com"
writer.name("year").value(2017); // "year" : 2017
writer.name("posts"); // "colors" :
writer.beginArray(); // [
writer.value("Java Core"); // "Java Core"
writer.value("Design Pattern"); // "Design Pattern"
writer.value("Spring"); // "Spring"
writer.endArray(); // ]
writer.endObject(); // }
writer.close();
System.out.println("Done!");
}
}
Thực thi chương trình trên, một file result.json được tạo ra trong thư mục data với nội dung sau:
{
"name": "GP Coder",
"website": "https://gpcoder.com",
"year": 2017,
"posts": ["Java Core", "Design Pattern", "Spring"]
}
Đọc chuỗi JSON sử dụng JsonReader
Trong ví dụ bên dưới, tôi sử dụng JsonReader để phân tích cú pháp hoặc đọc tập tin trên.
Trong chế độ streaming, mọi dữ liệu JSON được xem như là một token độc lập. Khi bạn sử dụng JsonReader để xử lý nó, mỗi token sẽ được xử lý tuần tự. Ví dụ:
{
"website" : "https://gpcoder.com"
}
Token 1 = “{”
Token 2 = “website”
Token 3 = “https://gpcoder.com”
Token 4 = “}”
Trong lớp JsonReader, chúng ta sử dụng các phương thức:
- hasNext(): kiểm tra nếu có phần tử kế tiếp.
- nextName(): lấy tên của thuộc tính (key).
- nextString(), nextInt(), nextBoolean(), …: trả về giá trị chuỗi của token tiếp theo. Tùy thuộc vào kiểu dữ liệu, phương thức sẽ trả về giá trị tương ứng (value).
- beginObject(), endObject(): Lấy token kế tiếp từ luồng JSON và khẳng định rằng nó là sự khởi đầu của một đối tượng mới (json object []).
- beginArray(), endArray(): Lấy token kế tiếp từ luồng JSON và khẳng định rằng nó là sự khởi đầu của một mảng mới (json array []).
package com.gpcoder.gson;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import com.google.gson.stream.JsonReader;
public class GsonStreamingReaderExample {
public static void main(String[] args) throws IOException {
InputStream out = new FileInputStream("data/result.json");
JsonReader reader = new JsonReader(new InputStreamReader(out, "UTF-8"));
reader.beginObject();
while (reader.hasNext()) {
String name = reader.nextName();
if (name.equals("name")) {
System.out.println(reader.nextString());
} else if (name.equals("website")) {
System.out.println(reader.nextString());
} else if (name.equals("year")) {
System.out.println(reader.nextInt());
} else if (name.equals("posts")) {
// it's an array.
reader.beginArray();
while (reader.hasNext()) {
System.out.println(reader.nextString());
}
reader.endArray();
} else {// unexpected value, skip it or generate error
reader.skipValue();
}
}
reader.endObject();
reader.close();
}
}
Kết quả thực thi chương trình trên:
GP Coder https://gpcoder.com 2017 Java Core Design Pattern Spring
Tài liệu tham khảo: