Изучаем Java EE 7

Как было показано выше (см. листинг 3.2), при определении ограничивающей аннотации есть три обязательных атрибута: message, groups и payload. Каждое ограничение должно определять задаваемое по умолчанию сообщение типа String, которое используется для индикации ошибки, если при валидации компонента нарушается то или иное ограничение.

Значение такого стандартного сообщения можно жестко запрограммировать, но рекомендуется применять ключ пакета ресурсов для обеспечения интернационализации. В соответствии с действующим соглашением ключ пакета ресурсов должен быть полностью квалифицированным именем класса той ограничивающей аннотации, которая сцепляется с. message.

// Жестко закодированное сообщение об ошибке

String message() default "Неверный электронный адрес";

// Ключ пакета ресурсов

String message() default "{org.agoncal.book.javaee7.Email.message}";

По умолчанию файл пакета ресурсов называется ValidationMessages.properties и должен быть указан в пути к классам приложения. Файл построен в виде пар «ключ — значение», именно это нам и нужно для экстернализации и интернационализации сообщения об ошибке.

org.agoncal.book.javaee7.Email.message=Неверный электронный адрес

Это стандартное сообщение, заданное в ограничивающей аннотации, может быть переопределено во время объявления в зависимости от конкретных условий использования.

@Email(message = "Восстановленный электронный адрес не является действительным")

private String recoveryEmail;

Благодаря интерполяции сообщений (интерфейс javax.validation.MessageInterpolator) сообщение об ошибке может содержать джокерные элементы. Цель интерполяции — определить сообщение об ошибке, разрешая его строки и параметры, находящиеся в скобках. Следующее сообщение об ошибке интерполировано таким образом, что джокерные строки {min} и {max} заменяются значениями соответствующих элементов:

javax.validation.constraints.Size.message = size must be between {min} and {max}

В листинге 3.16 показан класс Customer, использующий сообщения об ошибках несколькими способами. Атрибут userId имеет аннотацию @Email, говорящую о том, что если значение не является действительным адресом электронной почты, то будет использоваться заданное по умолчанию сообщение об ошибке. Обратите внимание: с атрибутами firstName и age стандартные сообщения об ошибках переопределяются, вместо них используются варианты с джокерными последовательностями.

Листинг 3.16. Класс Customer, определяющий несколько сообщений об ошибках

public class Customer {

··@Email

··private String userId;

··@NotNull @Size(min = 4, max = 50, message = "Имя должно быть размером от {min} до {max} символов")

··private String firstName;

··private String lastName;

··@Email(message = "Восстановленный электронный адрес не является действительным")

··private String recoveryEmail;

··private String phoneNumber;

··@Min(value = 18, message = "Покупатель слишком молод. Ему должно быть больше {value} лет")

··Private Integer age;

··// Конструкторы, геттеры, сеттеры

}

Контекст ConstraintValidator

Итак, мы убедились, что классы реализации ограничений должны реализовывать ConstraintValidator и, следовательно, определять собственный метод isValid. Сигнатура метода isValid принимает тип данных, к которому применяется ограничение, а также ConstraintValidationContext. Этот интерфейс инкапсулирует данные, относящиеся к тому контексту, в котором поставщик выполняет валидацию компонентов. В табл. 3.3 перечислены методы, определяемые в интерфейсе javax.validation.ConstraintValidatorContext.

Таблица 3.3. Методы интерфейса ConstraintValidationContext