Einrichten und Verwenden privater Module in Go

Der Einstieg in private Module in Go kann ohne die richtigen Referenzressourcen zu einer entmutigenden Aufgabe werden. Dies liegt daran, dass Go-Module nicht von einem zentralen Repository gespeichert oder bereitgestellt werden, sondern aus verschiedenen Repositorys abgerufen werden können. Ein Beispiel ist Github.

Das Importieren öffentlicher Go-Pakete in Ihr Projekt kann so einfach sein wie das Ausführen eines einzigen Befehls:

$ go get github.com/author/module-name

Andererseits sind für die Einrichtung und Verwendung privater Module in Go weitere Schritte erforderlich. Mit privaten Modulen können Sie private Pakete in einem Repository Ihrer Wahl hosten und verwenden, ohne den Code unbedingt öffentlich zugänglich zu machen.

Um ein privates Modul einzurichten, erstellen Sie zunächst ein Verzeichnis und navigieren Sie dorthin. Initialisieren Sie das Modul, indem Sie den folgenden Befehl ausführen:

$ go mod init github.com/author/module-name

Der nächste Schritt ist das Festschreiben, das Hinzufügen eines Tags für das Festschreiben, das bei der Versionierung des Moduls hilft, und das Übertragen des Moduls in ein Repository, in diesem Fall Github.

In diesem Beispiel ist das Modul das Stammverzeichnis Ihres Projekts, aber es gibt Fälle, in denen ein anderes Go-Modul das Stammverzeichnis ist und Sie Submodule haben könnten. Bei Submodulen würde der obige Befehl wie folgt übersetzt werden:

$ go mod init github.com/author/root-module/module-name

Ein privates Repository abrufen
Das Modul wird jetzt in einem Repository gehostet, ist jedoch privat und erfordert daher eine Authentifizierung, bevor man es abrufen und in seinen Projekten verwenden kann. Projekte können auf das Modul zugreifen, indem sie sich mithilfe lokaler Umgebungsvariablen, über eine Github-Aktion oder eine Docker-Datei authentifizieren.

In diesem Artikel konzentrieren wir uns auf den Zugriff auf ein privates Repository unter Verwendung lokaler Umgebungsvariablen. Dies kann mit den folgenden zwei Optionen erreicht werden.

Bei beiden Optionen ist es erforderlich, die Umgebungsvariable GOPRIVATE festzulegen. Mithilfe der Umgebungsvariablen GOPRIVATE kann der Go-Befehl ermitteln, ob das abgerufene Modul öffentlich oder privat ist. Es enthält Muster, die mit Repository-Paketnamen verglichen werden, und alle Paketnamen, die mit dieser Variablen übereinstimmen, werden nicht über den öffentlichen Go-Cache-Server abgerufen.

Legen Sie die Umgebungsvariable GOPRIVATE fest und exportieren Sie sie, indem Sie die folgenden Befehle im Modulverzeichnis ausführen.

$ export GOPRIVATE=github.com/author/module-name

Alternativ können Sie den Befehl „Go env“ verwenden, um die Variable GOPRIVATE wie folgt festzulegen:

$ go env -w GOPRIVATE=github.com/author/module-name
$ go env GOPRIVATE

*Git für den Abruf über SSH statt HTTP(S) konfigurieren
*
Der Befehl „Go get“ verwendet http oder https, um Module von Git abzurufen. Um sicherzustellen, dass SSH zum Abrufen des Moduls verwendet wird, können Sie dies tun, indem Sie die Git-Konfigurationsdatei bearbeiten oder diesen Befehl verwenden:

$ go env -w GOPRIVATE=github.com/author/module-name
$ go env GOPRIVATE

*Go mit einem persönlichen Zugriffstoken konfigurieren
*
Wenn die Variable GOPRIVATE festgelegt ist, müssen Sie für diese Option zwei weitere Variablen festlegen und exportieren.

Die Variable GITHUB_ACCESS_TOKEN ist auf ein persönliches Zugriffstoken festgelegt, das Sie über die Github-Einstellungen erstellen können: Persönliches Zugriffstoken. Stellen Sie sicher, dass Sie dem Token einen Namen geben und das Repo im Abschnitt „Bereich“ auswählen.

Die andere Variable, die festgelegt und exportiert werden muss, ist die GONOPROXY-Variable, die auf „localhost“ gesetzt ist, was hervorhebt, dass diese URL nicht mit der Prüfsummendatenbank verglichen werden sollte.

$ git config --global url."git@github.com:author/module-name".insteadOf "https://github.com/author/module-name"

Aktualisieren Sie abschließend die globale Git-Konfiguration, um das generierte persönliche Token zu verwenden.

$ export GONOPROXY=localhost 
$ export GITHUB_ACCESS_TOKEN=<your-token>

Mit diesen Konfigurationen sollten Sie nun in der Lage sein, das private Modul mit einer der oben genannten Optionen abzurufen und in Ihrem Projekt zu verwenden. Um das Modul abzurufen, führen Sie go run aus. Befehl zum Erstellen des Projekts, der wiederum das Modul abruft, wenn eine der Abhängigkeiten des Projekts hinzugefügt wird, oder indem der Befehl go get ausgeführt wird, der den Github-Pfad des Moduls angibt.

Das obige ist der detaillierte Inhalt vonEinrichten und Verwenden privater Module in Go. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!