栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Go语言

go module是什么?怎么用?(附使用示例)

Go语言 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

go module是什么?怎么用?(附使用示例)

本文由golang教程栏目给大家介绍关于go module的使用方法,希望对需要的朋友有所帮助!

go module 使用

go module 在 go 1.14 版本之后被推出

一、go module 使用介绍

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,删除无用的modulego mod vendor      将依赖复制到vendor下go mod verify      校验依赖go mod why         解释为什么需要依赖

1.4 go.mod

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

module github.com/Q1mi/studygo/bloggergo 1.12require (    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-dd632973f1e7gopkg.in/vmihailenco/msgpack.v2 v2.9.1gopkg.in/yaml.v2 <=v2.2.1github.com/tatsushid/go-fastping v0.0.0-20160109021039-d7bb493dee3elatest

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命令可以下载依赖包,并且还可以指定下载的版本。

    运行go get -u将会升级到最新的次要版本或者修订版本(x.y.z, z是修订版本号, y是次要版本号)运行go get -u=patch将会升级到最新的修订版本运行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,可以按照以下步骤操作:

    在项目目录下执行go mod init,生成一个go.mod文件。执行go get,查找并记录当前项目的依赖,同时生成一个go.sum记录每个依赖库的版本和哈希值。

1.8.2 新项目

对于一个新创建的项目,我们可以在项目文件夹下按照以下步骤操作:

    执行go mod init 项目名命令,在当前项目文件夹下创建一个go.mod文件。手动编辑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 mypackagego 1.14

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

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

3.导入和使用

import "mypackage"  // 因为该包目录本身就是包文件所以无需添加下一级路径mp.MyPackage()  // 使用包中的 MyPackage() 函数

以上就是go module是什么?怎么用?(附使用示例)的详细内容,更多请关注考高分网其它相关文章!

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/793722.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号