如何编写自己的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只能的处理所有定义的需要自动装配的类的。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,686评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,668评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,160评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,736评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,847评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,043评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,129评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,872评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,318评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,645评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,777评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,470评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,126评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,861评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,095评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,589评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,687评论 2 351

推荐阅读更多精彩内容