Перевірка даних форми за допомогою анотацій (@Size, @Email та ін) в Spring MVC

Ця стаття є продовженням статті про форми в Spring і про перевірку введених користувачем даних. Будуть розглянуті анотації, що замінюють валідатор.

Щоб вказати параметри перевірки ім'я користувача будемо використовувати наступні анотації:

@NotBlank
@Size(min=3, max=16)
private String username;

Анотація @Email використовується для перевірки правильності введеного email'у:

@Email
private String email;

На жаль, немає стандартної анотації, яка перевіряє, що значення двох полів однакові (в нашому випадку - password і confirmPassword). Таку анотацію ми створимо в наступній статті.

Тобто, остаточний варіант класу SignupForm буде виглядати наступним чином:

package com.seostella.springfa.form;

import javax.validation.constraints.Size;

import org.hibernate.validator.constraints.Email;
import org.hibernate.validator.constraints.NotBlank;

public class SignupForm {
	@NotBlank
	@Size(min=3, max=16)
	private String username;
	
	@NotBlank
	private String password;
	
	@NotBlank
	private String confirmPassword;
	
	@Email
	private String email;
	
	public String getUsername() {
		return username;
	}
	
	public void setUsername(String username) {
		this.username = username;
	}
	
	public String getPassword() {
		return password;
	}
	
	public void setPassword(String password) {
		this.password = password;
	}
	
	public String getConfirmPassword() {
		return confirmPassword;
	}
	
	public void setConfirmPassword(String confirmPassword) {
		this.confirmPassword = confirmPassword;
	}
	
	public String getEmail() {
		return email;
	}
	
	public void setEmail(String email) {
		this.email = email;
	}
}

У класі SignupValidator вже немає ніякої необхідності, тому він виключений з проекту.

Необхідно внести ще одну правку в контролер SignupController. Так як ми використовуємо анотації, які будуть перевіряти значення полів класу, необхідно описати анотацією @Valid параметр методу SignupForm. Нижче наведено повний лістинг класу SignupController:

package com.seostella.springfa.controller;

import javax.validation.Valid;

import org.springframework.stereotype.Controller;
import org.springframework.ui.ModelMap;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

import com.seostella.springfa.form.SignupForm;

@Controller
@RequestMapping("/signup")
public class SignupController {

	@RequestMapping(method = RequestMethod.GET)
	public String signup(ModelMap model) {
		SignupForm signupForm = new SignupForm();
		model.put("signupForm", signupForm);
		return "signup";
	}

	@RequestMapping(method = RequestMethod.POST)
	public String processSignup(@Valid final SignupForm signupForm, final BindingResult result) {
		if (result.hasErrors()) {
			return "signup";
		}
		return "signup-success";
	}
}

Решта файлів проекту залишаються без змін.

У класі SignupForm використовувалися анотації з двох пакетів: javax.validation.constraints і org.hibernate.validator.constraints. Розглянемо інші анотації з цих пакетів.

Пакет javax.validation.constraints:

• AssertFalse - значення анотованого елемента має бути false;
• AssertTrue - значення анотованого елемента має бути true;
• DecimalMax - значенням анотованого елемента має бути число, яке повинно бути менше або дорівнює вказаному максимальному числу;
• DecimalMin - значенням анотованого елемента має бути число, яке повинно бути менше або дорівнює вказаному мінімального числа;
• Digits - анотований елемент повинен бути числом в межах допустимого діапазону. Типи, що підтримуються: BigDecimal, BigInteger, String, byte, short, int, long та їх типи-обгортки. null вважається валідним значенням;
• Future - анотований елемент повинен бути датою в майбутньому;
• Max - значенням анотованого елемента має бути число, яке повинно бути менше або дорівнює вказаному максимальному числу;
• Min - значенням анотованого елемента має бути число, яке повинно бути менше або дорівнює вказаному мінімального числа;
• NotNull - анотований елемент не повинен бути null;
• Null - анотований елемент повинен бути null;
• Past - анотований елемент повинен бути датою минулого;
• Pattern - анотований елемент (типу String) повинен відповідати регулярному виразу;
• Size - анотований розмір елемента має бути між заданими межами (межі включені в діапазон).

Пакет org.hibernate.validator.constraints:

• CreditCardNumber - анотований елемент повинен представляти дійсний номер кредитної картки;
• Email - рядок повинен бути правильно сформованою адресою електронної пошти;
• Length - довжина анотованого рядка повинна бути між мінімальним і максимальним значенням (включно);
• NotBlank - анотований рядок не дорівнює null і не є пустим;
• NotEmpty - анотований елемент типу String, Collection, Map або масив не дорівнює null і не є порожнім;
• Range - анотований елемент повинен бути у відповідному діапазоні;
• URL - анотована рядок є правильною URL-адресою.

Код проекту Ви можете завантажити за наступним посиланням - Завантажити spring-fa.zip.