Cara membuka sumber pustaka Go anda sendiri

Dengan semangat sumber terbuka, jika kita ingin berkongsi pakej yang kita bangunkan supaya orang lain boleh menggunakannya

arahan untuk mendapatkannya, apakah yang perlu saya lakukan?

Artikel ini akan membawa sumber terbuka ke platform Github sebagai contoh untuk menunjukkan proses.

Buat gudang

Mula-mula, buat gudang pada platform github dan tetapkan nama perpustakaan Go yang anda mahu buka sumber. Di sini, nama projek ialah publishdemo dan statusnya ialah Awam.

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

Pada masa ini, dalam direktori akar projek<code style="font-size: 14px;overflow-wrap: break-word;padding: 2px 4px;border-radius: 4px;margin-right: 2px;margin-left: 2px;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;word-break: break-all;background: rgba(14, 210, 247, 0.15);"><span style="font-size: 15px;">publishdemo/</span>下，仅包含了 LICENSE 和 README 文件，不包含任何 Go 代码。

$ ls
LICENSE   README.md

为项目初始化 mod 文件

$ go mod init github.com/golangShare/publishdemo

假设，我们想开源的 Go 工具类的库，此时准备先提供的是对字符串相关的操作。因此在<code style="font-size: 14px;overflow-wrap: break-word;padding: 2px 4px;border-radius: 4px;margin-right: 2px;margin-left: 2px;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;word-break: break-all;background: rgba(14, 210, 247, 0.15);"><span style="font-size: 15px;">publishdemo/</span>目录下，我们新增<span style="font-size: 15px;">stringutil/</span>publishdemo/< /code >, hanya fail LESEN dan README disertakan dan tiada kod Go disertakan.

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)
}

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

Sudah tentu, kami juga harus menyediakan kod ujian. Tambahkan fail reverse_test.go dalam direktori tahap yang sama dengan kandungan berikut.

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

$ go mod tidy

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

$ git push origin v0.1.0

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

$ 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 库，其实非常简单。