-
認真是一種態(tài)度,堅持是一種品格,優(yōu)秀是一種習慣鲤脏!
??最近被因為一場疫情,被關家了巡扇。2020愿一切早點好起來坪圾。
??在SpringBoot的使用過程中,我們深刻體會到了Springboot starter帶來的方便快捷杰赛,通過maven構建的項目爽室,只需要在pom.xml中引入某個starter,我們不用寫一行代碼淆攻,只需簡單的加些配置,一個基礎項目就有了嘿架。那我們是否也可以自己搞個自己的SDK瓶珊,當然可以。
??嘗試自己寫個簡單的DEMO:
基本步驟:
- 創(chuàng)建SpringBoot項目耸彪,引入自動配置依賴:
- 添加配置文件類(xxxProperties)和自動配置類
- 封裝SDK業(yè)務實現(xiàn)
- 在resources目錄下增加META-INF/spring.factpries配置自動配置類
- 構建SDK包伞芹,maven-install發(fā)布到本地倉庫測試
- 若有條件發(fā)布到自有私庫提供給其他項目使用
1.首先創(chuàng)建自己的SpringBoot Starter項目:直接創(chuàng)建一個Maven項目(注意項目名稱:自定義名稱-spring-boot-starter):如下圖
image.png
2.引入自動配置相關依賴
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.acm</groupId>
<artifactId>acm-sdk-spring-boot-starter</artifactId>
<version>1.0-SNAPSHOT</version>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.0.6.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.10</version>
<scope>provided</scope>
</dependency>
</dependencies>
</project>
3.創(chuàng)建配置屬性類和自動裝配Configuration
項目基本結構:
項目基本結構
4.編寫對應的實現(xiàn)代碼
- 屬性文件,假設我準備支持阿里云和sendCloud的短信API發(fā)送
package com.acm.sdk.properties;
import com.acm.sdk.constant.SmsTypes;
import com.acm.sdk.properties.type.AliYun;
import com.acm.sdk.properties.type.SendCloud;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import java.io.Serializable;
/**
* <p>
* SmsProperties
* </p>
*
* @author jackcooperz
* @date 2020/3/11 9:02
*/
@Data
@ConfigurationProperties(prefix = SmsProperties.SMS_NAME_PREFIX)
public class SmsProperties implements Serializable {
/**
* 短信配置前綴
*/
public static final String SMS_NAME_PREFIX = "sms";
/**
* 短信API類型 默認短信API類型 默認SendCloud
*/
private String defaultSmsType = SmsTypes.SEND_CLOUD.getSmsType();
/**
* SendCloud 短信API
*/
private SendCloud sendCloud;
/**
* 阿里云 短信API
*/
private AliYun aliyun;
}
- 業(yè)務實現(xiàn)Service(僅做demo)
package com.acm.sdk.service;
import com.acm.sdk.constant.SmsTypes;
import com.acm.sdk.properties.SmsProperties;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
/**
* <p>
* SmsService
* </p>
*
* @author jackcooperz
* @date 2020/3/11 9:08
*/
@Service
public class SmsService {
@Autowired
private SmsProperties smsProperties;
/**
* 讀取配置文件顯示返回測試
*
* @return SmsProperties
*/
public SmsProperties readSmsProperties() {
return smsProperties;
}
/**
* 發(fā)送短信
*
* @return String
*/
public String sendSms() {
if (SmsTypes.ALI_YUN.getSmsType().equals(smsProperties.getDefaultSmsType())) {
return "阿里云短信發(fā)送成功";
} else if (SmsTypes.SEND_CLOUD.getSmsType().equals(smsProperties.getDefaultSmsType())) {
return "sendCloud短信發(fā)送成功";
}
return "未知的短信API類型蝉娜,暫不支持";
}
}
- 編寫自動裝配類
package com.acm.sdk.configuration;
import com.acm.sdk.properties.SmsProperties;
import com.acm.sdk.service.SmsService;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
/**
* <p>
* SmsAutoConfiguration
* </p>
*
* @author jackcooperz
* @date 2020/3/11 9:05
*/
@Configuration
@ComponentScan("com.acm.sdk")
@EnableConfigurationProperties(value = {SmsProperties.class})
@ConditionalOnClass(SmsService.class)
public class SmsAutoConfiguration {
}
- 添加Spring.factories
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.acm.sdk.configuration.SmsAutoConfiguration
- maven-install構建SDK,
構建SDK
構建SDK
編寫DEMO測試看看
引入SDK
<dependency>
<groupId>com.acm</groupId>
<artifactId>acm-sdk-spring-boot-starter</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
配置屬性
sms:
default-sms-type: aliyun
aliyun:
signName: test
accessKeyId: test
accessKeySecret: test
編寫接口測試看看
@Autowired
private SmsService smsService;
@ResponseBody
@RequestMapping(value = "/readSms")
public SmsProperties readSms() {
return smsService.readSmsProperties();
}
@ResponseBody
@RequestMapping(value = "/send")
public String sendSms() {
return smsService.sendSms();
}
配置屬性讀取
發(fā)送業(yè)務調用
至此一個自己的spring-boot-starter就基本完成了唱较,剩下的就是根據(jù)自己的業(yè)務封裝SDK。
附上項目DEMO地址:https://gitee.com/jingchu/acm-sdk-spring-boot-starter.git