@Validated对单个实体类与List集合的验证

@Validated对单个实体类与List集合的验证

做过实体类参数校验的都知道,用@Validated注解可以很很方便的将实体类中的属性根据定义好的规则进行校验。然而今天我遇到了一个问题:我发现@Validated只能验证单个实体类,对List集合则不生效?

image.png


经研究发现,这个问题其实是可以解决的,下面记录一下。

@PutMapping("/")
@ApiOperation("修改数据")
@ControllerLog(actionType = ActionTypeIndex.UPDATE, module = "01-09")
@ApiResponses({ @ApiResponse(code = 0, message = "ok", response = JsonResult.class)})
public JsonResult updateReportByTime(@Validated @RequestBody List<KeyStationUpdateVO> list) {
	reservoirService.updateReportByTime(list);
	return JsonResult.success();
}

这段代码,参数中是List集合,在做参数校验时,并不生效。查网上资料得知,@Valid可以解决这个问题。需要我们自己定义个ValidList类来替换List,就可以达到目的。下面给出ValidList类代码:

package com.huaweisoft.app.report.model;

import lombok.Data;

import javax.validation.Valid;
import java.util.*;

/**
 * @DESCRIPTION: 校验List中字段属性
 * @USER: huyk
 * @DATE: 2020/11/24 16:00
 */
@Data
public class ValidList<E> implements List<E> {

    @Valid
    private List<E> list = new ArrayList<>();

    @Override
    public int size() {
        return list.size();
    }

    @Override
    public boolean isEmpty() {
        return list.isEmpty();
    }

    @Override
    public boolean contains(Object o) {
        return list.contains(o);
    }

    @Override
    public Iterator<E> iterator() {
        return list.iterator();
    }

    @Override
    public Object[] toArray() {
        return list.toArray();
    }

    @Override
    public <T> T[] toArray(T[] a) {
        return list.toArray(a);
    }

    @Override
    public boolean add(E e) {
        return list.add(e);
    }

    @Override
    public boolean remove(Object o) {
        return list.remove(o);
    }

    @Override
    public boolean containsAll(Collection<?> c) {
        return list.containsAll(c);
    }

    @Override
    public boolean addAll(Collection<? extends E> c) {
        return list.addAll(c);
    }

    @Override
    public boolean addAll(int index, Collection<? extends E> c) {
        return list.addAll(index, c);
    }

    @Override
    public boolean removeAll(Collection<?> c) {
        return list.removeAll(c);
    }

    @Override
    public boolean retainAll(Collection<?> c) {
        return list.retainAll(c);
    }

    @Override
    public void clear() {
        list.clear();
    }

    @Override
    public E get(int index) {
        return list.get(index);
    }

    @Override
    public E set(int index, E element) {
        return list.set(index, element);
    }

    @Override
    public void add(int index, E element) {
        list.add(index, element);
    }

    @Override
    public E remove(int index) {
        return list.remove(index);
    }

    @Override
    public int indexOf(Object o) {
        return list.indexOf(o);
    }

    @Override
    public int lastIndexOf(Object o) {
        return list.lastIndexOf(o);
    }

    @Override
    public ListIterator<E> listIterator() {
        return list.listIterator();
    }

    @Override
    public ListIterator<E> listIterator(int index) {
        return list.listIterator(index);
    }

    @Override
    public List<E> subList(int fromIndex, int toIndex) {
        return list.subList(fromIndex, toIndex);
    }
}

就是在该类中定义一个List,该类实现List的方法,方法中还都是List的实现,只是在类中new 的list上加了@Valid注解就可以了。剩下的就是将方法中参数List改为自己定义的ValidList就可以实现验证了。

@PutMapping("/")
@ApiOperation("修改数据")
@ControllerLog(actionType = ActionTypeIndex.UPDATE, module = "01-09")
@ApiResponses({ @ApiResponse(code = 0, message = "ok", response = JsonResult.class)})
public JsonResult updateReportByTime(@Validated @RequestBody ValidList<KeyStationUpdateVO> list) {
	reservoirService.updateReportByTime(list);
	return JsonResult.success();
}

其他的与验证单个实体类的操作一样。

@Valid嵌套校验

上述案例就是一个嵌套校验,在一待校验的pojo类中,包含了待验证的对象,需要在待验证的对象上注解@Valid,才能验证待验证对象中的成员属性,这里不能使用@Validated。

@Valid与@Validated注解位置上的区别

@Valid:用在方法、构造函数、方法参数和成员属性(field)上。
@Validated:用在类型、方法和方法参数上。但不能用在成员属性上,用在成员属性上会报错。

其他注解的含义

  • @Null:限制只能为null
  • @NotNUll:限制必须不为null
  • @AssertFalse:限制必须为false
  • @AssertTrue:限制必须为true
  • @DecimalMax(value):限制必须为一个不大于指定值的数字
  • @DecimalMin(value):限制必须为一个不小于指定的数字
  • @Digits(integer,fraction):限制必须为一个小数,且整数部分的位数不能超过integer,小数部分的位数不能超过fraction
  • @Future:限制必须是一个将来的日期
  • @Max(value):限制必须为一个不大于指定值的数字
  • @Min(value):限制必须为一个不小于指定值的数字
  • @Past:限制必须是一个过去的日期
  • @Pattern(value):限制必须符合指定的正则表达式
  • @Size(max,min):限制字符串长度必须在min到max之间
  • @NotEmpty:验证注解的元素值不为null且不为空(字符串长度不为0,集合大小不为0)
  • @NotBlank:验证注解的元素值不为空(不为null,去除首尾空格长度为0),不同于@NotEmpty,@NotBlank只应用与字符串且在比较时会去除字符串的空格。
  • @Email:验证注解的元素值是Email,也可以通过正则表达式和flag指定自定义的email格式

参考:https://www.it610.com/article/1293218839819001856.htm

Copyright: 采用 知识共享署名4.0 国际许可协议进行许可

Links: https://www.keikei.vip/archives/validated对单个实体类与list集合的验证