Jackson-streaming-api

提供:Dev Guides
移動先:案内検索

ジャクソン-ストリーミングAPI

ストリーミングAPIは、JSONコンテンツを個別のイベントとして読み書きします。 JsonParserはデータを読み取りますが、JsonGeneratorはデータを書き込みます。 これは3つの中で最も強力なアプローチであり、読み取り/書き込み操作のオーバーヘッドが最も低く、高速です。 XMLのStaxパーサーに類似しています。

この記事では、JacksonストリーミングAPIを使用してJSONデータを読み書きする方法を紹介します。 ストリーミングAPIはトークンの概念で動作し、Jsonの詳細はすべて慎重に処理する必要があります。 以下は、例で使用する2つのクラスです。

  • link:/jackson/jackson_jsongenerator [JsonGenerator] -JSON文字列に書き込みます。
  • link:/jackson/jackson_jsonparser [JsonParser] -JSON文字列を解析します。

JsonGeneratorを使用してJSONを記述する

JsonGeneratorの使用は非常に簡単です。 最初に、JsonFactory.createJsonGenerator()メソッドを使用してJsonGeneratorを作成し、write *()メソッドを使用して各json値を書き込みます。

JsonFactory jsonFactory = new JsonFactory();
JsonGenerator jsonGenerator = jsonFactory.createGenerator(new File(
   "student.json"), JsonEncoding.UTF8);
//{
jsonGenerator.writeStartObject();
//"name" : "Mahesh Kumar"
jsonGenerator.writeStringField("name", "Mahesh Kumar");

JsonGeneratorの動作を見てみましょう。 C:\> Jackson_WORKSPACE にJacksonTesterという名前のJavaクラスファイルを作成します。

ファイル:JacksonTester.java

import java.io.File;
import java.io.IOException;
import java.util.Map;

import com.fasterxml.jackson.core.JsonEncoding;
import com.fasterxml.jackson.core.JsonFactory;
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.core.JsonParseException;
import com.fasterxml.jackson.databind.JsonMappingException;
import com.fasterxml.jackson.databind.ObjectMapper;

public class JacksonTester {
   public static void main(String args[]){

      try {
         JsonFactory jsonFactory = new JsonFactory();
         JsonGenerator jsonGenerator = jsonFactory.createGenerator(new File("student.json"), JsonEncoding.UTF8);

         jsonGenerator.writeStartObject();

        //"name" : "Mahesh Kumar"
         jsonGenerator.writeStringField("name", "Mahesh Kumar");

        //"age" : 21
         jsonGenerator.writeNumberField("age", 21);

        //"verified" : false
         jsonGenerator.writeBooleanField("verified", false);

        //"marks" : [100, 90, 85]
         jsonGenerator.writeFieldName("marks");

        //[
         jsonGenerator.writeStartArray();
        //100, 90, 85
         jsonGenerator.writeNumber(100);
         jsonGenerator.writeNumber(90);
         jsonGenerator.writeNumber(85);
        //]

         jsonGenerator.writeEndArray();

         jsonGenerator.writeEndObject();
         jsonGenerator.close();

        //result student.json
        //{
        //  "name":"Mahesh Kumar",
        //  "age":21,
        //  "verified":false,
        //  "marks":[100,90,85]
        //}

         ObjectMapper mapper = new ObjectMapper();
         Map<String,Object> dataMap = mapper.readValue(new File("student.json"), Map.class);

         System.out.println(dataMap.get("name"));
         System.out.println(dataMap.get("age"));
         System.out.println(dataMap.get("verified"));
         System.out.println(dataMap.get("marks"));
      }
      catch (JsonParseException e) { e.printStackTrace(); }
      catch (JsonMappingException e) { e.printStackTrace(); }
      catch (IOException e) { e.printStackTrace(); }
   }
}

結果を確認する

次のように javac コンパイラを使用してクラスをコンパイルします。

C:\Jackson_WORKSPACE>javac JacksonTester.java

次に、jacksonTesterを実行して結果を確認します。

