編寫客戶端SDK，并開源發(fā)布包到GitHub

如果希望其他項(xiàng)目能夠使用該SDK，可以將該SDK打包為一個(gè)Go模塊，并將其發(fā)布到Go模塊倉庫中。這將使其他項(xiàng)目能夠通過Go的模塊依賴機(jī)制來使用該SDK?？梢暂p松地引用和使用你的代碼。

1. 創(chuàng)建 GitHub 倉庫

1. 登錄到你的 GitHub 帳戶。
2. 在 GitHub 主頁點(diǎn)擊右上角的加號（+），然后選擇 “New repository”（新建倉庫）。
3. 給你的倉庫起一個(gè)名稱，選擇是公共的，然后點(diǎn)擊 “Create repository”（創(chuàng)建倉庫）按鈕。

• 克隆項(xiàng)目到本地：使用 git clone 命令來克隆倉庫到本地。需要提供 GitHub 倉庫的 URL，可以在倉庫頁面的右上角找到 “Code” 按鈕，然后選擇 HTTPS 或 SSH URL。
• 使用 HTTPS URL 克隆倉庫：

  git clone https://github.com/用戶名/倉庫名.git
  

• 使用 SSH URL 克隆倉庫（需要配置 SSH 密鑰）：

  git clone git@github.com:用戶名/倉庫名.git
  

2. 構(gòu)建項(xiàng)目，編寫代碼

克隆成功后，此時(shí)項(xiàng)目是一個(gè)空倉庫，使用 go mod 的方式管理包，對項(xiàng)目進(jìn)行初始化：

git mod init github.com/用戶名/倉庫名

初始化成功后，項(xiàng)目根目錄下會新增一個(gè) go.mod 文件。
?? 注意：這里的項(xiàng)目名需要為 github.com/用戶名/倉庫名 （將用戶名、倉庫名替換為你實(shí)際項(xiàng)目中的名稱）

Go 代碼示例：

package clienttype Client struct {AccessKey stringSecretKey string
}func NewClient(accessKey, secretKey string) *Client {return &Client{AccessKey: accessKey,SecretKey: secretKey,}
}func (c *Client) GetNameByGet(name string) (data interface{}, err error) {return "名字是" + name, nil
}

項(xiàng)目目錄結(jié)構(gòu)展示：

3. 提交代碼到 GitHub倉庫

完成了代碼編寫及測試正常后，將代碼提交到遠(yuǎn)程倉庫中。

1. 添加文件到暫存區(qū)： 使用 git add 命令將你要提交的文件添加到 Git 的暫存區(qū)?？梢允褂靡韵旅钐砑铀懈?#xff1a;

   git add .	//這個(gè)命令將當(dāng)前目錄下所有文件（包括新添加、修改和刪除的文件）添加到暫存區(qū)。但它不會包括未跟蹤的文件，也就是那些沒有被 Git 管理的文件。如果你在項(xiàng)目中新建了文件，使用這個(gè)命令將不會將它們添加到暫存區(qū)。
   git add -A 或 git add --all	//這個(gè)命令會將當(dāng)前目錄下的所有更改（包括新添加、修改、刪除的文件）以及未跟蹤的文件全部添加到暫存區(qū)。它是一個(gè)更全面的命令，適用于確保所有更改都被提交到 Git。
   

   或者，如果你只想添加特定文件，可以使用：

   git add 文件名
   

2. 提交更改： 使用 git commit 命令將暫存區(qū)的更改提交到本地倉庫，并添加提交消息來描述你的更改。例如：

   git commit -m "添加了一個(gè)新功能"
   

3. 推送到遠(yuǎn)程倉庫： 使用 git push 命令。例如：

   git push -u origin 分支名
   

   將 “分支名” 替換為你要推送的分支名稱。通常，main 或 master 是默認(rèn)的主分支名稱。

4. 📢 注意，如果你是第一次提交到 GitHub 倉庫，需要配置 Git 以關(guān)聯(lián)本地倉庫和遠(yuǎn)程倉庫。使用 git remote 命令來添加遠(yuǎn)程倉庫的別名。例如：

   git remote add origin 倉庫URL
   

   “origin” 是遠(yuǎn)程倉庫的別名，可以自定義?！皞}庫URL” 是你 GitHub 倉庫的 URL。
   一旦關(guān)聯(lián)了遠(yuǎn)程倉庫，就使用 git push 將更改推送到遠(yuǎn)程倉庫

4. 發(fā)布版本

push成功后，刷新GitHub上的倉庫，確認(rèn)項(xiàng)目代碼已經(jīng)上傳成功。然后點(diǎn)擊tags 創(chuàng)建標(biāo)簽和構(gòu)建release版本。

接著點(diǎn)擊：Create a new release

然后，添加一個(gè)版本號打上tag，完善描述信息后，點(diǎn)擊 Publish release 發(fā)布。

5. 現(xiàn)在其他人可以引用使用你的模塊包了

成功發(fā)布后，其他人就可以像平時(shí)使用第三方包一樣直接go get 和 import 我們的模塊包了。

go get github.com/用戶名/倉庫名

或者

require (github.com/用戶名/倉庫名 v1.0.0
)

然后運(yùn)行 go get 命令下載該依賴。

使用該模塊包：

package main
import "github.com/xiaoxiongmao5/xapi-clientsdk/client"func main() {accessKey, secretKet := "zs", "123456"clientsdk = client.NewClient(accessKey, secretKey)data, err := clientsdk.GetNameByGet(name)if err != nil {fmt.Println("ERROR: Failed to read response, err=", err)return}fmt.Printf("SUCCESS: data=%T data=%v \n", data, data)
}