【初心者向け】Spring Boot入門体験セミナー|はじめてのWeb画面を動かす60分
Javaを少し学んだけれど、Webの画面とどうつながるのか分からない。Spring BootやThymeleafという名前は聞くものの、何から始めればよいか迷っている。そんな方に向けた体験セミナーです。 講師と一緒にS…
開催予定:2026/11/16 10:00〜 ほか
内容・開催日程を見る生徒
「Spring BootでHTTPレスポンスをカスタマイズしたいんですが、どうすればいいですか?」
先生
「HTTPレスポンスをカスタマイズする場合は、@ResponseEntityアノテーションが便利です。これを使うと、ステータスコードやヘッダーも自由に設定できます。」
生徒
「具体的にどう使うんですか?」
先生
「基本的な使い方から見ていきましょう!」
JavaのSpring Bootフレームワークでは、@ResponseEntityアノテーションを使うことで、サーバーからクライアントに返すHTTPレスポンスの中身を細かくコントロールできます。通常のコントローラーメソッドは、メソッドの戻り値をそのままレスポンスボディとして返し、ステータスコードは自動的に「200 OK」になりますが、@ResponseEntityを使うと、ステータスコード、レスポンスボディ、ヘッダーを自分の意図どおりに設定できます。
もう少しかみ砕いて言うと、@ResponseEntityは「どんな結果を、どんな状態で返すか」をひとまとめにして表現するための入れ物のようなものです。例えば「処理が成功したからメッセージを返したい」「エラーが起きたのでエラーメッセージとエラー用のステータスコードを返したい」といったときに、この入れ物の中に「文字列やオブジェクト」「ステータスコード」「必要ならヘッダー情報」を詰め込んで返すイメージです。
初心者のうちは、まず「ResponseEntity<型>という形で、どんなデータを返すかを指定する」「第2引数にHttpStatus.OKなどのステータスコードを渡せる」という二つを覚えておくと理解しやすくなります。これが分かってくると、Spring BootでREST APIを作るときに、「成功」「失敗」「データなし」といった状態をきちんとHTTPレスポンスとして表現できるようになり、実践的なWebアプリケーション開発に一歩近づけます。
ここでは、@ResponseEntityを実際にどう書くのか、いちばんシンプルな例で確認してみましょう。まずは「/hello」というパスにアクセスしたときに、メッセージとHTTPステータスコードをセットで返す基本パターンです。
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class ExampleController {
@GetMapping("/hello")
public ResponseEntity<String> sayHello() {
return new ResponseEntity<>("Hello, World!", HttpStatus.OK);
}
}
このコードでは、/helloというURLにブラウザからアクセスすると、「Hello, World!」という文字列と一緒にHTTPステータスコード200(OK)が返されます。ResponseEntity<String>という戻り値の型は、「文字列をボディとして持つHTTPレスポンスを返します」という意味だと考えると分かりやすいです。
new ResponseEntity<>("Hello, World!", HttpStatus.OK)の第1引数がクライアントに返すメッセージ(レスポンスボディ)、第2引数がステータスコードです。つまりこの1行だけで、「内容はこのテキスト」「結果は成功(OK)」という情報をまとめて返していることになります。ブラウザの開発者ツールでネットワークタブを開いてみると、ステータスが「200 OK」になっていることも確認できるので、Spring BootとHTTPレスポンスの関係を体感しながら学ぶことができます。
@ResponseEntityでは、HTTPステータスコードを自分で指定することができます。HTTPステータスコードとは、「リクエストの結果がどうなったか」を数字で表したものです。例えば、うまくいったときの200 OK、入力が間違っているときの400 Bad Request、ページが見つからないときの404 Not Foundといった種類があります。
まずは、リクエストが正しくない場合に「400 Bad Request」を返す、とてもシンプルなサンプルを見てみましょう。
@GetMapping("/error")
public ResponseEntity<String> handleError() {
return new ResponseEntity<>("Bad Request", HttpStatus.BAD_REQUEST);
}
このメソッドに対応する/errorというURLにアクセスすると、レスポンスボディには「Bad Request」という文字列が入り、ステータスコードにはHttpStatus.BAD_REQUEST(数値としては400)が設定されます。ブラウザやAPIクライアントの画面では、メッセージだけでなく「400 Bad Request」という結果も確認できるので、「入力が間違っている」「リクエストが不正」ということを機械にも人にも分かる形で伝えられます。
同じような書き方で、成功時に200 OKを返したり、新しくデータを作成したときに201 CREATEDを返したりすることもできます。Spring BootのコントローラーでResponseEntity<String>を使うと、「どんなメッセージを返すか」と同時に「その結果をどう評価するか(成功なのか、エラーなのか)」をHTTPステータスコードとして表現できるようになり、REST APIらしい分かりやすいWebアプリケーションを作りやすくなります。
HTTPレスポンスには「ヘッダー」と呼ばれる追加情報を載せることができます。ヘッダーは、荷物に貼る送り状のようなもので、「このデータはどんな形式か」「どこから来たデータか」など、ブラウザやクライアント側に伝えたいメタデータを記載する場所だと考えるとイメージしやすいです。
Spring Bootでは、HttpHeadersクラスを使うことで、このレスポンスヘッダーを簡単にカスタマイズできます。まずは、独自のヘッダーを1つ追加する、シンプルな例を見てみましょう。
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class HeaderController {
@GetMapping("/custom-header")
public ResponseEntity<String> customHeader() {
HttpHeaders headers = new HttpHeaders();
headers.add("Custom-Header", "MyValue");
return new ResponseEntity<>("Header added!", headers, HttpStatus.OK);
}
}
このコードでは、/custom-headerにアクセスすると、レスポンスボディとして「Header added!」という文字列が返されるだけでなく、レスポンスヘッダーにCustom-Header: MyValueという独自の情報が1行追加されます。ブラウザの開発者ツールやAPIクライアントのレスポンスヘッダーの一覧を確認すると、この項目が増えているのが分かります。
ポイントは、HttpHeaders headers = new HttpHeaders();でヘッダー用のオブジェクトを用意し、headers.add("名前", "値")で好きなヘッダーを登録してから、new ResponseEntity<>(ボディ, headers, ステータス)の形でまとめて返しているところです。Spring Bootのコントローラーでレスポンスヘッダーを扱えるようになると、「ダウンロード用のレスポンスにファイル名を付ける」「認証用のトークンをヘッダーに載せる」といった実践的なWeb APIの実装にもスムーズにつなげられるようになります。
@ResponseEntityは、単純な文字列だけでなく、Javaのオブジェクトそのものをレスポンスボディとして返すことができます。実際のWebアプリケーションやREST APIでは、文字列よりも「ユーザー情報」「商品情報」のようなまとまったデータを返すことが多いので、この仕組みを押さえておくと一気に実践寄りのSpring Boot開発に近づきます。
たとえば、ユーザーの名前と年齢をまとめて返したい場合は、次のように専用のクラスを用意して、それをResponseEntityで返すだけです。
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class UserController {
public static class User {
private String name;
private int age;
// コンストラクタ
public User(String name, int age) {
this.name = name;
this.age = age;
}
// ゲッター
public String getName() { return name; }
public int getAge() { return age; }
}
@GetMapping("/user")
public ResponseEntity<User> getUser() {
User user = new User("John", 30);
return new ResponseEntity<>(user, HttpStatus.OK);
}
}
このコードでは、/userエンドポイントにアクセスすると、Userクラスのインスタンスがレスポンスボディとして返されます。Spring Bootは内部でこのオブジェクトをJSON形式に自動変換してくれるため、開発者は「Userオブジェクトを返す」ことだけに集中すれば大丈夫です。特別な設定をしなくても、ゲッターメソッド(getNameやgetAge)が定義されていれば、そのプロパティがJSONの項目として出力されます。
実際にブラウザやAPIクライアントから/userにアクセスすると、次のようなJSONデータが返ってきます。Javaのオブジェクトが、そのまま「キーと値」の形に変換されているのが分かります。
{
"name": "John",
"age": 30
}
このように、ResponseEntity<User>のような形で型を指定しておけば、「どんなデータを返すAPIなのか」がメソッドシグネチャから一目で分かるようになります。複数の項目をまとめて返したいときや、ユーザー情報・商品情報・注文情報などを扱うときは、それぞれ専用のクラスを作り、@ResponseEntityで返すスタイルを覚えておくと、Spring BootのREST API設計がぐっとスムーズになります。
@ResponseEntityは成功時だけでなく、エラーを分かりやすく返す場面でも大きく役立ちます。WebアプリやREST APIでは「データが存在しない」「入力が間違っている」といった状況が必ず発生するため、初心者のうちからエラーレスポンスの返し方を押さえておくことが大切です。
まずは、もっともよく使う「リソースが見つからない場合」に404 Not Foundを返す基本的なサンプルから見てみましょう。
@GetMapping("/not-found")
public ResponseEntity<String> notFound() {
// データが無い状況を想定したサンプル
return new ResponseEntity<>("指定されたデータは見つかりませんでした", HttpStatus.NOT_FOUND);
}
このメソッドにアクセスすると、レスポンスボディには「指定されたデータは見つかりませんでした」というメッセージが返り、ステータスコードには404 Not Foundが設定されます。これによって「画面ではメッセージを確認でき、機械的にもエラーとして処理できる」という両方の利点を持つレスポンスになります。
プログラミング未経験の方は「エラーが起きたら、その理由をメッセージとして返し、HTTPステータスコードで状態を表す」と覚えると理解しやすくなります。こうした小さな工夫が、分かりやすく信頼性の高いWeb APIを作る第一歩につながります。
今回の記事では、JavaのSpring Bootで使用する@ResponseEntityアノテーションについて学びました。@ResponseEntityを使用すると、HTTPレスポンスの内容を細かくカスタマイズできるため、APIの設計や開発においてとても便利です。特に、ステータスコードの設定やレスポンスヘッダーの追加、オブジェクトを返す際のシリアライズの処理など、幅広い用途に対応できます。
以下は、今回学んだ重要なポイントです。
@ResponseEntityを使うことで、HTTPステータスコードを自由に設定可能。以下は、@ResponseEntityの様々な使い方をまとめたサンプルプログラムです。
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class SummaryController {
// ステータス200(OK)の例
@GetMapping("/success")
public ResponseEntity<String> successResponse() {
return new ResponseEntity<>("Success!", HttpStatus.OK);
}
// カスタムヘッダーの追加
@GetMapping("/header-example")
public ResponseEntity<String> headerExample() {
HttpHeaders headers = new HttpHeaders();
headers.add("X-Example-Header", "HeaderValue");
return new ResponseEntity<>("Header added", headers, HttpStatus.OK);
}
// ステータス404(Not Found)の例
@GetMapping("/not-found-example")
public ResponseEntity<String> notFoundExample() {
return new ResponseEntity<>("Resource not found", HttpStatus.NOT_FOUND);
}
// JSONオブジェクトのレスポンス
@GetMapping("/json-example")
public ResponseEntity<User> jsonExample() {
User user = new User("Alice", 25);
return new ResponseEntity<>(user, HttpStatus.OK);
}
// エラーハンドリングの例
@GetMapping("/bad-request-example")
public ResponseEntity<String> badRequestExample() {
return new ResponseEntity<>("Bad request error", HttpStatus.BAD_REQUEST);
}
}
このコードには、ステータスコード、カスタムヘッダー、エラーハンドリング、JSONレスポンスの例が含まれています。実際の開発では、これらを組み合わせてAPIの挙動をカスタマイズすることが一般的です。
生徒
「@ResponseEntityを使うと、HTTPレスポンスをかなり細かく制御できるんですね。」
先生
「そうですね。特に、APIの開発ではレスポンスの内容を調整することが大切なので、@ResponseEntityは非常に役立ちます。」
生徒
「エラーハンドリングも簡単にできるので、クライアントにわかりやすいエラーメッセージを返すことができますね。」
先生
「その通りです。適切なステータスコードとメッセージを返すことで、クライアント側の開発者もデバッグしやすくなります。」
生徒
「これで、Spring BootのAPI開発がもっとスムーズにできそうです!」
先生
「ぜひ試してみてください。実際に使いながら学ぶと理解が深まりますよ。」
ChatGPTなどの生成AIをこれから学びたい方に向けて、AIスキルアカデミーの口コミ・評判、料金、無料セミナーの内容を詳しくまとめています。
AIスキルアカデミーの口コミ・評判を詳しく見るSpring Boot教材、開発環境、スクール比較を優先し、Webアプリ制作まで進めやすくします。
Spring Boot教材を比較する