Question

假设我有一个@ConfigurationProperties类，该类需要根据另一个字段的值来验证一组字段。例如，SdkProperties有一个enabled字段。仅当enabled为true时，其他字段才有效。

SdkProperties

@Configuration
@ConfigurationProperties(...)
@Data
@Validated
public class SdkProperties
{
    private boolean enabled;

    @NotEmpty
    private String apiKey

    // ... etc.
}

只有在@NotEmpty为enabled的情况下，true批注才应被验证。

执行此操作的正确方法是什么？

我已经看到了使用@AssertTrue和isValid函数手动处理验证的示例。但是我不想那样做。

我想知道使用验证组是否可行？

Answer 1

您可以编写自定义ConstraintValidator。


@Configuration
@ConfigurationProperties(prefix = "sdk")
@Validated
@NotEmptyWhenEnabled // <----- custom validation -----
@Data
class SdkProperties {

    private boolean enabled;
    private String apiKey;
}

@Constraint(validatedBy = {NotEmptyWhenEnabledValidator.class})
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@interface NotEmptyWhenEnabled {
    String message() default "SDK apiKey needed when SDK is enabled";

    Class[] groups() default {};

    Class<? extends Payload>[] payload() default {};
}

class NotEmptyWhenEnabledValidator implements ConstraintValidator<NotEmptyWhenEnabled,SdkProperties> {

    @Override
    public boolean isValid(SdkProperties sdkProperties, 
                           ConstraintValidatorContext constraintValidatorContext) {
        boolean enabled = sdkProperties.isEnabled();
        boolean empty = null == sdkProperties.getApiKey() || sdkProperties.getApiKey().isEmpty();
        return !enabled || (enabled && !empty);
    }
}

然后，当启用 SDK 但未提供 API密钥时，启动时会收到一条很好的消息。

***************************
APPLICATION FAILED TO START
***************************

Description:

Binding to target org.springframework.boot.context.properties.bind.BindException: Failed to bind properties under 'sdk' to so.demo.SdkProperties$$EnhancerBySpringCGLIB$$1ecd6003 failed:

    Reason: SDK apiKey needed when SDK is enabled


Action:

Update your application's configuration


Process finished with exit code 0

EDIT

自spring-boot-2.2.0.RELEASE（2019年10月16日）以来，您还有另一种选择。您可以在构造函数中验证属性。

使用以下方式：不可变的@ConfigurationProperties 绑定

配置属性现在支持基于构造函数的绑定，该绑定允许带有@ConfigurationProperties注释的类是不可变的。可以通过使用@ConfigurationProperties注释@ConstructorBinding类或其构造函数之一来启用基于构造函数的绑定。可以在配置属性绑定提供的构造函数参数上使用诸如@DefaultValue和@DateTimeFormat之类的注释。

ref：boot-features-external-config-constructor-binding

所以就您而言...

@ConfigurationProperties(prefix = "sdk")
class SdkProperties {

    private boolean enabled;
    private String apiKey;

    @ConstructorBinding
    public SdkProperties(boolean enabled, String apiKey) {
        this.enabled = enabled;
        this.apiKey = apiKey;
        // direct validation in the constructor
        boolean apiKeyNullOrEmpty = null == apiKey || apiKey.isEmpty();
        Assert.isTrue(!enabled || !apiKeyNullOrEmpty, "When SDK is enabled, a SDK-api key is mandatory!");
    }

    public boolean isEnabled() {  return enabled; }
    public void setEnabled(boolean enabled) { this.enabled = enabled; }
    public String getApiKey() {return apiKey; }
    public void setApiKey(String apiKey) { this.apiKey = apiKey; }
}

仅在其他字段为假的情况下验证字段

1 个答案: