- 1 简介
- 2 命名规范
- 3 实现自己的SpringBoot Starter
- 3.1 引入pom
- 3.2 编写配置文件
- 4 让starter生效
- 4.1 被动生效
- 4.2 主动生效
- 5 总结
starter的实现:虽然我们每个组件的starter实现各有差异,但是它们基本上都会使用到两个相同的内容:ConfigurationProperties和AutoConfiguration。因为Spring Boot提倡“约定大于配置”这一理念,所以我们使用ConfigurationProperties来保存我们的配置,并且这些配置都可以有一个默认值,即在我们没有主动覆写原始配置的情况下,默认值就会生效。除此之外,starter的ConfigurationProperties还使得所有的配置属性被聚集到一个文件中(一般在resources目录下的application.properties),这样我们就告别了Spring项目中XML地狱。
starter的出现帮把我们把各种复杂的配置都封装起来了,让我们真正的可以达到了开箱即用。不仅降低了我们使用它的门槛,并且还大大提高了我们的开发效率。正如前面所说《SpringBoot自动装配》让我们有更多的时间去陪女朋友。
如果你快有孩子了,出生前你比较急的一定是起个名字。孩子的姓名标识着你和你爱人的血统,一定不会起隔壁老王的姓氏,肯定会招来异样的眼光。在maven中,groupId代表着姓氏,artifactId代表着名字。Spring Boot也是有一个命名的建议的。所以名字是不能够随随便便取得,可以按照官方的建议来取。
What’s in a name All official starters follow a similar naming pattern; spring-boot-starter-*, where * is a particular type of application. This naming structure is intended to help when you need to find a starter. The Maven integration in many IDEs lets you search dependencies by name. For example, with the appropriate Eclipse or STS plugin installed, you can press ctrl-space in the POM editor and type “spring-boot-starter” for a complete list. As explained in the “Creating Your Own Starter” section, third party starters should not start with spring-boot, as it is reserved for official Spring Boot artifacts. Rather, a third-party starter typically starts with the name of the project. For example, a third-party starter project called thirdpartyproject would typically be named thirdpartyproject-spring-boot-starter.
大概意思是
官方的 starter 的命名格式为 spring-boot-starter-{xxxx} 比如spring-boot-starter-activemq
第三方我们自己的命名格式为 {xxxx}-spring-boot-starter。比如mybatis-spring-boot-starter。
如果我们忽略这种约定,是不是会显得我们写的东西不够“专业“。
下面我们就来实现一个自定义的发送短信的starter,命名为sms-spring-boot-starter。
3.1 引入pom3.2 编写配置文件org.springframework.boot spring-boot-starterorg.springframework.boot spring-boot-configuration-processortrue org.projectlombok lombok1.16.18 provided
发短信我们需要配置一些账号信息,不同的短信供应商,账户信息是不一样的,所以我们需要定义一个SmsProperties 来自动装配这些账户信息。下面我们就以腾讯云和阿里云两家供应商为例;
@ConfigurationProperties(prefix = "sms")
@Data
public class SmsProperties {
private SmsMessage aliyun = new SmsMessage();
private SmsMessage tencent = new SmsMessage();
@Data
public static class SmsMessage{
private String userName;
private String passWord;
private String sign;
private String url;
@Override
public String toString() {
return "SmsMessage{" +
"userName='" + userName + ''' +
", passWord='" + passWord + ''' +
", sign='" + sign + ''' +
", url='" + url + ''' +
'}';
}
}
}
application.yml
如果需要在其他项目中使用发送短信功能的话,我们只需要在配置文件(application.yml)中配置SmsProperties 的属性信息就可以了。 比如:
sms:
aliyun:
pass-word: 12345
user-name: java金融
sign: 阿里云
url: http://aliyun.com/send
tencent:
pass-word: 6666
user-name: java金融
sign: 腾讯云
url: http://tencent.com/send
还记的@ConfigurationProperties注解里面是不是有个prefix 属性,我们配置的这个属性是sms,配置这个的主要一个作用的话是主要用来区别各个组件的参数。这里有个小知识点需要注意下当我们在配置文件输入sms我们的idea会提示这个sms有哪些属性可以配置,以及每个属性的注释都有标记,建议的话注释还是写英文,这样会显得你比较专业。
SmsAutoConfiguration
@EnableConfigurationProperties(value = SmsProperties.class)
@Configuration
public class SmsAutoConfiguration {
@Bean
public AliyunSmsSenderImpl aliYunSmsSender(SmsProperties smsProperties){
return new AliyunSmsSenderImpl(smsProperties.getAliyun());
}
@Bean
public TencentSmsSenderImpl tencentSmsSender(SmsProperties smsProperties){
return new TencentSmsSenderImpl(smsProperties.getTencent());
}
}
SmsSender
public interface SmsSender {
boolean send(String message);
}
AliyunSmsSenderImpl
public class AliyunSmsSenderImpl implements SmsSender {
private SmsMessage smsMessage;
public AliyunSmsSenderImpl(SmsMessage smsProperties) {
this.smsMessage = smsProperties;
}
@Override
public boolean send(String message) {
System.out.println(smsMessage.toString()+"开始发送短信==》短信内容:"+message);
return true;
}
}
TencentSmsSenderImpl
public class TencentSmsSenderImpl implements SmsSender {
private SmsProperties.SmsMessage smsMessage;
public TencentSmsSenderImpl(SmsProperties.SmsMessage smsProperties) {
this.smsMessage = smsProperties;
}
@Override
public boolean send(String message) {
System.out.println(smsMessage.toString()+"开始发送短信==》短信内容:"+message);
return true;
}
}
4 让starter生效
starter集成应用有两种方式:
4.1 被动生效我们首先来看下我们熟悉的方式,通过SpringBoot的SPI的机制来去加载我们的starter。我们需要在META-INF下新建一个spring.factories文件key为org.springframework.boot.autoconfigure.EnableAutoConfiguration, value是我们的SmsAutoConfiguration 全限定名(记得去除前后的空格,否则会不生效)。
在starter组件集成到我们的Spring Boot应用时需要主动声明启用该starter才生效,通过自定义一个@Enable注解然后在把自动配置类通过Import注解引入进来。
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import({SmsAutoConfiguration.class})
public @interface EnableSms {
}
使用的时候需要在启动类上面开启这个注解。
打包,部署到仓库
如果是本地的话,直接通过mvn install命令就可以了。
如果需要部署到公司的仓库话,这个就不说了。
新建一个新的SpringBoot项目引入我们刚写的starter
com.workit.sms sms-spring-boot-starter0.0.1-SNAPSHOT
在项目配置文件配上短信账号信息
测试代码
@SpringBootApplication
@EnableSms
public class AutoconfigApplication {
public static void main(String[] args) {
ConfigurableApplicationContext applicationContext = SpringApplication.run(AutoconfigApplication.class, args);
AliyunSmsSenderImpl aliyunSmsSender = applicationContext.getBean(AliyunSmsSenderImpl.class);
aliyunSmsSender.send(“用阿里云发送短信”);
TencentSmsSenderImpl tencentSmsSender = applicationContext.getBean(TencentSmsSenderImpl.class);
tencentSmsSender.send(“用腾讯云发送短信”);
}
运行结果:
SmsMessage{userName=‘java金融’, passWord=‘12345’, sign=‘阿里云’, url=‘http://aliyun.com/send’}开始发送短信==》短信内容:用阿里云发送短信
SmsMessage{userName=‘java金融’, passWord=‘6666’, sign=‘腾讯云’, url=‘http://tencent.com/send’}开始发送短信==》短信内容:用腾讯云发送短信
至此的话我们自定义的一个starter就已经完成了,这个starter只是一个演示的demo,代码有点粗糙,项目结构也有点问题。重点看下这个实现原理就好。赶紧动动小手去实现一个自己的starter吧。
5 总结SpringBoot starter的出现,让我们项目中集成其他组件变得简单。它把简单给了别人,把复杂留给了自己。“牺牲小我,成就大我”的思想还是值得学习的。平时我们工作中,比如要开发一个组件、或者一个工具类,也应该尽可能的让使用方可以做到无脑使用,不要搞的太复杂,又能让使用者可以灵活扩展。



