java - spring boot中入参校验的疑问?

Question

1.spring boot 版本: v2.7.14-SNAPSHOT

2. @RestController

3. maven:

        <dependency>         <groupId>org.springframework.boot</groupId>         <artifactId>spring-boot-starter-validation</artifactId>     </dependency>

问题描述:
我的接口有get和post两个类型, 其中post使用的是如下:

postApiMethod(@RequestBody @Valid TopicCreateDto topicCreateDto)

然后在dto中写类似 @NotNull 的注解是生效的(我捕获了MethodArgumentNotValidException异常), 生成的结果类似:

校验失败:parentId：不能为null, 

但是我的GET接口我做了如下工作:

1. controller类上面 添加 @Validated
2. postApiGet(@RequestParam Long feedId)

不符合我预期的结果:

Required request parameter 'feedId' for method parameter type Long is not present

我想要的结果是:

校验失败:feedId：不能为null,

其他尝试:

postApiGet(@RequestParam @NotNull Long feedId),也提示为不符合预期的结果

所以我该如何让检验结果统一成这样的结果格式(xxx不能为null类似)呢?

Answer 1

在Spring Boot中，对于GET请求和POST请求的参数校验，处理方式是有差异的。对于GET请求的参数校验，Spring Boot默认会在请求参数缺失时直接报错，而不会触发校验异常。这是因为在GET请求中，请求参数是直接作为URL的一部分，而不像POST请求一样在请求体中，所以无法使用@RequestBody注解来触发校验。

如果你希望在GET请求的参数校验时也能像POST请求一样触发校验异常并返回统一的错误格式，可以使用自定义的校验器和异常处理器来实现。下面是一种可能的解决方案：

自定义校验器：创建一个自定义的校验器，在该校验器中添加对GET请求参数的校验逻辑。这样，无论是GET还是POST请求，在参数校验失败时都会触发校验异常。
java
Copy code
import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({ElementType.PARAMETER, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = {NotNullValidator.class})
@Documented
public @interface NotNullParam {

String message() default "{javax.validation.constraints.NotNull.message}";Class<?>[] groups() default {};Class<? extends Payload>[] payload() default {};

}
自定义校验器的实现：实现自定义校验器的逻辑，对GET请求的参数进行校验。这里以非空校验为例。
java
Copy code
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

public class NotNullValidator implements ConstraintValidator<NotNullParam, Object> {

@Overridepublic boolean isValid(Object value, ConstraintValidatorContext context) {    return value != null;}

}
异常处理器：定义一个全局异常处理器，在该处理器中捕获校验异常，并返回统一的错误格式。
java
Copy code
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.validation.BindException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

@RestControllerAdvice
public class GlobalExceptionHandler {

@ExceptionHandler(BindException.class)public ResponseEntity<Object> handleValidationException(BindException ex) {    String errorMessage = ex.getFieldError().getDefaultMessage();    return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(errorMessage);}

}
以上是一种解决方案，通过自定义校验器和异常处理器，可以实现在GET请求和POST请求中统一处理参数校验异常并返回统一的错误格式。请注意在实际使用时根据自己的业务逻辑进行适当调整。

Answer 2

把GET请求的参数封装成一个对象，然后在这个对象的类上加JSR-303注解进行校验就行：

@GetMapping("/api")public String apiGet(@Valid ApiGetRequest request) {    // ...}public class ApiGetRequest {    @NotNull    private Long feedId;    // getters and setters}

然后再自定义一个全局的异常处理器：

@ControllerAdvicepublic class GlobalExceptionHandler {    @ExceptionHandler(MissingServletRequestParameterException.class)    @ResponseBody    public String handleMissingParams(MissingServletRequestParameterException ex) {        String name = ex.getParameterName();        // 格式化返回的错误信息        return "校验失败:" + name + "：不能为null";    }}