JSON.simple-クイックガイド

JSON.simpleJSON用のシンプルなJavaベースのツールキットです。JSON.simpleを使用して、JSONデータをエンコードまたはデコードできます。

特徴

• Specification Compliant − JSON.simpleは、JSON仕様に完全に準拠しています-RFC4627。

• Lightweight −クラスが非常に少なく、エンコード/デコードやjsonのエスケープなどの必要な機能を提供します。

• Reuses Collections −ほとんどの操作は、マップ/リストインターフェイスを使用して実行され、再利用性が向上します。

• Streaming supported −JSON出力テキストのストリーミングをサポートします。

• SAX like Content Handler −大量のJSONデータをストリーミングするためのSAXのようなインターフェースを提供します。

• High performance −ヒープベースのパーサーが使用され、高性能を提供します。

• No dependency−外部ライブラリへの依存はありません。個別に含めることができます。

• JDK1.2 compatible −ソースコードとバイナリはJDK1.2と互換性があります

ローカル環境のセットアップ

JSON.simpleはJavaのライブラリであるため、最初の要件はJDKをマシンにインストールすることです。

システム要件

JDK	記憶	ディスクスペース	オペレーティング・システム
1.5以上。	最小要件はありません。	最小要件はありません。	最小要件はありません。

ステップ1：マシンへのJavaのインストールを確認する

まず、コンソールを開き、作業しているオペレーティングシステムに基づいてJavaコマンドを実行します。

OS	仕事	コマンド
ウィンドウズ	コマンドコンソールを開く	c：\> java -version
Linux	コマンドターミナルを開く	$ java -version
マック	オープンターミナル	マシン：<joseph $ java -version

すべてのオペレーティングシステムの出力を確認しましょう-

OS	出力
ウィンドウズ	Javaバージョン「1.8.0_101」 Java（TM）SEランタイム環境（ビルド1.8.0_101）
Linux	Javaバージョン「1.8.0_101」 Java（TM）SEランタイム環境（ビルド1.8.0_101）
マック	Javaバージョン「1.8.0_101」 Java（TM）SEランタイム環境（ビルド1.8.0_101）

システムにJavaがインストールされていない場合は、次のリンクwww.oracle.comからJavaソフトウェア開発キット（SDK）をダウンロードしてください。このチュートリアルのインストールバージョンとして、Java1.8.0_101を想定しています。

ステップ2：JAVA環境を設定する

をセットする JAVA_HOMEJavaがマシンにインストールされているベースディレクトリの場所を指す環境変数。例えば。

OS	出力
ウィンドウズ	環境変数JAVA_HOMEをC：\ Program Files \ Java \ jdk1.8.0_101に設定します
Linux	export JAVA_HOME = / usr / local / java-current
マック	export JAVA_HOME = / Library / Java / Home

Javaコンパイラの場所をシステムパスに追加します。

OS	出力
ウィンドウズ	文字列を追加します C:\Program Files\Java\jdk1.8.0_101\bin システム変数の最後に、 Path。
Linux	export PATH = $ PATH：$ JAVA_HOME / bin /
マック	必要ありません

コマンドを使用してJavaのインストールを確認します java -version 上で説明したように。

ステップ3：JSON.simpleアーカイブをダウンロードする

最新バージョンのJSON.simplejarファイルをjson-simple @ MVNRepositoryからダウンロードします。このチュートリアルの執筆時点で、json-simple-1.1.1.jarをダウンロードし、C：\> JSONフォルダーにコピーしました。

OS	アーカイブ名
ウィンドウズ	json-simple-1.1.1.jar
Linux	json-simple-1.1.1.jar
マック	json-simple-1.1.1.jar

ステップ4：JSON_JAVA環境を設定する

をセットする JSON_JAVAJSON.simplejarがマシンに保存されているベースディレクトリの場所を指す環境変数。json-simple-1.1.1.jarをJSONフォルダーに保存したとしましょう。

