Spring5 REST APIにアクセスする(RestTemplate)

Spring5でREST APIにアクセスするサンプルです。RestTemplateを使用します。

確認環境
・Spring 5.3.7
・JDK 11
・STS 4

目次

サンプル Spring5でREST APIにアクセスする概要
  pom.xml
  1.起動するクラス(MainController.java)
  2.設定するクラス(TestConfig.java)
  3.受信した値を格納するクラス(RestDto.java)
  4.getとpostを実行するクラス(CommService.java)
  実行結果

Spring5でREST APIにアクセスする概要

今回作成したファイルです。

CommService.javaでRestTemplateを使用してGETとPOSTを行います。
GETで取得した一部の値は、RestDtoクラスに自動でセットされます。

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

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>

 

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

package com.example.test1;

import org.springframework.context.annotation.AnnotationConfigApplicationContext;

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

		AnnotationConfigApplicationContext context = 
				new AnnotationConfigApplicationContext(TestConfig.class);

		CommService cs = context.getBean(CommService.class);

		cs.getData();
		context.close();
	}
}

 

2.設定するクラス(TestConfig.java)

package com.example.test1;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;

@Configuration
@ComponentScan("com.example.test1")
public class TestConfig {
}

@Configurationは、設定クラスであることを示しています。
@ComponentScanは、対象のパッケージ配下にある@Componentが付与されたクラスを探してBeanとしてDIコンテナに登録します。

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

package com.example.test1;

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

GETで取得した一部の値であるjsonのurlの値は、4行目の変数に格納されます。
6行目のメソッドは、格納された値を確認するために使用します。

4.getとpostを実行するクラス(CommService.java)

Getを2回、Postを1回行います。

package com.example.test1;

import java.util.HashMap;
import java.util.Map;
import org.springframework.stereotype.Component;
import org.springframework.web.client.RestTemplate;

@Component
public class CommService {
	RestTemplate rest = new RestTemplate();
	public static final String URL1 
		= "http://httpbin.org/get";
	public static final String URL2 
		= "http://httpbin.org/post";

	public void getData() {
		String r1 = rest.getForObject(URL1, String.class);
		System.out.println(r1); //①文字列が出力される
		
		RestDto r2 = rest.getForObject(URL1, RestDto.class);
		System.out.println("2回目=" + r2.getUrl()); //②http://httpbin.org/get
		
		Map<String,String> color = new HashMap<>();
		color.put("a", "red");
		color.put("b", "blue");
		String r3 = rest.postForObject(URL2, color,String.class);
		System.out.println(r3); //③文字列が出力される
	}
}

12,14行目のURLはhttpbinのURLを指しています。httpbinはリクエストに対するレスポンスを返してくれる無料のサービスです。
17行目は、1回目のgetの送受信です。
結果は、Stringになります。出力される①文字列は以下を参照願います。
20行目は、2回目のgetの送受信です。
21行目は、RestDtoの変数に格納された値を確認しています。Jsonのurlの値が出力されます。
26行目は、postでの送受信です。
Mapの値はJsonとして送信されます。出力される③文字列は以下を参照願います。

実行結果

①の文字列

{
  "args": {}, 
  "headers": {
    "Accept": "text/plain, application/json, application/*+json, */*", 
    "Host": "httpbin.org", 
    "User-Agent": "Java/11.0.11", 
    "X-Amzn-Trace-Id": "Root=xxx"
  }, 
  "origin": "xxx.xxx.xxx.xxx", 
  "url": "http://httpbin.org/get"
}

getで送信してhttpbinから返信されたjsonです。
2回目のget送受信後に表示する文字列は、10行目の値が表示されます。

③の文字列

{
  "args": {}, 
  "data": "{\"a\":\"red\",\"b\":\"blue\"}", 
  "files": {}, 
  "form": {}, 
  "headers": {
    "Accept": "text/plain, application/json, application/*+json, */*", 
    "Content-Length": "22", 
    "Content-Type": "application/json", 
    "Host": "httpbin.org", 
    "User-Agent": "Java/11.0.11", 
    "X-Amzn-Trace-Id": "Root=xxx"
  }, 
  "json": {
    "a": "red", 
    "b": "blue"
  }, 
  "origin": "xxx.xxx.xxx.xxx", 
  "url": "http://httpbin.org/post"
}

postで送信してhttpbinから返信されたjsonです。

関連の記事

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

△上に戻る