21. Go 語言中如何開源本身寫的包給別人用?

時間 2020-05-30

標籤語言如何開源本身寫的包給別人简体版

原文原文鏈接

Hi，你們好，我是明哥。git

在本身學習 Golang 的這段時間裏，我寫了詳細的學習筆記放在個人我的微信公衆號《Go編程時光》，對於 Go 語言，我也算是個初學者，所以寫的東西應該會比較適合剛接觸的同窗，若是你也是剛學習 Go 語言，不防關注一下，一塊兒學習，一塊兒成長。github

個人在線博客：golang.iswbm.com 個人 Github：github.com/iswbm/GolangCodingTimegolang

一般以前的學習，咱們知道了在 Go 的項目中，能夠 import 一個託管在遠程倉庫的模塊，這個模塊在咱們使用 go get 的時候，會下載到本地。shell

既然是放在遠程倉庫上，意味着全部人均可以發佈，而且因此人也均可以使用。編程

今天就來學習一下，如何發佈一個開源的模塊，而且使用它。數組

1. 新建倉庫

先在你的 Github 上新建一個倉庫，記得選 Public（默認）微信

而後你會獲得一個倉庫地址，在你的電腦上使用 git clone 命令克隆下來函數

2. 編寫模塊代碼

使用前面學過的 go mod init 命令進行初始化，注意這裏的模塊名，填寫咱們的git倉庫地址（可是要去掉.git哈）工具

$ git clone https://github.com/BingmingWong/goutils.git
$ go mod init github.com/BingmingWong/goutils複製代碼

而後新建一個 hash 文件夾，存放編寫的一個計算 md5 值工具包，編輯 md5.go學習

package hash

import (
    "crypto/md5"
    "encoding/hex"
    "errors"
    "fmt"
    "io"
    "os"
)

// get file md5
func FileMd5(filename string) (string, error) {
    file, err := os.Open(filename)
    if err != nil {
    return "", errors.New(
        fmt.Sprintf("md5.go hash.FileMd5 os open error %v", err))
    }
    h := md5.New()
    _, err = io.Copy(h, file)
    if err != nil {
        return "", errors.New(fmt.Sprintf("md5.go hash.FileMd5 io copy error %v", err))
    }

    return hex.EncodeToString(h.Sum(nil)), nil
}

// get string md5
func StringMd5(s string) string {
    md5 := md5.New()
    md5.Write([]byte(s))
    return hex.EncodeToString(md5.Sum(nil))
}複製代碼

因爲咱們使用的都是內置包，沒有引入第三方的包，因此接下來能夠把你剛剛那些新增的文件，所有 push 到 git 倉庫。

$ git add -A
$ git commit -m "Add a md5 function"
$ git push複製代碼

3. 發佈版本

一切完成後，刷新咱們的倉庫，就能夠看到咱們的剛剛上傳的項目代碼了，點擊 release 發佈一個版本

而後像下圖同樣，添加一些版本說明

最後點擊一個 Publish release，就發佈了一個版本

4. 如何使用？

使用 go get 命令下載咱們的發佈的模塊

$ go get github.com/BingmingWong/goutils複製代碼

再使用 tree 命令，查看一下咱們下載的包已經放入了 $GOPATH/pkg/mod 下。

有一點頗有趣的是，個人 Github 用戶名（BingmingWong）是有大寫字母的，下載下來後，在目錄中大寫字母會對應變成 !小寫字母，以下所示

這個用戶名看起來有點非主流，你要想改的話，也是能夠的。若是你有其餘的開源項目，github 並不會爲你作重定向，你須要本身評估這個風險。

回過頭來，我仍是繼續講如何使用吧。

下載下來後，咱們試着去調用一下他的函數，有一點須要注意的是，在這個示例裏，你不能使用 github.com/BingmingWong/goutils 去導入，由於在這個目錄下並無 package，因此你必須導入 github.com/BingmingWong/goutils/hash 。

整個過程以下所示，供你參考：