返回

用final-validator实现springmvc参数验证

后端

轻松实现 SpringMVC 参数验证，告别数据困扰

在 SpringMVC 框架中，参数验证至关重要，它能确保请求参数的合法性，有效防止恶意攻击和数据污染。SpringMVC 内置了基本的参数校验功能，但对于更复杂的校验需求，我们需要借助第三方参数校验框架。

Final-validator：轻量级参数校验利器

Final-validator 是一款轻量级、易于使用的参数校验框架，提供丰富且灵活的校验规则和注解。它与 SpringMVC 框架无缝集成，让你轻松实现参数验证。

集成步骤

要将 Final-validator 集成到 SpringMVC 项目中，只需遵循以下步骤：

  1. 在 pom.xml 文件中添加 Final-validator 依赖：
<dependency>
  <groupId>com.github.lingkang-top</groupId>
  <artifactId>final-validator</artifactId>
  <version>1.0.0</version>
</dependency>
  1. 在 SpringMVC 配置文件中启用 Final-validator：
@Configuration
public class WebMvcConfigurerAdapter implements WebMvcConfigurer {

    @Override
    public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) {
        argumentResolvers.add(new FinalValidatorArgumentResolver());
    }

}
  1. 在控制器方法的参数上添加 Final-validator 的注解，如 @Validated，即可对请求参数进行校验。

自定义校验规则

Final-validator 支持自定义校验规则，以满足你的特定需求。只需实现 FinalValidator 接口并编写相应的校验逻辑即可。

例如，以下代码定义了校验用户名的自定义规则：

@Component
public class UsernameValidator implements FinalValidator<String> {

    @Override
    public void validate(String username, ValidationContext context) {
        if (username == null || username.isEmpty()) {
            context.addError("username", "用户名不能为空");
        }
    }

}

代码示例

以下代码示例展示了如何使用 Final-validator 对 SpringMVC 控制器的请求参数进行验证：

@PostMapping("/save")
public ResponseEntity<String> save(@RequestBody @Validated User user) {
    // ...
}

@Component
public class UserValidator implements FinalValidator<User> {

    @Override
    public void validate(User user, ValidationContext context) {
        // 校验用户名
        // ...

        // 校验密码
        // ...

        // 校验邮箱
        // ...
    }

}

总结

Final-validator 是一个轻量级、功能强大的参数校验框架，可与 SpringMVC 框架无缝集成。它提供了丰富的校验规则和注解，并支持自定义校验规则，让你轻松实现复杂的参数验证。

常见问题解答

  1. Final-validator 与 Hibernate-validator 有何区别？

    • Final-validator 是一个轻量级的参数校验框架，而 Hibernate-validator 提供了更丰富的校验规则和更复杂的校验机制。

  2. 是否需要在每个控制器方法中都添加 @Validated 注解？

    • 是的，只有在控制器方法的参数上添加 @Validated 注解，才能触发参数校验。

  3. 如何定义自定义校验规则？

    • 实现 FinalValidator 接口并编写相应的校验逻辑即可。

  4. 如何获取校验错误信息？

    • 可以通过 BindingResult 对象获取校验错误信息。

  5. Final-validator 是否支持级联校验？

    • 是的，Final-validator 支持级联校验，可以校验嵌套对象。