快捷導(dǎo)航

SpringBoot關(guān)于List集合的校驗方式

更新時間：2024年07月02日 16:50:17 作者：為什么要做囚徒

這篇文章主要介紹了SpringBoot關(guān)于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 // 這里是關(guān)鍵
    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 等）內(nèi)部的元素進行驗證，這可能導(dǎo)致在集合內(nèi)部存在不符合約束條件的元素時，驗證失效的問題。

解決方法

如果想要對集合內(nèi)部的元素進行驗證，可以結(jié)合使用 @Valid 注解和 @Validated 注解。

@Validated 注解是 Spring 提供的，它會啟用 Spring 的驗證機制，并且可以在集合上生效。

使用 @Validated 注解：在需要驗證的類上使用 @Validated 注解，以啟用 Spring 的驗證機制。
使用 @Valid 注解：在需要驗證的方法屬性集合上使用 @Valid 注解，以啟用集合內(nèi)部元素的驗證。

代碼示例：

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 注解用于對集合內(nèi)部的 User 對象進行驗證。

這樣，在請求體中的用戶列表元素會根據(jù) User 類中的約束條件進行驗證，從而確保集合內(nèi)部的元素也滿足約束條件。

請注意，如果你正在使用 Spring Boot，通常情況下它會自動啟用驗證機制。

在使用 @Valid 進行嵌套驗證時，要確保對內(nèi)部元素的約束條件也得到了正確的定義。