快捷導(dǎo)航

使用@Validated注解異常信息的處理方式

更新時(shí)間：2025年07月31日 09:01:03 作者：艾默絲

本文優(yōu)化Spring @Validated參數(shù)校驗(yàn)異常信息,通過(guò)MethodArgumentNotValidException和BindingResult提取關(guān)鍵錯(cuò)誤,使用@RestControllerAdvice實(shí)現(xiàn)統(tǒng)一異常處理,提升錯(cuò)誤信息簡(jiǎn)潔性及代碼可維護(hù)性

使用@Validated注解異常信息的處理

我在使用spring提供的注解@Validated進(jìn)行參數(shù)校驗(yàn)時(shí)，發(fā)現(xiàn)默認(rèn)的異常有點(diǎn)過(guò)于雜亂，本文就對(duì)這個(gè)問(wèn)題優(yōu)化一下。

首先是接收參數(shù)的dto

StoreItemInfoDto .java

@Data
@AllArgsConstructor
@NoArgsConstructor
public class StoreItemInfoDto {
    @Field(name = "二維碼中心-批次id")
    @NotNull(message = "centerRecordId為空，請(qǐng)檢查")
    private Integer centerRecordId;
}

//接收請(qǐng)求的方法
MultiResponse<CodeInfoItemVo> queryCodeInfos(@Validated @RequestBody(required = true) StoreItemInfoDto storeItemInfoDto);

請(qǐng)求參數(shù)校驗(yàn)失敗

我發(fā)現(xiàn)返回的信息過(guò)于雜亂且長(zhǎng)，其實(shí)只需要最后“[ ]”里面的信息，今天就來(lái)對(duì)這個(gè)異常優(yōu)化一下。

解決方案

寫(xiě)一個(gè)spring的統(tǒng)一異常處理，使用@ExceptionHandler注解標(biāo)注，通過(guò)字符串截取“[ ]”里面的信息就可以

這樣返回的錯(cuò)誤信息就簡(jiǎn)潔明了

今天又發(fā)現(xiàn)了一個(gè)更為簡(jiǎn)潔的寫(xiě)法，這里用到MethodArgumentNotValidException異常類(lèi)，查看其源碼，它對(duì)exception拋出的異常先進(jìn)行了處理，而且它將校驗(yàn)信息封裝到了BindingResult對(duì)象里面，我們可以直接根據(jù)getFieldErrors()方法拿到校驗(yàn)不通過(guò)的信息；

MethodArgumentNotValidException.java

public class MethodArgumentNotValidException extends Exception {
    private final MethodParameter parameter;
    private final BindingResult bindingResult;

    public MethodArgumentNotValidException(MethodParameter parameter, BindingResult bindingResult) {
        this.parameter = parameter;
        this.bindingResult = bindingResult;
    }

    public MethodParameter getParameter() {
        return this.parameter;
    }

    public BindingResult getBindingResult() {
        return this.bindingResult;
    }
	//這里對(duì)異常進(jìn)行了封裝
    public String getMessage() {
        StringBuilder sb = (new StringBuilder("Validation failed for argument [")).append(this.parameter.getParameterIndex()).append("] in ").append(this.parameter.getExecutable().toGenericString());
        if (this.bindingResult.getErrorCount() > 1) {
            sb.append(" with ").append(this.bindingResult.getErrorCount()).append(" errors");
        }

        sb.append(": ");
        Iterator var2 = this.bindingResult.getAllErrors().iterator();

        while(var2.hasNext()) {
            ObjectError error = (ObjectError)var2.next();
            sb.append("[").append(error).append("] ");
        }

        return sb.toString();
    }
}

基于MethodArgumentNotValidException這個(gè)類(lèi)我們可以把方法改寫(xiě)為如下：

    @ExceptionHandler(MethodArgumentNotValidException.class)
    public SingleResponse<?> handlerException(MethodArgumentNotValidException e) {
        BindingResult bindingResult = e.getBindingResult();
        String errorMsg = bindingResult.getFieldErrors().stream().map(o -> o.getDefaultMessage()).collect(Collectors.joining(","));
        return SingleResponse.buildFailure(ResultCodeEnum.CONSTRAINT_VIOLATION_ERROR.getCode(), errorMsg);
    }

拓展

@RestControllerAdvice是一個(gè)組合注解，由@ControllerAdvice、@ResponseBody組成，而@ControllerAdvice繼承了@Component，因此@RestControllerAdvice本質(zhì)上是個(gè)Component，用于定義@ExceptionHandler，@InitBinder和@ModelAttribute方法，適用于所有使用@RequestMapping方法。

@RestControllerAdvice的特點(diǎn)：

1.通過(guò)@ControllerAdvice注解可以將對(duì)于控制器的全局配置放在同一個(gè)位置。
2.注解了@RestControllerAdvice的類(lèi)的方法可以使用@ExceptionHandler、@InitBinder、@ModelAttribute注解到方法上。
3.@RestControllerAdvice注解將作用在所有注解了@RequestMapping的控制器的方法上。
4.@ExceptionHandler：用于指定異常處理方法。當(dāng)與@RestControllerAdvice配合使用時(shí)，用于全局處理控制器里的異常。
5.@InitBinder：用來(lái)設(shè)置WebDataBinder，用于自動(dòng)綁定前臺(tái)請(qǐng)求參數(shù)到Model中。
6.@ModelAttribute：本來(lái)作用是綁定鍵值對(duì)到Model中，當(dāng)與@ControllerAdvice配合使用時(shí)，可以讓全局的@RequestMapping都能獲得在此處設(shè)置的鍵值對(duì)