怎么配置golang项目module模块?

zhyuzh3d · · 1830 次点击 · · 开始浏览    
这是一个创建于 的文章,其中的信息可能已经有所发展或是发生改变。

怎么配置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就能运行起来。同样注意关闭。


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


有疑问加站长微信联系(非本文作者)

本文来自:简书

感谢作者:zhyuzh3d

查看原文:怎么配置golang项目module模块?

入群交流(和以上内容无关):加入Go大咖交流群,或添加微信:liuxiaoyan-s 备注:入群;或加QQ群:692541889

1830 次点击  
加入收藏 微博
暂无回复
添加一条新回复 (您需要 登录 后才能回复 没有账号 ?)
  • 请尽量让自己的回复能够对别人有帮助
  • 支持 Markdown 格式, **粗体**、~~删除线~~、`单行代码`
  • 支持 @ 本站用户;支持表情(输入 : 提示),见 Emoji cheat sheet
  • 图片支持拖拽、截图粘贴等方式上传