掌握SpringBoot接口参数校验，让后端开发更轻松！

后端

2023-11-02 15:39:34

提升后端开发体验：掌握SpringBoot高效参数校验

在现代后端开发中，确保传入API数据的有效性和一致性至关重要。SpringBoot提供了一套强大的注解和工具类，使接口参数校验变得轻而易举。

参数校验的意义

参数校验如同关卡守卫，在数据传递至后端之前检查其合法性和有效性。这可以防止无效或非法数据进入系统，有效降低故障风险并提高代码的可维护性。

SpringBoot中的参数校验注解

SpringBoot提供了丰富的注解来简化参数校验，包括：

@RequestParam： 用于校验请求参数，支持类型转换和格式校验。

@GetMapping("/user")
public User getUser(@RequestParam(name = "id", required = true) Long id) {
    // 校验参数id是否为必需且为Long类型
}

@PathVariable： 用于校验请求路径中的参数，与@RequestParam类似。

@GetMapping("/user/{id}")
public User getUser(@PathVariable(name = "id", required = true) Long id) {
    // 校验路径变量id是否为必需且为Long类型
}

@RequestBody： 用于校验请求体中的参数，支持复杂对象的类型转换和格式校验。

@PostMapping("/user")
public User createUser(@RequestBody User user) {
    // 校验请求体中User对象是否有效
}

自定义参数校验规则

除了内置注解，SpringBoot还提供Validator和BindingResult等工具类，允许自定义参数校验规则。这为复杂校验需求提供了极大的灵活性。

public class UserValidator implements Validator {
    @Override
    public boolean supports(Class<?> clazz) {
        return User.class.equals(clazz);
    }

    @Override
    public void validate(Object target, Errors errors) {
        User user = (User) target;
        if (user.getName() == null || user.getName().isEmpty()) {
            errors.rejectValue("name", "user.name.empty", "姓名不能为空");
        }
    }
}

实践示例

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

    @GetMapping
    public User getUser(@RequestParam(name = "id", required = true) Long id) {
        // 使用@RequestParam进行参数校验
        return userService.getUser(id);
    }

    @PostMapping
    public User createUser(@RequestBody User user, BindingResult bindingResult) {
        // 使用@RequestBody进行参数校验
        if (bindingResult.hasErrors()) {
            // 返回校验错误信息
            return null;
        }
        return userService.createUser(user);
    }
}