Spring Bootの@GetMappingと@PostMappingの違いを解説する記事のアイキャッチ。Java道場風の空間で若手エンジニアがGETとPOSTの使い分けを学ぶイラスト。

実装・エラー解決

Spring Bootの@GetMappingと@PostMappingの違い|@RequestMappingとの使い分け

AIによる要約

@GetMappingは一覧表示や詳細表示など、基本的にサーバーの状態を変更しない取得処理へ使います。@PostMappingは登録、申請、ファイル取込など、状態を変更する処理へ使います。@RequestMappingはController全体の共通パスや、HTTPメソッド以外の条件も含めて指定するときに使います。削除をGETで実装せず、成功後はredirectすることが現場で重要な確認点です。

新人SE
新人SE
画面が表示できれば、全部@GetMappingでも問題ないのでしょうか?
ポンコツSE
ポンコツSE
表示結果だけで決めません。そのリクエストがサーバーのデータを変更するか、再実行されても安全かでHTTPメソッドを選びます。

Spring BootのControllerでは、@GetMappingと@PostMappingを頻繁に使います。書き方は似ていますが、単に「画面表示はGET、ボタンはPOST」と暗記すると、検索、削除、確認画面などで判断に迷います。

HTTPメソッドは、URLと合わせて処理の意味を表します。使い方を誤ると、ブラウザの再読み込みで二重登録されたり、リンクを開いただけでデータが削除されたりします。この記事では社員管理画面を例に、新人が実装レビューで説明できる基準を整理します。完了画面の再読み込みとPOSTの再送の比較へ直接進めます。

この記事のポイント

  • GETは基本的に参照、POSTは登録や業務処理に使う
  • 同じURLでもHTTPメソッドが違えば別の処理として定義できる
  • Controller共通パスはクラスの@RequestMappingへまとめる
  • 登録成功後は詳細へリダイレクトし、完了画面の再読み込みをGETにする

実行用サンプル

社員データをGETでは変更せず、POSTで登録・リダイレクトします。無効な登録と、削除URLをGETで開いた場合も検証します。 ソース全文、JUnitの検証コード、pom.xml、READMEを収録しています。JDK 17とMaven 3.9系で mvn test を実行します。Spring Boot 3.5.16のサンプルです。

@GetMappingと@PostMappingの基本的な違い

観点@GetMapping@PostMapping
主な用途一覧、詳細、検索結果、入力画面登録、申請、実行、ファイル取込
データ変更原則として行わない行う処理に使う
パラメータクエリ文字列やパスに現れやすいFormやリクエストボディで送ることが多い
再読み込みGET自体では業務データを更新しない二重実行へ注意が必要

GETは安全なメソッドとして、サーバーの状態を変えないことが期待されます。アクセスログや最終閲覧日時など技術的な情報が更新される場合はありますが、注文登録や削除のような利用者が意図する業務データを変更させません。

POSTは、同じリクエストを2回送ると2件登録される可能性があります。そのため、画面の二重送信防止、サーバー側の重複チェック、トークンなど、処理に応じた対策を考えます。

@GetMappingの実装例

社員一覧と詳細をGETで開きます。テストでは一覧を1回、社員10の詳細を2回取得し、呼び出し前後の社員データの内容が一致することを確認します。

EmployeePageController.java の抜粋。一覧と詳細を参照するGET

    @GetMapping
    public String list(Model model) {
        model.addAttribute("employees", employees.findAll());
        model.addAttribute("employeeForm", new EmployeeForm(""));
        return "employees/list";
    }

    @GetMapping("/{id}")
    public String detail(@PathVariable long id, Model model) {
        model.addAttribute("employee", employees.find(id));
        return "employees/detail";
    }

クラスの @RequestMapping("/employees") と、メソッドのパスを組み合わせます。引数が10の詳細は GET /employees/10 です。

@PostMappingの実装例

登録や申請など、サーバーの状態を変更する処理をPOSTで受けます。

