解决@Validated对List对象验证失效问题
作者:to方圆圆
文章指出@Validated注解无法验证List数组参数,建议手动逐项验证或封装List为对象进行验证,前者代码冗余但直接,后者需调整JSON结构但更简洁,根据需求选择方案,权衡灵活性与参数改造成本
@Validated对List对象验证失效
在实际开发中,常常会对接口api入参做格式验证,有些入参是List数组对象。
public ApiResponse receiveManualTranscoding(@Validated @RequestBody List<SdZmDto> sdZmDtos)
其实这样是失效的,会发现其SdZmDto并不会进行验证。
因为@Validated参数只能验证单个对象。
解决方法1
手动对每一个参数对象进行做验证,但是代码会显得冗余
private ResultVo validate(@Valid SdZmDto gwbaDto) { Set<ConstraintViolation<@Valid SdZmDto >> validateSet = Validation.buildDefaultValidatorFactory() .getValidator() .validate(gwbaDto); if (!CollectionUtils.isEmpty(validateSet)) { String messages = validateSet.stream() .map(ConstraintViolation::getMessage) .reduce((m1, m2) -> m1 + ";" + m2) .orElse("参数输入有误!"); return ResultVo.builder().code(ResultConstants.FALSE).message(SYSTEM_ERROR_TSBAMESSAGE + messages).build(); } return null; }
解决方法2
定义一个对象,将list封装进行,则验证就验证单个对象了。
@Data public class ValidList<E> implements List<E> { @Valid private List<E> list = new ArrayList<>(); } 将 public ApiResponse receiveManualTranscoding(@Validated @RequestBody List<SdZmDto> sdZmDtos) 改成 public ApiResponse receiveManualTranscoding(@Validated @RequestBody ValidList<SdZmDto> sdZmDtos)
选择方案
解决方法1虽然冗余代码,但是符合需求,如果采用方法2,则需要将请求的json参数进行做调整。
@PostMapping("/receiveManualTranscoding") @ResponseBody public ApiResponse receiveManualTranscoding(@RequestBody List<SdZmDto> sdZmDtos) { for(SdZmDto sdZmDto : sdZmDtos){ ApiResponse apiResponse = null; if((apiResponse = validate(sdZmDto)) != null){ return apiResponse; } } ajmApiService.receiveManualTranscoding(sdZmDtos); return ApiDataResponse.ofSuccess(); } private ApiResponse validate(@Valid SdZmDto sdZmDto) { Set<ConstraintViolation<@Valid SdZmDto >> validateSet = Validation.buildDefaultValidatorFactory() .getValidator() .validate(sdZmDto); if (!CollectionUtils.isEmpty(validateSet)) { String messages = validateSet.stream() .map(ConstraintViolation::getMessage) .reduce((m1, m2) -> m1 + ";" + m2) .orElse("参数输入有误!"); return ApiResponse.ofFail(messages); } return null; } ```
总结
以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。