Java JacksonでJSONを変換するサンプル

JavaのJacksonでJSONを変換するサンプルです。

確認環境
・JDK 8
・Eclipse 4.8

目次

説明 Jacksonとは
  Jacksonの取得方法
サンプル JSONからJavaオブジェクトに変換
  JSON(配列)からJavaオブジェクトに変換
  JavaオブジェクトからJSONに変換

Jacksonとは

Jacksonとは、JSONを処理するライブラリです。
JSONからJavaオブジェクトまたはJavaオブジェクトからJSONに変換します。
ライセンスは、Apache License 2.0です。

以下は、Jackson Projectのリンクです。
https://github.com/FasterXML/jackson

Jacksonの取得方法

1.Mavenで取得する場合

pom.xmlの<dependencies>の間に以下のコードを追加します。

<!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-databind -->
&lt;dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
   <version>2.9.7</version>
</dependency>

Mavenで取得する手順は、以下を参照願います。
Eclipse Mavenでjarを取得(Java)

上記コードの追加で、jackson-databindの他にjackson-annotationsとjackson-coreも追加されます。

 

2.jarファイルで取得する場合

jarファイルもMavenRepositoryのサイトにあります。
https://mvnrepository.com/artifact/com.fasterxml.jackson.core

上記リンクから、「Jackson Databind」をクリックしVersionの「2.x.x」をクリックして、以下の図の「Files」の横にある「bundle」をクリックするとjarファイルがダウンロードされます。

jackson-databind-2.x.x.jarの他に
jackson-annotations-2.x.x.jarとjackson-core-2.x.x.jarもダウンロードします。

ダウンロード完了後、jarファイルをクラスパスに追加します。
Eclipse jarファイルをクラスパスに設定する方法

 

JSONからJavaオブジェクトに変換

JSONからJavaオブジェクトに変換するサンプルです。

1.JSONデータ

{
    "id": 1,
    "name": "taro",
    "sikaku": [
        "基本",
        "応用"
    ]
}

sikakuは、配列になっています。

2.JSONデータを受けるJavaのクラス (Syain.java)

package test1;
import java.util.List;
import com.fasterxml.jackson.annotation.JsonProperty;

class Syain {
	@JsonProperty("id")
	private int id;
	@JsonProperty("name") //@JsonPropertyはJSONのnameと紐付く
	private String test;
	@JsonProperty("sikaku")
	private List<String> sikaku;
	
	public int getId() {
		return id;
	}
	public String getN() {
		return test;
	}
	public List<String> getSikaku() {
		return sikaku;
	}
}

8行目の@JsonPropertyは、JSONのキーの「name」と紐付きます。
@JsonPropertyがない場合String testのtestは、JSONに名称がないので紐付けできずエラーになります。

3.JSONをJavaオブジェクトに変換するクラス (Test1.java)

package test1;
import java.io.IOException;
import com.fasterxml.jackson.core.JsonParseException;
import com.fasterxml.jackson.databind.JsonMappingException;
import com.fasterxml.jackson.databind.ObjectMapper;

public class Test1 {
	public static void main(String[] args) {
		// JSONのデータ
		String testJson1 =
		"{\"id\":1, \"name\":\"taro\",\"sikaku\":[\"基本\",\"応用\"]}";

		ObjectMapper mapper = new ObjectMapper();
		try {
			// JSONからJavaオブジェクトに変換
			Syain syain1 = mapper.readValue(testJson1, Syain.class);

			// Javaオブジェクトのデータの確認
			System.out.println(syain1.getId()); // 1
			System.out.println(syain1.getN()); // taro
			System.out.println(syain1.getSikaku()); // [基本, 応用]
		} catch (JsonParseException e) {
			e.printStackTrace();
		} catch (JsonMappingException e) {
			e.printStackTrace();
		} catch (IOException e) {
			e.printStackTrace();
		}
	}
}

11行目のJSONはリテラルなのでダブルコーテーションの前にエスケープシーケンスの\が入っています。
16行目は、JSONからJavaオブジェクトに変換しています。

 

