一次Java應用構建並部署阿里雲ECS體驗詳情 - spring,maven,xml,Python,後端開發碼海航行俠博客

前言：SDK的概念與價值

一、SDK開發的前期準備

1.1 環境與工具準備

1.2 項目初始化

二、Spring Boot Starter SDK的詳細實現步驟

2.1 創建項目與配置依賴

2.2 編寫配置屬性類

2.3 實現核心客户端功能

2.4 配置自動裝配

2.5 完善配置元數據（可選）

2.6 本地打包與使用測試

三、上傳SDK到阿里雲倉庫（組織內共享）

3.1 發包規範

3.2 版本管理

3.3 準備阿里雲倉庫

3.4 配置setting.xml與pom.xml

3.5 發佈SDK到製品倉庫中

四、SDK從倉庫中拉取使用

五、最佳實踐與注意事項

六、總結

前言：SDK的概念與價值

在軟件開發領域，SDK（Software Development Kit，軟件開發工具包）是一個不可或缺的概念，它通常包含了一組工具、庫、文檔和示例代碼，幫助開發者更高效地構建應用程序。

對於Java生態系統而言，Spring Boot Starter SDK是一種特殊形式的SDK，它通過自動配置和依賴管理機制，極大地簡化了第三方服務的集成過程。通過開發自己的SDK，我們可以將常用功能封裝成易於使用的組件，其他開發者只需引入依賴即可快速集成，而無需關心底層實現細節。

開發SDK不僅能提高代碼的複用性和可維護性，還能促進團隊協作和技術標準化。理想情況下，開發者引入SDK後，只需要在配置文件中填寫必要參數，就可以直接使用客户端調用接口，就像調用自己寫的代碼一樣簡單。

本文將手把手教你如何從零開始創建一個Spring Boot Starter SDK，並在本地打包使用，以及上傳到阿里雲倉庫中進行分發使用。無論你是想為團隊內部工具提供統一接口，還是希望將公司服務開放給外部開發者，掌握SDK開發技能都將為你打開新世界的大門。接下來，讓我們一步步深入SDK的開發之旅。

一、SDK開發的前期準備

在開始開發SDK之前，我們需要明確目標並準備好相應的開發環境。首先，應當明確SDK的目標平台、功能需求以及目標用户。例如，你的SDK是針對Web應用還是移動應用？需要提供哪些核心功能？主要使用者是內部開發團隊還是外部開發者？清晰的目標將幫助你有針對性地進行開發規劃。

1.1 環境與工具準備

SDK開發需要一些基本的開發工具和環境支持。以下是必備的工具列表：

工具類別	推薦選擇	作用説明
Java開發環境	JDK 8+	編譯和運行Java代碼的基礎環境
項目構建工具	Maven 3.6+	管理項目依賴、構建和打包SDK
集成開發環境	IntelliJ IDEA	提供高效的代碼編寫和調試體驗
版本控制	Git	管理代碼版本和協作開發

除了上述工具，還需要確保本地已安裝並配置好Maven環境變量，以便在命令行中執行mvn相關命令。如果你計劃使用阿里雲倉庫，還需要提前註冊阿里雲賬號並獲取相應的倉庫地址和認證信息。

1.2 項目初始化

一切準備就緒後，我們就可以開始創建SDK項目了。使用Spring Initializr（可通過IDEA內置功能或訪問start.spring.io）快速生成項目框架，在選擇依賴時，需要添加以下兩個核心依賴

Lombok：通過註解簡化JavaBean的編寫，減少getter/setter等樣板代碼

Spring Configuration Processor：用於生成配置元數據，在application.yml中填寫配置時提供自動補全和提示功能

創建項目後，需要進行一些結構調整。由於SDK是作為依賴被其他項目引入，而不是獨立運行的應用，因此需要刪除Spring Boot啓動類以及Maven構建配置中的部分內容。這些準備工作為後續的SDK核心功能開發奠定了堅實基礎。

