如何编写自己的starter

命名规则:

    不要使用spring-boot开头的,以避免将来spring-boot官方使用你的starter而重名。

    正例:xxxx-spring-boot-starter

    反例:spring-boot-starter-xxxx

功能界定:

    你所定义的starter需要有自己的独特功能,比如spring-boot-starter-web 提供的springmvc相关的自动装配,内嵌tomcat以及相关依赖,那们你自己定义的starter也是需要界定好自己的功能。示例中我们定义一个用于指定项目作者名的一个starter,并实现自动装配一个作者服务类(如果不存在实例的情况下)

项目起步:

    1:pom文件引入

1

processor 主要的作用是在编译时在META-INF下生成spring-configuration-metadata.json 文件,该文件主要为IDE使用,即可以通过在application.properties文件中通过ctrl + 点击进入配置属性所在的类中。

autoconfigure 主要作用是提供自动装配功能

代码编写:

1:编写配置文件读取类,一般命名为xxxProperties.class

2

这样就可以在配置文件中,使用前缀为wilson.custom.author = xxx 的形式配置了

2:编写需要你这个功能的服务类,即自动装配类会根据classpath下是否存在该服务类,如果存在就加载我们的自动装配类,并在不存在该服务类实例的情况下去实例化服务类的bean实例

3

3:编写自动装配类,主要点

4

首先看类上的注解有@Configuration,@ConditionOnClass以及@EnableConfigurationProperties

@Configuration:spring配置,省略了xml配置文件

@ConditionOnClass 当classpath下存在指定类时,该配置类才有效。

@EnableConfigurationProperties 支持配置属性

在看里面的方法上的注解有

@Bean 表示会注册为一个spring bean

@ConditionOnMissingBean(AuthorServer.class)表示当spring上下文中不存在AuthorServer实例时才会加载该方法以生成实例。

@ConditionOnProperties 表示当配置文件中存在该配置时,才会加载该方法,若加了matchIfMissing = true,则表示即使配置文件中没有定义该属性配置,也会加载该方法

方法体的代码很简单,就是获取到配置文件中配置的值,放进AuthorServer 实例中,并返回实例。

备注:springboot中相关condition注解大致有:

@ConditionalOnBean:当容器中有指定的Bean的条件下

@ConditionalOnClass:当类路径下有指定的类的条件下 

@ConditionalOnExpression:基于SpEL表达式作为判断条件 

@ConditionalOnJava:基于JVM版本作为判断条件 

@ConditionalOnJndi:在JNDI存在的条件下查找指定的位置 

@ConditionalOnMissingBean:当容器中没有指定Bean的情况下 

@ConditionalOnMissingClass:当类路径下没有指定的类的条件下 

@ConditionalOnNotWebApplication:当前项目不是Web项目的条件下 

@ConditionalOnProperty:指定的属性是否有指定的值 

@ConditionalOnResource:类路径下是否有指定的资源 

@ConditionalOnSingleCandidate:当指定的Bean在容器中只有一个,或者在有多个Bean的情况下,用来指定首选的Bean @ConditionalOnWebApplication:当前项目是Web项目的条件下

4:编写 spring.factories文件,指定autoconfigure加载的自动装配类是哪个

    在项目的resources下定义一个META-INF   文件夹,并新建spring.factories文件

6

  5:最后一步:

    修改pom文件中关于build 插件 spring-boot-maven-plugin,增加一个

7

如果不增加这个,会导致执行maven clean install 后,在其他项目中引用我们定义的这个pom时出现找不到class文件的报错信息

比如我们另起一个新的springboot项目,增加上述定义的starter的pom依赖后,启动

报错信息如下:

8

打开IDE外部jar依赖看到,

9

所以它找不到class文件。只要在上述自定义pom中的打包maven插件增加<skip>true</>即可。

10


11

再次启动,成功。

结语:

    定义自己的starter,用到了自动装配,其实是springboot在启动时,会自动去扫描每个starter中META-INF下的spring.factories文件中定义的key 为org.springframework.boot.autoconfigure.EnableAutoConfiguration的所有value值,合并到一起再去根据整个项目的classpath jar只能的处理所有定义的需要自动装配的类的。

©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容