シニア番号	OSと説明
1	Windows 環境変数JSON_JAVAをC：\ JSONに設定します
2	Linux JSON_JAVA = / usr / local / JSONをエクスポートします
3	Mac JSON_JAVA = / Library / JSONをエクスポートします

ステップ5：CLASSPATH変数を設定する

をセットする CLASSPATH JSON.simplejarの場所を指す環境変数。

シニア番号	OSと説明
1	Windows 環境変数CLASSPATHを％CLASSPATH％;％JSON_JAVA％\ json-simple-1.1.1.jar;。;に設定します。
2	Linux export CLASSPATH = $ CLASSPATH：$ JSON_JAVA /json-simple-1.1.1.jar:。
3	Mac export CLASSPATH = $ CLASSPATH：$ JSON_JAVA /json-simple-1.1.1.jar:。

JSON.simpleは、デコードまたは解析中にエンティティを左側から右側にマップし、エンコード中にエンティティを右側から左側にマップします。

JSON	Java
ストリング	java.lang.String
数	java.lang.Number
true | false	java.lang.Boolean
ヌル	ヌル
アレイ	java.util.List
オブジェクト	java.util.Map

デコードでは、デフォルトの具象クラスjava.util.Listにはありorg.json.simple.JSONArrayとのデフォルトの具象クラスjava.util.Mapであるorg.json.simple.JSONObject。

次の文字は予約文字であり、JSONで使用することはできません。文字列で使用するには、適切にエスケープする必要があります。

• Backspace \ bに置き換えられます

• Form feed \ fに置き換えられます

• Newline に置き換えられます\ n

• Carriage return \ rに置き換えられます

• Tab \ tに置き換えられます

• Double quote \ "に置き換えられます

• Backslash \\に置き換えられます

JSONObject.escape()メソッドを使用して、JSON文字列内のそのような予約済みキーワードをエスケープできます。以下は例です-

例

import org.json.simple.JSONObject;

public class JsonDemo {
   public static void main(String[] args) {
      JSONObject jsonObject = new JSONObject();
      String text = "Text with special character /\"\'\b\f\t\r\n.";
      System.out.println(text);
      System.out.println("After escaping.");
      text = jsonObject.escape(text);
      System.out.println(text);
   }
}

出力

Text with special character /"'
.
After escaping.
Text with special character \/\"'\b\f\t\r\n.

JSONValueは、指定されたjson文字列を解析してJSONObjectを返す静的メソッドparse（）を提供します。これを使用して、解析された値を取得できます。以下の例を参照してください。

例

import org.json.simple.JSONArray;
import org.json.simple.JSONObject;
import org.json.simple.JSONValue;

public class JsonDemo {
   public static void main(String[] args) {
      String s = "[0,{\"1\":{\"2\":{\"3\":{\"4\":[5,{\"6\":7}]}}}}]";
      Object obj = JSONValue.parse(s);
      JSONArray array = (JSONArray)obj;

      System.out.println("The 2nd element of array");
      System.out.println(array.get(1));
      System.out.println();

      JSONObject obj2 = (JSONObject)array.get(1);
      System.out.println("Field \"1\"");
      System.out.println(obj2.get("1"));    

      s = "{}";
      obj = JSONValue.parse(s);
      System.out.println(obj);

      s = "[5,]";
      obj = JSONValue.parse(s);
      System.out.println(obj);

      s = "[5,,2]";
      obj = JSONValue.parse(s);
      System.out.println(obj);
   }
}

出力

The 2nd element of array
{"1":{"2":{"3":{"4":[5,{"6":7}]}}}}

Field "1"
{"2":{"3":{"4":[5,{"6":7}]}}}
{}
[5]
[5,2]

JSONParser.parse（）は、無効なJSONの場合にParseExceptionをスローします。次の例は、ParseExceptionを処理する方法を示しています。

