Spring中的@ConfigurationProperties在方法上的使用详解
前言
在学习spring的时候,@ConfigurationProperties应该经常被使用到,作用在类上的时候,将该类的属性取值 与配置文件绑定,并生成配置bean对象,放入spring容器中,提供给其他地方使用。
在工作中,或者看spring内部代码的时候,无意发现@ConfigurationProperties居然还可以用在方法上,点开@ConfigurationProperties注解的时候,我们发现:
1 2 3 4 5 6 | // targer:可作用在类、方法上 @Target ({ ElementType.TYPE, ElementType.METHOD }) @Retention (RetentionPolicy.RUNTIME) @Documented public @interface ConfigurationProperties { } |
似乎平时我们都是用在类上的,因此特意写这篇文章记录一下,记录@ConfigurationProperties的使用方式。
先说结论
- @ConfigurationProperties无论是使用在类上,或用在方法上,其本质都是将某个配置类的属性值与配置文件application.yml中内容进行绑定。
- 其使用场景用如下三种:
- @ConfigurationProperties + @Component + 在类上使用的场景
- @ConfigurationProperties + @EnableConfigurationProperties 在类上使用的场景
- @ConfigurationProperties + @Bean 在方法上使用的场景
代码解释
@Component + @ConfigurationProperties
在类上使用@ConfigurationProperties效果:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 | @Component @ConfigurationProperties (prefix = "test.config" ) @Setter @ToString public class TestConfigDemo { private String username; private String pwd; } // yml test: config: username: test-config-username pwd: test-config-pwd // 测试代码 @Component public class TestConfigAppRunner implements ApplicationRunner { @Autowired TestConfigDemo testConfigDemo; @Override public void run(ApplicationArguments args) throws Exception { System.out.println(testConfigDemo); } } |
从上述可看出@ConfigurationProperties的作用,而@ConfigurationProperties的使用则是在配置类上需要有set方法、以及是需要@Component。
@EnableConfigurationProperties + @ConfigurationProperties
这里不做过多说明
@Bean + @ConfigurationProperties
直接看代码:
1 2 3 4 5 6 7 | // 该配置类上 无 任何spring的注解 @Setter @ToString public class TestConfigDemo { private String username; private String pwd; } |
1 2 3 4 5 6 7 8 9 10 11 | // 准备个@Configuration 配置类 @Configuration public class ConfigurationDemo { // 这里将TestConfigDemo 配置类 生成bean对象 // 此时:TestConfigDemo里面的属性将与配置文件yml内容进行绑定 @Bean @ConfigurationProperties (prefix = "test.config" ) public TestConfigDemo testConfigDemo(){ return new TestConfigDemo(); } } |
1 2 3 4 5 6 7 8 9 10 11 | @Component public class TestConfigAppRunner implements ApplicationRunner { @Autowired TestConfigDemo testConfigDemo; @Override public void run(ApplicationArguments args) throws Exception { System.out.println(testConfigDemo); } } |
看到上述的例子,想必大家内心此时的想法是:@ConfigurationProperties使用在方法上的效果,跟使用在类上的完全没任何区别,只是将@ConfigurationProperties的位置换了一个地方,并无太大区别吧。
但其出现必然有其存在意义: 个人觉得,其作用就是,如果项目中有个@Configuration这种类的话,可以把config配置类的注解内容等都放入该类中,达到一种配置好管理的效果,之后如果要改什么内容,只要看@Configuration这种类即可,无需到处找。
到此这篇关于Spring中的@ConfigurationProperties在方法上的使用详解的文章就介绍到这了,更多相关@ConfigurationProperties的使用内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!
微信公众号搜索 “ 脚本之家 ” ,选择关注
程序猿的那些事、送书等活动等着你
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如若内容造成侵权/违法违规/事实不符,请将相关资料发送至 reterry123@163.com 进行投诉反馈,一经查实,立即处理!
相关文章
Java修饰符 abstract,static,final 的区别详解
以下是对Java修饰符abstract,static,final的区别进行了详细的介绍,需要的朋友可以过来参考下2013-09-09
最新评论