如何创建自己 module

我们为什么要创建自己的 module?原因有二:

  1. 不用再一遍又一遍的写重复代码
  2. 可以持续迭代优化我们写出的代码

希望在阅读本篇文章后,您可以成功创建出自己的 module

创建 mymodule

  1. GitHub 中创建一个仓库 mymodule,然后 clone 到本地

    $ git clone git@github.com:gh-zhangpeng/mymodule.git
    
  2. 进入我们刚刚 clone 下来的仓库中

    $ cd mymodule && vim hello.go
    
  3. 编写我们需要放入 module 中的代码

    package mymodule
    
    import (
        "fmt"
    )
    
    func Hello(name string) string {
        return fmt.Sprintf("Hello, %s", name)
    }
    
  4. 生成 go.mod 文件

    使用我们在第一步中创建的仓库,生成我们 mymodulego.mod

    $ go mod init github.com/gh-zhangpeng/mymodule
    

    生成后的文件内容如下:

    module github.com/gh-zhangpeng/mymodule
    
    go 1.16
    
  5. 将我们的刚刚编写的代码提交到 github

    $ git add . && git commit -m "init mymodule" && git push
    

代码推送成功后,mymodule 就已经创建完成了。

使用 mymodule

进入一个使用 go mod 进行包管理的项目,使用 go get 命令将 mymodule 包添加到依赖中,然后我们就可以使用 mymodule 包中的代码了。

  1. 在项目中添加 mymodule 的依赖

    $ go get github.com/gh-zhangpeng/mymodule
    go: downloading github.com/gh-zhangpeng/mymodule v0.0.0-20211019160614-87837bdd5f7a
    

    此时查看 go.mod 文件,可以看到文件内多了一行 mymodule 的依赖。表示当前项目依赖 mymodulev0.0.0-20211019160614-87837bdd5f7a 版本

    require github.com/gh-zhangpeng/mymodule v0.0.0-20211019160614-87837bdd5f7a // indirect
    
  2. 使用 mymodule 中的方法

    package main
    
    import (
        "fmt"
    
        "github.com/gh-zhangpeng/mymodule"
    )
    
    func main() {
        fmt.Println(mymodule.Hello("jack"))
    }
    

创建版本

当有了稳定的或者准备长期使用的 module 后,我们就可以为它创建一个版本。module 的版本是由 gittag 控制的,因此我们在代码仓库中添加 tag

$ git tag v1.0.0
$ git push --tags

现在我们将 go.mod 中依赖的 mymodule 的版本改为 v1.0.0。然后执行下面的代码,这样就将项目中依赖的 mymodule 版本设置为 v1.0.0

$ go get github.com/gh-zhangpeng/mymodule

go module 的版本号规范可以参考 Module version numbering 这篇文章,在此就不多做赘述了。

最后

看到文章这个位置,您应该已经使用上了自己创建的 module 了。如果还没有,欢迎留言~

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 151,688评论 1 330
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 64,559评论 1 273
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 101,749评论 0 226
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 42,581评论 0 191
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 50,741评论 3 271
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 39,684评论 1 192
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,122评论 2 292
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 29,847评论 0 182
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,441评论 0 228
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 29,939评论 2 232
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,333评论 1 242
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 27,783评论 2 236
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,275评论 3 220
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,830评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,444评论 0 180
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 34,553评论 2 249
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 34,618评论 2 249

推荐阅读更多精彩内容

  • 软件是由代码组成的。为了复用代码,代码的组织出现了不同层次的抽象和实现,如 Module(模块),包(Packag...
    人世间阅读 33,554评论 5 45
  • 前言 mod 是 modules 的简称,Go 1.11 和 Go 1.12 早已支持 modules。在 Go ...
    吃猪的蛇阅读 1,250评论 0 6
  • https://www.cnblogs.com/chnmig/p/11806609.html[https://ww...
    千沙qiansha阅读 167评论 0 0
  • 在介绍之前先讲几个直接上手使用的命令,前面4个及可实现项目的初始化、检测依赖、下载依赖、导出依赖 go mod i...
    品儒阅读 468评论 0 0
  • I.可重复构建 可重复构建即构建是可以重现的,如果给定相同的源代码、构建环境和构建指令,任何人都可以重新构建一个B...
    金琥阅读 1,793评论 0 3