知識庫 / Spring / Spring Boot RSS 訂閱

PurchaseOrderItem item = createValidPurchaseOrderItem();
item.setProductId(null);

Set<ConstraintViolation<PurchaseOrderItem>> violations = validator.validate(item);
assertThat(collectViolations(violations))
  .containsExactly(
    "productId: must have valid check digit",
    "productId: must not be null");

5. 多字段驗證器

現在我們已經構建了一個單字段驗證器，接下來我們來看選擇個人或物品套裝的規則。

5.1. 創建驗證標註

對於多字段驗證，我們需要將驗證應用到父類型上：

@Constraint(validatedBy = ChoosePacksOrIndividualsValidator.class)
@Target({ ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
public @interface ChoosePacksOrIndividuals {
    String message() default "";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

此標註的目標是<em>TYPE</em>，因為它 intended for use with the<em>PurchaseOrderItem</em> 類型。

我們需要對整個<em>PurchaseOrderItem</em> 進行驗證，因為僅逐字段驗證只會檢查特定字段，而不會考慮周圍的上下文。<strong>跨字段驗證在類型級別實現</strong>。

5.2. 創建驗證器

驗證器需要根據數量是否設置的不同情況，創建不同的約束違規。它需要避免驗證框架在<em>isValid()</em>返回false時可能產生的默認錯誤。

我們首先創建該類，該類能夠使用<em>ChoosePacksOrIndividual</em>註解驗證一個<em>PurchaseOrderItem</em>。

public class ChoosePacksOrIndividualsValidator 
  implements ConstraintValidator<ChoosePacksOrIndividuals, PurchaseOrderItem> {}

在 isValid() 方法中，我們首先禁用默認的錯誤提示信息:

@Override
public boolean isValid(PurchaseOrderItem value, ConstraintValidatorContext context) {
    context.disableDefaultConstraintViolation();
    ...

這使得我們能夠自定義錯誤消息，而不是使用標註的默認 message。

接下來，我們可以實現判斷字段是否有效的邏輯，併為無效的字段添加約束違規信息：

boolean isValid = true;

if ((value.getNumberOfPacks() == 0) == (value.getNumberOfIndividuals() == 0)) {
    // either both are zero, or both are turned on
    isValid = false;
    context.disableDefaultConstraintViolation();
    if (value.getNumberOfPacks() == 0) {
        context.buildConstraintViolationWithTemplate("must choose a quantity when no packs")
                .addPropertyNode("numberOfIndividuals")
                .addConstraintViolation();
        context.buildConstraintViolationWithTemplate("must choose a quantity when no individuals")
                .addPropertyNode("numberOfPacks")
                .addConstraintViolation();
    } else {
        context.buildConstraintViolationWithTemplate("cannot be combined with number of packs")
                .addPropertyNode("numberOfIndividuals")
                .addConstraintViolation();
        context.buildConstraintViolationWithTemplate("cannot be combined with number of individuals")
                .addPropertyNode("numberOfPacks")
                .addConstraintViolation();
    }
}

if (value.getNumberOfPacks() > 0 && value.getItemsPerPack() == 0) {
    isValid = false;

    context.buildConstraintViolationWithTemplate("cannot be 0 when using packs")
            .addPropertyNode("itemsPerPack")
            .addConstraintViolation();
}

return isValid;

該算法檢查兩個字段是否都為零，或者兩個字段是否都為非零值，這表明我們既指定了其中兩個，又沒有指定任何一個。它還添加了一個自定義約束違反，以解釋所犯的錯誤。

5.3. 跨字段驗證測試

首先，我們需要將新的標註添加到我們的 PurchaseOrderItem 中：

@ChoosePacksOrIndividuals
public class PurchaseOrderItem {
}

然後我們可以測試一個無效的組合：

PurchaseOrderItem item = createValidPurchaseOrderItem();
item.setNumberOfIndividuals(10);
item.setNumberOfPacks(20);
item.setItemsPerPack(0);

Set<ConstraintViolation<PurchaseOrderItem>> violations = validator.validate(item);
assertThat(collectViolations(violations))
  .containsExactly(
    "itemsPerPack: cannot be 0 when using packs",
    "numberOfIndividuals: cannot be combined with number of packs",
    "numberOfPacks: cannot be combined with number of individuals");

6. 使用 Spring 屬性進行狀態化驗證

我們之前已經將靜態代碼綁定到註解，並使用編譯時已知的信息進行算法驗證。 也許我們需要使用配置屬性來確定什麼是有效的。

6.1. 有效通道的配置

假設我們有一些運行時配置屬性：

com.baeldung.tenant.channels[0]=retail
com.baeldung.tenant.channels[1]=wholesale

這段數據將存在於我們的 應用程序屬性文件, 並加載到 配置屬性類 中：

@ConfigurationProperties("com.baeldung.tenant")
public class TenantChannels {
    private String[] channels;

    // getter/setter
}

現在，我們希望能夠使用此通道數組在一個驗證器中，以檢查請求中選擇的通道在該租户中是否可用。

6.2. 使用注入 Bean 創建驗證器

由於 Spring 提供了驗證器，我們還可以將其他 Spring Bean 注入到我們的驗證器中。 這樣，我們就可以自動注入配置屬性到一個自定義驗證器中：

public class AvailableChannelValidator implements ConstraintValidator<AvailableChannel, String> {

    @Autowired
    private TenantChannels tenantChannels;

}

使用從 properties 對象中的數組來驗證每個通道，有點笨拙。讓我們通過覆蓋 initialize() 方法，將其值轉換為一個集合：

private Set<String> channels;

@Override
public void initialize(AvailableChannel constraintAnnotation) {
    channels = Arrays.stream(tenantChannels.getChannels()).collect(toSet());
}

@Override
public boolean isValid(String value, ConstraintValidatorContext context) {
    return channels.contains(value);
}

現在我們已經有一個通過服務器當前 Spring 配置文件驅動的驗證註解。只需要在我們的 PurchaseOrderItem 中註解該字段即可。

@AvailableChannel
private String tenantChannel;

7. 基於數據的驗證

一旦我們能夠使用 Spring Bean 驗證我們的字段，我們就可以使用相同的技術來利用我們的數據庫或其他 Web 服務：

@Repository
public class WarehouseRouteRepository {

    public boolean isWarehouseRouteAvailable(String sourceWarehouse, String destinationCountry) {
        // read from database
    }
}

這個倉庫可以注入到驗證器中：

public class AvailableWarehouseRouteValidator implements 
  ConstraintValidator<AvailableWarehouseRoute, PurchaseOrderItem> {
    @Autowired
    private WarehouseRouteRepository warehouseRouteRepository;

    @Override
    public boolean isValid(PurchaseOrderItem value, ConstraintValidatorContext context) {
        return warehouseRouteRepository.isWarehouseRouteAvailable(value.getSourceWarehouse(), 
          value.getDestinationCountry());
    }
}

最後，由於此驗證了採購訂單的多個字段，我們將在此類級別添加相關的註釋：

@ChoosePacksOrIndividuals
@AvailableWarehouseRoute
public class PurchaseOrderItem {
    ...
}

8. 結論

在本文中，我們探討了如何為字段和類型添加驗證。我們編寫了與自定義註解關聯的自定義驗證邏輯，並瞭解瞭如何使用默認錯誤消息或自定義錯誤消息操作單個字段或多個字段。

最後，我們編寫了狀態型驗證器，利用其他 Spring Bean 以實現基於運行時配置或數據的驗證。