例

import org.json.simple.parser.JSONParser;
import org.json.simple.parser.ParseException;

class JsonDemo {
   public static void main(String[] args) {
      JSONParser parser = new JSONParser();
      String text = "[[null, 123.45, \"a\tb c\"]}, true";

      try{
         Object obj = parser.parse(text);         
         System.out.println(obj);
      }catch(ParseException pe) {
         System.out.println("position: " + pe.getPosition());
         System.out.println(pe);
      }
   }
}

出力

position: 24
Unexpected token RIGHT BRACE(}) at position 24.

ContainerFactoryを使用して、解析されたJSONオブジェクト/配列のカスタムコンテナーを作成できます。まず、ContainerFactoryオブジェクトを作成し、それをJSONParserの解析メソッドで使用して必要なオブジェクトを取得する必要があります。以下の例を参照してください-

例

import java.util.LinkedHashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;

import org.json.simple.parser.ContainerFactory;
import org.json.simple.parser.JSONParser;
import org.json.simple.parser.ParseException;

class JsonDemo {
   public static void main(String[] args) {
      JSONParser parser = new JSONParser();
      String text =  "{\"first\": 123, \"second\": [4, 5, 6], \"third\": 789}";
      ContainerFactory containerFactory = new ContainerFactory() {
         @Override
         public Map createObjectContainer() {
            return new LinkedHashMap<>();
         }
         @Override
         public List creatArrayContainer() {
            return new LinkedList<>();
         }
      };
      try {
         Map map = (Map)parser.parse(text, containerFactory);       
         map.forEach((k,v)->System.out.println("Key : " + k + " Value : " + v));
      } catch(ParseException pe) {
         System.out.println("position: " + pe.getPosition());
         System.out.println(pe);
      }
   }
}

出力

Key : first Value : 123
Key : second Value : [4, 5, 6]
Key : third Value : 789

ContentHandlerインターフェースは、大きなjsonをストリーミングするためのSAXのようなインターフェースを提供するために使用されます。停止可能な機能も提供します。次の例は、概念を示しています。

例

import java.io.IOException;
import java.util.List;
import java.util.Stack;

import org.json.simple.JSONArray;
import org.json.simple.JSONObject;
import org.json.simple.parser.ContentHandler;
import org.json.simple.parser.JSONParser;
import org.json.simple.parser.ParseException;

class JsonDemo {
   public static void main(String[] args) {
      JSONParser parser = new JSONParser();
      String text =  "{\"first\": 123, \"second\": [4, 5, 6], \"third\": 789}";
      try {
         CustomContentHandler handler = new CustomContentHandler();
         parser.parse(text, handler,true);       
      } catch(ParseException pe) {
      }
   }
}
class CustomContentHandler implements ContentHandler {
   @Override
   public boolean endArray() throws ParseException, IOException {     
      System.out.println("inside endArray");
      return true;
   }
   @Override
   public void endJSON() throws ParseException, IOException {
      System.out.println("inside endJSON");
   }
   @Override
   public boolean endObject() throws ParseException, IOException {       
      System.out.println("inside endObject");
      return true;
   }
   @Override
   public boolean endObjectEntry() throws ParseException, IOException {
      System.out.println("inside endObjectEntry");
      return true;
   }
   public boolean primitive(Object value) throws ParseException, IOException {
      System.out.println("inside primitive: " + value);
      return true;
   }
   @Override
   public boolean startArray() throws ParseException, IOException {
      System.out.println("inside startArray");
      return true;
   }
   @Override
   public void startJSON() throws ParseException, IOException {
      System.out.println("inside startJSON");
   }
   @Override
   public boolean startObject() throws ParseException, IOException {
      System.out.println("inside startObject");      
      return true;
   }
   @Override
   public boolean startObjectEntry(String key) throws ParseException, IOException {
      System.out.println("inside startObjectEntry: " + key); 
      return true;
   }    
}

