怎么配置golang项目module模块?

怎么配置golang项目module模块?


image.png

为什么要配置模块?

我们需要在app.go文件中调用b.go中的函数,甚至需要调用modules/文件夹中所有.go文件的函数,这时候b.go或者整个modules文件夹都应该改作为模块进行编写,类似golang内置模块那样可以直接import导入到a.go中使用。

当然,app.go本身也应该被视为模块,它可以作为main主入口模块。

使用命令行go env GO111MODULE检查你的golang配置是否已经打开模块开发模式,如果返回onauto都可以继续。否则的话请执行go env -w GO111MODULE="on"命令打开模块开发模式。

image

文件结构

如上图所示,每个模块都应该有一个文件夹放置单个或多个.go文件。而调用模块app/和被调用模块b/,modules/之间并没有必然的层次关系。

每个模块下都应该有个go.mod文件,你需要在命令行中用cd app这样的命令进入到每个模块文件夹,然后执行go mod init app或者go mod init bgo mod init modules来自动生成。

实现模块引用

go mod init ...只是把每个模块进行单独生成,如果我们要在app.go中调用其他模块,那么就还要在app/文件夹下的go.mod中用replace说明要调用的模块的位置,方法是直接添加代码,添加之后它看起来像下面这样(最后一行是新加的):

module app

go 1.15

replace abc.com/b => ../b

注意这里的abc.com只要和app.go中import的内容一致就行,可以是任意网址。

箭头后的是b/文件夹的实际目录,../表示上一层,也就是说app/文件夹和b/文件夹是在同一层次的。如果b/app/下面,那么就不是双点而是replace abc.com/b => ./b

被调用的函数

b.goc.go中的函数名称要大写才能被调用,func Hello()...是可以的,func hello()...就不行。

另外也要注意b.go中第一行是package b,而c.go属于modules/模块所以第一行是package modules

实战案例:创建web服务器

我们需要创建一个服务器程序app.go,它能够提供网页文件服务,也能够对类似.../api/Ksave这样的API接口请求作出回应。

因为API接口可能会有很多,所以我建了一个api/文件夹,这样可以分别把每个接口写成一个.go文件进行管理,而在app.go就可以使用api.Ksave来调用。

image

这个文件目录是怎样创造的?先创建app/文件夹,然后下面创建app.go文件和api/文件夹,然后api/文件夹下创建ksave.go。两个go.mod是使用命令生成的,先在终端用cd命令进入对应的文件夹,然后go mod init appgo mod init api就会生成go.mod了。

web文件夹是用来放网页文件的,里面手工创建index.html写入<h1>Hello!!</h1>即可。

然后修改app/下面的go.mod,内容如下:

module app

go 1.15

replace ksite.10knet.com/api => ./api

接下来就是编码了。下面是app.go的完整代码:

package main

import (
    "fmt"
    "log"
    "net/http"
    "os"
    "path"
    "strconv"

    "ksite.10knet.com/api"
)

func main() {
    //获取当前程序运行的目录
    dir, _ := os.Getwd()
    webDir := path.Join(dir, "../web")

    //设置文件服务
    http.Handle("/", http.FileServer(http.Dir(webDir)))

    //设置API接口
    http.HandleFunc("/api/Ksave", api.Ksave)

    //启动服务
    port := 80
    fmt.Println("Server is running on port " + strconv.Itoa(port) + " ...")
    log.Fatal(http.ListenAndServe(":"+strconv.Itoa(port), nil))

}

下面是ksave.go的完整代码:

package api

import "net/http"

// Ksave 只是返回一个问候语.
func Ksave(w http.ResponseWriter, r *http.Request) {
    w.Write([]byte("Hello Ksave!"))
    return
}

最后,用cd命令进入到app/文件夹下,执行go run app.go就可以把服务运行起来,打开首页http://localhost和接口测试页http://localhost/api/Ksave就可以看到问候了。

注意!每次运行前要用Ctrl+C快捷键关闭当前程序,否则可能导致失败,重启电脑才能解决。

我们也可以执行go build app.go可以得到如上面文件列表中所示的app程序,然后执行./app就能运行起来。同样注意关闭。


欢迎批评指正,交流学习。

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

推荐阅读更多精彩内容