EmployeePageController.java の抜粋。入力エラーと登録成功を分けるPOST

    @PostMapping
    public String create(@Valid @ModelAttribute("employeeForm") EmployeeForm form,
                         BindingResult errors) {
        if (errors.hasErrors()) {
            return "employees/form";
        }
        return "redirect:/employees/" + employees.create(form.name()).id();
    }

氏名が空白なら employees/form に戻り、登録件数は増えません。正常時は1件追加され、302とLocationに詳細URLが返ります。

完了画面の再読み込みはGET、登録の再送はPOST

同じ社員登録コードで、完了画面を開き直す場合と、登録先/employeesへのPOST自体を送り直す場合を比べました。Spring Boot 3.5.16のMockMvcでは、302のLocationにある詳細URLを自分でGETしています。

操作HTTPの実測社員の総件数
1回登録したあと、詳細画面を再読み込みPOST 302 → GET 200 → GET 2001 → 2 → 2 → 2
同じ氏名で登録先にPOSTを2回送るPOST 302 → POST 3021 → 2 → 3
各行は社員1件の状態から開始。登録フォームの氏名はどちらも「鈴木」。

上の1行目を配布サンプルのHttpMethodTestで確認できます。name=鈴木を送ると詳細URLは/employees/11になり、GETを続けても増えません。2行目を手元で試すなら、別の初期状態から最初のPOSTと同じname=鈴木を/employeesへもう一度送ります。2回目の302のLocationは/employees/12になり、社員の総件数は1件から3件に増えます。

登録成功後にGETの詳細へ移す設計をPRG(Post/Redirect/Get)と呼びます。画面を調べるときは、ブラウザのNetworkで再読み込みがGETになっているか確認します。同じ登録POSTが2本届いている場合は、同じ操作を見分ける受付IDも検討します。HTTP仕様では302後のGETへの切り替えは許容される動作で、参照先への取得を明示するステータスは303です。

関連記事Spring BootでPOSTの二重登録を防ぐ|同じ受付IDの再送をDBで判定 通信が途切れて同じPOSTが届いても、同じ受付IDならDBに1件だけ残す実装です。逐次再送と並行POSTをテストします。 記事を読む

@RequestMappingはいつ使うのか

@GetMappingは@RequestMapping(method = RequestMethod.GET)を読みやすくした合成アノテーションです。POST、PUT、PATCH、DELETEにも対応する専用アノテーションがあります。

この例では、クラスの @RequestMapping("/employees") に共通パスを置きます。各メソッドには @GetMapping と @PostMapping を付けるので、同じURLでも参照と登録を読み分けられます。

同じURLをGETとPOSTで使ってもよい

URLだけでなく、HTTPメソッドも処理を識別する条件です。/employeesをGETで呼べば一覧取得、POSTで呼べば新規登録という設計にできます。

この画面では GET /employees を一覧参照、POST /employees を社員登録として割り当てています。両方とも上で掲載した同じ EmployeePageController にあります。

HTML画面では/employees/newをGETの入力画面、/employeesをPOSTの登録先にする構成もよくあります。URL命名だけを真似せず、既存プロジェクトの規約に揃えます。

削除処理を@GetMappingにしてはいけない

GETはリンクの先読み、クローラー、ブラウザ履歴など、人が削除ボタンを押す以外の理由でもアクセスされ得ます。GETでデータを変更すると、意図しない実行につながります。

HTML FormであればPOSTを使い、REST APIであれば@DeleteMappingを検討します。CSRF対策、権限確認、対象の存在確認もHTTPメソッドとは別に必要です。

EmployeePageController.java の抜粋。画面の削除POST

    @PostMapping("/{id}/delete")
    public String delete(@PathVariable long id) {
        employees.delete(id);
        return "redirect:/employees";
    }

EmployeeApiController.java の抜粋。APIの削除DELETE

    @DeleteMapping("/{id}")
    public ResponseEntity<Void> delete(@PathVariable long id) {
        employees.delete(id);
        return ResponseEntity.noContent().build();
    }

