堅持學習第六天:SpringBoot 2.x 編寫自己的Springboot starter

  • 認真是一種態(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

最后編輯于
?著作權歸作者所有,轉載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末召川,一起剝皮案震驚了整個濱河市南缓,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌荧呐,老刑警劉巖汉形,帶你破解...
    沈念sama閱讀 219,110評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異倍阐,居然都是意外死亡概疆,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,443評論 3 395
  • 文/潘曉璐 我一進店門峰搪,熙熙樓的掌柜王于貴愁眉苦臉地迎上來岔冀,“玉大人,你說我怎么就攤上這事概耻∈固祝” “怎么了罐呼?”我有些...
    開封第一講書人閱讀 165,474評論 0 356
  • 文/不壞的土叔 我叫張陵,是天一觀的道長童漩。 經(jīng)常有香客問我弄贿,道長,這世上最難降的妖魔是什么矫膨? 我笑而不...
    開封第一講書人閱讀 58,881評論 1 295
  • 正文 為了忘掉前任差凹,我火速辦了婚禮,結果婚禮上侧馅,老公的妹妹穿的比我還像新娘危尿。我一直安慰自己,他們只是感情好馁痴,可當我...
    茶點故事閱讀 67,902評論 6 392
  • 文/花漫 我一把揭開白布谊娇。 她就那樣靜靜地躺著,像睡著了一般罗晕。 火紅的嫁衣襯著肌膚如雪济欢。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,698評論 1 305
  • 那天小渊,我揣著相機與錄音法褥,去河邊找鬼。 笑死酬屉,一個胖子當著我的面吹牛半等,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播呐萨,決...
    沈念sama閱讀 40,418評論 3 419
  • 文/蒼蘭香墨 我猛地睜開眼杀饵,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了谬擦?” 一聲冷哼從身側響起切距,我...
    開封第一講書人閱讀 39,332評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎惨远,沒想到半個月后蔚舀,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,796評論 1 316
  • 正文 獨居荒郊野嶺守林人離奇死亡锨络,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,968評論 3 337
  • 正文 我和宋清朗相戀三年赌躺,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片羡儿。...
    茶點故事閱讀 40,110評論 1 351
  • 序言:一個原本活蹦亂跳的男人離奇死亡礼患,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情缅叠,我是刑警寧澤悄泥,帶...
    沈念sama閱讀 35,792評論 5 346
  • 正文 年R本政府宣布,位于F島的核電站肤粱,受9級特大地震影響弹囚,放射性物質發(fā)生泄漏。R本人自食惡果不足惜领曼,卻給世界環(huán)境...
    茶點故事閱讀 41,455評論 3 331
  • 文/蒙蒙 一鸥鹉、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧庶骄,春花似錦毁渗、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,003評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至羔飞,卻和暖如春肺樟,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背逻淌。 一陣腳步聲響...
    開封第一講書人閱讀 33,130評論 1 272
  • 我被黑心中介騙來泰國打工么伯, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人恍风。 一個月前我還...
    沈念sama閱讀 48,348評論 3 373
  • 正文 我出身青樓,卻偏偏與公主長得像誓篱,于是被迫代替她去往敵國和親朋贬。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 45,047評論 2 355

推薦閱讀更多精彩內(nèi)容