taiPyのお悩み解決ブログ

日々の発見をまとめます!

Gradleを使用:Springの入力値検証機能を使いたい。spring-boot-starter-validation

はじめに

自分用の備忘録です。 Springの入力値検証機能を使いたいってなりましたが、自分のプロジェクトに必要なライブラリというか機能が備わっていなかったんですよね。

なので、Gradleで依存関係を整理して使えるようにしました!

環境

  • エクリプス
  • Windows
  • Spring

手順

大きく分けて次の2つ。

  1. Spring Boot Starter Dependencyを追加する: Spring Boot Starter Dependencyには、必要な依存関係が含まれています。build.gradleファイルに次のような依存関係を追加します:
   dependencies {
       implementation 'org.springframework.boot:spring-boot-starter-validation'
       // 他の依存関係も追加する場合はここに記述します
   }

これにより、Spring Bootが提供するバリデーション機能がプロジェクトに追加されます。

  1. 入力値の検証を行うクラスを作成する

今回はFormクラスを使っています。入力値を受け取るときにFormクラスを使う方法とModelクラスを使う方法の2種類があると思いますが、Formクラスを使っています。入力値検証をしたい、バリエーションをしたいってなったら基本Formクラスを作成することになるかと存じ上げますが。

入力値の検証を行うクラスを作成します。通常は、入力値を持つDTO(Data Transfer Object)クラスや、コントローラー内で使用されるフォームクラスが対象となります。以下は例です:

   import javax.validation.constraints.NotBlank;

   public class MyForm {
       @NotBlank(message = "名前を入力してください")
       private String name;

       // getterとsetterを省略
   }

ここでは、@NotBlankアノテーションを使用して名前が空でないことを検証しています。

これらの手順を実行することで、GradleプロジェクトでSpringの入力値検証機能を使用できるようになります。