Heim >Backend-Entwicklung >Golang >Was ist ein Go-Modul? Wie benutzt man es? (mit Anwendungsbeispielen)

Was ist ein Go-Modul? Wie benutzt man es? (mit Anwendungsbeispielen)

藏色散人
藏色散人nach vorne
2022-01-12 16:02:395535Durchsuche

Dieser Artikel wird in der golangtutorial-Kolumne vorgestellt, um die Verwendung des Go-Moduls vorzustellen. Ich hoffe, dass er Freunden in Not hilfreich sein wird!

go-Modulnutzung

go-Modul wurde nach der Go-Version 1.14 gestartet

1. Einführung in die Go-Modulnutzung

go module ist das offizielle Versionsverwaltungstool, das nach der Go-Version 1.11 gestartet wurde Ab der Go1.13-Version ist go module das Standard-Abhängigkeitsverwaltungstool der Go-Sprache. go module是Go1.11版本之后官方推出的版本管理工具,并且从Go1.13版本开始,go module将是Go语言默认的依赖管理工具。

1.1 GO111MODULE

要启用go module支持首先要设置环境变量GO111MODULE,通过它可以开启或关闭模块支持,它有三个可选值:offonauto,默认值是auto

  • GO111MODULE=off禁用模块支持,编译时会从GOPATHvendor文件夹中查找包。

  • GO111MODULE=on启用模块支持,编译时会忽略GOPATHvendor文件夹,只根据 go.mod下载依赖,将依赖下载至%GOPATH%/pkg/mod/ 目录下。

  • GO111MODULE=auto,当项目在$GOPATH/src外且项目根目录有go.mod文件时,开启模块支持。

简单来说,设置GO111MODULE=on之后就可以使用go module了,以后就没有必要在GOPATH中创建项目了,并且还能够很好的管理项目依赖的第三方包信息。

使用 go module 管理依赖后会在项目根目录下生成两个文件go.modgo.sum

1.2 GOPROXY

Go1.11之后设置GOPROXY命令为:

export GOPROXY=https://goproxy.cn

Go1.13之后GOPROXY默认值为https://proxy.golang.org,在国内是无法访问的,所以十分建议大家设置GOPROXY,这里我推荐使用goproxy.cn。

go env -w GOPROXY=https://goproxy.cn,direct

1.3 go mod命令

常用的go mod命令如下:

go mod download    下载依赖的module到本地cache(默认为$GOPATH/pkg/mod目录)
go mod edit        编辑go.mod文件
go mod graph       打印模块依赖图
go mod init        初始化当前文件夹, 创建go.mod文件
go mod tidy        增加缺少的module,删除无用的module
go mod vendor      将依赖复制到vendor下
go mod verify      校验依赖
go mod why         解释为什么需要依赖

1.4 go.mod

go.mod文件记录了项目所有的依赖信息,其结构大致如下:

module github.com/Q1mi/studygo/blogger

go 1.12

require (
    github.com/DeanThompson/ginpprof v0.0.0-20190408063150-3be636683586
    github.com/gin-gonic/gin v1.4.0
    github.com/go-sql-driver/mysql v1.4.1
    github.com/jmoiron/sqlx v1.2.0
    github.com/satori/go.uuid v1.2.0
    google.golang.org/appengine v1.6.1 // indirect
)

其中,

  • module用来定义包名
  • require用来定义依赖包及版本
  • indirect表示间接引用

1.4.1 依赖的版本

go mod支持语义化版本号,比如go get foo@v1.2.3,也可以跟git的分支或tag,比如go get foo@master,当然也可以跟git提交哈希,比如go get foo@e3702bed2。关于依赖的版本支持以下几种格式:

gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7
gopkg.in/vmihailenco/msgpack.v2 v2.9.1
gopkg.in/yaml.v2 <=v2.2.1
github.com/tatsushid/go-fastping v0.0.0-20160109021039-d7bb493dee3e
latest

1.4.2 replace

在国内访问golang.org/x的各个包都需要翻墙,你可以在go.mod中使用replace替换成github上对应的库。

replace (
    golang.org/x/crypto v0.0.0-20180820150726-614d502a4dac => github.com/golang/crypto v0.0.0-20180820150726-614d502a4dac
    golang.org/x/net v0.0.0-20180821023952-922f4815f713 => github.com/golang/net v0.0.0-20180826012351-8a410e7b638d
    golang.org/x/text v0.3.0 => github.com/golang/text v0.3.0
)

1.5 go get

在项目中执行go get命令可以下载依赖包,并且还可以指定下载的版本。

  1. 运行go get -u将会升级到最新的次要版本或者修订版本(x.y.z, z是修订版本号, y是次要版本号)
  2. 运行go get -u=patch将会升级到最新的修订版本
  3. 运行go get package@version将会升级到指定的版本号version

如果下载所有依赖可以使用go mod download命令。

1.6 整理依赖

