。

本文将从如何创建一个公共的Golang工程开始#xff0c;指导你一步步创建它、并引入到你的工程中。

1、公共模块规范

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

项目结构定义好项目的结构使其易于理解和使用。

一个常见的Golang项目结构如下

my-module/|-

单元测试编写完整的单元测试和集成测试保证模块的正确性和稳定性。

测试代码放在

tests/

Modules。

当你的模块准备发布新版本时确保适当地更新go.mod文件并通过

get

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

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

以上是一个基本的指南来创建企业内部的Golang公共模块工程可根据实现项目灵活调整。

记得在开发过程中关注代码质量和安全性并积极倾听来自其他开发人员的反馈不断改进和优化模块。

2、如何引入公共模块

语句来实现具体取决于你的使用场景。

以下是引入私有Git仓库包的三种常见方法。

在下述前两种方法中你需要将

github.com/yourusername/yourprivatepkg

替换为你私有Git仓库的实际路径然后根据需要设置路径或版本号。

完成后运行

如果你希望在开发过程中使用本地路径或其他方式替代私有Git仓库可以使用

replace

github.com/yourusername/yourprivatepkg

replace

github.com/yourusername/yourprivatepkg

require

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

require

github.com/yourusername/yourprivatepkg

get

是你的个人账户所在地址默认情况下如果设置GOPRIVATE会自动设置GONOPROXY和GONOSUMDB配置

Golang项目非代理NOPROXY配置

如果设置GONOPROXY和GONOSUMDB均为none意味着所有module不管是公共的还是私有的都要经过proxy下载经过sumdb验证。

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

url.https://${user}:${password}gitlab.example.com.insteadOf

https://gitlab.example.comGit全局配置查看和删除:

#查看git全局配置

或是修改${GitProject}/.git/config文件中对应url

git

url.gitgitlab.example.com.insteadOf方法二使用SSH替换HTTPS进行认证

git

url.gitgitlab.example.com.insteadOf

https://gitlab.example.comGolang私有项目的http访问

如果私有库不支持https协议会报如下的错误。

这是因为Go更新依赖时会强制校验CA证书来确保依赖库的安全性。

go:

gitee.com/modules/projectv0.0.0-20200320063051-28c4ad7fe2ea:

unrecognized

https://gitee.com/modules/project?go-get1:

dial

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

方法一go

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

-insecure

时提供适当的认证凭证。

这可能包括用户名、密码、Personal

Access

(your/repo/path/to/submodule/package

)func

使用子模块的包submodulepackage.DoSomething()

}使用

-replaceexample.com/submodulepath/to/submodule更新子模块

mod

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

参考文章