二、Spring Boot Starter SDK的詳細實現步驟

2.1 創建項目與配置依賴

首先，我們需要創建一個新的Spring Boot項目作為我們SDK的基礎框架。使用IntelliJ IDEA的Spring Initializr功能，選擇Maven作為構建工具，並設置合適的GroupId和ArtifactId。例如，如果你的SDK名為"example-sdk"，那麼可以設置：

com.exampleexample-sdk-spring-boot-starter1.0

在選擇依賴時，添加Lombok和Spring Configuration Processor等依賴。Spring Configuration Processor的作用是在其他開發者使用你的SDK時，在application.yml中提供配置項的智能提示和自動補全功能，極大提升開發體驗。

項目創建完成後，需要修改pom.xml文件，刪除<build>標籤中的內容。因為默認的build配置會將項目打包為可執行jar，但SDK應當作為依賴庫使用。同時，確保packaging設置為jar：

jar

最終的pom.xml文件：

4.0.0com.exampleexample-sdk-spring-boot-starter1.0example-sdkjar1717UTF-8org.springframework.bootspring-boot-starter2.7.12org.springframework.bootspring-boot-configuration-processortrue2.7.12org.springframework.bootspring-boot-autoconfigure2.7.12org.projectlomboklombok1.18.24

父pom文件：

4.0.0com.exampleexample-sdk-spring-boot-starter1.0pomexample-sdk1717UTF-8

2.2 編寫配置屬性類

配置屬性類是SDK自動配置的核心，它負責讀取application.yml或application.properties中的配置信息。創建一個配置類，使用@ConfigurationProperties註解指定配置前綴：

package com.example.sdk.config;
/**
 * Created with IntelliJ IDEA.
 *
 * @Author: yang
 * @Description: SDK配置
 */
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
@Data
@ConfigurationProperties(prefix = "example.api.client")
public class ExampleSDKProperties {
    /** 訪問密鑰 */
    private String accessKey;
    /** 密鑰 */
    private String secretKey;
}

上述代碼定義了一個配置類，它能夠讀取以shousi.api.client為前綴的配置項。@Data是Lombok註解，自動生成getter、setter等方法。這個類將配置信息集中管理，使其他組件可以方便地獲取這些屬性值。

2.3 實現核心客户端功能

SDK的核心價值在於封裝複雜邏輯，提供簡潔易用的API。接下來我們創建主要的客户端類，它包含了SDK提供的所有核心方法：

package com.example.sdk;
/**
 * Created with IntelliJ IDEA.
 *
 * @Author: yang
 * @Description: ApiClient
 */
import com.example.sdk.config.ExampleSDKProperties;
import lombok.extern.slf4j.Slf4j;
@Slf4j
public class ExampleApiClient {
    private final ExampleSDKProperties properties;
    public ExampleApiClient(ExampleSDKProperties properties) {
        this.properties = properties;
    }
    public String getUserInfo(String userId) {
        return properties.getAccessKey();
    }
    public String generateSignature() {
        return properties.getSecretKey();
    }
}

這個客户端類封裝了與後端API的交互細節，使用者只需調用getUserInfo方法並傳入userId，即可獲取用户信息，而無需關心HTTP請求的構造、認證等複雜細節。

2.4 配置自動裝配

自動裝配是Spring Boot Starter的核心特性，它使得SDK在被引入時能夠自動配置所需的Bean。我們需要創建一個配置類來定義這些Bean：

package com.example.sdk.config;
/**
 * Created with IntelliJ IDEA.
 *
 * @Author: yang
 * @Description: SDK自動配置
 */
import com.example.sdk.ExampleApiClient;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
@EnableConfigurationProperties(ExampleSDKProperties.class)
public class ExampleSDKAutoConfiguration {
    @Bean
    public ExampleApiClient exampleApiClient(ExampleSDKProperties properties) {
        return new ExampleApiClient(properties);
    }
}