C:\Jackson_WORKSPACE>java JacksonTester

出力を確認する

Mahesh Kumar
21
false
[100, 90, 85]

JsonParserを使用したJSONの読み取り

JsonParserの使用方法も簡単です。 最初にJsonFactory.createJsonParser()メソッドを使用してJsonParserを作成し、そのnextToken()メソッドを使用して各json文字列をトークンとして読み取ります。 各トークンを確認し、それに応じて処理します

JsonFactory jasonFactory = new JsonFactory();
JsonParser jsonParser = jasonFactory.createJsonParser(new File("student.json"));
while (jsonParser.nextToken() != JsonToken.END_OBJECT) {
  //get the current token
   String fieldname = jsonParser.getCurrentName();
   if ("name".equals(fieldname)) {
     //move to next token
      jsonParser.nextToken();
      System.out.println(jsonParser.getText());
   }
}

JsonParserの動作を見てみましょう。 C:\> Jackson_WORKSPACE にJacksonTesterという名前のJavaクラスファイルを作成します。

ファイル:JacksonTester.java

import java.io.File;
import java.io.IOException;
import java.util.Map;

import com.fasterxml.jackson.core.JsonEncoding;
import com.fasterxml.jackson.core.JsonFactory;
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.core.JsonParseException;
import com.fasterxml.jackson.databind.JsonMappingException;
import com.fasterxml.jackson.databind.ObjectMapper;

public class JacksonTester {
   public static void main(String args[]){
      JacksonTester tester = new JacksonTester();
      try {
         JsonFactory jsonFactory = new JsonFactory();

         JsonGenerator jsonGenerator = jsonFactory.createGenerator(new File(
            "student.json"), JsonEncoding.UTF8);
         jsonGenerator.writeStartObject();
         jsonGenerator.writeStringField("name", "Mahesh Kumar");
         jsonGenerator.writeNumberField("age", 21);
         jsonGenerator.writeBooleanField("verified", false);
         jsonGenerator.writeFieldName("marks");
         jsonGenerator.writeStartArray();//[
         jsonGenerator.writeNumber(100);
         jsonGenerator.writeNumber(90);
         jsonGenerator.writeNumber(85);
         jsonGenerator.writeEndArray();
         jsonGenerator.writeEndObject();
         jsonGenerator.close();

        //result student.json
        //{
        //  "name":"Mahesh Kumar",
        //  "age":21,
        //  "verified":false,
        //  "marks":[100,90,85]
        //}

         JsonParser jsonParser = jsonFactory.createParser(new File("student.json"));
         while (jsonParser.nextToken() != JsonToken.END_OBJECT) {
           //get the current token
            String fieldname = jsonParser.getCurrentName();
            if ("name".equals(fieldname)) {
              //move to next token
               jsonParser.nextToken();
               System.out.println(jsonParser.getText());
            }
            if("age".equals(fieldname)){
              //move to next token
               jsonParser.nextToken();
               System.out.println(jsonParser.getNumberValue());
            }
            if("verified".equals(fieldname)){
              //move to next token
               jsonParser.nextToken();
               System.out.println(jsonParser.getBooleanValue());
            }
            if("marks".equals(fieldname)){
              //move to [
               jsonParser.nextToken();
              //loop till token equal to "]"
               while (jsonParser.nextToken() != JsonToken.END_ARRAY) {
                  System.out.println(jsonParser.getNumberValue());
               }
            }
         }
      } catch (JsonParseException e) {
         e.printStackTrace();
      } catch (JsonMappingException e) {
         e.printStackTrace();
      } catch (IOException e) {
         e.printStackTrace();
      }
   }
}

結果を確認する

次のように javac コンパイラを使用してクラスをコンパイルします。

C:\Jackson_WORKSPACE>javac JacksonTester.java

次に、jacksonTesterを実行して結果を確認します。

C:\Jackson_WORKSPACE>java JacksonTester

出力を確認する

Mahesh Kumar
21
false
[100, 90, 85]