SpringBoot 请求参数验证

ゞ浴缸里的玫瑰 2024-03-31 14:12 100阅读 0赞

参考：https://blog.csdn.net/Ma\_\_CC/article/details/118927186  
controller层参数校验

在controller层的参数校验可以分为两种场景：  
**单个参数校验**

当处理GET请求时或只传入少量参数的时候，我们可能不会建一个bean来接收这些参数，就可以像上面这样直接在controller方法的参数中进行校验。  
注意：这里一定要在方法所在的controller类上加入@Validated注解，不然没有任何效果。

@RestController
    @Validated
    public class PingController {
        
    
    @GetMapping("/getUser")
    public String getUserStr(@NotNull(message = "name 不能为空") String name,
                             @Max(value = 99, message = "不能大于99岁") Integer age) {
        
        return "name: " + name + " ,age:" + age;
    }

实体类参数校验

### GET请求 ###

在方法参数中使用验证注解，与@RequsetParam注解同时使用，注意类上使用@Validated

@Slf4j
    @RestController
    @RequestMapping(ServersConstant.OPEN)
    @Validated
    public class CreateTogetherController extends BaseController {
        
    	@GetMapping(value = "/update")
        public Result updateProjectName(@RequestParam(value = "app_id") @NotNull(message = "app_id 不能为空！") String appId,
                                        @RequestParam(value = "timestamp") @NotNull(message = "时间戳 不能为空！") Long timestamp,
                                        @RequestParam(value = "signature") @NotNull(message = "签名 不能为空！") String signature,
                                        @RequestParam(value = "survey_sn") @NotBlank(message = "问卷编号 不能为空！") String surveySn,
                                        @RequestParam(value = "project_name") @NotBlank(message = "问卷名称 不能为空！") String projectName) {
        
            // 修改问卷
            Boolean result = true;
            // 权限范围：通过敏捷共创模块创建的问卷 `create_source = 2`
            return Result.status(HttpStatus.OK).message(result ? "修改成功" : "修改失败");
        }
    }

异常的捕获

/**
         * 验证异常
         *
         * @param e e
         * @return {@link Result }
         * @author ZhaoYingJie
         * @date 2022-12-02 15:06:25
         */
        @ExceptionHandler(ValidationException.class)
        @ResponseBody
        @ResponseStatus(value = HttpStatus.BAD_REQUEST)
        public Result validationException(ValidationException e) {
        
    
            List<String> msgList = new ArrayList<>();
            for (ConstraintViolation<?> constraintViolation : ((ConstraintViolationException) e).getConstraintViolations()) {
        
                msgList.add(constraintViolation.getMessage());
            }
            String messages = StringUtils.join(msgList.toArray(), "；");
    
            return Result.status(HttpStatus.BAD_REQUEST, messages);
        }