Jackson 流式 API

17 Mar 2025 | 4 分钟阅读

Jackson 流式 API 是一种广泛使用的 API。它用于将 JSON 数据读取和写入为离散事件。该 API 提供了 JsonParser 和 JsonGenerator 类，用于同时读取和写入数据。流式 API 是读取和写入 JSON 数据的最强大、最快速且开销最低的方法。这种方法使用 token 的概念，并小心地处理 JSON 的每一条信息。

让我们看一些例子来了解如何使用流式 API 编写和读取 JSON。

使用 JsonGenerator 类创建 JSON

JsonGenerator 是用于写入 JSON 的最重要的类之一。它很容易在我们的代码中使用。为了使用 JsonGenerator 类，首先我们借助 JsonFactory.createJsonGenerator() 创建 JsonGenerator 类的实例。我们使用 JsonGenerator 类的 write() 方法写入 JSON 值。

使用 JsonGenerator 类的语法如下

JsonFactory factory = new JsonFactory();
JsonGenerator generator = factory.createGenerator(new File(
   "product.json"), JsonEncoding.UTF8);
jsonGenerator.writeStartObject();
jsonGenerator.writeStringField("proName", "MX Pro 20");

让我们创建一个程序来演示同样的事情。

StreamingAPIExample1.java

// import required classes and package if any
import java.io.File;
import java.io.IOException;
import java.util.Map;
import java.util.Scanner;
import com.fasterxml.jackson.core.JsonEncoding;
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.core.JsonParseException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.core.JsonFactory;
import com.fasterxml.jackson.databind.JsonMappingException;
// create class StreamingAPIExample1 to understand Streaming API
public class StreamingAPIExample1 {	
	// main() method start
	public static void main(String args[]){
		// use try-catch block 
		try {         		
			// create an instance of JsonFactory 
			JsonFactory jsonFactory = new JsonFactory();
			
			// create an instance of JsonGenerator by using the createGenerator() method of JsonFactory
			JsonGenerator jsonGenerator = jsonFactory.createGenerator(new File("C:\\Users\\rastogi ji\\Desktop\\product.json"), JsonEncoding.UTF8);
			// create an instance of Scanner class
			Scanner sc = new Scanner(System.in);
			// use writeStartObject()
			jsonGenerator.writeStartObject();
			// write name field to product.json file
			System.out.println("Enter Product Name:");
			String name = sc.nextLine();
			jsonGenerator.writeStringField("name", name); 
			// write price field to product.json file
			System.out.println("Enter Product Price:");
			String price = sc.nextLine();
			jsonGenerator.writeStringField("price", price);
			// write expire field to product.json
			System.out.println("Is product expire(Yes/No)?:");
			String expire = sc.nextLine();
			jsonGenerator.writeStringField("expire", expire);
			// "variation" : [X1, X2, X3]
			jsonGenerator.writeFieldName("variations"); 			
			// use writeStartArray() method to write values in an array
			jsonGenerator.writeStartArray(); 			
			System.out.println("Total number of variations:");
			int size = Integer.parseInt(sc.nextLine());			
			for(int i = 0; i < size; i++) {
				System.out.println("Enter "+(i+1)+" variation name:");
				jsonGenerator.writeString(sc.nextLine()); 
			}			
			// use writeEndArray() method to stop writing values in the array
			jsonGenerator.writeEndArray(); 
			// use writeStartObject()
			jsonGenerator.writeEndObject(); 			
			// close JsonGenerator using close() method
			jsonGenerator.close();        			
			// close Scanner class
			sc.close();		
			// create an instance of the ObjectMapper class
			ObjectMapper mapper = new ObjectMapper();
			@SuppressWarnings("unchecked")
			Map<String,Object> mapData = mapper.readValue(new File("C:\\Users\\rastogi ji\\Desktop\\product.json"), Map.class);
			System.out.println(mapData.get("name"));
			System.out.println(mapData.get("price"));
			System.out.println(mapData.get("expire"));
			System.out.println(mapData.get("variations"));
		} 
		catch (JsonParseException e) { 
			e.printStackTrace(); 
		} catch (JsonMappingException e) {
			e.printStackTrace(); 
		} catch (IOException e) { 
			e.printStackTrace(); 
		}
	}
}

输出

使用 JsonParser 类读取 JSON

JsonParser 是另一个用于读取 JSON 数据的最重要的类。它也很容易在我们的代码中使用。为了使用 JsonParser 类，首先我们借助 JsonFactory.createJsonParser() 创建 JsonParser 的实例。我们使用 nextToken() 方法将每个 JSON 字符串读取为一个 token。

使用 JsonParser 类的语法如下

JsonFactory factory = new JsonFactory();
JsonParser parser = factory.createJsonParser(new File("product.json"));
while (parser.nextToken() != JsonToken.END_OBJECT) {
   //getting current token
   String fieldname = parser.getCurrentName();
   if ("name".equals(fieldname)) {
      //switch to next token
      parser.nextToken();
      System.out.println(parser.getText());        	 
   }
}