出力

inside startJSON
inside startObject
inside startObjectEntry: first
inside primitive: 123
inside endObjectEntry
inside startObjectEntry: second
inside startArray
inside primitive: 4
inside primitive: 5
inside primitive: 6
inside endArray
inside endObjectEntry
inside startObjectEntry: third
inside primitive: 789
inside endObjectEntry
inside endObject
inside endJSON

JSON.simpleを使用すると、次の方法でJSONオブジェクトをエンコードできます-

• Encode a JSON Object - to String −単純なエンコーディング。

• Encode a JSON Object - Streaming −出力はストリーミングに使用できます。

• Encode a JSON Object - Using Map −順序を維持することによるエンコード。

• Encode a JSON Object - Using Map and Streaming −順序を維持してストリーミングすることによるエンコード。

次の例は、上記の概念を示しています。

例

import java.io.IOException;
import java.io.StringWriter;
import java.util.LinkedHashMap;
import java.util.Map;

import org.json.simple.JSONObject;
import org.json.simple.JSONValue;

class JsonDemo {
   public static void main(String[] args) throws IOException {
      JSONObject obj = new JSONObject();
      String jsonText;

      obj.put("name", "foo");
      obj.put("num", new Integer(100));
      obj.put("balance", new Double(1000.21));
      obj.put("is_vip", new Boolean(true));
      jsonText = obj.toString();

      System.out.println("Encode a JSON Object - to String");
      System.out.print(jsonText);

      StringWriter out = new StringWriter();
      obj.writeJSONString(out);       
      jsonText = out.toString();

      System.out.println("\nEncode a JSON Object - Streaming");       
      System.out.print(jsonText);

      Map obj1 = new LinkedHashMap();
      obj1.put("name", "foo");
      obj1.put("num", new Integer(100));
      obj1.put("balance", new Double(1000.21));
      obj1.put("is_vip", new Boolean(true));

      jsonText = JSONValue.toJSONString(obj1); 
      System.out.println("\nEncode a JSON Object - Preserving Order");
      System.out.print(jsonText);

      out = new StringWriter();
      JSONValue.writeJSONString(obj1, out); 
      jsonText = out.toString();
      System.out.println("\nEncode a JSON Object - Preserving Order and Stream");
      System.out.print(jsonText);
   }
}

出力

Encode a JSON Object - to String
{"balance":1000.21,"is_vip":true,"num":100,"name":"foo"}
Encode a JSON Object - Streaming
{"balance":1000.21,"is_vip":true,"num":100,"name":"foo"}
Encode a JSON Object - Preserving Order
{"name":"foo","num":100,"balance":1000.21,"is_vip":true}
Encode a JSON Object - Preserving Order and Stream
{"name":"foo","num":100,"balance":1000.21,"is_vip":true}

JSON.simpleを使用すると、次の方法でJSON配列をエンコードできます-

• Encode a JSON Array - to String −単純なエンコーディング。

• Encode a JSON Array - Streaming −出力はストリーミングに使用できます。

• Encode a JSON Array - Using List −リストを使用したエンコード。

• Encode a JSON Array - Using List and Streaming −リストとストリーミングを使用したエンコード。

次の例は、上記の概念を示しています。

例

import java.io.IOException;
import java.io.StringWriter;
import java.util.LinkedList;
import java.util.List;

import org.json.simple.JSONArray;
import org.json.simple.JSONValue;

