统一参数校验

news2024/11/26 8:51:05

使用注解，统一参数校验

我们在实际的开发过程中经常会遇到需要对参数进行校验的情况，比如在需要用户输入手机号的时候他是不是真的输入了一个合法的手机号，在需要用户输入一个邮箱的时候他是不是真的输入了一个合法的邮箱，用户输入的内容是不是超出了长度限制等等。

当一个表单的数据较多的时候，单纯的数据校验代码就会占到很大的幅度，所以简化基础数据的校验可以省去我们很多的工作，让我们能更专注于功能的实现。

接下来我们一起看一下 springboot中参数校验（validation）的使用，首先导入依赖

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

Validator可以非常方便的制定校验规则，并自动帮你完成校验。首先在入参里需要校验的字段加上注解,每个注解对应不同的校验规则，并可制定校验失败后的信息：

public class User {
    
    private String userId;

    @NotNull(message = "username 不能为空")
    private String username;
}

校验规则和错误提示信息配置完毕后，接下来只需要在接口需要校验的参数上加上@Validated注解，并添加BindResult参数即可方便完成验证：

@RestController
@RequestMapping("/user")
public class UserController {

    @RequestMapping("/addUser")
    public BaseResponse addUser(@Validated User user, BindingResult bindingResult){

        List<FieldError> fieldErrors = bindingResult.getFieldErrors();

        //如果参数校验失败，会将错误信息封装成对象组装在 BindingResult
        if(!fieldErrors.isEmpty()){
            return BaseResponse.fail(fieldErrors.get(0).getDefaultMessage());
        }

        return BaseResponse.success("OK");
    }
}

测试

http://localhost:8888/user/addUser?username="tom"
{
 "code": "500",
 "message": "userId 不能为空",
 "data": null
}
http://localhost:8888/user/addUser?username="tom"&userId=1
{
 "code": "200",
 "message": "操作成功",
 "data": "OK"
}