【朝花夕拾】Golang之Go Module工程实践

一、背景

在引入Go Module管理之前,即在Go 版本在1.11之前,项目的框架结构主要是bin、pkg、src,如下的结构应该都比较熟悉

~/projectname/
    bin/
    pkg/
    src/
      mypack/        --项目内容
        foo.go
        bar.go
        mypack_test.go
      commpack       --三方公共库
        comunit.go   

正常情况下,如果引入第三方库,有三种引入方式:

  1. 一般三方库代码都是需要放在GOPATH的Src路径下面,然后直接引入

import (
    "commpack"
)

  1. 通过本地相对路径引用的方式,如:

import (
    "../commpack"
)

  1. 引用git源码库的http路径

import (
    "github.com/projectname/commpack"
)

二、Go Module项目工程管理

在Go 1.13版本之后,引入了Go Module模式,通过go.mod文件配置,改进了项目框架结构。

下面介绍下如何通过脚本创建项目:

  1. 进入任何路径,不需要在GOPATH路径下面,创建项目。

该步骤主要就是生成go.mod文件,也就是通过改文件来对项目、包进行项目工程管理。

# mkdir projectname
# cd projectname
# go mod init projectname   //这里的projectname其实就是module name,可以跟project name不同

注意:
当执行go mod init代码的时候,就是在项目目录的根目录创建一个go.mod文件,里面的首行描述为模块路径,后续import不同模块的时候,都带上这个路径。默认跟projectname同名。

go.mod文件内容如下,具体每个节点用户描述参考结构描述:

module projectname  //此处的projectname,可以为本地项目名,如gateway,或者 源码项目路径 github.com/gateway
go 1.14
  1. 新建公共package
# mkdir commpack
# cd commpack
# vi foo.go   //创建go文件

foo.go 文件源码如下,参考了网上的例子


package commpack

import "fmt"

func Greet(name string) string {

    return fmt.Sprintf("%s,hello", name)
}

  1. 新建main package,demo的项目入口文件
# mkdir mypack
# cd mypack
# vi main.go   

main.go 文件源码如下


package main

import (
    "fmt"
    "projectname/commpack"   //注意这里导入路径,projectname是定义在go.mod文件里面
)

func main() {

    fmt.Println(commpack.Greet("liyu"))

}

4.现在回过头来,整体的项目结构如下,特别注意下,文件名和package名可以不一致。

~/projectname/
    commpack/
      foo.go
      foo_test.go
    mypack       
      main.go   
    go.mod
  1. 执行编译、运行,
# cd projectname/mypack
# go run main.go

附注
# Go.Mod的文件结构描述

module
  
to define the module path; 

go
  
to set the expected language version;

require

to require a particular module at a given version or later;

exclude

to exclude a particular module version from use; and

replace

to replace a module version with a different module version.

# Go Module常用命令

go mod init  # 初始化go.mod
go mod tidy  # 更新依赖文件
go mod download  # 下载依赖文件
go mod vendor  # 将依赖转移至本地的vendor文件
go mod edit  # 手动修改依赖文件
go mod graph  # 打印依赖图
go mod verify  # 校验依赖

参考

Go Module 工程化实践 https://segmentfault.com/a/1190000018398763

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

推荐阅读更多精彩内容

  • Go Module是Go会在1.12中正式推出的包管理机制。 Go mod 简介 Golang一直存在一个被人诟病...
    会飞的鲶鱼阅读 47,536评论 1 14
  • 一、Go的包设计理念 1.代码盒子 在Go程序中,包是代码模块组织的单位,为项目代码组织结构,提高代码的可读性、重...
    GoFuncChan阅读 449评论 0 0
  • 关于收学费条奖励机制:从上学期开始,收学费条已经不再加班务分了,为了激励班级教师积极鼓励家长年前交托费现在制定本学...
    素衣凡凡阅读 239评论 0 0
  • 琴音和鹤舞,雪色共梅香。山外仙桥近,人间耀佛光。 2020年03月21日 《看图斗诗,好诗送贝》https://w...
    流浪的问号阅读 723评论 8 33
  • touch是用来修改时间的 cat才是用来查看文件内容的,追加内容到文件 cat /root/.ssh/id_rs...
    你说你要一场阅读 799评论 0 0