class JsonDemo {
   public static void main(String[] args) throws IOException {
      JSONArray list = new JSONArray();
      String jsonText;

      list.add("foo");
      list.add(new Integer(100));
      list.add(new Double(1000.21));
      list.add(new Boolean(true));
      list.add(null);
      jsonText = list.toString();

      System.out.println("Encode a JSON Array - to String");
      System.out.print(jsonText);

      StringWriter out = new StringWriter();
      list.writeJSONString(out);       
      jsonText = out.toString();

      System.out.println("\nEncode a JSON Array - Streaming");       
      System.out.print(jsonText);

      List list1 = new LinkedList();
      list1.add("foo");
      list1.add(new Integer(100));
      list1.add(new Double(1000.21));
      list1.add(new Boolean(true));
      list1.add(null);

      jsonText = JSONValue.toJSONString(list1); 
      System.out.println("\nEncode a JSON Array - Using List");
      System.out.print(jsonText);

      out = new StringWriter();
      JSONValue.writeJSONString(list1, out); 
      jsonText = out.toString();
      System.out.println("\nEncode a JSON Array - Using List and Stream");
      System.out.print(jsonText);
   }
}

出力

Encode a JSON Array - to String
["foo",100,1000.21,true,null]
Encode a JSON Array - Streaming
["foo",100,1000.21,true,null]
Encode a JSON Array - Using List
["foo",100,1000.21,true,null]
Encode a JSON Array - Using List and Stream
["foo",100,1000.21,true,null]

JSON.simpleでは、JSONObject.putAll（）メソッドを使用して2つのJSONオブジェクトを簡単にマージできます。

次の例は、上記の概念を示しています。

例

import java.io.IOException;
import org.json.simple.JSONObject;

class JsonDemo {
   public static void main(String[] args) throws IOException {
      JSONObject obj1 = new JSONObject();       
      obj1.put("name", "foo");
      obj1.put("num", new Integer(100)); 

      JSONObject obj2 = new JSONObject();       
      obj2.put("balance", new Double(1000.21));
      obj2.put("is_vip", new Boolean(true));       
      obj1.putAll(obj2);       
      System.out.println(obj1);
   }
}

出力

{"balance":1000.21,"is_vip":true,"num":100,"name":"foo"}

JSON.simpleでは、JSONArray.addAll（）メソッドを使用して2つのJSON配列を簡単にマージできます。

次の例は、上記の概念を示しています。

例

import java.io.IOException;
import org.json.simple.JSONArray;

class JsonDemo {
   public static void main(String[] args) throws IOException {
      JSONArray list1 = new JSONArray();
      list1.add("foo");
      list1.add(new Integer(100));

      JSONArray list2 = new JSONArray();       
      list2.add(new Double(1000.21));
      list2.add(new Boolean(true));
      list2.add(null);

      list1.addAll(list2);       
      System.out.println(list1);       
   }
}

出力

["foo",100,1000.21,true,null]

JSONArrayオブジェクトを使用して、プリミティブ、オブジェクト、および配列で構成されるJSONを作成できます。

次の例は、上記の概念を示しています。

例

import java.io.IOException;
import org.json.simple.JSONArray;
import org.json.simple.JSONObject;

class JsonDemo {
   public static void main(String[] args) throws IOException {
      JSONArray list1 = new JSONArray();
      list1.add("foo");
      list1.add(new Integer(100));

      JSONArray list2 = new JSONArray();       
      list2.add(new Double(1000.21));
      list2.add(new Boolean(true));
      list2.add(null);

      JSONObject obj = new JSONObject();

      obj.put("name", "foo");
      obj.put("num", new Integer(100));
      obj.put("balance", new Double(1000.21));
      obj.put("is_vip", new Boolean(true));
     
      obj.put("list1", list1); 
      obj.put("list2", list2);
      System.out.println(obj);       
   }
}

出力

{"list1":["foo",100],"balance":1000.21,"is_vip":true,"num":100,"list2":[1000.21,true,null],"name":"foo"}

JSONValueオブジェクトを使用して、プリミティブ、マップ、およびリストで構成されるJSONを作成できます。

次の例は、上記の概念を示しています。

例

import java.io.IOException;
import java.util.LinkedHashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;

import org.json.simple.JSONValue;

