問(wèn)題復(fù)現(xiàn)

當(dāng)開(kāi)發(fā)一個(gè)學(xué)籍管理系統(tǒng)時(shí)，我們會(huì)提供了一個(gè) API 接口去添加學(xué)生的相關(guān)信息，學(xué)生中有個(gè)嵌套屬性聯(lián)系電話，其對(duì)象定義參考下面的代碼：

import lombok.Data;
import javax.validation.constraints.Size;
@Data
public class Student {
    @Size(max = 10)
    private String name;
    private short age;
    private Phone phone;
}

@Data
class Phone {
    @Size(max = 10)
    private String number;
}

這里我們也給 Phone 對(duì)象做了合法性要求（@Size(max = 10)），當(dāng)我們使用下面的請(qǐng)求（請(qǐng)求 body 攜帶一個(gè)聯(lián)系電話信息超過(guò) 10 位），測(cè)試校驗(yàn)會(huì)發(fā)現(xiàn)這個(gè)約束并不生效。

定義完對(duì)象后，我們?cè)俣x一個(gè) Controller 去使用它，使用方法如下：

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
@RestController
@Slf4j
@Validated
public class StudentController {
    @RequestMapping(path = "students", method = RequestMethod.POST)
    public void addStudent(@Validated @RequestBody Student student){
        log.info("add new student: {}", student.toString());
        //省略業(yè)務(wù)代碼
    };
}

我們提供了一個(gè)支持學(xué)生信息添加的接口。啟動(dòng)服務(wù)后，使用 IDEA 自帶的 HTTP Client 工具來(lái)發(fā)送下面的請(qǐng)求以添加一個(gè)學(xué)生：

POST http://localhost:8080/students
Content-Type: application/json
{
  "name": "xiaoming",
  "age": 10,
  "phone": {"number":"12306123061230612306"}
}

發(fā)現(xiàn)校驗(yàn)器并沒(méi)有生效。

案例解析

關(guān)于 student 本身的 Phone 類型成員是否校驗(yàn)是在校驗(yàn)過(guò)程中（即案例 1 中的代碼行 binder.validate(validationHints)）決定的。

在校驗(yàn)執(zhí)行時(shí)，首先會(huì)根據(jù) Student 的類型定義找出所有的校驗(yàn)點(diǎn)，然后對(duì) Student 對(duì)象實(shí)例執(zhí)行校驗(yàn)，這個(gè)邏輯過(guò)程可以參考代碼 ValidatorImpl#validate：

@Override
public final <T> Set<ConstraintViolation<T>> validate(T object, Class<?>... groups) {
   //省略部分非關(guān)鍵代碼
   Class<T> rootBeanClass = (Class<T>) object.getClass();
   //獲取校驗(yàn)對(duì)象類型的“信息”（包含“約束”）
   BeanMetaData<T> rootBeanMetaData = beanMetaDataManager.getBeanMetaData( rootBeanClass );

   if ( !rootBeanMetaData.hasConstraints() ) {
      return Collections.emptySet();
   }

   //省略部分非關(guān)鍵代碼
   //執(zhí)行校驗(yàn)
   return validateInContext( validationContext, valueContext, validationOrder );
}

這里語(yǔ)句"beanMetaDataManager.getBeanMetaData( rootBeanClass )"根據(jù) Student 類型組裝出 BeanMetaData，BeanMetaData 即包含了需要做的校驗(yàn)（即 Constraint）。

在組裝 BeanMetaData 過(guò)程中，會(huì)根據(jù)成員字段是否標(biāo)記了 @Valid 來(lái)決定（記錄）這個(gè)字段以后是否做級(jí)聯(lián)校驗(yàn)，參考代碼 AnnotationMetaDataProvider#getCascadingMetaData：

private CascadingMetaDataBuilder getCascadingMetaData(Type type, AnnotatedElement annotatedElement,
      Map<TypeVariable<?>, CascadingMetaDataBuilder> containerElementTypesCascadingMetaData) {
   return CascadingMetaDataBuilder.annotatedObject( type, annotatedElement.isAnnotationPresent( Valid.class ), containerElementTypesCascadingMetaData,
               getGroupConversions( annotatedElement ) );
}

在上述代碼中"annotatedElement.isAnnotationPresent( Valid.class )"決定了 CascadingMetaDataBuilder#cascading 是否為 true。如果是，則在后續(xù)做具體校驗(yàn)時(shí)，做級(jí)聯(lián)校驗(yàn)，而級(jí)聯(lián)校驗(yàn)的過(guò)程與宿主對(duì)象（即 Student）的校驗(yàn)過(guò)程大體相同，即先根據(jù)對(duì)象類型獲取定義再來(lái)做校驗(yàn)。

在當(dāng)前案例代碼中，phone 字段并沒(méi)有被 @Valid 標(biāo)記，所以關(guān)于這個(gè)字段信息的 cascading 屬性肯定是 false，因此在校驗(yàn) Student 時(shí)并不會(huì)級(jí)聯(lián)校驗(yàn)它。

問(wèn)題修正

從源碼級(jí)別了解了嵌套 Validation 失敗的原因后，我們會(huì)發(fā)現(xiàn)，要讓嵌套校驗(yàn)生效，解決的方法只有一種，就是加上 @Valid，修正代碼如下：

@Valid
private Phone phone;

當(dāng)修正完問(wèn)題后，我們會(huì)發(fā)現(xiàn)校驗(yàn)生效了。而如果此時(shí)去調(diào)試修正后的案例代碼，會(huì)看到 phone 字段 MetaData 信息中的 cascading 確實(shí)為 true 了，參考下圖：

總結(jié)  

到此這篇關(guān)于Spring常見(jiàn)錯(cuò)誤之Web嵌套對(duì)象校驗(yàn)失效解決辦法的文章就介紹到這了,更多相關(guān)Spring Web嵌套對(duì)象校驗(yàn)失效內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論