SpringBootのRESTコントローラで1リソースに対して複数パターンの相関チェックを実現したい

解決済

回答 1

投稿 編集

  • 評価
  • クリップ 2
  • VIEW 1,491

kojisaiki

score 11

いつもお世話になっています。

実現したいこと

SpringBootを使って、WebAPIを提供するシステムを作成しています。

例えば「記事データ(post)」というリソースがあったとして、
記事データ用の1つのRESTコントローラを作成することを考えています。

このとき、RESTコントローラ内に次の2つのAPIを用意したいです。

  • 下書き保存
  • 公開保存

記事データの保存先テーブルは同一の「記事テーブル」をイメージしています。
(各列にNOTNULL制約がほとんどないイメージ)

これを実現するため、コントローラ内で次のようなイメージの入力チェックをしたいと考えています。

/**
 * 下書き保存するAPI
 */
@RequestMapping("/post/draft")
@入力チェック("下書き用")
public ResponseEntity<PostData> saveDraftPost(@Validated @RequestBody PostData postData) {
...

/**
 * 公開保存するAPI
 */
@RequestMapping("/post/open")
@入力チェック("本番用")
public ResponseEntity<PostData> saveOpenPost(@Validated @RequestBody PostData postData) {
...

このような要件を実現するには、どのような実装方法が適しているでしょうか?

 現在思いついている案

  • @NotNull(groups=下書き.class)などとし、@Validatedにgroupsの定義を渡す

この実現方法が最もスタンダードなのかと思いますが、
下書き用/本番用、以外に入力チェックパターンが増えた時にドメインのアノテーションのメンテナンスが大変そうです。
また、下書き用/本番用のチェックの中で、ビジネスロジックが必要になった時に対応できません。

  • Spring Validatorを使う

これをすると、コントローラに対してビジネスロジックも呼び出せる入力チェック処理が書けます。
ただし、1コントローラの中で、下書き用/本番用などの入力チェックモードみたいな切り替えを実現する方法がわかりません。


ご助力を宜しくお願いします。

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 1

checkベストアンサー

+1

両方の合わせ技が良いと思います。

単純なチェックは、Bean Validationのアノテーションでチェックし、ビジネスロジックはSpring Validatorを使うのが良いと思います。
「下書き用」と「本番用」での切り替えは、Bean Validationはgroupsを指定して行い、Spring Validatorは、validateメソッド内で処理を分けてはどうでしょうか?
validateメソッド内で処理を分けるのは、Formクラスで「下書き用」「本番用」を区別できる値を持って(処理によって画面から受け取る値を分ける)、その値で処理を分岐したら良いのかなと思います。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2016/09/23 13:35 編集

    ご回答ありがとうございます。検討してみます。また進展があれば更新致します。

    キャンセル

  • 2016/09/27 16:44 編集

    お教え頂いた方法で進めようと思います。今のところ、「下書き用」と「本番用」でチェック内容が切り替わるものは、単一チェックもSpringValidatorに含めることを考えています(項目が多く無いので)。

    ありがとうございました。

    キャンセル

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 90.22%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる
  • トップ
  • Javaに関する質問
  • SpringBootのRESTコントローラで1リソースに対して複数パターンの相関チェックを実現したい