BXW

博哥的blog

博哥的技术博客

0%

go.mod创建使用

发表于 更新于 分类于

go包管理

go.mod 是go1.11后引入的包管理工具

go mod命令

golang 提供了 go mod命令来管理包。go mod 有以下命令：
go mod命令

go.mod 文件内提供了module, require、replace和exclude四个关键字，这里注意区分与上表中命令的区别，一个是管理go mod命令，一个是go mod文件内的关键字。

  • module语句指定包的名字（路径）
  • require语句指定的依赖项模块
  • replace语句可以替换依赖项模块
  • exclude语句可以忽略依赖项模块
创建项目

以websocket服务为例,创建main.go文件

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
package main

import (
    "flag"
    "html/template"
    "log"
    "net/http"

    "github.com/gorilla/websocket"
)

var addr = flag.String("addr", "localhost:8080", "http service address")

var upgrader = websocket.Upgrader{} // use default options

func echo(w http.ResponseWriter, r *http.Request) {
    c, err := upgrader.Upgrade(w, r, nil)
    if err != nil {
        log.Print("upgrade:", err)
        return
    }
    defer c.Close()
    for {
        mt, message, err := c.ReadMessage()
        if err != nil {
            log.Println("read:", err)
            break
        }
        log.Printf("recv: %s", message)
        err = c.WriteMessage(mt, message)
        if err != nil {
            log.Println("write:", err)
            break
        }
    }
}

func main() {
    flag.Parse()
    log.SetFlags(0)
    http.HandleFunc("/echo", echo)
    log.Fatal(http.ListenAndServe(*addr, nil))
}
初始化mod

在当前目录下，命令行运行 go mod init + 模块名称 初始化模块

1
go mod init socket

运行完之后，会在当前目录下生成一个go.mod文件，这是一个关键文件，之后的包的管理都是通过这个文件管理。
官方说明：除了go.mod之外，go命令还维护一个名为go.sum的文件，其中包含特定模块版本内容的预期加密哈希 
go命令使用go.sum文件确保这些模块的未来下载检索与第一次下载相同的位，以确保项目所依赖的模块不会出现意外更改，无论是出于恶意、意外还是其他原因。 go.mod和go.sum都应检入版本控制。 
go.sum 不需要手工维护，所以可以不用太关注。

注意：子目录里是不需要init的，所有的子目录里的依赖都会组织在根目录的go.mod文件里

运行项目

执行运行

1
go run main.go

go 会自动查找代码中的包，下载依赖包，并且把具体的依赖关系和版本写入到go.mod和go.sum文件中
查看go.mod，它会变成这样：

1
2
3
4
5
module socket

go 1.16

require github.com/gorilla/websocket v1.4.2

require 关键字是引用，后面是包，最后v1.4.2 是引用的版本号