PUT・PATCH・DELETEはどう使い分けるか

アノテーション主な意味例
@PutMapping対象全体を置き換える更新社員情報全体の更新
@PatchMapping対象の一部を変更在籍ステータスだけ変更
@DeleteMapping対象を削除社員情報を削除

実際の業務システムでは、更新もPOSTへ統一する画面設計や、論理削除を使う設計があります。HTTPの一般原則を理解した上で、API仕様書と既存Controllerの方針を優先してください。

405 Method Not Allowedが出たときの確認点

この例の削除URLはPOSTにだけ割り当てています。そこをGETで開くと405になり、Allow にPOSTが含まれます。テストは、社員データが残ることと、その後のPOSTで削除されることまで確認します。

  • HTML FormのmethodがControllerと一致しているか
  • JavaScriptのfetchやAjaxで指定したmethodが正しいか
  • クラスとメソッドのパスを結合したURLが正しいか
  • 同じパスを別Controllerが重複定義していないか
  • PUTやDELETEをHTML Formから送るための構成が整っているか

list.html の抜粋。一覧画面に置いた登録フォーム

<form th:action="@{/employees}" method="post" th:object="${employeeForm}">
  <label>氏名 <input th:field="*{name}"></label>
  <button type="submit">登録</button>
</form>

次は HttpMethodTest の全文です。HTTPのステータスや遷移先と、呼び出し後に残る社員データを両方確認しています。

HttpMethodTest.java の全文

package info.syachiku.employee;

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.web.servlet.MockMvc;

import static org.assertj.core.api.Assertions.assertThat;
import static org.hamcrest.Matchers.containsString;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;

@SpringBootTest
@AutoConfigureMockMvc
class HttpMethodTest {
    @Autowired
    MockMvc mvc;
    @Autowired
    EmployeeDirectory employees;

    @Test
    void GETを繰り返しても社員データは変わらない() throws Exception {
        var before = employees.findAll();

        mvc.perform(get("/employees")).andExpect(status().isOk());
        mvc.perform(get("/employees/10")).andExpect(status().isOk());
        mvc.perform(get("/employees/10")).andExpect(status().isOk());

        assertThat(employees.findAll()).containsExactlyElementsOf(before);
    }

    @Test
    void POSTで一件登録しリダイレクト後のGETでさらに増えない() throws Exception {
        int before = employees.findAll().size();

        String location = mvc.perform(post("/employees").param("name", "鈴木"))
                .andExpect(status().isFound())
                .andReturn().getResponse().getRedirectedUrl();
        assertThat(location).startsWith("/employees/");
        assertThat(employees.findAll()).hasSize(before + 1);
        mvc.perform(get(location)).andExpect(status().isOk())
                .andExpect(content().string(containsString("鈴木")));
        mvc.perform(get(location)).andExpect(status().isOk());

        assertThat(employees.findAll()).hasSize(before + 1);
    }

    @Test
    void 無効なPOSTはフォームを返し社員データを変えない() throws Exception {
        var before = employees.findAll();

        mvc.perform(post("/employees").param("name", " "))
                .andExpect(status().isOk())
                .andExpect(view().name("employees/form"))
                .andExpect(model().attributeHasFieldErrors("employeeForm", "name"));

        assertThat(employees.findAll()).containsExactlyElementsOf(before);
    }

    @Test
    void 削除URLをGETで開いても消えずPOSTのときだけ消える() throws Exception {
        long id = employees.create("削除対象").id();
        var before = employees.findAll();

        mvc.perform(get("/employees/{id}/delete", id))
                .andExpect(status().isMethodNotAllowed())
                .andExpect(header().string("Allow", containsString("POST")));
        assertThat(employees.findAll()).containsExactlyElementsOf(before);

        mvc.perform(post("/employees/{id}/delete", id))
                .andExpect(status().isFound())
                .andExpect(redirectedUrl("/employees"));
        assertThat(employees.findAll()).noneMatch(employee -> employee.id() == id);
    }

