Golang项目中如何轻松实现私有仓库pkg包的引入

这篇具有很好参考价值的文章主要介绍了Golang项目中如何轻松实现私有仓库pkg包的引入。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

在企业内部创建一个公共的Golang模块工程可以帮助提高代码复用性和开发效率。本文将从如何创建一个公共的Golang工程开始,指导你一步步创建它、并引入到你的工程中。

1、公共模块规范

下面是一个简单的步骤指南来创建这样一个公共模块项目。

创建版本控制仓库:使用版本控制工具(如Git)创建一个新的代码仓库,用于管理该公共模块工程的代码。

项目结构:定义好项目的结构,使其易于理解和使用。一个常见的Golang项目结构如下:

my-module/
   |- README.md        # 项目文档和说明
   |- go.mod           # Go模块定义文件
   |- go.sum           # Go模块的依赖版本文件
   |- cmd/             # 命令行应用程序目录(如果有的话)
   |- pkg/             # 项目的库代码目录
   |- internal/        # 内部库代码目录,不对外公开
   |- examples/        # 示例代码目录
   |- tests/           # 单元测试和集成测试目录

  1. Go模块初始化:进入项目根目录,运行 go mod init <module-name> 来初始化 Go 模块。模块名称应该是该模块工程的唯一标识符。

  2. 编写代码:在 pkg/ 目录下编写公共的Golang库代码。这些代码应该是可复用的,不与具体应用逻辑绑定。

  3. 文档和注释:对于公共模块,清晰的文档和注释是非常重要的。确保每个公共函数和类型都有良好的注释,方便其他开发人员理解和使用。

  4. 示例代码:在 examples/ 目录下提供一些简单的示例代码,展示如何使用这个公共模块。

  5. 单元测试:编写完整的单元测试和集成测试,保证模块的正确性和稳定性。测试代码放在 tests/ 目录下。

  6. 版本管理:在Go中,版本管理使用Go Modules。当你的模块准备发布新版本时,确保适当地更新go.mod文件,并通过 go get <module-name>@<version>go mod tidy 来更新依赖关系。

  7. 持续集成:将公共模块纳入到企业的持续集成流程中,确保每次修改都通过了测试,并符合质量标准。

  8. 发布和文档:根据企业内部的发布流程,发布新的版本,并及时更新项目文档,方便其他开发人员使用。

以上是一个基本的指南来创建企业内部的Golang公共模块工程,可根据实现项目灵活调整。记得在开发过程中关注代码质量和安全性,并积极倾听来自其他开发人员的反馈,不断改进和优化模块。

2、如何引入公共模块

在Go中引入私有Git仓库的包可以通过在 go.mod 文件中添加 replacerequire 语句来实现,具体取决于你的使用场景。以下是引入私有Git仓库包的三种常见方法。

在下述前两种方法中,你需要将 github.com/yourusername/yourprivatepkg 替换为你私有Git仓库的实际路径,然后根据需要设置路径或版本号。

完成后,运行 go mod tidy 命令来更新依赖。Go会自动下载和管理你的私有Git仓库包。

2.1 私有项目的路径替换

使用 replace 语句实现。

如果你希望在开发过程中使用本地路径或其他方式替代私有Git仓库,可以使用 replace 语句。这样可以方便地在不同环境中进行开发和测试。

如果私有项目 A 依赖另一个私有项目 B,且通过 go get 无法获取权限,可以采用 replace 方式。

在你的项目的 go.mod 文件中添加类似如下的 replace 语句,将私有Git仓库的路径替换为本地路径或其他路径:

replace github.com/yourusername/yourprivatepkg => /path/to/local/repo

或者,你可以使用相对路径:

replace github.com/yourusername/yourprivatepkg => ../path/to/local/repo

2.2 go mod私有项目的访问

使用 require 语句实现。

如果你想直接从私有Git仓库获取包并将其添加到项目依赖中,可以使用 require 语句。

在你的项目的 go.mod 文件中添加类似如下的 require 语句,将私有Git仓库的路径和版本号添加到依赖中:

require github.com/yourusername/yourprivatepkg v1.0.0

