如何在 Spring Boot Data Rest 控制器中以 RFC-7807 格式返回验证错误？

Question

我有一个 Spring 存储库，

@RepositoryRestResource
public interface MongoIntegrationTokenRepository extends MongoRepository<IntegrationToken, String>, CrudRepository<IntegrationToken, String> {}

我添加了验证配置以添加验证支持，并且我的实体具有验证注释：

@Configuration
class MyRestMvcConfiguration implements RepositoryRestConfigurer {

    private final LocalValidatorFactoryBean localValidatorFactoryBean;

    @Autowired
    public MyRestMvcConfiguration(LocalValidatorFactoryBean localValidatorFactoryBean) {
        this.localValidatorFactoryBean = localValidatorFactoryBean;
    }

    @Override
    public void configureValidatingRepositoryEventListener(
            ValidatingRepositoryEventListener validatingRepositoryEventListener) {
        validatingRepositoryEventListener.addValidator("beforeCreate", localValidatorFactoryBean);
        validatingRepositoryEventListener.addValidator("beforeSave", localValidatorFactoryBean);
        validatingRepositoryEventListener.addValidator("beforeSave", localValidatorFactoryBean);
    }
}

运行创建操作时，如果存在任何验证错误，实体创建将失败，但 JSON 响应不包含任何内容错误详细信息。

使用无效数据发送到我的端点只会返回：

{
  "message": "Server Error",
  "details": [
    "Validation failed"
  ]
}

我想返回 中的验证错误RFC7807 格式。 应该可以通过 Spring HATEOAS 或 Zalando 的这个流行库实现 https://github.com/zalando/problem-spring-web 但是我不确定它们需要如何连接或应该使用哪种方法。

Answer 1

在 Spring 6 和 Spring Boot 3 中，现在无需使用额外的库就可以实现这一点。

您可以返回 ProblemDetail

@RestControllerAdvice
public class GlobalExceptionHandler extends ResponseEntityExceptionHandler {

    @ExceptionHandler(BookmarkNotFoundException.class)
    ProblemDetail handleBookmarkNotFoundException(BookmarkNotFoundException e) {
        ProblemDetail problemDetail = ProblemDetail.forStatusAndDetail(HttpStatus.NOT_FOUND, e.getMessage());
        problemDetail.setTitle("Bookmark Not Found");
        problemDetail.setType(URI.create("https://api.bookmarks.com/errors/not-found"));
        problemDetail.setProperty("errorCategory", "Generic");
        problemDetail.setProperty("timestamp", Instant.now());
        return problemDetail;
    }
}

或 ErrorResponse

@RestControllerAdvice
public class GlobalExceptionHandler extends ResponseEntityExceptionHandler {

    @ExceptionHandler(BookmarkNotFoundException.class)
    ErrorResponse handleBookmarkNotFoundException(BookmarkNotFoundException e) {
        return ErrorResponse.builder(e, HttpStatus.NOT_FOUND, e.getMessage())
                .title("Bookmark not found")
                .type(URI.create("https://api.bookmarks.com/errors/not-found"))
                .property("errorCategory", "Generic")
                .property("timestamp", Instant.now())
                .build();
    }
}

如果您不需要自定义错误处理，似乎您也可以在 application.properties 中激活 ProblemDetails：

spring.mvc.problemdetails.enabled=true

获取信息和示例来自这篇文章： https://www.sivalabs.in/spring-boot-3-error-reporting-using-problem-details/

Answer 2

我在 Github 上找到了这个孤独的例子。 https://github.com/marciovmartins/problem-spring-web-starter-expanded/blob/aed5825c958fad93f4aaad022689958926cf3b4a/src/main/kotlin/com/github/marciovmartins/problem/spring/web/expanded/ProblemExceptionHandler.kt 并将其重写为爪哇。这似乎可以做到。

import java.util.List;
import java.util.stream.Collectors;

import org.springframework.data.rest.core.RepositoryConstraintViolationException;
import org.springframework.http.ResponseEntity;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.context.request.NativeWebRequest;
import org.zalando.problem.Problem;
import org.zalando.problem.ThrowableProblem;
import org.zalando.problem.spring.web.advice.ProblemHandling;
import org.zalando.problem.violations.Violation;

@ControllerAdvice
public class ProblemControllerAdvice implements ProblemHandling {

    @ExceptionHandler
    public ResponseEntity<Problem> handleRepositoryConstraintViolationException(RepositoryConstraintViolationException exception, NativeWebRequest request) {
        List<Violation> violationList = exception.getErrors().getAllErrors()
                .stream()
                .map(objectError -> {
                    if (objectError instanceof FieldError) {
                        return new Violation(((FieldError) objectError).getField(), objectError.getDefaultMessage());
                    }
                    return new Violation(null, objectError.getDefaultMessage());
                })
                .collect(Collectors.toList());

        ThrowableProblem problem = Problem.builder()
                .withTitle("Constraint Violation")
                .withStatus(defaultConstraintViolationStatus())
                .with("violations", violationList)
                .build();
        return create(problem, request);
    }

}