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

本文轉載自查看原文 2020-05-29 11:05 797 Python

Hi，大家好，我是明哥。

在自己學習 Golang 的這段時間里，我寫了詳細的學習筆記放在我的個人微信公眾號《Go編程時光》，對於 Go 語言，我也算是個初學者，因此寫的東西應該會比較適合剛接觸的同學，如果你也是剛學習 Go 語言，不防關注一下，一起學習，一起成長。

我的在線博客：http://golang.iswbm.com
我的 Github：github.com/iswbm/GolangCodingTime

通常之前的學習，我們知道了在 Go 的項目中，可以 import 一個托管在遠程倉庫的模塊，這個模塊在我們使用 go get 的時候，會下載到本地。

既然是放在遠程倉庫上，意味着所有人都可以發布，並且所以人也都可以使用。

今天就來學習一下，如何發布一個開源的模塊，並且使用它。

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 。

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