【前面的话】在使用SpringBoot的日常开发过程中,我们不可避免的要封装一些自己的Starter,今天这篇文章就来讨论一下怎么自定义一个Starter,本文会封装一个短信发送能力的Starter,使用云之讯的SDK。
壹、命名规范
官方的约定主要有一个命名的约定:在maven中,groupId代表着姓氏,artifactId代表着名字。Spring Boot也是有一个命名的建议的。groupId不要用官方的org.springframework.boot而要用你自己独特的。对于artifactId的命名,Spring Boot官方建议非官方的Starter命名格式遵循 xxxx-spring-boot-starter ,例如 mybatis-spring-boot-starter 。官方starter会遵循spring-boot-starter-xxxx ,例如spring-boot-starter-web 。很多开源starter作者会忽略这种约定,显得不够“专业“。
贰、新建工程
新建一个sms-spring-boot-starter工程,pom依赖如下:
1 | <dependencies> |
叁、Properties配置
一般配置参数都是在Spring Boot 的application.yml中。我们会定义一个前缀标识来作为名称空间隔离各个组件的参数。对应的组件会定义一个XXXXProperties 来自动装配这些参数。自动装配的机制基于@ConfigurationProperties注解,请注意一定要显式声明你配置的前缀标识(prefix)。所以这里我们新建SmsProperties类,可以配置信息通过配置项名称映射成实体类
1 |
|
在这里我们可以将配置文件中前缀为ucpaassms-config的配置,映射到SmsProperties类中。在将来使用时只需要在application.yml中加入上面对应SmsProperties的配置:
1 | ucpaassms-config: |
肆、定义业务实现类
拿到配置后,接下来就是根据配置来初始化我们的功能接口。这里我们新建SmsService,用来提供具体业务逻辑处理能力
1 | public class SmsService { |
伍、定义配置类
功能接口实现完后我们会编写一个自动配置类 SmsAutoConfiguration 。除了@Configuration注解外,@EnableConfigurationProperties会帮助我们将我们的配置类SmsProperties加载进来。然后将我们需要暴露的功能接口声明为Spring Bean暴露给Spring Boot应用。这里我们新建SmsAutoConfiguration类
1 | //注释使类成为bean的工厂 |
陆、自动装配
这里会用到类似java的SPI机制。在资源包下新建META-INF/spring.factories写入SmsAutoConfiguration全限定名。这样在starter组件集成入Spring Boot应用时就可以被应用捕捉到。
1 | org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.eelve.sms.starter.config.SmsAutoConfiguration |
这里还有另外一种方式:
1 | (ElementType.TYPE) |
到这里我们的自定义配置就可以完成了,然后就可以上传仓库,提供给第三方使用了。
柒、测试
7.1 加入sms-spring-boot-starter短信依赖
7.2 编写配置
1 | ucpaassms-config: |
7.3 编写测试类
1 | package com.eelve.ucpaassms.controller; |
然后运行,访问http://localhost:8080/sms/sendsmsTest,就可以收到发送的短信了
【蔚然山庄】尊敬的用户,敬请关注我们的后续活动。
【后面的话】
在引入自己封装的Starter的时候,有的人会报错xxxx类的bean没有找到问题,是因为@SpringBootApplication扫描包的范围是启动类所在同级包和子包,但是不包括第三方的jar包.如果需要扫描maven依赖添加的Jar,我们就要单独使用@ComponentScan注解扫描包.
针对这种情况解决方式有两种:
第一种:是你封装的Starter项目下父级包名称和测试项目的父级包名一样,例如这两个项目包名都叫com.eelve,这样可以不使用@ComponentScan注解,很显然这样做有局限性,不推荐.
第二种:是可以单独使用@ComponentScan注解扫描第三方包,但是这里一定要注意@SpringBootApplication注解等价于默认属性使用@Configuration+@EnableAutoConfiguration+@ComponentScan,如果@SpringBootApplication和@ComponentScan注解同时存在,那么@SpringBootApplication注解中@ComponentScan的扫描范围会被覆盖,所以单独使用@ComponentScan的话,必须在该注解上配置项目需要扫描的包的所有范围,即项目包路径+依赖包路径.
1 | /** |
另外具体实现可以参考我的项目:ucpaas-spring-boot-starter