為了讓Spring Boot能夠識別這個自動配置類，我們需要在src/main/resources目錄下創建META-INF文件夾，並在其中創建spring.factories文件，內容如下：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.example.sdk.config.ExampleSDKAutoConfiguration

SPI（Service Provider Interface）是一種服務發現機制，允許框架在運行時動態加載實現類。

在Java中，SPI通常通過在META-INF/services或META-INF/spring.factories等配置文件中聲明接口的實現類來實現。

Spring Boot利用SPI機制實現自動裝配（AutoConfiguration）。開發人員只需在組件的META-INF/spring.factories文件中配置自動配置類，Spring Boot啓動時便會自動加載並初始化這些類。

這樣，當其他項目引入我們的SDK時，Spring Boot會自動加載ExampleSDKAutoConfiguration類，並創建其中定義的所有Bean。

2.5 完善配置元數據（可選）

為了在使用SDK時提供更好的開發體驗（如在application.yml中輸入配置時獲得提示），我們可以創建額外的配置元數據文件。在src/main/resources/META-INF中創建additional-spring-configuration-metadata.json文件：

{
  "properties": [
    {
      "name": "example.api.client.access-key",
      "type": "java.lang.String",
      "description": "訪問API所需的AccessKey",
      "sourceType": "com.example.sdk.config.ExampleSDKProperties"
    },
    {
      "name": "example.api.client.secret-key",
      "type": "java.lang.String",
      "description": "訪問API所需的SecretKey",
      "sourceType": "com.example.sdk.config.ExampleSDKProperties"
    }
  ]
}

這個JSON文件為IDE提供了配置項的詳細信息，當開發者在application.yml中輸入配置時，IDE會顯示相應的描述和默認值，大大提升開發體驗。

2.6 本地打包與使用測試

三、上傳SDK到阿里雲倉庫（組織內共享）

你開發完的組件或者SDK，不只是你使用，還有其他很多人使用。但跨部門，跨組的別人又不一定都有你的代碼庫權限，這個時候就需要把本地微服務的 Jar 發包到公司或者第三方的 Maven 鏡像庫中。如：https://packages.aliyun.com/ 讓公司的所有人 Maven setting 配置文件都配置這套製品庫，這樣就解決了一個人發包，其他人也能拉取到使用。

另外，如果你想你發的包，不只是你自己或公司裏的人使用，那麼就要把包發到 Maven 統一的中心倉庫：https://central.sonatype.com/publishing 這個過程稍微有點漫長，會持續 4-12 個小時才能完全同步好。

3.1 發包規範

工程發包會分為開發階段的 snapshot 包和正式上線使用的 release 包，snapshot 包同一個版本發包後可以被替代，release 包，只能每次更換版本號。

com.exampleexample-sdk-spring-boot-starter1.0.0-SNAPSHOTcom.exampleexample-sdk-spring-boot-starter1.0.0

1.0.0-SNAPSHOT 以 SNAPSHOT 結尾是開發階段包，都是 1.0.0-SNAPSHOT 命名。

RELEASE包，只需要命名版本號即可。

另外這樣的微服務包的版本號，在一個工程中每個模塊都需要在發包的時候一起操作修改。如果是手動的修改就容易遺漏導致問題，所以這裏我們要使用 Maven 提供的插件管理包。如:

org.codehaus.mojoversions-maven-plugin2.7

一次Java應用構建並部署阿里雲ECS體驗_xml

配置好 versions-maven-plugin 點擊 version:set 就可以統一管理工程的版本號了。

3.2 版本管理

org.springframework.aispring-ai-bom${spring-ai.version}pomimport

首選，學東西我們可以先參考標準，看看 Spring 怎麼玩的，MyBatis 怎麼搞的。他們都是怎麼定義包讓我們引入的。

