SpringBoot自动配置自定义条件注解怎么写才有效

陌萱姑娘_3474

陌萱姑娘_3474

2026-08-07

636人浏览

原创

要在springboot自动配置中让自定义条件注解真正生效,必须同时满足注解声明、条件逻辑实现、运行时加载三重约束。需定义带@conditional的注解并绑定非抽象condition实现类,该类matches方法须安全判空处理profile,再在配置类或@bean方法上使用,并通过激活对应profile验证加载效果。

springboot自动配置自定义条件注解怎么写才有效

要在SpringBoot自动配置中让自定义条件注解真正生效,必须同时满足注解声明、条件逻辑实现、运行时加载三重约束,缺一不可——比如只写注解不配Condition实现类,Spring容器根本不会识别该条件。

定义注解并绑定Condition实现类

创建自定义注解@ConditionalOnProduction,用@Conditional指定具体的条件判断逻辑类:

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(OnProductionEnvCondition.class)
public @interface ConditionalOnProduction {}

【OnProductionEnvCondition.class必须是实现了Condition接口的非抽象类】,否则Spring在解析注解时会抛出IllegalStateException。

编写Condition实现类

新建OnProductionEnvCondition类,实现matches方法,判断是否为生产环境:

public class OnProductionEnvCondition implements Condition {
  @Override
  public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
    String profile = context.getEnvironment().getActiveProfiles()[0];
    return "prod".equals(profile);
  }
}

注意:如果项目未激活任何profile,getActiveProfiles()返回空数组,直接取[0]会触发ArrayIndexOutOfBoundsException。应先判空再取值。

在自动配置类中使用自定义条件注解

方法一:直接标注在@Configuration类上

橙篇
橙篇

橙篇是一款由百度推出的 AI 长文理解、检索和内容创作工具。

下载

@Configuration
@ConditionalOnProduction
public class ProductionOnlyConfig {
  @Bean
  public RedisTemplate redisTemplate() { ... }
}

方法二:标注在@Bean方法上,粒度更细

@Configuration
public class AppConfig {
  @Bean
  @ConditionalOnProduction
  public ScheduledTaskExecutor taskExecutor() { ... }
}

这一步操作起来很简单,直接把@ConditionalOnProduction加到目标类或方法上方就行。

验证条件是否真正触发

第一步:启动应用时显式指定生产环境profile:
java -jar app.jar --spring.profiles.active=prod

第二步:观察控制台日志,确认ProductionOnlyConfig类被加载(Spring Boot启动日志中会出现"Loading XML bean definitions from class path resource"或类似提示)。

第三步:切换为dev环境再次启动:
java -jar app.jar --spring.profiles.active=dev

此时ProductionOnlyConfig中的Bean不应出现在ApplicationContext中,可通过@Autowired注入测试或调用applicationContext.getBeanNamesForType(RedisTemplate.class)验证返回结果为空数组。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
spring框架介绍
spring框架介绍

本专题整合了spring框架相关内容,想了解更多详细内容,请阅读专题下面的文章。

2025.08.06

2151

22

Java Spring Security 与认证授权
Java Spring Security 与认证授权

本专题系统讲解 Java Spring Security 框架在认证与授权中的应用,涵盖用户身份验证、权限控制、JWT与OAuth2实现、跨站请求伪造(CSRF)防护、会话管理与安全漏洞防范。通过实际项目案例,帮助学习者掌握如何 使用 Spring Security 实现高安全性认证与授权机制,提升 Web 应用的安全性与用户数据保护。

2026.01.26

397

25

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

2026.09.23

20

15

Buffalo框架路由与请求处理实操指南
Buffalo框架路由与请求处理实操指南

本专题讲解Buffalo框架路由与请求处理机制,涵盖路由注册与分组、资源路由、Handler编写规范、Context上下文方法、参数绑定、中间件编写挂载、Session与Cookie读写、Flash消息及错误页面定制方法。

2026.09.23

0

15

Buffalo框架零基础入门教程
Buffalo框架零基础入门教程

本专题整理Buffalo框架入门内容,涵盖Go环境准备、buffalo CLI安装、新项目生成、目录结构说明、dev热加载启动、数据库连接配置与常见报错排查,帮助新手按约定优于配置的思路跑通第一个Buffalo框架应用。

2026.09.23

0

15

Conan创建软件包配方指南
Conan创建软件包配方指南

本专题介绍通过conanfile.py创建软件包的方法,讲解包名、版本、依赖和构建设置等基础信息,以及source、build、package、package_info等常用方法的作用及编写思路。

2026.09.22

0

12

Conan二进制包配置指南
Conan二进制包配置指南

本专题介绍Conan根据操作系统、编译器、架构和构建类型生成二进制包的方法,讲解Profile、Settings、Options及Package ID的作用,帮助管理不同平台和编译环境下的包版本。

2026.09.22

20

13

Conan私有仓库搭建教程
Conan私有仓库搭建教程

本专题系统的讲解Conan私有仓库的搭建流程,涵盖仓库服务部署、存储目录配置、用户认证、权限划分和远程地址添加,并介绍内部C++依赖包的上传、下载及版本维护方法。

2026.09.22

0

19

loomy官网入口地址合集
loomy官网入口地址合集

本专题汇总了 Loomy 桌面 AI 助理的官方入口地址合集及使用指南。提供 macOS 与 Windows 客户端下载 。Loomy 是讯飞推出的桌面级 AI 工作搭子,支持文件整理、数据分析、网页操作及通过飞书/钉钉远程操控电脑,助你高效完成本地办公任务 。

2026.09.22

0

19

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Redis6入门到精通超详细教程
Redis6入门到精通超详细教程

共47课时 | 7.1万人学习