具有自定义HTTP错误响应的自定义ConstraintValidator消息

Question

我正在努力裁剪javax。验证。ConstraintValidator和javax。验证。根据我的需要限制ValidatorContext。我从格式错误的请求正文收到的响应消息始终采用以下形状：

• <代码>

此消息也以500而不是400错误请求的形式返回。我无法获得工作到解决方案来执行以下操作：

1. 仅包括<代码>

我有以下代码：

import org.path.validation.ValidCreateThingRequest;
import org.path.service.ThingService;
// ... various other imports

  @PostMapping("/things")
  @ApiOperation(value = "Create a new thing")
  @ApiResponse(code = 201, message = "Newly created thing", response = Thing.class)
  @ResponseStatus(HttpStatus.CREATED)
  public ThingResponseProto createThing(
      @RequestBody @ValidCreateThingRequest final CreateThingRequestProto thingDto,
      final HttpServletRequest httpServletRequest) {
    final Context context = new RequestContext(httpServletRequest);
    final Thing createdThing = thingService.createThing(thingDto);
    return mapObjToProtoUtils.map(createdThing, ThingResponseProto.class);
  }

@Constraint(validatedBy = CreateThingRequestValidator.class)
@Target({ METHOD,PARAMETER })
@Retention(RUNTIME)
@Documented
public @interface ValidCreateThingRequest {
    String message() default "Request must be well-formed.";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};
}

public class CreateCodeRequestValidator
    implements ConstraintValidator<ValidCreateThingRequest, CreateThingRequestProto> {

  private static final Pattern FORBIDDEN_NAME_CHARACTERS_REGEX =
      Pattern.compile("[\\\\/\\t\\n\\r\\f?;]");

  @Override
  public void initialize(ValidCreateCodeRequest constraintAnnotation) {};

  @Override
  public boolean isValid(final CreateThingRequestProto thingDto, ConstraintValidatorContext context) {
    return isValidCharacters(thingDto, context)
        && isValidNameExists(thingDto, context)
  }

  boolean isValidCharacters(final CreateThingRequestProto thingDto, ConstraintValidatorContext context) {
    final String name = thingDto.getName();

    if (FORBIDDEN_NAME_CHARACTERS_REGEX.matcher(name).find()) {
      context
          .buildConstraintViolationWithTemplate("Name must not contain forbidden characters.")
          .addConstraintViolation();
      return false;
    } else {
      return true;
    }
  }

  boolean isValidNameExists(final CreateThingRequestProto thingDto, ConstraintValidatorContext context) {
    final String name = thingDto.getName();

    if (name != null && !name.trim().isEmpty()) {
      context
          .buildConstraintViolationWithTemplate("Name must not be null or empty.")
          .addConstraintViolation();
      return false;
    } else {
      return true;
    }
  }
}

向上面的代码发送格式错误的有效负载将导致如下消息：

{
  error: "Internal Server Error",
  message: "createThing.thingDto: Request must be well-formed., createThing.thingDto: Name must not be null or empty.",
  path: "/things"
  status: 500
  timestamp: 1607110364124
}

我希望能够收到以下信息：

{
  error: "Bad Request",
  message: "Name must not be null or empty.",
  path: "/things"
  status: 400
  timestamp: 1607110364124
}

基于buildConstraintViolationWithTemplate（），这可能吗？？

Answer 1

也许你可以使用@ControlllerAdments注释，比如

@ControllerAdvice
public class ConstraintValidatorExceptionHandler {

    @ExceptionHandler(ConstraintViolationException.class)
    public void handleConstraintViolationException(ConstraintViolationException exception,
            ServletWebRequest webRequest) throws IOException {
        webRequest.getResponse().sendError(HttpStatus.BAD_REQUEST.value(), exception.getMessage());
    }
}