首页 > 软件编程 > java > SpringBoot List集合的校验

SpringBoot关于List集合的校验方式

2024-07-02 16:50:18 作者：为什么要做囚徒

这篇文章主要介绍了SpringBoot关于List集合的校验方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教

SpringBoot List集合的校验

List集合失效的校验

    @PostMapping("saveBatch")
    @ApiOperation("批量保存")
    @LogOperation("批量保存")
    public Result saveBatch(@RequestBody @Validated List<ResultFieldDTO> list) {
        resultFieldService.saveBatch(list);
        return Result.ok();
    }

针对List集合的校验有两种方案

第一种方案

重新定义一个集合ValidList，需继承集合List，并且定义一个List集合属性，并添加@Valid注解

@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);
    }

}

集合的校验则变成如下方式

	@PostMapping("saveBatch")
    @ApiOperation("批量保存")
    @LogOperation("批量保存")
    public Result saveBatch(@RequestBody @Validated ValidList<ResultFieldDTO> list) {
        resultFieldService.saveBatch(list);
        return Result.ok();
    }

第二种方案

controller上添加@Validated

@RestController
@RequestMapping("search")
@Validated
public class ResultFieldController {
......
}

则集合校验变成如下方式

	@PostMapping("saveBatch")
    @ApiOperation("批量保存")
    @LogOperation("批量保存")
    public Result saveBatch(@RequestBody @Valid List<ResultFieldDTO> list) {
        resultFieldService.saveBatch(list);
        return Result.ok();
    }

@Valid对List校验失效问题

失效原因

@Valid 注解用于验证对象的属性值是否满足指定的约束条件。

然而，@Valid 注解默认不会对集合（如 List、Set 等）内部的元素进行验证，这可能导致在集合内部存在不符合约束条件的元素时，验证失效的问题。

解决方法

如果想要对集合内部的元素进行验证，可以结合使用 @Valid 注解和 @Validated 注解。

@Validated 注解是 Spring 提供的，它会启用 Spring 的验证机制，并且可以在集合上生效。

使用 @Validated 注解：在需要验证的类上使用 @Validated 注解，以启用 Spring 的验证机制。
使用 @Valid 注解：在需要验证的方法属性集合上使用 @Valid 注解，以启用集合内部元素的验证。

代码示例：

import org.springframework.validation.annotation.Validated;

@RestController
@Validated
public class UserController {

    @PostMapping("/users")
    public ResponseEntity<String> createUser(@Valid @RequestBody List<User> users) {
        // 处理用户列表
        return ResponseEntity.ok("Users created successfully");
    }
}

在上述示例中，@Validated 注解用于启用 Spring 的验证机制，而 @Valid 注解用于对集合内部的 User 对象进行验证。

这样，在请求体中的用户列表元素会根据 User 类中的约束条件进行验证，从而确保集合内部的元素也满足约束条件。

请注意，如果你正在使用 Spring Boot，通常情况下它会自动启用验证机制。

在使用 @Valid 进行嵌套验证时，要确保对内部元素的约束条件也得到了正确的定义。

总结

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。