    @Test
    void APIではDELETEが登録済みの社員を削除して204を返す() throws Exception {
        long id = employees.create("API削除対象").id();

        mvc.perform(delete("/api/employees/{id}", id)).andExpect(status().isNoContent());
        assertThat(employees.findAll()).noneMatch(employee -> employee.id() == id);
    }
}

この章の5件と、同じZIPの画面・APIの戻り値を確認する4件を実行した結果です。

Tests run: 9, Failures: 0, Errors: 0, Skipped: 0

URLとメソッドを設計する手順

  1. 何を対象にする処理かを名詞で決める
  2. 参照か、登録・変更かを判断する
  3. GET、POST、PUT、PATCH、DELETEから意味に合うものを選ぶ
  4. 成功時、入力エラー時、対象不存在時の遷移を決める
  5. Controller、HTML、JavaScript、API仕様書のメソッドを揃える

アノテーションから考え始めず、「この操作は何を変えるのか」を先に文章にします。

現場レビューでよくある指摘

// レビューコメント例
削除処理がGETになっています。
リンクの先読みでも実行され得るため、POSTまたはDELETEへ変更してください。

// レビューコメント例
POST直後の画面を再読み込みすると、ブラウザが再送の確認を出す場合があります。
登録成功時は詳細URLへリダイレクトしてください。

// レビューコメント例
全メソッドで共通パス /employees が重複しています。
クラスの@RequestMappingへ共通パスをまとめると読みやすくなります。

提出前のセルフチェック

  • GETで業務データを登録・更新・削除していないか
  • 登録や申請はPOSTになっているか
  • 登録成功後にリダイレクトし、完了画面をGETで再読み込みしても登録件数が増えないか
  • ControllerとHTML FormのHTTPメソッドが一致しているか
  • 共通パスをクラスの@RequestMappingへまとめられるか
  • API仕様書とステータスコードの方針に合っているか

HTTPとWebアプリの基本を学ぶ参考書

Springのアノテーションだけでなく、HTTPメソッドやステータスコードの意味を押さえると、Controller設計の判断が安定します。Webの基本へ立ち戻りたいときに役立つ一冊です。

書籍「Webを支える技術」の表紙
商品画像:Amazon.co.jp
PR Web開発に入る新人向け

Webを支える技術

山本 陽平 (著)

HTTP・URI・RESTを、Webアプリ開発の土台から理解する。

RequestParamやRequestBodyの暗記だけでは見えにくい、Web通信の基本原則を整理できます。

  • HTTPの仕組みから理解したい
  • RESTやURIの設計意図を学びたい

当サイトはAmazonアソシエイト・プログラムの参加者です。価格・在庫・配送条件はAmazonでご確認ください。

この記事とあわせて読みたい

関連記事Spring Bootの入力値はどこで受ける?@RequestParam・@PathVariable・@RequestBodyの使い分け @RequestParam、@PathVariable、@ModelAttribute、@RequestBodyの選び方を整理します。 記事を読む 関連記事Spring BootのControllerでやってはいけないこと 業務ロジックやDB操作をControllerへ詰め込まないための基準を解説します。 記事を読む 関連記事Spring MVCの@RequestMappingの使い方と値によるメソッド分割 既存記事で@RequestMappingの基本的な書き方を確認できます。 記事を読む

まとめ

@GetMappingは一覧や詳細などの参照処理、@PostMappingは登録や申請などサーバーの状態を変更する処理へ使います。Controller共通のパスはクラスの@RequestMappingへまとめると、各メソッドの役割を読みやすくできます。

削除をGETにしないこと、登録成功後にredirectすること、HTMLやJavaScriptとControllerのHTTPメソッドを揃えることが、現場で特に重要な確認点です。アノテーションの形ではなく、操作の意味からHTTPメソッドを選びましょう。

-実装・エラー解決
-,