【Sprint Boot2】POSTリクエストでクライアント側からサーバサイドへデータ送信

Sprint Boot2.3の入門ページです。HTTPのPOSTリクエスト時に、クライアント側からサーバサイドへデータの受け渡しする簡単なウェブアプリをSpring Bootで作っています。Spring Bootの初心者・入門者の方は、参考にしてください。

環境と今回の目的

最終更新日:2021/4/20

以前にHTTPのGETリクエストのクエリストリングを使って、クライアント側からサーバサイドへのデータの受け渡しをやりました。
【Sprint Boot2入門】GETリクエストでクライアントからサーバサイドへデータ送信【クエリストリング】

今回は、HTTPのPOSTリクエストで、クライアント側からサーバサイドへのデータの受け渡しをやってみます。

・開発環境やバージョンは以下の通りです。
OS:macOS Catalina(バージョン10.15.5)
開発環境:Eclipse(Pleiades All in One、4.16(2020-06)、Java Full Edition版)、(*2020/8/28時点の最新安定版です)
Spring Boot:バージョン2.3.3
Java:11

◾️Eclipse(Pleiades All in One、Java Full Edition版)
Eclipse(Pleiades All in One、Java Full Edition版)は、最初からEclipseの日本語化がされていますし、STS(Spring Tool Suite)やLombokなどの複数の有用なプラグインも入っていて設定済みなので、開発環境構築の手間が省けます。
Eclipseの導入については別ページに書いていますので、参考にしてください。

【Java初心者】Eclipse(Pleiades All in One)をインスールしてJava開発ができるようにする【macOS版】

フロントエンド(HTML)の作成

EclipseでのSpring Bootプロジェクトのひな形の作成や新規Javaクラスやhtmlファイルの作成については別ページで書いていますので、そちらを参考にしてください。
Sprint Boot2.3で初めてのJavaのウェブアプリ開発【Eclipse(Pleiades)、macOS版】

まずはフロントエンドのHTMLファイルから作成します。POSTリクエストするためのフォームを持ったHTMLを作ります。
プロジェクトの「src/main/resources」ディレクトリの「templates」ディレクトリ内に、新規でhtmlファイルを作成します。
ファイル名は適当で良いですが(あとで作るコントローラクラスのメソッドの戻り値に合わせる必要がありますが)、ここではtestpostform.htmlとします。

testpostform.htmlを編集します。

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>Insert title here</title>
</head>
<body>
<h3>Spring Boot2のPOSTリクエストのテスト</h3>
<form th:action="@{/testpostrequest}" method="post">
<input type="text" name="postdata">
<button type="submit">送信する</button>
</form>
</body>
</html>

ブラウザ画面で表示してみます。

formには1つだけデータ送信のためのテキストボックスがあります。
「th:action="@{/testpostrequest}"」はthymeleafの書式で、「http://localhost:8080/testpostrequest」にPOSTリクエストするようにしています。

サーバサイドのControllerクラスの作成、@PostMappingアノテーション

次に、サーバサイドのコントローラクラスを作成します。プロジェクト内の「src/main/java」ディレクトリの「com.example.demo.controllers」パッケージ内にTestControllerクラスを作成します。

Eclipseでのコントローラ(Javaクラス)の作成手順については、こちらのページを参考にしてください。

そして、TestController.javaクラスを編集します。

package com.example.demo.controllers;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
public class TestController {

	//フォーム表示
	@RequestMapping("/testpostform")
	public String testPostForm() {
		return "testpostform";
	}

	//POSTリクエスト時
	//@RequestMapping("/testpostrequest")
	@PostMapping("/testpostrequest")
	@ResponseBody
	public String testPostRequest(@RequestParam String postdata) {
		String str = "";
		str = str.concat("postdata is " + postdata + "<br>");
		return str;
	}
}

TestControllerのメソッドは2つです。1つ目のtestPostFormメソッドは、「フロントエンド(HTML)の作成」で説明しましたPOSTリクエストをするためのページを表示します。「http://localhost:8080/testpostform」にリクエストした時に、呼び出されます。

2つ目のtestPostRequestメソッドは、POSTリクエスト時に呼び出されます。@RequestParamの変数名のpostdataは、HTMLフォームのテキストボックスの名前(name)と一致させる必要があります。これで、POSTリクエストでクライアント側からサーバサイドへデータ送信(データの受け渡し)ができます。

@RequestParamの扱い方、メソッドの定義の仕方は、GETリクエスト時のクエリストリングと同じです。GETリクエスト時の@RequestParamについては別ページに書いていますので、そちらを参考にしてください。
【Sprint Boot2】GETリクエストでクライアント側からサーバサイドへデータ送信。サーバサイドのControllerクラスの作成、@RequestParam、@GetMapping

@PostMappingアノテーション
そして、testPostRequestメソッドのURLのマッピングは@PostMappingアノテーションを使っています。@PostMappingはPOSTリクエストのみ受ける事ができ、GETリクエストはエラーになります。

@RequestMappingアノテーションは、GET・POST関係なくリクエストを受ける事ができますが、HTMLフォームからのリクエストを想定している時のように、使われ方が明確になっている場合は@PostMappingを使ったほうが良いと思います。

アプリの実行と動作確認

それでは、実際にSpring Bootウェブアプリを起動して、ブラウザで動作確認をします。アプリの起動方法については、こちらのページを参考にしてください。

アプリを起動したら、ブラウザで表示確認をしてみましょう。
まず、HTMLフォームのページを開きます。アクセスするurlは「http://localhost:8080/testpostform」です。

そして、テキストボックスに適当なデータを入力し、"送信する"ボタンを押し、POSTリクエストをします。
下の画像は、"こんばんは"を入力した時のリクエスト結果です。"postdata is ○○"が表示されれば正常に動作しています。
Spring BootでPOSTリクエストの動作確認

その他のSpring Bootの記事

Spring Boot2で日記投稿ウェブアプリ開発入門トップページ
Spring Boot2.3,2.4でシンプルな日記投稿ウェブアプリの開発しながら、入門者・初心者にもわかりやすいように説明しています。DBを使用して、新規投稿、編集、削除、一覧表示という基本的なCRUD機能を備えたアプリです。