關(guān)于BindingResult的使用總結(jié)及注意事項(xiàng)

更新時(shí)間：2021年12月02日 15:16:24 作者：啊~~噙！

這篇文章主要介紹了關(guān)于BindingResult的使用總結(jié)及注意事項(xiàng)，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教

BindingResult總結(jié)及注意事項(xiàng)

記一個(gè)簡(jiǎn)單又好用的API：BindingResult

BindingResult使用起來(lái)很簡(jiǎn)單，一般在controller中使用

作用：用于對(duì)前端穿進(jìn)來(lái)的參數(shù)進(jìn)行校驗(yàn)，省去了大量的邏輯判斷操作

其他驗(yàn)證

@Vaild 遞歸驗(yàn)證，用于對(duì)象、數(shù)組和集合，會(huì)對(duì)對(duì)象的元素、數(shù)組的元素進(jìn)行一一校驗(yàn)
@Email 用于驗(yàn)證一個(gè)字符串是否是一個(gè)合法的右鍵地址，空字符串或null算驗(yàn)證通過(guò)
@URL(protocol=,host=,port=,regexp=,flags=) 用于校驗(yàn)一個(gè)字符串是否是合法URL

數(shù)值檢查

建議使用在Stirng,Integer類(lèi)型，不建議使用在int類(lèi)型上，因?yàn)楸韱沃禐?" 時(shí)無(wú)法轉(zhuǎn)換為int，但可以轉(zhuǎn)換為Stirng為"",Integer為null

@Min：驗(yàn)證 Number 和 String 對(duì)象是否大等于指定的值
@Max：驗(yàn)證 Number 和 String 對(duì)象是否小等于指定的值
@DecimalMax：被標(biāo)注的值必須不大于約束中指定的最大值. 這個(gè)約束的參數(shù)是一個(gè)通過(guò)BigDecimal定義的最大值的字符串表示.小數(shù)存在精度
@DecimalMin：被標(biāo)注的值必須不小于約束中指定的最小值. 這個(gè)約束的參數(shù)是一個(gè)通過(guò)BigDecimal定義的最小值的字符串表示.小數(shù)存在精度
@Digits：驗(yàn)證 Number 和 String 的構(gòu)成是否合法
@Digits(integer=,fraction=)：驗(yàn)證字符串是否是符合指定格式的數(shù)字，interger指定整數(shù)精度，fraction指定小數(shù)精度。

項(xiàng)目使用中遇到的問(wèn)題

一開(kāi)始傳入的參數(shù)沒(méi)有使用@Validated 修飾，結(jié)果綁定不起作用，參數(shù)校驗(yàn)不成功，加上此注解即可生效。

所以BingdingResult是要與@Validated同時(shí)使用的。

項(xiàng)目中具體使用如下：

controller中：

@ApiOperation("添加角色")
@RequestMapping(value = "/create", method = RequestMethod.POST)
@ResponseBody
public CommonResult create(@Validated @RequestBody UmsRole role, BindingResult bindingResult ) {
    int count = roleService.create(role);
    if (count > 0) {
        return CommonResult.success(count);
    }
    return CommonResult.failed();
}

domain中：

import io.swagger.annotations.ApiModelProperty;
import javax.validation.constraints.NotEmpty;
import java.io.Serializable;
import java.util.Date;
@Data
public class UmsRole implements Serializable {
    private Long id;
    @ApiModelProperty(value = "名稱(chēng)")
    @NotEmpty(message = "name不能為空！")
    private String name;
    @ApiModelProperty(value = "描述")
    @NotEmpty(message = "描述不能為空！")
    private String description;
    @ApiModelProperty(value = "后臺(tái)用戶數(shù)量")
    private Integer adminCount;
    @ApiModelProperty(value = "創(chuàng)建時(shí)間")
    private Date createTime;
    @ApiModelProperty(value = "啟用狀態(tài)：0->禁用；1->啟用")
    private Integer status;
    private Integer sort;
    private static final long serialVersionUID = 1L;

調(diào)用接口返回效果：

參數(shù)：

{
“name”:“test”
}

返回值：

{
“code”: 404,
“message”: “描述不能為空！”,
“data”: null
}

注意！

1.@Validated 與BindingResult 需要相鄰，否則變量result 不能接受錯(cuò)誤信息

控制臺(tái)輸出

Field error in object 'entity' on field '變量': rejected value [null]; codes [NotNull.entity.變量,NotNull.變量,NotNull.java.lang.String,NotNull]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes

2.如果使用了@Validated，那么BeanValidate也會(huì)拋出異常而不是之前的封裝在BindingResult中

總結(jié)：

使用BindingResult，省去了代碼塊中的大部分校驗(yàn)

BindingResult作用原理

controller代碼

@RequestMapping("")
    public String index(@Valid User user , BindingResult bindingResult){
        if (bindingResult.hasErrors()){
            List<ObjectError> allErrors = bindingResult.getAllErrors();
            ObjectError objectError = allErrors.get(0);
            System.out.println(objectError.getDefaultMessage());
            System.out.println(objectError.getObjectName());
            System.out.println(allErrors);
        }
        return "index";
    }

請(qǐng)求先來(lái)到DispatcherServlet的doDispatch 方法，最終會(huì)調(diào)用ModelAttributeMethodProcessor#resolveArgument方法