recherche

Maison >développement back-end >Golang >Qu'est-ce que le module Go ? Comment l'utiliser ? (avec des exemples d'utilisation)

Qu'est-ce que le module Go ? Comment l'utiliser ? (avec des exemples d'utilisation)

藏色散人
藏色散人avant
2022-01-12 16:02:395472parcourir

Cet article est introduit par la colonne tutoriel golang pour présenter comment utiliser le module go. J'espère qu'il sera utile aux amis dans le besoin !

Utilisation du module go

Le module go a été lancé après la version go 1.14

1 Introduction à l'utilisation du module go

go module est l'outil de gestion de version officiel lancé après la version Go1.11, et. À partir de la version Go1.13, le go module sera l'outil de gestion des dépendances par défaut du langage Go. go module是Go1.11版本之后官方推出的版本管理工具，并且从Go1.13版本开始，go module将是Go语言默认的依赖管理工具。

1.1 GO111MODULE

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

  • GO111MODULE=off禁用模块支持，编译时会从GOPATH和vendor文件夹中查找包。

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

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

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

使用 go module 管理依赖后会在项目根目录下生成两个文件go.mod和go.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. Pour activer la prise en charge du go module, vous devez d'abord définir la variable d'environnement GO111MODULE, grâce à laquelle vous pouvez activer ou désactiver la prise en charge du module . Il a trois options de sélection : off, on, auto, la valeur par défaut est auto.

  • GO111MODULE=off désactive la prise en charge des modules et compile à partir de GOPATH et Trouvez le package dans le dossier supplier.

  • GO111MODULE=on Activez le support du module, les dossiers GOPATH et vendor seront ignorés lors de la compilation, uniquement selon allez .modTéléchargez les dépendances dans le répertoire %GOPATH%/pkg/mod/. 🎜🎜
  • 🎜GO111MODULE=auto, lorsque le projet est en dehors de $GOPATH/src et qu'il y a un fichier go.mod dans le répertoire racine du projet, activer la prise en charge du module. 🎜🎜
🎜En termes simples, après avoir activé GO111MODULE=on, vous pouvez utiliser le go module. Il n'est pas nécessaire de créer des projets dans GOPATH à l'avenir, et il est également capable de gérer les informations sur les packages tiers dont dépend le projet. 🎜🎜Après avoir utilisé le module go pour gérer les dépendances, deux fichiers go.mod et go.sum seront générés dans le répertoire racine du projet. 🎜

1.2 GOPROXY

🎜Après Go1.11, définissez la commande GOPROXY sur : 🎜
moduledemo
├── go.mod
├── main.go
└── mypackage
    └── mypackage.go  // package mp 定义包名为 mp
🎜Après Go1.13, la valeur par défaut de GOPROXY est https:// proxy.golang.org est inaccessible en Chine, il est donc fortement recommandé de configurer GOPROXY. Ici, je recommande d'utiliser goproxy.cn. 🎜
module moduledemo  // 设定 moduledemo 为包根目录名，可以随意改变该名字，只需要导入时一致就好
go 1.14  // 表明版本

Commande go mod 1.3

🎜Les commandes go mod couramment utilisées sont les suivantes : 🎜
import "moduledemo/mypackage"  // 这里是导入包目录下的包文件名

1.4 go.mod

🎜Le fichier go.mod enregistre tout à propos du projet Les informations de dépendance du package et de la version 🎜
  • indirect signifie référence indirecte 🎜🎜1.4.1 version dépendante 🎜🎜go mod prend en charge les numéros de version sémantiques, tels que go get foo@v1. 2.3, vous pouvez également suivre des branches ou des balises git, telles que go get foo@master. Bien sûr, vous pouvez également soumettre des hachages avec git, tels que <. code>va chercher foo@e3702bed2. Concernant la version de dépendance, les formats suivants sont pris en charge : 🎜
    mp.MyPackage()  // 使用包中的 MyPackage() 函数
    🎜1.4.2 replace🎜🎜Chaque package accédant à golang.org/x en Chine doit contourner le pare-feu. Vous pouvez utiliser replace dans go.mod pour le remplacer par le correspondant. un sur la bibliothèque github. 🎜
    ├── moduledemo
│   ├── go.mod
│   └── main.go
└── mypackage
    ├── go.mod
    └── mypackage.go  // package mp 定义包名为 mp

    1.5 go get

    🎜Exécutez la commande go get dans le projet pour télécharger le package de dépendances, et vous pouvez également spécifier la version téléchargée. 🎜
    1. Exécuter go get -u mettra à niveau vers la dernière version ou révision mineure (x.y.z, z est le numéro de révision, y est le numéro de version mineure)🎜
    2. Exécuter go get -u=patch sera mis à niveau vers la dernière révision🎜
    3. Exécuter go get package@version sera mis à niveau vers le numéro de version spécifié🎜 🎜🎜Si vous souhaitez télécharger toutes les dépendances, vous pouvez utiliser la commande go mod download. 🎜

      1.6 Organiser les dépendances

      🎜Après avoir supprimé le code dépendant dans le code, les bibliothèques dépendantes associées ne seront pas automatiquement supprimées du fichier go.mod. Dans ce cas, nous pouvons utiliser la commande go mod Tidy pour mettre à jour les dépendances dans go.mod. 🎜

      1.7 go mod edit

      🎜Formatage🎜🎜Étant donné que nous pouvons modifier manuellement le fichier go.mod, nous devons parfois formater le fichier. Go fournit les commandes suivantes : 🎜
      module mypackage

go 1.14
      🎜Ajouter des dépendances🎜
      module moduledemo

go 1.14


require mypackage v0.0.0  // 这个会在你执行 go build 之后自动在该文件添加
replace mypackage => ../mypackage  // 指定需要的包目录去后面这个路径中寻找
      🎜Supprimer les dépendances🎜🎜Si vous souhaitez simplement modifier le contenu du fichier go.mod, vous pouvez exécuter go mod edit - droprequire=package path, par exemple, pour supprimer le package golang.org/x/text dans go.mod, vous pouvez utiliser la commande suivante : 🎜 
      import "mypackage"  // 因为该包目录本身就是包文件所以无需添加下一级路径

mp.MyPackage()  // 使用包中的 MyPackage() 函数
      🎜À propos D'autres utilisations de go mod edit peuvent être consultées via go help mod edit. 🎜

      1.8 Utilisation du module go dans les projets

      🎜1.8.1 Projets existants🎜🎜Si vous devez activer le go module pour un projet existant, vous pouvez suivre les étapes ci-dessous : 🎜
    4. Exécutez go mod init dans le répertoire du projet pour générer un fichier go.mod. 🎜
    5. Exécutez go get pour rechercher et enregistrer les dépendances du projet en cours, et générez un go.sum pour enregistrer la version et la valeur de hachage de chaque bibliothèque dépendante. 🎜🎜🎜1.8.2 Nouveau projet🎜🎜Pour un projet nouvellement créé, nous pouvons suivre les étapes suivantes sous le dossier du projet :🎜
      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() 函数

    • Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!

    Déclaration：
    Cet article est reproduit dans:. en cas de violation, veuillez contacter admin@php.cn Supprimer
    Article précédent：Que dois-je faire si la longueur du contenu est trop courte ?Article suivant：Que dois-je faire si la longueur du contenu est trop courte ?

    Articles Liés

    Voir plus