Обработка ошибки проверки бина

Как JAX-RS справляется с ошибкой проверки

Результатом ошибки проверки bean-компонента является ответ «400 Bad Request» от сервера. Давайте узнаем, как ответить клиенту более информативным ответом.

Два способа справиться с ошибками

Два способа сообщить клиенту о нарушениях целостности данных:

• Ответьте клиенту со списком проблемных полей в HTTP-заголовке пользовательской пары ключ-значение, и
• Используйте  тело ответа для инкапсуляции ответа об ошибке .

Оба метода имеют свои  плюсы и минусы . Выбор, который вы сделаете, будет зависеть от вашей бизнес-модели и требований клиентов. В любом случае вам нужно   хорошо документировать это, чтобы разработчик внешнего интерфейса знал,  как использовать ответ об ошибке .

Изучите Валидацию Бина с JAX-RS .

Заголовок HTTP пользовательской пары ключ-значение

Давайте посмотрим на первую технику.

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

Я буду использовать карту имен свойств и сообщение с подробным описанием причин сбоя проверки.

Реализуйте менеджер исключений

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

Исключение нарушения ограничений

ConstraintViolation  экземпляр  содержит много полезной информации о нарушении , например , как имя поля и сообщения нарушения. Мы можем использовать эту информацию, чтобы построить ответ клиенту. Для этого  извлеките имена полей и сообщения об ошибках , превратив набор в поток и собрав его на карту следующим образом.

final Map<String, String> errorResponse =
    exception.getConstraintViolations()
      .stream()
      .collect(Collectors.toMap(o -> o.getPropertyPath().toString(), o -> o.getMessage()));

return Response
         .status(Response.Status.BAD_REQUEST)
         .entity(new DataIntegrityValidation(errorResponse))
         .build();

{
  "errorResponse": {
  "entry": [{
      "key": "description",
      "value": "size must be between 100 and 2147483647"
    },
    {
      "key": "published",
      "value": "must be in the past"
    },
    {
      "key": "link",
      "value": "must match \"^(https?:\\/\\/)?([\\da-z\\.-]+)\\.([a-z\\.]{2,6})([\\/\\w \\.-]*)*\\/?$\""
    }]
 }
}

final String message = 
    exception
      .getConstraintViolations()
      .stream()
      .map(cv -> extractPropertyName(cv.getPropertyPath().toString()) + " : " + cv.getMessage())
      .collect(Collectors.joining(", "));

return Response
         .status(Response.Status.BAD_REQUEST)
         .header("X-Validation-Failure", message)
         .build();

link : must match "^(https?:\/\/)?([\da-z\.-]+)\.([a-z\.]{2,6})([\/\w \.-]*)*\/?$", 
published : must be in the past, 
description : size must be between 100 and 2147483647