springboot自定义Starter过程的示例分析
小编给大家分享一下springboot自定义Starter过程的示例分析,相信大部分人都还不怎么了解,因此分享这篇文章给大家参考一下,希望大家阅读完这篇文章后大有收获,下面让我们一起去了解一下吧!
专注于为中小企业提供网站建设、网站制作服务,电脑端+手机端+微信端的三站合一,更高效的管理,为中小企业郯城免费做网站提供优质的服务。我们立足成都,凝聚了一批互联网行业人才,有力地推动了成百上千家企业的稳健成长,帮助中小企业通过网站建设实现规模扩充和转变。
自定义Starter命名规则
注意artifactId的命名规则,Spring官方Starter通常命名为spring-boot-starter-{name}如 spring-boot-starter-web, Spring官方建议非官方Starter命名应遵循{name}-spring-boot-starter的格式, 如mybatis-spring-boot-starter。这里创建的项目的artifactId为helloworld-spring-boot-starter
开发Starter步骤
创建Starter项目 定义Starter需要的配置(Properties)类 编写自动配置类 编写spring.factories文件加载自动配置类 编写配置提示文件spring-configuration-metadata.json(不是必须的)
具体流程
创建配置类
@ConfigurationProperties 来定义配置的前缀
@EnableConfigurationProperties(InfluxdbProperties.class)@ConfigurationProperties(prefix = "spring.influxdb")public class InfluxdbProperties { private String username; public String getDatabase() { return database; } public void setDatabase(String database) { this.database = database; }}
编写自动配置类
@EnableConfigurationProperties配置依赖的属性类 @ConditionalOnProperty 配置Configuration的加载规则 value 指的是Properties的哪个字段 havingValue指的是配置value是什么值的时候加载Configuration matchIfMissing 指的是当value配置的字段没有配置时的默认值 @Bean 配置自动注入的bean springboot特有的常见的条件依赖注解有: @ConditionalOnBean,仅在当前上下文中存在某个bean时,才会实例化这个Bean。 @ConditionalOnClass,某个class位于类路径上,才会实例化这个Bean。 @ConditionalOnExpression,当表达式为true的时候,才会实例化这个Bean。 @ConditionalOnMissingBean,仅在当前上下文中不存在某个bean时,才会实例化这个Bean。 @ConditionalOnMissingClass,某个class在类路径上不存在的时候,才会实例化这个Bean。 @ConditionalOnNotWebApplication,不是web应用时才会实例化这个Bean。 @AutoConfigureAfter,在某个bean完成自动配置后实例化这个bean。 @AutoConfigureBefore,在某个bean完成自动配置前实例化这个bean。
@Configuration@Order(1)@EnableConfigurationProperties(InfluxdbProperties.class)@ConditionalOnClass(InfluxdbProperties.class)@ConditionalOnProperty(prefix = "spring.influxdb", value = "use-influxdb", havingValue="true" ,matchIfMissing = false)public class InfluxdbAutoConfiguration {private String scanEntitySuffix = "Entity.class";@Bean@ConditionalOnMissingBean(AiInfluxdbTemplate.class)@Order(Ordered.HIGHEST_PRECEDENCE)public AiInfluxdbTemplate AiInfluxdbTemplate(InfluxdbProperties influxdbProperties){ return new AiInfluxdbTemplate(influxdbProperties);}}
编写spring.factories文件
Spring Boot会默认扫描跟启动类平级的包,如果我们的Starter跟启动类不在同一个主包下,需要通过配置spring.factories文件来生效
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\com.ai.base.boot.influxdb.InfluxdbAutoConfiguration
以上是“springboot自定义Starter过程的示例分析”这篇文章的所有内容,感谢各位的阅读!相信大家都有了一定的了解,希望分享的内容对大家有所帮助,如果还想学习更多知识,欢迎关注创新互联行业资讯频道!
文章名称:springboot自定义Starter过程的示例分析
本文地址:http://hbruida.cn/article/gesoei.html