go的依赖与go module学习笔记

依赖管理

为什么需要依赖管理

最早的时候，Go所依赖的所有的第三方库都放在GOPATH这个目录下面。这就导致了同一个库只能保存一个版本的代码。如果不同的项目依赖同一个第三方的库的不同版本，那么就需要依赖管理来处理了。

godep
Go语言从v1.5开始开始引入vendor模式，如果项目目录下有vendor目录，那么go工具链会优先使用vendor内的包进行编译、测试等。
godep是一个通过vender模式实现的Go语言的第三方依赖管理工具，类似的还有由社区维护准官方包管理工具dep。

vender机制

Go1.5版本之后开始支持，能够控制Go语言程序编译时依赖包搜索路径的优先级。

例如查找项目的某个依赖包，首先会在项目根目录下的vender文件夹中查找，如果没有找到就会去$GOAPTH/src目录下查找。

godep开发流程
保证程序能够正常编译
执行godep save保存当前项目的所有第三方依赖的版本信息和代码
提交Godeps目录和vender目录到代码库。
如果要更新依赖的版本，可以直接修改Godeps.json文件中的对应项

go module是Go1.11版本之后官方推出的版本管理工具，并且从Go1.13版本开始，go module将是Go语言默认的依赖管理工具。

GO111MODULE

Go1.11版本之后开始支持gomodule

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

GO111MODULE=off禁用模块支持，编译时会从GOPATH和vendor文件夹中查找包。
GO111MODULE=on启用模块支持，编译时会忽略GOPATH和vendor文件夹，只根据 go.mod下载依赖。
GO111MODULE=auto，当项目在$GOPATH/src外且项目根目录有go.mod文件时，开启模块支持。
简单来说，设置GO111MODULE=on之后就可以使用go module了，以后就没有必要在GOPATH中创建项目了，并且还能够很好的管理项目依赖的第三方包信息。

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

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         解释为什么需要依赖

go.mod文件记录了项目所有的依赖信息

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

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

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 module

既有项目
如果需要对一个已经存在的项目启用go module，可以按照以下步骤操作：
在项目目录下执行go mod init，生成一个go.mod文件。
执行go get，查找并记录当前项目的依赖，同时生成一个go.sum记录每个依赖库的版本和哈希值。

新项目
对于一个新创建的项目，我们可以在项目文件夹下按照以下步骤操作：
执行go mod init 项目名命令，在当前项目文件夹下创建一个go.mod文件。
手动编辑go.mod中的require依赖项或执行go get自动发现、维护依赖。

如何使用go module导入本地包：

导入自己的包时，应该把我们要导入的包放到GOROOT或者GOPATH路径下的src文件夹中，如果没有这个文件夹则创建一个，这样编译环境才能找到包的位置。但很多时候项目不会这么分散，会把包写在同一个项目下。

1.在同一项目下：
①
目录结构：
moduledemo
├── go.mod
├── main.go
└── mypackage
    └── mypackage.go

moduledemo/go.mod 内容如下：
/*
module moduledemo
go 1.14
*/

导入
/*
import（
    “fmt”
    "moduledemo/mypackage"
）
*/
②
目录结构：
└── bubble
    ├── dao
    │   └── mysql.go
    ├── go.mod
    └── main.go

bubble/go.mod 内容如下：
/*
module github.com/q1mi/bubble
go 1.14
*/

导入
/*
import（
    “fmt”
    “github.com/q1mi/bubble/dao”
）
*/

2.不在同一项目
①
目录结构：
├── moduledemo
│   ├── go.mod
│   └── main.go
└── mypackage
    ├── go.mod
    └── mypackage.go

这个时候，mypackage也需要进行module初始化：go mod init mypackage

mypackage/go.mod内容如下：
/*
module mypackage
go 1.14
*/

然后在moduledemo/main.go中按如下方式导入：
/*
import (
    "fmt"
    "mypackage"
)
*/
因为这两个包不在同一个项目路径下，如果想要导入本地包，并且这些包也没有发布到远程的github或其他代码仓库地址。这个时候就需要在go.mod文件中使用replace指令。

在调用方也就是moduledemo/go.mod中按如下方式指定使用相对路径来寻找mypackage这个包。

/*
module moduledemo
go 1.14

require "mypackage" v0.0.0
replace "mypackage" => "../mypackage"
*/

②
目录结构
├── p1
│   ├── go.mod
│   └── main.go
└── p2
    ├── go.mod
    └── p2.go

p1/main.go中想要导入p2.go中定义的函数。

p2/go.mod内容如下：
/*
module  dk.com/q1mi/p2
go 1.14
*/

然后在p1/main.go中按如下方式导入：
/*
import (
    "fmt"
    " dk.com/q1mi/p2"
)
*/
因为我并没有把dk.com/q1mi/p2这个包上传到dk.com这个网站，我们只是想导入本地的包，这个时候就需要用到replace这个指令了。

p1/go.mod内容如下：
/*
module github.com/q1mi/p1

go 1.14

require "dk.com/q1mi/p2" v0.0.0
replace "dk.com/q1mi/p2" => "../p2"
*/

实例：

package main

import (

    "fmt"

    mpge2 "mainygw/mpge" //mainygw 是go.mod里的依赖  mpge是要导入的包的文件夹名

    even "mypackage"     //用包的名字even做文件夹名mypackage的别名

)

func main() {

    i := 5

    j := even.Odd(i) //调用函数时使用包名even，在导入包的时候用文件夹名mypackage

    fmt.Println(j)

    l := mpge2.Showsss()

    fmt.Printf("%d", l)

}

模块的导入

1.相对路径     
import   "./test_model"  //当前文件同一目录的test_model目录，但是不建议这种方式import
2.绝对路径    
import   "mygoproject/test_model"  //加载GOPATH/src/mygoproject/test_model模块

 

import操作

1._操作
_操作其实只是引入该包。当导入一个包时，它所有的init()函数就会被执行，但有些时候并非真的需要使用这些包，仅仅是希望它的init()函数被执 行而已。
这个时候就可以使用_操作引用该包了。即使用_操作引用包是无法通过包名来调用包中的导出函数，而是只是为了简单的调用其init函数()。
2.别名操作
import( f “fmt” )   //别名操作调用包函数时前缀变成了重命名的前缀
f.Println(“hello world”)
3.点操作
import . “fmt”
这个点操作的含义就是这个包导入之后在你调用这个包的函数时，你可以省略前缀的包名，也就是前面你调用的
fmt.Println(“hello world”)  可以省略的写成Println(“hello world”)