プログラミング Java

【Spring+Thymeleaf】リクエストパラメーターをControllerで受け取る方法

投稿日:

概要

Spring+Thymeleafにおいて、リクエストパラメーターをControllerで受け取るパターンを紹介します。

リクエストパラメーターのパターンは以下の通りです。
・単一(inputタグのType=text, number等を想定)
・複数(複数のinputタグ、またはselectタグを想定)
・単一 & 複数(組み合わさったパターン)

実装例

単一(inputタグのType=text, number等を想定)

@RequestParam

@RequestParamでフィールド名を指定してパラメータを受け取る方法です。
リクエストされるパラメータが少ない(1~2個くらいの)画面からのリクエストで使用される印象があります。

HTML

 
Controller

 

@PathVariable

@PathVariableはパスパラメータでリクエストされる場合に使用します。
WebAPIの実装じおいてパスパラメータを指定するケースで使用される印象があります。

リクエスト
curl http://localhost/search/hoge

Controller

他の指定方法と異なり、URLはパラメータを含める構造になっていることに注意すること。
 

複数(複数のinputタグ、またはselectタグを想定)

@RequestParam Map<K, V>

画面から単一(type=text等)のリクエストパラメーターを複数個受け取る場合に使用される印象です。

HTML

Controller

  

@RequestParam(value = “[リクエストパラメータ名]”) String[]

selectタグでmultipleが有効になっている値をリクエストパラメータとして受け取る場合です。
画面からのリクエストで複数条件をパラメータとしたい場合に使用する印象です。

HTML

Controller

 

単一 & 複数(組み合わさったパターン)

@Validated

@Validatedはバリデーションを実行するためのアノテーションですが、リクエストパラメータのマッピングも行ってくれます。
ただし、マッピング用のオブジェクトを準備することが前提なるため、複雑なリクエストパラメータである場合のみ使用する印象です。

HTML

マッピング用オブジェクト(Form)

Controller

 

その他

必須、デフォルト値指定

リクエストパラメータが必須なのか、デフォルト値があるのかを設定することも可能です。
詳しくは以下でまとめられています。
Spring MVC コントローラの引数

 

まとめ

  • リクエストパラメータの複雑さによって、適切な実装をすることが望ましい。
  • パスパラメータの場合はURLの構造でパラメータを指定することに注意する。

 
最後までお読み頂き、ありがとうございました!
ご意見・ご要望がありましたら、遠慮なくコメント下さい!
もし内容が良かったらランキング評価を頂けると励みになります(^^)

ランキング評価する

-プログラミング, Java
-,

執筆者:


comment

メールアドレスが公開されることはありません。

CAPTCHA


関連記事

Facadeパターンの使い道をコードとクラス図で説明します。

Facadeパターンはどんな役に立つか? 簡単にいうと、複数の処理のまとめ役。 なので、依頼1つでいろんな仕事をやってくれる点で役に立つ。 Facadeパターンの要件 Facadeクラスはあくまでサブ …

no image

【PHP】配列と連想配列と多次元配列の説明と使用例

配列とは? 1つの変数に複数の値を持つものです。 整数型や文字列型は1つの変数に1つの値を持ちますが、配列は同じようなデータの集まりを1つの変数に持つことができるようになっています。 配列には通常の添 …

SingletonパターンをJUnitでテストする

シングルトンパターンはインスタンスが1つであることを保証する設計です。 Junitを使って、本当に1つだけなのかを検証してみます。 またその手順をテスト駆動開発に従った手順(Red→Green→リファ …

ExcelをA1セルに揃えて拡大率100%にするツール

(追記:2021年8月18日) サブフォルダを処理対象にするかどうかを選択できるように改修しました。   たくましゅくじょさんのところで公開されていた、 「エクセルで全シートの拡大率を100%にしA1 …

【Java】HashSetの使い方(順序なしSet)

HashSetの使い方をまとめました。 HashSetに関する使い方のサイトは他にもありますが、 それらのサイトには書かれていないメソッドについても書いてあります。 HashSetの基本情報 ・重複す …

SpringFramworkの良書

■おすすめ教材
Javaの基本を学んだ人が、次のステップとして読む本(中級者向け)

※SpringはJavaのFrameworkの1つです。
変更のしやすさ、保守性の高さが特徴です。