本文深入探讨了 Spring `@Conditional` 注解，特别是 `@ConditionalOnProperty` 在 bean 创建时的评估机制，并揭示了 `@Primary` 注解可能对其行为产生的影响。同时，文章强调了使用 `@Validated` 结合 JSR-303 验证注解来增强配置属性的健壮性，有效避免因配置缺失导致的运行时错误，为构建灵活且可靠的 Spring 应用程序提供了专业的指导。
在 Spring 框架中，@Conditional 注解系列为开发者提供了强大的条件化配置能力，允许根据特定条件（如环境变量、属性值、类路径存在性等）动态地注册或排除 bean。其中，@ConditionalOnProperty 是一个常用的条件注解，它根据 Spring 环境中某个配置属性的存在与否或其特定值来决定是否创建 bean。然而，在使用过程中，开发者可能会遇到一些预期之外的行为，例如条件 bean 似乎总是被创建，即使条件不满足。本文将详细解析这类问题，并提供健壮的解决方案。
理解 @ConditionalOnProperty 的工作原理
@ConditionalOnProperty 注解通常用于根据应用程序的配置属性来控制 bean 的生命周期。例如，当某个代理 URL 属性存在时才创建一个带代理的 HttpHost bean。其基本用法如下：
@Bean@ConditionalOnProperty(name = "application.proxy-url")public HttpHost getProxyHostWithCondition(ApplicationConfiguration applicationConfiguration) { // ... 创建 HttpHost bean}
理论上，当 application.proxy-url 属性未在 application.properties 或 application.yml 中定义时，带有此注解的 getProxyHostWithCondition 方法将不会被调用，相应的 bean 也不会被注册到 Spring 容器中。
@Primary 注解对条件化 Bean 的潜在影响
在某些情况下，即使使用了 @ConditionalOnProperty，条件 bean 仍可能被创建。这可能与 @Primary 注解的结合使用有关。考虑以下场景：
@Beanpublic HttpHost getProxyHost() { return null; // 提供一个默认的、无代理的 HttpHost}@Bean@Primary // 标记为主要 bean@ConditionalOnProperty(name = "application.proxy-url")public HttpHost getProxyHost(ApplicationConfiguration applicationConfiguration) { // 如果 applicationConfiguration.getProxyUrl() 返回 null，可能抛出 NullPointerException return new HttpHost( applicationConfiguration.getProxyUrl(), applicationConfiguration.getProxyPort(), applicationConfiguration.getProxyScheme() );}
在此示例中，开发者希望当 application.proxy-url 存在时，使用第二个带代理的 HttpHost bean，并将其标记为主要（@Primary）。否则，使用第一个无代理的 HttpHost bean。然而，实际运行中发现，即使 application.proxy-url 未设置，第二个 bean 仍可能被创建，导致 applicationConfiguration.getProxyUrl() 返回 null 进而引发 NullPointerException。
问题分析与解决方案：
@Primary 注解用于在存在多个相同类型的 bean 时，指定一个作为首选。当它与 @ConditionalOnProperty 结合使用时，可能会在 Spring 容器解析 bean 定义的过程中产生意想不到的交互。一种可能的解释是，Spring 在某些情况下，为了解析 HttpHost 类型的 Primary bean 定义，可能会在条件尚未完全评估或生效之前，尝试处理带有 @Primary 标记的 bean 定义。
解决此问题的直接方法是移除条件 bean 上的 @Primary 注解。
《PHP程序设计》第二版
本书图文并茂，详细讲解了使用LAMP（PHP）脚本语言开发动态Web程序的方法，如架设WAMP平台，安装与配置开源Moodle平台，PHP程序设计技术，开发用户注册与验证模块，架设LAMP平台。 本书适合计算机及其相关专业本、专科学生作为学习LAMP（PHP）程序设计或动态Web编程的教材使用，也适合对动态Web编程感兴趣的读者自觉使用，对LAMP（PHP）程序设计人员也具有一定的参考价值。
713 查看详情
@Beanpublic HttpHost getProxyHost() { return null; // 提供一个默认的、无代理的 HttpHost}@Bean// 移除 @Primary 注解@ConditionalOnProperty(name = "application.proxy-url")public HttpHost getProxyHost(ApplicationConfiguration applicationConfiguration) { return new HttpHost( applicationConfiguration.getProxyUrl(), applicationConfiguration.getProxyPort(), applicationConfiguration.getProxyScheme() );}
通过移除 @Primary，Spring 将更严格地遵循 @ConditionalOnProperty 的条件。如果 application.proxy-url 未设置，第二个 bean 将不会被创建。如果 application.proxy-url 存在，则会创建两个 HttpHost 类型的 bean，此时可能需要通过 @Qualifier 或其他方式明确指定使用哪个 bean。
增强配置的健壮性：使用 @Validated 进行属性验证
即使 @ConditionalOnProperty 能够按预期工作，也存在一种情况：当条件满足，但 application.proxy-url 或其他相关属性的值在配置文件中被错误地设置为空或 null。这同样会导致 NullPointerException。为了防止此类问题，强烈建议对 @ConfigurationProperties 类进行严格的验证。
Spring 结合 JSR-303 (Bean Validation) 规范提供了强大的验证机制。通过在 @ConfigurationProperties 类上添加 @Validated 注解，并使用如 @NotBlank、@NotNull 等验证注解，可以在应用程序启动阶段就捕获到配置错误。
import lombok.AllArgsConstructor;import lombok.Getter;import org.springframework.boot.context.properties.ConfigurationProperties;import org.springframework.validation.annotation.Validated;import javax.validation.constraints.NotBlank;import javax.validation.constraints.NotNull; // 也可以使用 @NotNull@Validated // 启用此类的属性验证@ConfigurationProperties(prefix = "application")@Getter@AllArgsConstructor // 假设所有字段都通过构造函数注入public class ApplicationConfiguration { @NotBlank(message = "Proxy URL must not be blank") // 确保 proxyUrl 不为空白 private final String proxyUrl; @NotBlank(message = "Proxy port must not be blank") // 确保 proxyPort 不为空白 private final String proxyPort; // 注意：端口通常是整数，这里示例保持与原问题一致为 String @NotBlank(message = "Proxy scheme must not be blank") // 确保 proxyScheme 不为空白 private final String proxyScheme;}
工作原理：
当 Spring 尝试绑定配置属性到 ApplicationConfiguration 类的实例时，如果 ApplicationConfiguration 类被 @Validated 注解，并且其字段上存在验证注解（如 @NotBlank），Spring 会自动执行这些验证。如果任何一个验证失败（例如，proxyUrl 在配置文件中未设置或为空白），应用程序将在启动时抛出 BindException 或 ValidationException，明确指出哪个属性存在问题，从而避免在运行时才暴露 NullPointerException。
注意事项：
确保你的项目中包含了 JSR-303 验证 API 的实现，例如 spring-boot-starter-validation。对于端口号等数值类型，更推荐使用 @NotNull 和 @Min/@Max 等注解，并将字段类型定义为 Integer 或 int。
总结
在使用 Spring 的 @Conditional 注解时，特别是与 @Primary 结合时，需要仔细考虑其行为。移除 @Primary 往往能确保 @ConditionalOnProperty 按预期生效。同时，为了构建更加健壮和可靠的应用程序，对 @ConfigurationProperties 类进行严格的验证是不可或缺的实践。通过结合 @Validated 和 JSR-303 验证注解，可以在应用程序启动的早期阶段捕获并解决配置错误，从而提升开发效率和应用程序的稳定性。
以上就是Spring @Conditional 注解的行为与配置验证策略的详细内容，更多请关注创想鸟其它相关文章！
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容， 请发送邮件至 chuangxiangniao@163.com 举报，一经查实，本站将立刻删除。
发布者：程序猿，转转请注明出处：https://www.chuangxiangniao.com/p/898104.html
微信扫一扫 
支付宝扫一扫 
