Springboot项目javax.validation使用方法详解包含组合bean和list特殊情况无法使用

最新推荐文章于 2024-08-14 23:15:50 发布

Angus博客

最新推荐文章于 2024-08-14 23:15:50 发布

阅读量5.6k

点赞数 3

分类专栏： J2EE java 文章标签： validation

本文链接：https://blog.csdn.net/onceing/article/details/110119877

版权

J2EE 同时被 2 个专栏收录

25 篇文章 0 订阅

订阅专栏

java

11 篇文章 0 订阅

订阅专栏

javax.validation 是基于JSR-303标准开发出来的，使用注解方式实现，及其方便，但是这只是一个接口，没有具体实现。

Hibernate-Validator是一个hibernate独立的包，可以直接引用，他实现了javax.validation同时有做了扩展，比较强大。SpringBoot在内部集成了hibernate-validation，可以直接使用。

常用注解：

代码	说明
@Null	被注解的元素必须为null
@NotNull	被注解的元素必须不为null
@AssertTrue	被注解的元素必须为true
@AssertFalse	被注解的元素必须为false
@Min(value)	被注解的元素必须为数字，其值必须大于等于最小值
@Max(value)	被注解的元素必须为数字，其值必须小于等于最小值
@Size(max,min)	被注解的元素的大小必须在指定范围内
@Past	被注解的元素必须为过去的一个时间
@Future	被注解的元素必须为未来的一个时间
@Pattern	被注解的元素必须符合指定的正则表达式

bean

package me.yanand.pojo;
import javax.validation.constraints.Max;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;
public class User {
  @NotBlank(message = "姓名不能为空")
  private String name;
  @NotNull(message = "年龄不能为空")
  @Max(value = 100,message = "年龄太大")
  private Integer age;
  public String getName() {
    return name;
  }
  public void setName(String name) {
    this.name = name;
  }
  public Integer getAge() {
    return age;
  }
  public void setAge(Integer age) {
    this.age = age;
  }

controller

package me.yanand.controller;
import me.yanand.pojo.User;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.validation.Valid;
@RestController
public class TestController {
  @RequestMapping("/")
  String hello(@RequestBody @Valid User user, BindingResult bindingResult){
    if(bindingResult.hasErrors()){
      return bindingResult.getFieldError().getDefaultMessage();
    }
    return "ok";
  }
}

postman请求

@Valid 和 BindingResult 是一一对应的，如果有多个@Valid，那么每个@Valid后面跟着的BindingResult就是这个@Valid的验证结果，顺序不能乱

以上是基础实现参考的脚本之家代码文章地址 https://www.jb51.net/article/185660.htm

然后特殊情况比如，多个bean组合的DTO，或者list存储的bean 发现@Valid失效了，无法起到作用，查询文章发现有多种方式可以实现

方法1：对List进行Wrapper

既然List不是JavaBean，那我们就把它封装成JavaBean，我们定义一个ListWrapper类如下：

package com.wyq.firstdemo.util;
 
import lombok.Getter;
import lombok.Setter;
 
import javax.validation.Valid;
import java.util.ArrayList;
import java.util.List;
 
@Setter
@Getter
public class ListWrapper<E> {
    @Valid
    private List<E> list;
 
    public ListWrapper() {
        list = new ArrayList<>();
    }
 
    public  ListWrapper(List<E> list) {
        this.list = list;
    }
 
}

同时修改一下controller对应的方法：

    // 使用包装类对list进行验证
    @PostMapping("/insert/all")
    public ServerResponse<String> insertList(@Valid @RequestBody ListWrapper<UserEntity> listWrapper, BindingResult bindingResult) {
        if(bindingResult.hasErrors()) {
            log.error(bindingResult.getFieldError().toString());
            return ServerResponse.createByErrorMessage(bindingResult.getFieldError().getDefaultMessage());
        }
 
        userService.insertList(listWrapper.getList());
        return ServerResponse.createBySuccess();
    }

这样相当于把list做了一层封装，，，。。。

方法2：使用@Validated+@Valid

在controller类上面增加@Validated注解，并且删除方法参数中的BindingResult bindingResult（因为这个参数已经没有用了，异常统一有controller返回了）

然后我们运行一下测试一下

可以看到可以对参数进行校验了，但还还有一个问题，那就是这个不是我们想要的返回格式，它controller自己返回的格式，所以我们需要做一个统一异常处理。这个不做过多解释

方法3：自定义一个List

先上代码后说明，先定义一个ValidList

package com.wyq.firstdemo.util;
 
 
import javax.validation.Valid;
import java.util.*;
 
public class ValidList<E> implements List<E> {
 
    @Valid
    private List<E> list;
 
    public ValidList() {
        this.list = new ArrayList<>();
    }
 
    public ValidList(List<E> list) {
        this.list = list;
    }
 
    public List<E> getList() {
        return list;
    }
 
    public void setList(List<E> list) {
        this.list = list;
    }
 
    @Override
    public int size() {
        return list.size();
    }
 
    @Override
    public boolean isEmpty() {
        return list.isEmpty();
    }
 
    ...
 
}

对比方法3和方法1，有没有觉得代码有点相似，新建一个类，并且让他实现List接口，使这个类即具有了JavaBean的特性，又具有了List的特性，比方法1简单优雅很多。

只需要把List换成ValidList就可以了，还不需要多统一异常处理。