让我们创建一个程序来演示同样的事情。

StreamingAPIExample2.java

//import required classes and package if any
import java.io.File;
import java.io.IOException;
import java.util.Scanner;
import com.fasterxml.jackson.core.JsonEncoding;
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.core.JsonParseException;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonToken;
import com.fasterxml.jackson.core.JsonFactory;
import com.fasterxml.jackson.databind.JsonMappingException;
//create class StreamingAPIExample2 to understand Streaming API
public class StreamingAPIExample2 {	
	// main() method start
	public static void main(String args[]){
		// use try-catch block 
		try {         
			
			// create an instance of JsonFactory 
			JsonFactory jsonFactory = new JsonFactory();
			// create an instance of JsonGenerator by using the createGenerator() method of JsonFactory
			JsonGenerator jsonGenerator = jsonFactory.createGenerator(new File("C:\\Users\\rastogi ji\\Desktop\\product.json"), JsonEncoding.UTF8);
			// create an instance of Scanner class
			Scanner sc = new Scanner(System.in);			
			// use writeStartObject()
			jsonGenerator.writeStartObject();
			// write name field to product.json file
			System.out.println("Enter Product Name:");
			String name = sc.nextLine();
			jsonGenerator.writeStringField("name", name); 

			// write price field to product.json file
			System.out.println("Enter Product Price:");
			String price = sc.nextLine();
			jsonGenerator.writeStringField("price", price);

			// write expire field to product.json
			System.out.println("Is product expire(Yes/No)?:");
			String expire = sc.nextLine();
			jsonGenerator.writeStringField("expire", expire);

			// "variation" : [X1, X2, X3]
			jsonGenerator.writeFieldName("variations"); 
			
			// use writeStartArray() method to write values in an array
			jsonGenerator.writeStartArray(); 
			
			System.out.println("Total number of variations:");
			int size = Integer.parseInt(sc.nextLine());
			
			for(int i = 0; i < size; i++) {
				System.out.println("Enter "+(i+1)+" variation name:");
				jsonGenerator.writeString(sc.nextLine()); 
			}
			
			// use writeEndArray() method to stop writing values in the array
			jsonGenerator.writeEndArray(); 
			// use writeStartObject()
			jsonGenerator.writeEndObject(); 
			// close JsonGenerator using close() method
			jsonGenerator.close();        			
			// close Scanner class
			sc.close();
			// create an instance of JsonParser by using createParser
			JsonParser parser = jsonFactory.createParser(new File("C:\\Users\\rastogi ji\\Desktop\\product.json"));
			
			// read each json string as a token
			while (parser.nextToken() != JsonToken.END_OBJECT) {
	            //getting current token
	            String fieldname = parser.getCurrentName();
	            if ("name".equals(fieldname)) {
	               //switch to next token
	               parser.nextToken();
	               System.out.println("Product Name: "+parser.getText());        	 
	            }
	            if("price".equals(fieldname)){
	               //switch to next token
	               parser.nextToken();
	               System.out.println("Price: "+parser.getText());        	 
	            }
	            if("expire".equals(fieldname)){
	               //switch to next token
	               parser.nextToken();
	               System.out.println("Is expire?: "+parser.getText());        	 
	            }
	            if("variations".equals(fieldname)){
	               //switch to next token "["
	               parser.nextToken();
	               // loop till token equal to "]"
	               while (parser.nextToken() != JsonToken.END_ARRAY) {
	                  System.out.println("Product Variations: "+parser.getText()); 
	               }
	            }
	         }
		} 
		catch (JsonParseException e) { 
			e.printStackTrace(); 
		} catch (JsonMappingException e) {
			e.printStackTrace(); 
		} catch (IOException e) { 
			e.printStackTrace(); 
		}
	}
}

输出

下一个主题Jackson 中的 JsonGenerator 类

Jackson 流式 API

使用 JsonGenerator 类创建 JSON

使用 JsonParser 类读取 JSON

联系信息

关注我们

教程

面试题

在线编译器

Python

Java

.Net Framework

AI, ML and Data Science

Cloud Technology

B.Tech and MCA

Web Technology

PHP

Software Testing

Technical Interview

Java Interview

Python

Web Interview

Database Interview

B.Tech / MCA

Important Interview

Software Testing Interview

Company Interviews

Online Compilers

Multiple Choice Questions

Jackson 教程

Jackson 注解

序列化/反序列化

高级编组

Jackson 流式 API

使用 JsonGenerator 类创建 JSON

使用 JsonParser 类读取 JSON

相关帖子

第一个应用

JsonParser 类

树模型

Jackson vs Gson

JsonGenerator 类

对象序列化

ObjectMapper 类

设置环境

Jackson

数据绑定

订阅 Tpoint Tech

联系信息

关注我们

教程

面试题

在线编译器