那麼，如上面 spring-ai 的使用方式，會先讓你引入一個 pom 文件，這個文件定義了 spring-ai 當前版本下各種包信息，每一個包匹配的版本都會給你定義好。也就是説這個 pom 是整個組件的規範定義。

一次Java應用構建並部署阿里雲ECS體驗_xml_02

在 example-sdk 下，新增加一個 example-sdk-bom 來統一管理SDK工程下的組件引入。這樣其他的業務項目，引入 example-sdk-bom 後，再引入其他的組件時，就不需要額外添加 version 版本號，需要什麼直接引入就可以了。

3.3 準備阿里雲倉庫

一次Java應用構建並部署阿里雲ECS體驗_xml_03

一次Java應用構建並部署阿里雲ECS體驗_maven_04

你會看到製品倉庫配置，包括生產庫和非生產庫，他們主要負責給你提供 release、snapshot 發包和拉取。

分別進入 release、snapshot，都可以獲得一份 Maven settings.xml 配置文件，把兩份文件夾下載後可以找到 release、snapshot 的差異，合併成一份文件。這樣你就可以在本地發 release、snapshot 包了。

一次Java應用構建並部署阿里雲ECS體驗_spring_05

注意；下載的 setting.xml 自帶賬號密碼。如果你將來要部署上線你的項目，使用的是雲服務器構建，那麼在雲服務器的 Maven 配置上下載的 setting.xml 文件。

另外，這個倉庫還可以手動上傳一個jar進來，之後在本地的 IntelliJ IDEA 打開的 SpringBoot 工程，也可以拉取到你上傳的 jar。其他人想使用你的 Jar 也要引入這個 setting.xml 但如果不需要對方上傳jar，只是拉取，那麼可以把server部分刪掉在給對方。

具體操作詳情請參考：

一次Java應用構建並部署阿里雲ECS體驗_spring_06

樣例文件

/Users/fuzhengwei/Applications/apache-maven-3.8.4/repositorymirrorcentral,jcenter,!2452122-snapshot-XqjwfNmirrorhttps://maven.aliyun.com/nexus/content/groups/public2452122-snapshot-XqjwfN65b081c2242105ca211dd310每個人會有自己的密碼2452122-release-dbuebF65b081c2242105ca211dd310每個人會有自己的密碼rdc
          2452122-snapshot-XqjwfN::default::https://packages.aliyun.com/65b081d4076e069afe3d2f50/maven/2452122-snapshot-xqjwfn
        
          2452122-release-dbuebF::default::https://packages.aliyun.com/65b081d4076e069afe3d2f50/maven/2452122-release-dbuebf
        centralhttps://maven.aliyun.com/nexus/content/groups/publictruefalsesnapshotshttps://maven.aliyun.com/nexus/content/groups/publicfalsetrue2452122-snapshot-XqjwfNhttps://packages.aliyun.com/65b081d4076e069afe3d2f50/maven/2452122-snapshot-xqjwfnfalsetrue2452122-release-dbuebFhttps://packages.aliyun.com/65b081d4076e069afe3d2f50/maven/2452122-release-dbuebftruefalsecentralhttps://maven.aliyun.com/nexus/content/groups/publictruefalsesnapshotshttps://maven.aliyun.com/nexus/content/groups/publicfalsetrue2452122-snapshot-XqjwfNhttps://packages.aliyun.com/65b081d4076e069afe3d2f50/maven/2452122-snapshot-xqjwfnfalsetrue2452122-release-dbuebFhttps://packages.aliyun.com/65b081d4076e069afe3d2f50/maven/2452122-release-dbuebftruefalserdc

3.4 配置setting.xml與pom.xml

推送步驟

一次Java應用構建並部署阿里雲ECS體驗_maven_07

在項目的父pom.xml中添加distributionManagement倉庫認證配置與插件配置：