JSON(配列)からJavaオブジェクトに変換

配列のJSONからJavaオブジェクトに変換するサンプルです。

1.配列のJSONデータ

配列のjsonデータです。最初と最後に[ ]があります。

[
   {
    "id": "1",
    "name": "suzuki",
    "sikaku": ["基本","応用"]
   },
   {
    "id": "2",
    "name": "tanaka",
    "sikaku": ["基本"]
   }
]

2.配列のJSONデータを受けるJavaのクラス (Syain.java)

配列のJSONデータを受けるJavaのクラスは、上記の「2.JSONデータを受けるJavaのクラス (Syain.java)」と同じです。

3.配列のJSONをJavaオブジェクトに変換するクラス (Test1.java)

package test1;
import java.io.IOException;
import com.fasterxml.jackson.core.JsonParseException;
import com.fasterxml.jackson.databind.JsonMappingException;
import com.fasterxml.jackson.databind.ObjectMapper;

public class Test1 {
	public static void main(String[] args) {
		// JSONのデータ
		String testJson1 =
	"[{\"id\": \"1\",\"name\":\"suzuki\",\"sikaku\":[\"基本\",\"応用\"]},"
	+ "{\"id\": \"2\",\"name\": \"tanaka\",\"sikaku\": [\"基本\"]}]";

		ObjectMapper mapper = new ObjectMapper();
		try {
			// JSONからJavaオブジェクトに変換
			Syain[] syain1 = mapper.readValue(testJson1, Syain[].class);

			// Javaオブジェクトのデータの確認
			for (Syain a : syain1) {
				System.out.println(a.getId());
				System.out.println(a.getN());
				System.out.println(a.getSikaku());
			}
		} catch (JsonParseException e) {
			e.printStackTrace();
		} catch (JsonMappingException e) {
			e.printStackTrace();
		} catch (IOException e) {
			e.printStackTrace();
		}
	}
}

11,12行目のJSONはリテラルなのでダブルコーテーションの前にエスケープシーケンスの\が入っています。
17行目は、JSONからJavaオブジェクトに変換しています。Syain[]と配列にしています。

 

JavaオブジェクトからJSONに変換

JavaオブジェクトからJSONに変換するサンプルです。

1.JSONデータを作るためのJavaのクラス (Syain.java)

JSONデータを作るためのJavaのクラスです。

package test1;
import java.util.List;
import com.fasterxml.jackson.annotation.JsonProperty;

class Syain {
	@JsonProperty("id")
	private int id;
	@JsonProperty("name")
	private String n;
	@JsonProperty("sikaku")
	private List<String> sikaku;

	public void setId(int id) {
		this.id = id;
	}
	public void setN(String n) {
		this.n = n;
	}
	public void setSikaku(List<String> sikaku) {
		this.sikaku = sikaku;
	}
}

値をセットするために@JsonProperty("値")の指定が必要です。
13行目以降は、値をセットするためのセッターです。

2.JavaオブジェクトからJSONに変換するクラス (Test1.java)

package test1;
import java.util.ArrayList;
import java.util.List;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;

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

	//Javaオブジェクトに値をセット
	Syain syain1 = new Syain();
	syain1.setId(1);
	syain1.setN("taro");
	List<String> sikaku = new ArrayList<>();
	sikaku.add("基本");
	sikaku.add("応用");
	syain1.setSikaku(sikaku);
	
	ObjectMapper mapper = new ObjectMapper();
	try {
		//JavaオブジェクトからJSONに変換
		String testJson1 = mapper.writeValueAsString(syain1);
		//JSONの確認
		System.out.println(testJson1); 
		//{"id":1,"name":"taro","sikaku":["基本","応用"]}
	} catch (JsonProcessingException e) {
		e.printStackTrace();
	}
	}
}

11~17行目は、Javaオブジェクトを生成し値をセットしています。
22行目は、JavaオブジェクトからJSONに変換しています。
24行目は、JSONのデータが生成されています。

関連の記事

JavaScript JSONをオブジェクトにする(parse)
JavaScript オブジェクトをJSONにする(stringify)

△上に戻る