class JsonDemo {
   public static void main(String[] args) throws IOException {
      Map m1 = new LinkedHashMap(); 
      m1.put("k11","v11"); 
      m1.put("k12","v12"); 
      m1.put("k13", "v13");

      List l1 = new LinkedList();
      l1.add(m1);
      l1.add(new Integer(100));

      String jsonString = JSONValue.toJSONString(l1);
      System.out.println(jsonString);
   }
}

出力

[{"k11":"v11","k12":"v12","k13":"v13"},100]

JSONValueオブジェクトを使用して、プリミティブ、オブジェクト、マップ、およびリストで構成されるJSONを作成できます。

次の例は、上記の概念を示しています。

例

import java.io.IOException;
import java.util.LinkedHashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;

import org.json.simple.JSONObject;
import org.json.simple.JSONValue;

class JsonDemo {
   public static void main(String[] args) throws IOException {
      JSONObject obj = new JSONObject();

      Map m1 = new LinkedHashMap(); 
      m1.put("k11","v11");
      m1.put("k12","v12");
      m1.put("k13", "v13");

      List l1 = new LinkedList();      
      l1.add(new Integer(100));

      obj.put("m1", m1);
      obj.put("l1", l1);
      String jsonString = JSONValue.toJSONString(obj);
      System.out.println(jsonString);
   }
}

出力

{"m1":{"k11":"v11","k12":"v12","k13":"v13"},"l1":[100]}

カスタムクラスに基づいてJSON出力をカスタマイズできます。唯一の要件は、JSONAwareインターフェースを実装することです。

次の例は、上記の概念を示しています。

例

import java.io.IOException;

import org.json.simple.JSONArray;
import org.json.simple.JSONAware;
import org.json.simple.JSONObject;

class JsonDemo {
   public static void main(String[] args) throws IOException {
      JSONArray students = new JSONArray(); 
      students.add(new Student(1,"Robert")); 
      students.add(new Student(2,"Julia")); 

      System.out.println(students);     
   }
}
class Student implements JSONAware {
   int rollNo;
   String name;
   Student(int rollNo, String name){
      this.rollNo = rollNo;
      this.name = name;
   }
   @Override
   public String toJSONString() {
      StringBuilder sb = new StringBuilder();
      sb.append("{");
      sb.append("name");
      sb.append(":");
      sb.append("\"" + JSONObject.escape(name) + "\"");
      sb.append(",");
      sb.append("rollNo");
      sb.append(":");
      sb.append(rollNo);
      sb.append("}");
      return sb.toString();
   }    
}

出力

[{name:"Robert",rollNo:1},{name:"Julia",rollNo:2}]

カスタムクラスに基づいてJSONストリーミング出力をカスタマイズできます。唯一の要件は、JSONStreamAwareインターフェースを実装することです。

次の例は、上記の概念を示しています。

例

import java.io.IOException;
import java.io.StringWriter;
import java.io.Writer;
import java.util.LinkedHashMap;
import java.util.Map;

import org.json.simple.JSONArray;
import org.json.simple.JSONStreamAware;
import org.json.simple.JSONValue;

class JsonDemo {
   public static void main(String[] args) throws IOException {
      JSONArray students = new JSONArray(); 
      students.add(new Student(1,"Robert")); 
      students.add(new Student(2,"Julia")); 
      StringWriter out = new StringWriter();
      students.writeJSONString(out); 
      System.out.println(out.toString());     
   }
}
class Student implements JSONStreamAware {
   int rollNo;
   String name;

   Student(int rollNo, String name){
      this.rollNo = rollNo;
      this.name = name;
   }
   @Override
   public void writeJSONString(Writer out) throws IOException {
      Map obj = new LinkedHashMap();
      obj.put("name", name);
      obj.put("rollNo", new Integer(rollNo));
      JSONValue.writeJSONString(obj, out);        
   }    
}

出力

[{name:"Robert",rollNo:1},{name:"Julia",rollNo:2}]