Java 参数校验模块

原创

mob64ca12f7ae31 2024-05-12 06:56:30 ©著作权

©著作权归作者所有：来自51CTO博客作者mob64ca12f7ae31的原创作品，请联系作者获取转载授权，否则将追究法律责任

实现Java参数校验模块指南

一、整体流程

下面是实现Java参数校验模块的步骤：

步骤	描述
1	添加依赖库
2	创建校验注解
3	编写校验器
4	在Controller中使用校验注解

二、详细步骤

步骤1：添加依赖库

首先，在pom.xml文件中添加依赖库：

<!-- 参数校验模块依赖 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

这样我们就引入了Spring Boot的参数校验模块。

步骤2：创建校验注解

在需要校验参数的实体类字段上添加校验注解，例如@NotBlank、@Min等。下面是一个示例：

public class User {

    @NotBlank(message = "用户名不能为空")
    private String username;

    @Min(value = 18, message = "年龄必须大于等于18岁")
    private Integer age;

    // 省略getter和setter方法
}

步骤3：编写校验器

创建一个校验器类，用于实现参数校验逻辑。这里以UserValidator为例：

@Component
public class UserValidator implements Validator {

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

    @Override
    public void validate(Object target, Errors errors) {
        ValidationUtils.rejectIfEmptyOrWhitespace(errors, "username", "username.required", "用户名不能为空");
        User user = (User) target;
        if (user.getAge() < 18) {
            errors.rejectValue("age", "age.invalid", "年龄必须大于等于18岁");
        }
    }
}

步骤4：在Controller中使用校验注解

在Controller中使用@Valid注解来触发参数校验，同时在方法参数中添加BindingResult参数来接收校验结果。示例代码如下：

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

    @Autowired
    private UserValidator userValidator;

    @InitBinder
    protected void initBinder(WebDataBinder binder) {
        binder.setValidator(userValidator);
    }

    @PostMapping("/add")
    public String addUser(@Valid @RequestBody User user, BindingResult result) {
        if (result.hasErrors()) {
            // 校验不通过，返回错误信息
            return result.getFieldError().getDefaultMessage();
        }
        // 校验通过，继续业务逻辑处理
        return "用户添加成功";
    }
}

通过以上步骤，你就完成了Java参数校验模块的实现。