Spring postForEntityでJSONを取得する(POST)

nas2021/12/26

Spring5のRestTemplateのpostForEntityでJSONを取得するサンプルです。
(確認環境:Spring 5.3.7、JDK 11、STS 4)

目次

サンプル postForEntityでJSONを取得するサンプル
  pom.xml
  １．起動するクラス(MainController.java)
  ２．設定ファイル(applicationContext.xml)
  ３．postForEntityでJSONを取得するクラス(CommService.java)
  ４．受信した値を格納するクラス(RestDto.java)

postForEntityでJSONを取得する

無料Webサービスのhttpbinに対してCommService.javaのRestTemplateを使用してpostForEntityでJSONデータを取得します。

また取得した一部の値をRestDtoクラスにセットします。

githubにコードがあります。
https://github.com/ut23405/spring5/tree/master/spring-postForEntity

pom.xml

以下のコードをpom.xmlの<project>の<dependencies>タグ内に貼り付けます。

		<!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-databind -->
		<dependency>
			<groupId>com.fasterxml.jackson.core</groupId>
			<artifactId>jackson-databind</artifactId>
			<version>2.12.4</version>
		</dependency>
		<!-- https://mvnrepository.com/artifact/org.springframework/spring-web -->
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-web</artifactId>
			<version>5.3.8</version>
		</dependency>
		<!-- https://mvnrepository.com/artifact/org.springframework/spring-context -->
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-context</artifactId>
			<version>5.3.7</version>
		</dependency>

4行目のjackson-databindは、JSONとJavaオブジェクトの変換をします。
10行目のspring-webは、RestTemplateで使用します。
16行目のspring-contextは、@ComponentScanや@Componentで使用します。

１．起動するクラス(MainController.java)

package com.example.test1;

import org.springframework.context.support.ClassPathXmlApplicationContext;

public class MainController {
	public static void main(String[] args) {
		ClassPathXmlApplicationContext context = 
				new ClassPathXmlApplicationContext("applicationContext.xml");
		CommService cs = context.getBean(CommService.class);
		cs.getData();
		context.close();
	}
}

CommServiceクラスのメソッドを使用して通信を行いJSONを取得します。

２．設定ファイル(applicationContext.xml)

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:context="http://www.springframework.org/schema/context"
	xsi:schemaLocation="http://www.springframework.org/schema/beans
    http://www.springframework.org/schema/beans/spring-beans.xsd
    http://www.springframework.org/schema/context
    http://www.springframework.org/schema/context/spring-context.xsd">

	<bean id="restTemplate" class="org.springframework.web.client.RestTemplate"></bean>
	<context:component-scan base-package="com.example.test1" />
	
	<bean id="clientHttpRequestFactory"
		class="org.springframework.http.client.SimpleClientHttpRequestFactory">
		<property name="connectTimeout" value="3000" />
		<property name="readTimeout" value="3000" />
	</bean>
</beans>

10行目は、RestTemplateをDIコンテナに登録しています。このサンプルではidの値は使用していません。
11行目のcomponentScanは、対象のパッケージ配下にある@Componentが付与されたクラスを探してBeanとしてDIコンテナに登録します。CommServiceで使用します。
15行目は、サーバとの接続タイムアウトの設定時間です。単位はミリ秒。
16行目は、レスポンスデータの読み込みタイムアウト時間です。単位はミリ秒。

３．postForEntityでJSONを取得するクラス(CommService.java)

public <T> ResponseEntity<T> postForEntity(String url, @Nullable Object request,
Class<T> responseType, Object... uriVariables) throws RestClientException		 
package com.example.test1;

import java.util.HashMap;
import java.util.Map;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Component;
import org.springframework.web.client.RestTemplate;

@Component
public class CommService {
	@Autowired
	RestTemplate restTemplate;

	private static final String URL2 = "http://httpbin.org/post";

	public void getData() {
		Map<String, String> color = new HashMap<>();
		color.put("a", "red");
		color.put("b", "blue");

		ResponseEntity<RestDto> r2
				= restTemplate.postForEntity(URL2, color, RestDto.class);
		System.out.println("Code=" + r2.getStatusCode()); //200 OK
		System.out.println("ContentType=" + r2.getHeaders().getContentType()); //application/json
		
		System.out.println(r2.getBody().getUrl()); //http://httpbin.org/post
		System.out.println(r2.getBody().getHeaders().getAccept());// application/json, application/*+json
		System.out.println(r2.getBody().getHeaders().getUserAgent());// Java/11.0.11
		System.out.println(r2.getBody().getHeaders().getHost());// httpbin.org
	}
}

16行目のURLはhttpbinのURLを指しています。
23,24行目は、2つめの引数は送信するクラスで自作した19行目のmapです。
3つめの引数は受信するクラスです。RestDtoクラスに受信した値がセットされます。
25行目は、HTTPステータスコードで200は成功です。
26行目のContent-Typeは出力するMIMEタイプでJSONです。
22行目以降は、RestDtoの変数に格納された値を確認しています。
28～31行目の値は、自作したクラスRestDtoの値を取り出しています。getBody()から始めます。

 

４．受信した値を格納するクラス(RestDto.java)

package com.example.test1;

public class RestDto {
	private Headers headers;
	private String url;
	
	public Headers getHeaders() {
		return headers;
	}
	public String getUrl() {
		return url;
	}
}

4行目は、JSONのオブジェクトに対する項目でクラスです。

Headers.java

上記4行目のクラスです。

package com.example.test1;

import com.fasterxml.jackson.annotation.JsonProperty;

public class Headers {
	@JsonProperty("Accept")
	private String Accept;
	@JsonProperty("Host")
	private String Host;
	@JsonProperty("User-Agent")
	private String UserAgent;
	
	public String getAccept() {
		return Accept;
	}
	public String getHost() {
		return Host;
	}
	public String getUserAgent() {
		return UserAgent;
	}
}

10行目は、JSONにハイフンがありますがJavaではエラーになるので@JsonPropertyではハイフンあり、Javaの項目ではハイフン無しにしています。

関連の記事

Spring5 MyBatisでselectするサンプル(XML)

△上に戻る