4.0.0com.exampleexample-sdk-spring-boot-starter1.0pomexample-sdkexample-sdk-testexample-sdk-bom。。。https://packages.aliyun.com/。。。/maven/。。。-release-oubjyb1717UTF-8${project.artifactId}org.apache.maven.pluginsmaven-compiler-plugin3.0${java.version}
                    ${java.version}${project.build.sourceEncoding}17org.apache.maven.pluginsmaven-resources-plugin2.5UTF-8org.codehaus.mojoversions-maven-plugin2.7

3.5 發佈SDK到製品倉庫中

配置好步驟中的setting.xml文件以及maven後，進行deploy發佈。

一次Java應用構建並部署阿里雲ECS體驗_xml_08

查看倉庫

一次Java應用構建並部署阿里雲ECS體驗_xml_09

發包後，可以到你的倉庫查看是否已經將本地包發到了倉庫中。

到這裏，你的整個研發組，都配置好來自 https://packages.aliyun.com/ Maven 配置下的下載鏈接，就可以統一使用這套包拉取到自己本來進行使用了。

四、SDK從倉庫中拉取使用

拉取步驟

一次Java應用構建並部署阿里雲ECS體驗_xml_10

配置好setting.xml文件後新建測試工程

pom.xml 依賴文件

4.0.0com.exampleexample-sdk-test1.01717UTF-8。。。-release-oUbjYBhttps://packages.aliyun.com/。。。/maven/。。。-release-oubjybtruecom.exampleexample-sdk1.0org.springframework.bootspring-boot-starter-test2.7.12

執行命令

mvn install

一次Java應用構建並部署阿里雲ECS體驗_maven_11

一次Java應用構建並部署阿里雲ECS體驗_xml_12

可以看到製品倉庫中已經有下載量了，成功下載進我們的測試工程中。

application.yml 配置文件

將配置信息 example.api.client 放入配置文件中

server:
  port: 8080
example:
  api:
    client:
      access-key: test-access-key
      secret-key: test-secret-key

SdkApplication 主啓動類

package com.example.sdk;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
/**
 * Created with IntelliJ IDEA.
 *
 * @Author: yang
 * @Description: sdk主啓動類
 */
@SpringBootApplication
public class SdkApplication {
    public static void main(String[] args) {
        SpringApplication.run(SdkApplication.class, args);
    }
}

ExampleSdkApplicationTest SDK測試類

package com.example.sdk;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
/**
 * Created with IntelliJ IDEA.
 *
 * @Author: yang
 * @Description: sdk測試類
 */
@SpringBootTest(classes = SdkApplication.class)
class ExampleSdkApplicationTest {
    @Autowired
    private ExampleApiClient exampleApiClient;
    @Test
    void testGetUserInfo() {
        System.out.println(exampleApiClient.getUserInfo("1"));
    }
    @Test
    void testGenerateSignature() {
        System.out.println(exampleApiClient.generateSignature());
    }
}

測試結果

test-access-key
test-secret-key

這樣就成功實現自己開發一個簡單的測試SDK並且上傳到阿里雲製品倉庫供組織內成員使用。

五、最佳實踐與注意事項

版本管理：遵循語義化版本控制(versions-maven-plugin)

文檔編寫：提供清晰的README和使用示例

兼容性：考慮向後兼容性，避免破壞性變更

安全性：不要將敏感信息硬編碼在SDK中

性能：優化關鍵路徑的性能

六、總結

開發併發布自己的SDK是一個系統性的工程，從項目創建、代碼編寫到發佈部署，每個環節都需要仔細考慮。通過本文的指導，你應該已經掌握了開發簡單SDK並將其發佈到阿里雲倉庫的完整流程。一個好的SDK不僅能提高開發效率，還能促進團隊協作和代碼複用。隨着經驗的積累，你可以進一步探索更復雜的SDK設計模式和架構

本文章為轉載內容，我們尊重原作者對文章享有的著作權。如有內容錯誤或侵權問題，歡迎原作者聯繫我們進行內容更正或刪除文章。

碼海航行俠博客

碼海航行俠博客

博客 / 詳情