如何開源自己的 Go 函式庫

我們在開發 Go 專案時，常常會使用到一些外部依賴套件。它們一般都是透過形如<span style="font-size: 15px;">go get example.com/xxx</span>的指令形式來取得到本機使用。

本著開源精神，如果我們想將自己開發的套件共享出去，讓其他人也能使用<span style="font-size: 15px;">go get</span>指令取得到它們，該如何做呢？

本文將以開源至 Github 平台為例，展示其流程。

建立倉庫

首先，在 github 平台建立倉庫，設定想要開源的 Go 函式庫名稱。這裡將專案名稱取為 publishdemo，狀態為 Public。

開發模組程式碼

#將建立好的倉庫，透過git clone 指令拉取至本機開發。

$ git clone git@github.com:golangShare/publishdemo.git

此時，在專案根目錄<span style="font-size: 15px;">publishdemo/</span>下，僅包含了 LICENSE 和 README 文件，不包含任何 Go 程式碼。

$ ls
LICENSE   README.md

為專案初始化mod 檔

$ go mod init github.com/golangShare/publishdemo

假設，我們想要開源的Go 工具類別的函式庫，此時準備先提供的是對字串相關的操作。因此在<span style="font-size: 15px;">publishdemo/</span>目錄下，我們新增<span style="font-size: 15px;">stringutil/</span>子目錄，在子目錄中增加reverse.go 文件，其內容如下。

package stringutil

// Reverse returns its argument string reversed rune-wise left to right.
func Reverse(s string) string {
 r := []rune(s)
 for i, j := 0, len(r)-1; i < len(r)/2; i, j = i+1, j-1 {
  r[i], r[j] = r[j], r[i]
 }
 return string(r)
}

很簡單，我們想提供的是一個翻轉字串函數。

當然，我們也應該提供測試程式碼。在同級目錄增加 reverse_test.go 文件，其內容如下。

package stringutil

import "testing"

func TestReverse(t *testing.T) {
 for _, c := range []struct {
  in, want string
 }{
  {"Hello, world", "dlrow ,olleH"},
  {"Hello, 世界", "界世 ,olleH"},
  {"", ""},
 } {
  got := Reverse(c.in)
  if got != c.want {
   t.Errorf("Reverse(%q) == %q, want %q", c.in, got, c.want)
  }
 }
}

回到專案根目錄，此時，程式碼結構如下

.
├── LICENSE
├── README.md
├── go.mod
└── stringutil
    ├── reverse.go
    └── reverse_test.go

1 directory, 5 files

測試程式碼也都透過

$ go test ./...
ok   github.com/golangShare/publishdemo/stringutil 0.005s

開發完成，我們就可以將工具庫共用出去了。

發布

為了避免模組中也記錄了不再需要的依賴項，執行 go mod tidy 移除它們。

$ go mod tidy

使用 git tag 指令標記版本資訊

$ git commit -m "add Reverse: for v0.1.0"
$ git tag v0.1.0

將其 push 至遠端倉庫

$ git push origin v0.1.0

使用

发布之后，其他项目就可以通过以下命令获取我们开源的 Go 包了。

$ go get github.com/golangShare/publishdemo@v0.1.0

此时项目 go.mod 文件中，将会增加以下一行记录

require github.com/golangShare/publishdemo v0.1.0

和其他三方库一样的方式使用即可

package main

import (
 "fmt"
 "github.com/golangShare/publishdemo/stringutil"
)

func main() {
 s := stringutil.Reverse("hello gopher")
 fmt.Println(s)
}

总结

看完了上述流程，可以发现：开源自己的 Go 库，其实非常简单。

以上是如何開源自己的 Go 函式庫的詳細內容。更多資訊請關注PHP中文網其他相關文章！