要实现上述方式,需要额外的配置,确保能够正常 go get 私有Git仓库的工程。

  1. 设置 Go GOPRIVATE 变量

    # 配置多个私有项目地址
    go env -w GOPRIVATE="gitlab.example.com"
    # 其中gitee.com/user 是你的个人账户所在地址
    
    • 默认情况下,如果设置GOPRIVATE,会自动设置GONOPROXY和GONOSUMDB配置;

    • Golang项目非代理NOPROXY配置
      如果设置GONOPROXY和GONOSUMDB均为none,意味着所有module,不管是公共的还是私有的,都要经过proxy下载,经过sumdb验证。

  2. 私有仓库的请求认证

    方法一:在请求URL中嵌入认证信息

    git config --global url."https://${user}:${password}@gitlab.example.com".insteadOf "https://gitlab.example.com"
    

    Git全局配置查看和删除:

    #查看git全局配置
    git config --global -l
    # 删除url路径替换, 或是修改${GitProject}/.git/config文件中对应url
    git config --global --unset url."git@gitlab.example.com".insteadOf
    

    方法二:使用SSH替换HTTPS进行认证

    git config --global url."git@gitlab.example.com".insteadOf "https://gitlab.example.com"
    
  3. Golang私有项目的http访问

    如果私有库不支持https协议,会报如下的错误。这是因为Go更新依赖时,会强制校验CA证书来确保依赖库的安全性。

    go: gitee.com/modules/project@v0.0.0-20200320063051-28c4ad7fe2ea: unrecognized import path "gitee.com/modules/project": https fetch: Get "https://gitee.com/modules/project?go-get=1": dial tcp 123.123.123:443: connect: connection refused
    

    如果私有库不支持https协议,还需要go配置参数或环境变量,使其使用http方式访问。

    方法一:go get -insecure

    使用 go get -insecure,这种方式不推荐,原因如下:

    • 添加 `-insecure`` 参数,即表示更新依赖时可以不去校验CA证书,但是这会带来一个问题:范围无法界定(overkill),所有与要更新依赖相关联的依赖,均不会去做校验,可能会意外更新到不安全的依赖。

    • -insecure 仅支持 go get 命令,不支持 go mod 命令,因此使用 go mod 命令时是无法更新不支持https协议的私有库的。

    方法二:GOINSECURE

    添加 GOINSECURE 参数,推荐这种方式

    • 在Go 1.14 中增加了新的环境变量,用于指定哪些域名下的仓库不去校验 CA 证书。

    • 使用方式同 GOINSECURE 类似 go env -w GOINSECURE=gitlab.example.com

2.3 git 子模块(推荐)

在 Go 中,你可以使用 Git 子模块的方式引用私有的公共模块工程,以便在你的项目中使用。

  1. 创建 Git 子模块

    在你的项目中,使用以下命令添加 Git 子模块,将私有的公共模块工程作为子模块引入:

    git submodule add <repository-url> path/to/submodule
    

    其中 <repository-url> 是你私有模块工程的 Git 仓库 URL,path/to/submodule 是子模块在你的项目中的路径。

  2. 配置认证

    如果你的私有模块工程需要身份验证,你可能需要在执行 go getgo mod 时提供适当的认证凭证。这可能包括用户名、密码、Personal Access Token(如果使用 GitLab)等。

  3. 使用子模块的包

    在你的项目中,可以通过 import 语句引入子模块的包,然后在代码中使用这些包。

    import (
        "your/repo/path/to/submodule/package"
    )
    
    func main() {
        // 使用子模块的包
        submodulepackage.DoSomething()
    }
    
  4. 使用 Go Modules 进行版本管理

    确保你的项目启用了 Go Modules,并在 go.mod 文件中添加了子模块的引用。

    go mod edit -replace=example.com/submodule=path/to/submodule
    
  5. 更新子模块

    如果子模块的工程代码发生变化,你可以进入子模块目录,使用 git pull 更新子模块的代码。然后在你的项目根目录使用 go mod tidy 更新模块依赖。

3、总结

条条道路通罗马,技术更是如此。

具体选择那种取决于你的实际环境、实际场景,这里只提供一个思路、方向供大家参考。


参考文章:文章来源地址https://www.toymoban.com/news/detail-647672.html

  1. Go Mod引用私有库
  2. 怎么让Go Modules使用私有依赖模块
  3. Git: submodule 子模块简明教程

到了这里,关于Golang项目中如何轻松实现私有仓库pkg包的引入的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • 普通程序员如何实现在公网环境下也可以访问私有仓库Gitlab

    🎬 鸽芷咕 :个人主页  🔥 个人专栏 : 《高效编程技巧》《cpolar》 ⛺️生活的理想,就是为了理想的生活! GitLab 是一个用于仓库管理系统的开源项目,使用Git作为代码管理工具,并在此基础上搭建起来的Web服务。 Gitlab是被广泛使用的基于git的开源代码管理平台, 基于Ruby o

    2024年02月11日
    浏览(49)
  • golang抓取tcp包的实现

    要抓取 TCP 请求的数据包,你可以使用 `golang` 中的 `packet` 库和 `pcap` 库。下面是一种使用这些库来抓取 TCP 数据包的方法: 首先,确保已经安装了 `pcap` 库,可以使用以下命令来安装: ``` go get -u github.com/google/gopacket ``` 接下来,可以使用以下代码来抓取 TCP 数据包: 这个示例

    2024年02月11日
    浏览(44)
  • 如何建立Docker私有仓库?

    Docker 私有仓库是一个用于存储和管理 Docker 镜像的私有存储库。它允许你在内部网络中创建和管理 Docker 镜像,并提供了更好的安全性和控制,因为你可以完全控制谁能够访问和下载你的镜像。 以下是 Docker 私有仓库的一些重要特点和详细介绍: 镜像存储和管理:Docker 私有仓

    2024年02月07日
    浏览(34)
  • 如何搭建私有maven仓库?

    Maven仓库 1.如何搭建私有maven仓库? ChatGPT: 要搭建私有 Maven 仓库,您可以按照以下步骤进行操作: 选择 Maven 仓库管理器:有多种 Maven 仓库管理器可供选择,比如 Nexus、Artifactory 等。您可以根据自己的需求选择适合的管理器。这里以 Nexus 为例。 下载和安装 Maven 仓库管理器

    2024年02月15日
    浏览(44)
  • mac环境使用pkgbuild命令打pkg包的几个小细节

    最近,研发提出要使用jenkins来自动生成mac环境下的pkg包,研究了一下,可以使用pkgbuild来打包。但是有几个小细节需要注意一下: 目前还没研究好,后续补充。 记之。

    2024年02月09日
    浏览(34)
  • 在Linux搭建GitLab私有仓库配置实现远程访问私有仓库Gitlab ——【内网穿透】

    🎬 鸽芷咕 :个人主页  🔥 个人专栏 : 《高效编程技巧》《cpolar》 ⛺️生活的理想,就是为了理想的生活! GitLab 是一个用于仓库管理系统的开源项目,使用Git作为代码管理工具,并在此基础上搭建起来的Web服务。 Gitlab是被广泛使用的基于git的开源代码管理平台, 基于Ruby o

    2024年02月11日
    浏览(41)
  • k8s实战-如何使用私有镜像仓库

    本文介绍如何通过创建Secret来拉取私有镜像仓库的镜像,从而完成Deployment的创建。 拉取镜像时需要认证 ​ 使用私有仓库时需要通过用户名和密码进行认证。所以,若是直接配置镜像仓库的地址,无法拉取到镜像文件,会报拉取镜像的错误。 可能由于网络问题导致镜像拉取

    2024年02月17日
    浏览(38)
  • 如何在Windows上搭建私有化远程仓库之Gitlab

    先说背景,电脑由于没有Linux系统,是Win10系统,但是团队要求部署在自己服务器的远程仓库,这因为代码有保护要求,在比人服务器总归是不安全。这里就有几个选择,首先是Github,由于科学上网要求,传文件太慢;然后是Gitee,国内服务器,但是允许的协作开发人员数量有

    2024年02月08日
    浏览(37)
  • 【GitLab私有仓库】如何在Linux上用Gitlab搭建自己的私有库并配置cpolar内网穿透?

    GitLab 是一个用于仓库管理系统的开源项目,使用Git作为代码管理工具,并在此基础上搭建起来的Web服务。 Gitlab是被广泛使用的基于git的开源代码管理平台, 基于Ruby on Rails构建, 主要针对软件开发过程中产生的代码和文档进行管理, Gitlab主要针对group和project两个维度进行代码和

    2024年02月12日
    浏览(46)
  • Git篇如何在自己服务器搭建自己的git私有仓库

    要在自己的服务器上搭建自己的Git私有仓库,可以按照以下步骤进行操作: 安装Git服务器软件:选择一款适合的Git服务器软件,如GitLab或GitHub,并按照官方文档进行安装和配置。 创建数据库:如果使用GitLab,需要创建一个数据库来存储用户信息、项目和代码。根据所选的服

    2024年02月03日
    浏览(58)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包