Go | 浅谈包管理模式

简介: Go | 浅谈包管理模式

任何一门编程语言都离不开对各种工具包的使用,工具包的管理就显得异常重要了。Go 的包管理方式是逐渐演进的,本文介绍Go语言的两种包管理模式。


GOPATH模式引包(不推荐)


在 1.5 版本之前,所有的依赖包都是存放在 GOPATH 下,没有多版本控制。


go的编译器会在 $GOPATH/src 下面寻找对应的模块,src 下的每一个目录都可以对应一个模块,目录中的目录也可以是一个模块


下面展示如何在入口文件main.go 里引入非标准库model包中的变量


  1. 目录层级如下
├───main
│       main.go
└───model
        utils.go
  • main/main.go 入口文件引入utils里面的Name变量
  • model/utils.go 文件声明 package model,并定义变量var Name string = "xiao" ,变量必须是大写,否则报错name not exported by package model


  1. main.go 文件引model包


package main
import (
  "fmt"
  // 引包
  // 省略GOPATH/src, Go编译的时候会自动在src目录下寻找
  "go_code/pointer/model"
)
func main() {
  fmt.Println(model.Name) // xiao
}


开启GO111MODULE后非module项目产生的问题


GO111MODULE=on,并且已经设置GOPATH的条件下,写的代码在$GOPATH/src下,我想要使用另一个package里面的内容,并且这个package不是标准库,或者说不在GOROOT里(一般我们不会修改GOROOT中的内容),编译会报错,如下👇👇

package go_code/pointer/model is not in GOROOT

image.png


解决方法一:


设置GO111MODULE=off

go env -w GO111MODULE=off

设置完之后, go env查看

然后重新编译即可


解决方法二


使用go mod , 请看下文介绍👇


GO MODULE 模式引包(推荐)


go modules 介绍


go modules 是 golang 1.11 新加的特性。

  • 模块是相关Go包的集合
  • modules是源代码交换和版本控制的单元

go命令直接支持使用modules,包括记录和解析对其他模块的依赖性。modules替换旧的基于GOPATH的方法来指定在给定构建中使用哪些源文件。


GO111MODULE 有三个值:off, on和auto(默认值)。


  1. GO111MODULE=off,go命令行将不会支持module功能,寻找依赖包的方式将会沿用旧版本那种通过vendor目录或者GOPATH模式来查找(也就是本文最开始介绍的方式)。


  1. GO111MODULE=on,go命令行会使用modules,不会去GOPATH目录下查找所引用的包。


  1. GO111MODULE=auto,默认值,go命令行将会根据当前目录来决定是否启用module功能。这种情况下可以分为两种情形:


  • 当前目录在GOPATH/src之外且该目录包含go.mod文件
  • 当前文件在包含go.mod文件的目录下面。

当modules功能启用时,依赖包的存放位置变更为$GOPATH/pkg,允许同一个package多个版本并存,且多个项目可以共享缓存module

image.png

利用GO111MODULEGOPROXY,可以直接将Github上的第三方库直接下载到本地使用,不需要使用go get命令。执行 go run 运行时,GOMODULES包管理工具会自动帮我们下载github上面的包


使用 go mod 创建新项目


当开启GO111MODULE的时候,才可以使用go mod


1、初始化项目


mkdir test-mod
cd test-moe
go mod init maze-mod


在项目根目录生成 go.mod 文件


module test-mod
go 1.17
require github.com/astaxie/beego v1.12.1
require (
  golang.org/x/net v0.0.0-20190620200207-3b0461eec859 // indirect
  golang.org/x/text v0.3.0 // indirect
)

