Go中Vendo机制的使用

1. 介绍

自 Go 1.6 起,vendor 机制正式启用,它允许把项目的依赖放到一个位于本项目的 vendor 目录中,这个 vendor 目录可以简单理解成私有的 GOPATH 目录。 项目编译时,编译器会优先从 vendor 中寻找依赖包,如果 vendor 中找不到,则再到 GOPATH 中寻找。

2. vendor 目录位置

一个项目可以有多个 vendor 目录,分别位于不同的目录级别,建议每个项目只在根目录下放置一个 vendor 目录。
假如有一个 github.com/test/testcase 项目,项目目录结构如下:

GOPATH/src/github.com/test/testcase/testpackage/main/main.go

其中 main.go 中依赖如下几个包:

import (
    "golang.org/x/crypto/ssh"
    "github.com/pkg/sftp"
)

在没有使用 vendor 目录时,若想编译这个项目,则 GOPATH 目录经过应该如下:

GOPATH/src/github.com/test/testcase/
GOPATH/src/github.com/pkg/sftp
GOPATH/src/golang.org/x/crypto/ssh

即所有依赖的包都位于 GOPATH/src 下。
为了把所使用到的 golang.org/x/crypto/ssh 和 github.com/pkg/sftp 版本固化下来,可以使用 vendor 机制。
在项目 github.com/test/testcase/ 根目录下创建一个 vendor 目录,并把 golang.org/x/crypto/ssh 和 github.com/pkg/sftp存放到此目录中,让其成为项目的一部分:

GOPATH/src/github.com/test/testcase/testpackage/main/main.go
GOPATH/src/github.com/test/testcase/vendor/github.com/pkg/sftp/
GOPATH/src/github.com/test/testcase/vendor/golang.org/x/crypto/ssh/

使用 vendor 的好处是在项目 github.com/test/testcase 发布时可以把其所依赖的软件一并发布,编译时不会受到 GOPATH 目录的影响,即便 GOPATH 下也有一个
同名但不同版本的依赖包。

3. 搜索顺序

编译器会从源码文件所在的目录开始逐级向上搜索,在上面的例子中,在编译 main.go 时,编译器搜索依赖包的顺序为:

  • 从 GOPATH/src/github.com/test/testcase/testpackage/main/ 下寻找 vendor 目录,没有找到,继续从上层查找。
  • 从 GOPATH/src/github.com/test/testcase/testpackage/ 下寻找vendor 目录,没有找到,继续从上层查找。
  • 从 GOPATH/src/github.com/test/testcase/ 下寻找 vendor 目录,从 vendor 目录中查找到依赖包,结束查找。

如果 GOPATH/src/github.com/test/testcase/ 下的 vendor 目录中没有依赖包,则返回 GOPATH 目录继续查找。这就是 GOPATH 机制了。
实际上 vendor 目录可以存在于项目的任意目录下。但是不推荐,如果 vendor 目录过于分散,则可能同一个依赖包在项目的多个 vendor 中出现
多次,这样依赖包会多次编译进二进制文件,从而造成二进制文件的体积急剧增大,也很可能出现一个项目中使用同一个依赖包的多个版本的情况。

4. vendor 的不足

vendor 很好地解决了多项目间的隔离问题,但是也有一些不足之处:

  • 项目依赖关系不清晰,无法清楚地看出 vendor 目录中依赖包的版本。
  • 依赖包升级时很不方便审核。

更严重的是二进制文件的体积急剧增大的问题,比如项目依赖开源包A和B,但是A中也有一个vendor目录,其中也放了B,那么项目中将出现两个开源包B。
如果两个开源包B的版本不一致或者不兼容,那么后果非常可怕。

vendor 能够解决大部分项目中的问题,但是也存在很多的不足之处。

到此这篇关于Go中Vendo机制的使用的文章就介绍到这了,更多相关Go Vendo内容请搜索恩蓝小号以前的文章或继续浏览下面的相关文章希望大家以后多多支持恩蓝小号!

原创文章,作者:WLKSV,如若转载,请注明出处:http://www.wangzhanshi.com/n/5524.html

(0)
WLKSV的头像WLKSV
上一篇 2024年12月17日 19:27:38
下一篇 2024年12月17日 19:27:40

相关推荐

  • golang 实现比特币内核之处理椭圆曲线中的天文数字

    在比特币密码学中,我们需要处理天文数字,这个数字是如此巨大,以至于它很容易超出我们宇宙中原子的总数,也许 64 位的值不足以表示这个数字,而像加、乘、幂这样的操作如果使用 64 位…

    Golang 2024年12月17日
  • go语言串口通信的项目实践

    Go语言(Golang)作为一种现代、高效且支持并发的编程语言,在处理硬件通信任务时表现出色,尤其是在实现串口通信方面。以下是对Go语言实现串口通信的关键步骤、库使用以及示例代码的…

    Golang 2024年12月17日
  • go语言中io操作中的 io.Reader 和 io.Writer的获取方法

    我们在对文件进行io操作的时候,经常看到需要我们传递一个 io.Reader 或者 io.Writer 对象作为读写的入参, 那么我们该如何或者这些个RW对象呢?&nbs…

    Golang 2024年12月17日
  • Go项目的目录结构详解

    项目目录结构如何组织,一般语言都是没有规定。但Go语言这方面做了规定,这样可以保持一致性。 1、一般的,一个Go项目在GOPATH下,会有如下三个目录: 复制代码 代码如下:|&#…

    Golang 2024年12月29日
  • go mod tidy命令的使用

    go mod tidy 是 Go 语言的命令,用于清理和更新 go.mod 和 go.sum 文件。它主要有以下功能: 移除未使用…

    Golang 2024年12月17日
  • Go语言操作MySql数据库的详细指南

    前言 go-sql-driver/mysql库是Go语言官方推荐的MySQL驱动库,可以很方便地实现对MySQL数据库的连接和操作。本文记录一下使用go-sql-driver/my…

    2024年12月26日
  • Go语言中命令行参数解析工具pflag的使用指南

    在使用 Go 进行开发的过程中,命令行参数解析是我们经常遇到的需求。尽管 Go 标准库提供了 flag 包用于实现命令行参数解析,但只能满足基本需要,不支持高级特性。于是 Go 社…

    Golang 2024年12月17日
  • golang读取yaml配置文件的方法实现

    Viper Viper是适用于Go应用程序的完整配置解决方案。它被设计用于在应用程序中工作,并且可以处理所有类型的配置需求和格式。它支持以下特性: 设置默认值 从JSON、TOML…

    Golang 2024年12月17日
  • golang套接字的实现

    在 Go 语言中,使用标准库 net 来实现套接字编程。以下是有关 Go 套接字的基本概念和示例。 1. 基本概念 网络类型: TCP:流套接字,提供可靠的、面…

    Golang 2024年12月17日
  • go语言中的log 包示例详解

    Go语言的log包提供了用于记录日志的基本功能。相比fmt包,log包增加了时间戳、日志级别等日志管理功能,非常适合用于调试和记录运行信息。下面是对log包的详细说明,以及它与fm…

    Golang 2024年12月17日

发表回复

登录后才能评论