<code style='letter-spacing: 1px; word-spacing: 3px; text-align: left; 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;">go get example.com/xxx</span>
go get example.com/xxx的命令形式获取到本地使用。本着开源精神,如果我们想将自己开发的包共享出去,让其他人也能使用<span style="font-size: 15px;">go get</span>
<span style="font-size: 15px;">go get</span>
本文将以开源至 Github 平台为例,展示其流程。
首先,在 github 平台建立仓库,设置想要开源的 Go 库名。这里将项目名取为 publishdemo,状态为 Public。
将创建好的仓库,通过 git clone 命令拉取至本地开发。
$ git clone git@github.com:golangShare/publishdemo.git
此时,在项目根目录<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>
publishdemo/下,仅包含了 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><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> 很简单,我们想提供的是一个翻转字符串功能函数。 发布 <🎜>将其 push 至远程仓库<🎜><🎜> 发布之后,其他项目就可以通过以下命令获取我们开源的 Go 包了。 此时项目 go.mod 文件中,将会增加以下一行记录 和其他三方库一样的方式使用即可 看完了上述流程,可以发现:开源自己的 Go 库,其实非常简单。<span style="font-size: 15px;">stringutil/</span>
目录下,我们新增</span>stringutil/</p>
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
$ 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
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 库的详细内容。更多信息请关注PHP中文网其他相关文章!