SpringMVC使用@Valid注解实现数据验证

王柳  金牌会员 | 2023-10-14 06:21:28 | 显示全部楼层 | 阅读模式
打印 上一主题 下一主题

主题 909|帖子 909|积分 2727

一、@Valid 注解的作用

  @Valid 注解是 javax.validation 包中的一个注解,它可以用来标注需要验证的数据对象。当一个带有 @Valid 注解的对象传递给 SpringMVC 的控制器方法时,SpringMVC 会自动调用验证器来验证这个对象。
二、数据验证的流程

SpringMVC 中的数据验证流程如下:

  • 客户端发起请求。
  • DispatcherServlet 接收到请求后,根据请求的 URL 映射到对应的 Controller。
  • Controller 中的方法接收到请求后,如果有需要验证的数据,就使用 @Valid 注解进行标注。
  • 如果数据验证失败,会抛出 MethodArgumentNotValidException 异常,SpringMVC 会自动将错误信息封装成 JSON 格式返回给客户端。
  • 如果数据验证通过,Controller 方法会继续执行。
三、如何使用 @Valid 注解

  在 SpringMVC 中,我们可以在 Controller 方法的参数中使用 @Valid 注解来标注需要验证的数据对象。例如:
  1. @RequestMapping("/user")
  2. public String addUser(@Valid User user, BindingResult result) {
  3.     if (result.hasErrors()) {
  4.         // 处理验证失败的情况
  5.     }
  6.     // 处理验证成功的情况
  7. }
复制代码
  在上面的例子中,我们使用 @Valid 注解标注了 User 对象,当这个对象传递给 addUser 方法时,SpringMVC 会自动调用验证器来验证这个对象。验证结果会被封装成一个 BindingResult 对象,我们可以通过它来获取验证结果。
四、数据验证的规则

  在使用 @Valid 注解进行数据验证时,我们需要定义验证规则。验证规则可以通过在对应的数据对象中添加 javax.validation.constraints 包中的注解来实现。例如,我们可以在 User 类中添加如下注解:
  1. public class User {
  2.     @NotNull(message = "用户名不能为空")
  3.     private String username;
  4.     @Size(min = 6, max = 20, message = "密码长度必须在 6 到 20 个字符之间")
  5.     private String password;
  6.     @Email(message = "邮箱格式不正确")
  7.     private String email;
  8.     // 省略 getter 和 setter 方法
  9. }
复制代码
  在上面的例子中,我们使用 @NotNull、@Size 和 @Email 注解来定义了用户名、密码和邮箱的验证规则。如果这些规则被违反了,验证器会自动将错误信息封装成 BindingResult 对象返回给客户端。
五、自定义验证规则

  除了使用 javax.validation.constraints 包中的注解来定义验证规则外,我们还可以自定义验证规则。自定义验证规则需要实现 ConstraintValidator 接口,例如:
  1. public class CheckCaseValidator implements ConstraintValidator<CheckCase, String> {
  2.     private CaseMode caseMode;
  3.     @Override
  4.     public void initialize(CheckCase constraintAnnotation) {
  5.         this.caseMode = constraintAnnotation.value();
  6.     }
  7.     @Override
  8.     public boolean isValid(String value, ConstraintValidatorContext context) {
  9.         if (value == null) {
  10.             return true;
  11.         }
  12.         if (caseMode == CaseMode.UPPER) {
  13.             return value.equals(value.toUpperCase());
  14.         } else {
  15.             return value.equals(value.toLowerCase());
  16.         }
  17.     }
  18. }
复制代码
  在上面的例子中,我们实现了一个 CheckCaseValidator 验证器,它可以用来验证一个字符串是否全是大写或全是小写。这个验证器需要使用 @CheckCase 注解来标注,例如:
  1. public class User {
  2.     @CheckCase(CaseMode.UPPER)
  3.     private String name;
  4.     // 省略 getter 和 setter 方法
  5. }
复制代码
  

免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作!
回复

使用道具 举报

0 个回复

倒序浏览

快速回复

您需要登录后才可以回帖 登录 or 立即注册

本版积分规则

王柳

金牌会员
这个人很懒什么都没写!

标签云

快速回复 返回顶部 返回列表