【Spring MVC】RestTemplateを使ったAPIアクセス（putの使い方）

概要

RestTemplate#putメソッドの基本的な使用方法についてまとめた。
動作確認を行うための事前準備については、以下に記載している。

あわせて読みたい

【Spring MVC】RestTemplateの導入

概要 RESTfulなAPIを呼ぶクライアントライブラリである、RestTemplateの概要についてまとめた。 RestTemplateを使用するための準備と、どんなメソッドがあるのかを紹介している。   前提 今[…]

基本的な使い方

RestTemplate#putメソッドは、指定したURIにPUT通信を行ってリクエストボディを送信する。
レスポンスは一律voidとなるため、更新可否については例外発生有無などによって判断する。

実装方法

RestTemplate#putメソッドは、基本的に以下のように実装する。

使用例

APIアクセスクラスにputメソッドを追加し、動作確認を行う。

APIアクセスクラス

putを使用したメソッドを追加する。

RestClient.java

package com.example.client_prototype.biz;

import java.net.URI;

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

@Component
public class RestClient {

	@Autowired
	private RestTemplate restTemplate;
	
	/**
	 * PUTの利用
	 * @param uri
	 * @param requestBody
	 */
	public void put(URI uri, Object requestBody) {
		restTemplate.put(uri, requestBody);
	}

	/**
	 * 動作確認用
	 * @param <T>
	 * @param uri
	 * @param responseType
	 * @return
	 */
	public <T> T getForObject(URI uri, Class<T> responseType) {
		return restTemplate.getForObject(uri, responseType);
	}
}

引数にURI、リクエストボディを指定している。
戻り値はvoidとなる。

動作確認

動作確認を行う。

動作確認用クラス

package com.example.client_prototype.executor;

import java.net.URI;
import java.time.LocalDate;
import java.util.Arrays;

import org.springframework.context.support.ClassPathXmlApplicationContext;
import org.springframework.web.util.UriComponentsBuilder;

import com.example.client_prototype.biz.RestClient;
import com.example.rest_client_prototype.resources.Resource;

public class Main {

	public static void main(String[] args) {
		try (var context = new ClassPathXmlApplicationContext("/META-INF/spring/applicationContext.xml")) {
			// DIコンテナから取得
			var restClient = context.getBean(RestClient.class);
			
			// URI定義
			URI uri = UriComponentsBuilder
					.fromUriString("http://localhost:8080/rest_prototype/rest03/{id}")
					.buildAndExpand(1)
					.toUri();
			
			// リソースの更新
			var req = new Resource("1", "パスタ", LocalDate.of(2022, 5, 1));
			restClient.put(uri, req);
			
			// 更新結果確認
			uri = UriComponentsBuilder
					.fromUriString("http://localhost:8080/rest_prototype/rest05/")
					.build()
					.toUri();
			var resArr = restClient.getForObject(uri, Resource[].class);
			Arrays.stream(resArr).forEach(r -> System.out.println(r));
		}
	}
}

戻り値はないため、上記のように呼び出して終わりとなる。
try-catchで例外ハンドリングを行う等により、更新可否を判断できる。

コンソール

Resource(id=1, name=パスタ, hogeDate=2022-05-01)
Resource(id=2, name=ごりら, hogeDate=2024-06-05)
Resource(id=3, name=らっぱ, hogeDate=2023-05-10)

まとめ