注意:

  1. indirect注释的代表间接依赖,没有的代表直接依赖
  2. 前面是版本号+时间戳+hash(如:v0.0.0-20190620200207-3b0461eec859
  1. go.mod文件一旦创建后,它的内容将会被go toolchain全面掌控。go toolchain会在各类命令执行时(比如go get、go build、go mod等),修改维护go.mod文件。
  2. go.mod 提供了module, require、replace和exclude 四个命令
  • module 语句指定包的名字(路径)
  • require 语句指定的依赖项模块
  • replace 语句可以替换依赖项模块
  • exclude 语句可以忽略依赖项模块


2、添加依赖


  1. 新建main.go文件
  2. 执行 go run main.go
  • 一般来说 go mod 模式下,运行 go run 会自动安装所有依赖,但是没有安装
  • 运行 go get ./ ... 可以自动查找并下载安装所有的包
  • 运行 go get package@version 安装指定版本的依赖包


3、查看依赖


  • go list -m all 查看当前模块所依赖的包列表
  • go mod tidygo.mod 中移除不需要的依赖


4、go.sum文件


用来做包版本管理

go.sum文件与go.mod文件同级。go.sum文件是对导入的依赖包的特定版本的hash校验值,作用就是记录第一次下载的依赖版本号,防止有依赖版本升级带来的不兼容问题。所以,go.modgo.sum文件都需要被加入版本管理中。


总结


  1. GOPATH模式 是 go在 1.5 版本之前的包管理模式,不具备版本控制功能,且所有项目的依赖都放在 GOPATH 里面,管理比较混乱


  1. GO MODULE 模式是go在1.11 版本推出的,使用git的管理方式,直接从GitHub上下载所需要的依赖,可能会存在一些安全性问题,同时国内需要设置GOPROXY代理服务器才可使用,相对来说好用一点。


包管理模式一直是各个开发语言所面临的棘手问题,比如NPMYarn,设计一种完美的包管理模式还需要不断探索实践。


目录
相关文章
|
13天前
|
数据挖掘 API Go
《Go 简易速速上手小册》第7章:包管理与模块(2024 最新版)(下)
《Go 简易速速上手小册》第7章:包管理与模块(2024 最新版)
38 1
|
13天前
|
Go 开发者
Go语言包管理基础:构建高效、可维护的代码库
【2月更文挑战第9天】Go语言以其简洁、高效和并发的特性受到了开发者的广泛欢迎。在Go中,包(package)是组织和管理代码的基本单位。本文将深入探讨Go语言包管理的基础知识,包括包的定义、组织结构、导入导出规则等,帮助读者更好地理解和应用Go语言中的包管理机制,构建高效、可维护的代码库。
|
8天前
|
Go
配置go语言下载包 - 蓝易云
这个命令会将包下载到你的GOPATH目录下,并自动安装它。
71 1
|
13天前
|
前端开发 Go
Golang深入浅出之-Go语言中的异步编程与Future/Promise模式
【5月更文挑战第3天】Go语言通过goroutines和channels实现异步编程,虽无内置Future/Promise,但可借助其特性模拟。本文探讨了如何使用channel实现Future模式,提供了异步获取URL内容长度的示例,并警示了Channel泄漏、错误处理和并发控制等常见问题。为避免这些问题,建议显式关闭channel、使用context.Context、并发控制机制及有效传播错误。理解并应用这些技巧能提升Go语言异步编程的效率和健壮性。
30 5
Golang深入浅出之-Go语言中的异步编程与Future/Promise模式
|
13天前
|
设计模式 Go 调度
Golang深入浅出之-Go语言中的并发模式:Pipeline、Worker Pool等
【5月更文挑战第1天】Go语言并发模拟能力强大,Pipeline和Worker Pool是常用设计模式。Pipeline通过多阶段处理实现高效并行,常见问题包括数据竞争和死锁,可借助通道和`select`避免。Worker Pool控制并发数,防止资源消耗,需注意任务分配不均和goroutine泄露,使用缓冲通道和`sync.WaitGroup`解决。理解和实践这些模式是提升Go并发性能的关键。
32 2
|
13天前
|
安全 测试技术 Go
Golang深入浅出之-Go语言单元测试与基准测试:testing包详解
【4月更文挑战第27天】Go语言的`testing`包是单元测试和基准测试的核心,简化了测试流程并鼓励编写高质量测试代码。本文介绍了测试文件命名规范、常用断言方法,以及如何进行基准测试。同时,讨论了测试中常见的问题,如状态干扰、并发同步、依赖外部服务和测试覆盖率低,并提出了相应的避免策略,包括使用`t.Cleanup`、`t.Parallel()`、模拟对象和检查覆盖率。良好的测试实践能提升代码质量和项目稳定性。
18 1
|
13天前
|
安全 Go
Golang深入浅出之-Go语言标准库中的文件读写:io/ioutil包
【4月更文挑战第27天】Go语言的`io/ioutil`包提供简单文件读写,适合小文件操作。本文聚焦`ReadFile`和`WriteFile`函数,讨论错误处理、文件权限、大文件处理和编码问题。避免错误的关键在于检查错误、设置合适权限、采用流式读写及处理编码。遵循这些最佳实践能提升代码稳定性。
24 0
|
13天前
|
缓存 编译器 Go
【Go语言专栏】理解Go语言的包管理机制
【4月更文挑战第30天】Go语言包管理是构建可维护应用的关键,从基本概念如包导入、初始化到版本管理和依赖管理,再到Go Modules的引入,简化了过程。包的可见性规则和社区生态也至关重要。理解并掌握这些机制对于编写高质量Go代码具有决定性影响。随着Go语言的持续发展,包管理将更加强大易用。
|
13天前
|
安全 Unix Go
Golang深入浅出之-Go语言中的时间与日期处理:time包详解
【4月更文挑战第26天】Go语言的`time`包提供处理日期和时间的功能,包括`time.Time`类型、时间戳、格式化与解析。本文讨论了核心概念、常见问题(如时区处理、格式字符串混淆、超时控制和并发安全)及解决方法。推荐使用`time.LoadLocation`管理时区,熟悉时间格式规则,用`context`精确控制超时,并注意并发安全。文中通过代码示例展示了如何获取格式化时间、计算时间差以及创建定时任务。学习和应用这些知识可提高程序的健壮性和准确性。
31 2
|
13天前
|
XML JSON Go
Golang深入浅出之-XML处理在Go语言中的实现:encoding/xml包
【4月更文挑战第26天】Go语言的`encoding/xml`库提供XML处理,包括序列化和反序列化。本文讨论了XML处理的基础,如`xml.Marshal`和`xml.Unmarshal`函数,以及常见问题和易错点,如标签命名、结构体嵌套、omitempty标签和命名空间。建议遵循标签命名规则,正确处理嵌套和属性,谨慎使用omitempty,以及理解并有效利用命名空间。文中还给出了基础示例和处理XML属性的代码示例,帮助读者掌握XML处理技巧。
26 1
Golang深入浅出之-XML处理在Go语言中的实现:encoding/xml包