我们在代码中删除依赖代码后,相关的依赖库并不会在go.mod文件中自动移除。这种情况下我们可以使用go mod tidy命令更新go.mod中的依赖关系。

1.7 go mod edit

格式化

因为我们可以手动修改go.mod文件,所以有些时候需要格式化该文件。Go提供了一下命令:

go mod edit -fmt

添加依赖项

go mod edit -require=golang.org/x/text

移除依赖项

如果只是想修改go.mod文件中的内容,那么可以运行go mod edit -droprequire=package path,比如要在go.mod中移除golang.org/x/text包,可以使用如下命令:

go mod edit -droprequire=golang.org/x/text

关于go mod edit的更多用法可以通过go help mod edit查看。

1.8 在项目中使用go module

1.8.1 既有项目

如果需要对一个已经存在的项目启用go module,可以按照以下步骤操作:

  1. 在项目目录下执行go mod init,生成一个go.mod文件。
  2. 执行go get,查找并记录当前项目的依赖,同时生成一个go.sum

    1.1 GO111MODULE

  3. Um die go module-Unterstützung zu aktivieren, müssen Sie zunächst die Umgebungsvariable GO111MODULE festlegen, über die Sie die Modulunterstützung aktivieren oder deaktivieren können . Es gibt drei Optionen zur Auswahl: off, on, auto, der Standardwert ist auto.
  • GO111MODULE=off deaktiviert die Modulunterstützung und kompiliert aus GOPATH und . Finden Sie die Paket im Ordner Vendor.

  • GO111MODULE=on Modulunterstützung aktivieren, die Ordner GOPATH und vendor werden beim Kompilieren ignoriert, nur gemäß go .modLaden Sie Abhängigkeiten in das Verzeichnis %GOPATH%/pkg/mod/ herunter. 🎜🎜
  • 🎜GO111MODULE=auto, wenn das Projekt außerhalb von $GOPATH/src liegt und eine go.mod-Datei darin vorhanden ist Projektstammverzeichnis, Modulunterstützung aktivieren. 🎜🎜
🎜Einfach ausgedrückt: Nachdem Sie GO111MODULE=on gesetzt haben, können Sie go module verwenden. Es besteht in Zukunft keine Notwendigkeit, Projekte in GOPATH zu erstellen Es kann auch die Paketinformationen von Drittanbietern, von denen das Projekt abhängt, gut verwalten. 🎜🎜Nachdem das Go-Modul zum Verwalten von Abhängigkeiten verwendet wurde, werden zwei Dateien go.mod und go.sum im Projektstammverzeichnis generiert. 🎜

1.2 GOPROXY

🎜Nach Go1.11 setzen Sie den GOPROXY-Befehl auf: 🎜
moduledemo
├── go.mod
├── main.go
└── mypackage
    └── mypackage.go  // package mp 定义包名为 mp
🎜Nach Go1.13 ist der Standardwert von GOPROXY https:// Proxy.golang.org ist in China nicht zugänglich, daher wird dringend empfohlen, GOPROXY einzurichten. Hier empfehle ich die Verwendung von goproxy.cn. 🎜
module moduledemo  // 设定 moduledemo 为包根目录名,可以随意改变该名字,只需要导入时一致就好
go 1.14  // 表明版本

1.3 go mod-Befehl

🎜Die häufig verwendeten go mod-Befehle sind wie folgt: 🎜
import "moduledemo/mypackage"  // 这里是导入包目录下的包文件名

1.4 go.mod

