【Spring Boot】単項目チェックしてエラーメッセージを表示する（@Validated）
この記事では、@Validatedを使用して入力チェックを行う方法について解説します。
VSCodeでSpringBootのMavenプロジェクトを作成します。
手順は以下の記事を参照。
プロジェクト作成時、以下の5つの依存関係を選択します。5個目のvalidationを選択しておかないと入力チェックができないので注意してください。
SpringBootで新規プロジェクトを作成したら、以下のソースを用意して実行できる状態にします。
(BaseController.java)com.example.demo3.controlloer直下に以下の内容でBaseController.javaを作成します。
BaseController.java
package com.example.demo3.controlloer;
import com.example.demo3.model.Person;
import org.springframework.stereotype.Controller;
import org.springframework.validation.BindingResult;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.PostMapping;
@Controller
public class BaseController{
@GetMapping("/")
public String home(@ModelAttribute Person person) {
return "form";
}
@PostMapping("/form")
public String result(@Validated
@ModelAttribute Person person,
BindingResult result){
if(result.hasErrors()){
return "form";
}
return "result";
}
}
@ValidatedアノテーションBindingResult resultに代入され、エラーが存在する場合はresult.hasErrors()でtrueを受け取れます。(Person.java)com.example.demo3.model直下に以下の内容でPerson.javaを作成します。
Person.java
package com.example.demo3.model;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;
import javax.validation.constraints.Email;
import javax.validation.constraints.Min;
import lombok.Data;
@Data
public class Person {
/**
* <p>項目名：名前</p>
* <p>必須入力かつ、最大10文字まで</p>
*/
@NotBlank
@Size(max=10)
private String name;
/**
* <p>項目名：年齢</p>
* <p>1以上</p>
*/
@NotNull
@Min(1)
private Integer age;
/**
* <p>項目名：職業</p>
* <p>必須入力かつ、最大10文字まで</p>
*/
@NotBlank
@Size(max=10)
private String business;
/**
* <p>項目名：メールアドレス</p>
* <p>条件：必須入力かつ、最大64文字まで</p>
*/
@NotBlank
@Email
@Size(max=64)
private String email;
}
@NotBlankアノテーション@Sizeアノテーション
文字列の長さが指定した範囲を超えた場合、エラーになります。
例えば@Size(max=10)とした場合、11字以上入力するとエラーになります。
@Emailアノテーション
不正なメールアドレス（書式が正しくない）場合、エラーになります。
(form.html)resources\templates直下に以下の内容でform.htmlを作成します。
form.html
<!DOCTYPE html>
<html lang="ja" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>form</title>
<script type="text/javascript"></script>
<style type="text/css">
.errorStr {color:red;}
</style>
</head>
<body>
<form th:action="@{/form}" th:object="${person}" method="post" novalidate>
<label for="name">名前：</label>
<input type="text" th:field="*{name}">
<span class="errorStr" th:errors="*{name}"></span>
<br>
<label for="age">年齢：</label>
<input type="number" th:field="*{age}">
<span class="errorStr" th:errors="*{age}"></span>
<br>
<label for="business">職業：</label>
<input type="text" th:field="*{business}">
<span class="errorStr" th:errors="*{business}"></span>
<br>
<label for="email">Eメール：</label>
<input type="text" th:field="*{email}">
<span class="errorStr" th:errors="*{email}"></span>
<br>
<button>送信</button>
</form>
</body>
</html>
(result.html)resources\templates直下に以下の内容でresult.htmlを作成します。
result.html
<!DOCTYPE html>
<html lang="ja" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>result</title>
<script type="text/javascript"></script>
</head>
<body>
<p>名前：[[${person.name}]]</p>
<p>年齢：[[${person.age}]]</p>
<p>職業：[[${person.business}]]</p>
<p>Eメール：[[${person.email}]]</p>
</body>
</html>
上記のソースを実行してブラウザでhttp://localhost:8080/にアクセスすると以下の画面が表示されます。これは遷移元ページ(form.html)が表示されています。
このまま何も入力せずに「送信」ボタンを押すと、以下のようにエラーメッセージが表示されます。
続いて、以下のようにエラーにならない入力内容を考えてみます。
この内容で「送信」ボタンを押すと、次のように遷移先ページ(result.html)に遷移して入力内容が登録されたことが確認できました。
以上で記事の解説はお終い！
もっとJavaやSpringを勉強したい方にはUdemyがオススメ！同僚に差をつけよう！