So öffnen Sie Ihre eigene Go-Bibliothek als Open Source

Freigeben: 2023-07-24 15:15:42
nach vorne
843 Leute haben es durchsucht
Wenn wir Go-Projekte entwickeln, verwenden wir häufig einige externe Abhängigkeitspakete. Sie haben im Allgemeinen die Form: Radius: 4px; Rand-links: 2px; Schriftfamilie: „Operator Mono“, Monospace: break-all; , 0,15);"><span style="font-size: 15px;">go get example.com/xxx</span>的命令形式获取到本地使用。

本着开源精神,如果我们想将自己开发的包共享出去,让其他人也能使用<span style="font-size: 15px;">go get</span>go get example.com/xxx Befehlsformular, um die lokale Verwendung zu erhalten.


Im Sinne von Open Source, wenn wir die von uns entwickelten Pakete teilen möchten, damit andere sie nutzen können

go get

Befehl, um sie zu bekommen, was soll ich tun?

In diesem Artikel wird Open Source auf der Github-Plattform als Beispiel verwendet, um den Prozess zu veranschaulichen.

So öffnen Sie Ihre eigene Go-Bibliothek als Open SourceErstellen Sie ein Warehouse

Erstellen Sie zunächst ein Warehouse auf der Github-Plattform und legen Sie den Namen der Go-Bibliothek fest, die Sie als Open Source öffnen möchten. Hier lautet der Projektname „publishdemo“ und der Status „Öffentlich“.

🎜🎜Modulcode entwickeln🎜🎜🎜🎜Übertragen Sie das erstellte Warehouse über den Git-Clone-Befehl in die lokale Entwicklung. 🎜🎜
$ git clone git@github.com:golangShare/publishdemo.git
Nach dem Login kopieren

Zu diesem Zeitpunkt im Projektstammverzeichnis下,仅包含了 LICENSE 和 README 文件,不包含任何 Go 代码。

$ ls
LICENSE   README.md
Nach dem Login kopieren

为项目初始化 mod 文件

$ go mod init github.com/golangShare/publishdemo
Nach dem Login kopieren

假设,我们想开源的 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 >, nur die LIZENZ- und README-Dateien sind enthalten und kein Go-Code ist enthalten.

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)
}
Nach dem Login kopieren
Initialisieren Sie die Mod-Datei für das Projekt

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)
  }
 }
}
Nach dem Login kopieren
Angenommen, wir möchten die Go-Tool-Klassenbibliothek als Open Source veröffentlichen. Zu diesem Zeitpunkt werden wir zunächst stringbezogene Operationen bereitstellen. Also in

<p data-tool="mdnice编辑器" style="padding-top: 8px;padding-bottom: 8px;line-height: 26px;font-size: 17px;word-spacing: 3px;letter-spacing: 1px;">publishdemo/<span style="font-size: 15px;">Unter dem Verzeichnis haben wir hinzugefügt

<p data-tool="mdnice编辑器" style="padding-top: 8px;padding-bottom: 8px;line-height: 26px;font-size: 17px;word-spacing: 3px;letter-spacing: 1px;">stringutil/<span style="font-size: 15px;">Unterverzeichnis, im Unterverzeichnis umgekehrt hinzufügen. go-Datei, ihr Inhalt ist wie folgt.

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

1 directory, 5 files
Nach dem Login kopieren
Es ist ganz einfach, wir möchten eine Flip-String-Funktion bereitstellen.

Natürlich sollten wir auch Testcode bereitstellen. Fügen Sie die Datei reverse_test.go im Verzeichnis derselben Ebene mit dem folgenden Inhalt hinzu.

$ go test ./...
ok   github.com/golangShare/publishdemo/stringutil 0.005s
Nach dem Login kopieren
Gehen Sie zurück zum Projektstammverzeichnis. Zu diesem Zeitpunkt ist die Codestruktur wie folgt:

$ go mod tidy
Nach dem Login kopieren
Der Testcode wurde ebenfalls von

$ git commit -m "add Reverse: for v0.1.0"
$ git tag v0.1.0
Nach dem Login kopieren
entwickelt und wir können die Toolbibliothek teilen.

🎜🎜🎜Release🎜🎜🎜🎜Um zu vermeiden, dass nicht mehr benötigte Abhängigkeiten im Modul aufgezeichnet werden, führen Sie go mod Tidy aus, um sie zu entfernen. 🎜🎜
$ git push origin v0.1.0
Nach dem Login kopieren
Nach dem Login kopieren
🎜🎜Verwenden Sie den Befehl git tag, um die Versionsinformationen zu markieren🎜🎜
$ go get github.com/golangShare/publishdemo@v0.1.0
Nach dem Login kopieren
Nach dem Login kopieren
🎜🎜Schieben Sie sie in das Remote-Repository🎜🎜
$ git push origin v0.1.0
Nach dem Login kopieren
Nach dem Login kopieren

使用

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

$ go get github.com/golangShare/publishdemo@v0.1.0
Nach dem Login kopieren
Nach dem Login kopieren

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

require github.com/golangShare/publishdemo v0.1.0
Nach dem Login kopieren

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

package main

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

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

总结

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

Das obige ist der detaillierte Inhalt vonSo öffnen Sie Ihre eigene Go-Bibliothek als Open Source. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!

Verwandte Etiketten:
go
Quelle:Go语言进阶学习
Erklärung dieser Website
Der Inhalt dieses Artikels wird freiwillig von Internetnutzern beigesteuert und das Urheberrecht liegt beim ursprünglichen Autor. Diese Website übernimmt keine entsprechende rechtliche Verantwortung. Wenn Sie Inhalte finden, bei denen der Verdacht eines Plagiats oder einer Rechtsverletzung besteht, wenden Sie sich bitte an admin@php.cn
Beliebte Tutorials
Mehr>
Neueste Downloads
Mehr>
Web-Effekte
Quellcode der Website
Website-Materialien
Frontend-Vorlage