下面我们就来实现一个自定义的发送短信的starter，命名为sms-spring-boot-starter。
一、引入 POM
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>二、配置文件
发短信我们需要配置一些账号信息，不同的短信供应商，账户信息是不一样的，所以我们需要定义一个XXXXProperties 来自动装配这些账户信息。下面我们就以腾讯云和阿里云两家供应商为例；
@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;
}
}如果需要在其他项目中使用发送短信功能的话，我们只需要在配置文件(application.ym）中配置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三、自动配置类
@EnableConfigurationProperties(value = SmsProperties.class)
@Configuration
public class SmsAutoConfiguration {
/**
* 阿里云发送短信的实现类
* @param smsProperties
* @return
*/
@Bean
public AliyunSmsSenderImpl aliYunSmsSender(SmsProperties smsProperties){
return new AliyunSmsSenderImpl(smsProperties.getAliyun());
}
/**
* 腾讯云发送短信的实现类
* @param smsProperties
* @return
*/
@Bean
public TencentSmsSenderImpl tencentSmsSender(SmsProperties smsProperties){
return new TencentSmsSenderImpl(smsProperties.getTencent());
}
}编写我们的发送短信实现类：
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;
}
}四、让 starter 生效
1、原理
如果上面的注解加在当前项目中那么当SpingBoot主类启动的时候，@SpringBootApplication 注解会默认去扫描的本包和它的子包的所有需要装配的类，自动装配到spring的bean容器中。
但是如果你提供了一个Jar包供第三方用户使用，那么你这个jar包中的Bean，能被第三方加载么？
这就要看你当前项目的包名和你你引用的第三方Jar包的包名了。
- 如果项目包名和第三方 jar 包的包名相同，可以被扫描到，但是一般不会出现相同的情况
既然@SpringBootApplication注解默认扫描只是当前项目的本包和它的子包,那就想办法让它扫描第三方jar的包就好了。
2、@ComponentScan
@ComponentScan主要就是定义扫描的路径从中找出标识了需要装配的类自动装配到spring的bean容器中。
@ComponentScan(basePackages ={"com.third.bean"})
@SpringBootApplication()
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class);
}
}不过一般自定义 starter 不会采用上面这种方式，而是采用下面两种方式
3、@Import
@ComponentScan是扫描整个包,但其实你可能只需注入一个或者几个指定的Bean,那我们可以考虑用 @Import 注解
@Import(value= com.third.bean.ThirdComponentBean.class)
@SpringBootApplication()
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class);
}
}一般这种方式会在做一层封装，@Enable***
如 @EnableScheduling、@EnableAsync
在starter组件集成到我们的Spring Boot应用时需要主动声明启用该starter才生效，通过自定义一个@Enable注解然后在把自动配置类通过Import注解引入进来。
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import({SmsAutoConfiguration.class})
public @interface EnableSms {
}使用的时候需要在启动类上面开启这个注解。
@EnableSms
@SpringBootApplication()
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class);
}
}4、spring.factories
上面两种注入方式都有个很明显缺点,就是如果我需要引用外部jar包的Bean的时候,都需要在当前项目配置 @ComponentScan 或者 @Import 去扫描才能注入当前Bean，这样显然不够友好。
可不可以当前项目什么都不做就可以直接引用第三方jar的Bean呢？
我们只需要在将配置放在第三方jar指定的文件中即可，使用者会自动加载，从而避免的代码的侵入（SPI机制）
- 在资源目录下新建目录 META-INF
- 在 META-INF 目录下新建文件
spring.factories - 在文件中添加下面配置
org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.third.bean.ConfigurationBean