🎜Die go.mod-Datei zeichnet alles über das Projekt auf. Die Abhängigkeitsinformationen von Paket und Version 🎜
  • indirekt bedeutet indirekte Referenz 🎜🎜1.4.1 abhängige Version 🎜🎜go mod unterstützt semantische Versionsnummern, wie z. B. go get foo@v1. 2.3, Sie können auch Git-Zweigen oder -Tags folgen, wie z. B. go get foo@master. Natürlich können Sie auch Hashes mit Git einreichen, z als go get foo@e3702bed2. In Bezug auf abhängige Versionen werden die folgenden Formate unterstützt: 🎜
    mp.MyPackage()  // 使用包中的 MyPackage() 函数
    🎜1.4.2 replace🎜🎜Jedes Paket, das in China auf golang.org/x zugreift, muss umgangen werden. Sie können replace in go.mod verwenden, um es durch das entsprechende zu ersetzen Github. Bibliothek. 🎜
    ├── moduledemo
    │   ├── go.mod
    │   └── main.go
    └── mypackage
        ├── go.mod
        └── mypackage.go  // package mp 定义包名为 mp

    1.5 go get

    🎜Führen Sie den Befehl go get im Projekt aus, um das Abhängigkeitspaket herunterzuladen, und Sie können auch die heruntergeladene Version angeben. 🎜
    1. Durch Ausführen von go get -u wird auf die neueste Nebenversion oder Revision aktualisiert (x.y.z, z ist die Revisionsnummer, y ist die Nebenversionsnummer)🎜
    2. Wird ausgeführt go get -u=patch führt ein Upgrade auf die neueste Version durch🎜
    3. Durch Ausführen von go get package@version wird ein Upgrade auf die angegebene Versionsnummer version durchgeführt🎜 🎜🎜Wenn Sie möchten Um alle Abhängigkeiten herunterzuladen, können Sie den Befehl go mod download verwenden. 🎜

      1.6 Abhängigkeiten organisieren

      🎜Nachdem wir den abhängigen Code im Code gelöscht haben, werden die zugehörigen abhängigen Bibliotheken nicht automatisch aus der Datei go.mod entfernt. In diesem Fall können wir den Befehl go mod Tidy verwenden, um die Abhängigkeiten in go.mod zu aktualisieren. 🎜

      1.7 go mod edit

      🎜Formatierung🎜🎜Da wir die go.mod-Datei manuell ändern können, müssen wir die Datei manchmal formatieren. Go bietet die folgenden Befehle: 🎜
      module mypackage
      
      go 1.14
      🎜Abhängigkeiten hinzufügen🎜
      module moduledemo
      
      go 1.14
      
      
      require mypackage v0.0.0  // 这个会在你执行 go build 之后自动在该文件添加
      replace mypackage => ../mypackage  // 指定需要的包目录去后面这个路径中寻找
      🎜Abhängigkeiten entfernen🎜🎜Wenn Sie nur den Inhalt der Datei go.mod ändern möchten, können Sie go mod edit ausführen - droprequire=package path, um beispielsweise das Paket golang.org/x/text in go.mod zu entfernen, können Sie den folgenden Befehl verwenden: 🎜
      import "mypackage"  // 因为该包目录本身就是包文件所以无需添加下一级路径
      
      mp.MyPackage()  // 使用包中的 MyPackage() 函数
      🎜Über die weitere Verwendung von go mod edit kann unter go help mod edit eingesehen werden. 🎜

      1.8 Go-Modul in Projekten verwenden

      🎜1.8.1 Vorhandene Projekte🎜🎜Wenn Sie go-Modul für ein bestehendes Projekt aktivieren müssen, können Sie die folgenden Schritte ausführen: 🎜
    4. Führen Sie go mod init im Projektverzeichnis aus, um eine go.mod-Datei zu generieren. 🎜
    5. Führen Sie go get aus, um die Abhängigkeiten des aktuellen Projekts zu finden und aufzuzeichnen, und generieren Sie eine go.sum, um die Version und den Hash-Wert jeder abhängigen Bibliothek aufzuzeichnen. 🎜🎜🎜1.8.2 Neues Projekt🎜🎜Für ein neu erstelltes Projekt können wir die folgenden Schritte im Projektordner ausführen:🎜
      1. 执行go mod init 项目名命令,在当前项目文件夹下创建一个go.mod文件。
      2. 手动编辑go.mod中的require依赖项或执行go get自动发现、维护依赖。

      二、包和调用文件在同一项目下

      例如:

      moduledemo
      ├── go.mod
      ├── main.go
      └── mypackage
          └── mypackage.go  // package mp 定义包名为 mp

      步骤:

      1.在项目下创建一个 go.mod 文件,文件名只能为这个。

      2.在 go.mod 文件中添加以下代码

      module moduledemo  // 设定 moduledemo 为包根目录名,可以随意改变该名字,只需要导入时一致就好
      go 1.14  // 表明版本

      3.导入想要的包文件

      import "moduledemo/mypackage"  // 这里是导入包目录下的包文件名

      4.使用包文件

      mp.MyPackage()  // 使用包中的 MyPackage() 函数

      三、包和被调用文件不在同一个项目下

      例如:

      ├── moduledemo
      │   ├── go.mod
      │   └── main.go
      └── mypackage
          ├── go.mod
          └── mypackage.go  // package mp 定义包名为 mp

      步骤

      1.在 mypackage 下面创建 go.mod 文件,并添加以下代码

      module mypackage
      
      go 1.14

      2.在 moduledemo 下面创建 go.mod 文件,并添加以下代码

      module moduledemo
      
      go 1.14
      
      
      require mypackage v0.0.0  // 这个会在你执行 go build 之后自动在该文件添加
      replace mypackage => ../mypackage  // 指定需要的包目录去后面这个路径中寻找

      3.导入和使用

      import "mypackage"  // 因为该包目录本身就是包文件所以无需添加下一级路径
      
      mp.MyPackage()  // 使用包中的 MyPackage() 函数
  • Das obige ist der detaillierte Inhalt vonWas ist ein Go-Modul? Wie benutzt man es? (mit Anwendungsbeispielen). Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!

    Stellungnahme:
    Dieser Artikel ist reproduziert unter:segmentfault.com. Bei Verstößen wenden Sie sich bitte an admin@php.cn löschen