Golang 多模块开发

今天学习下Golang中多模块的基础知识学习多模块的运行原理使用多模块的方式可以让开发者的代码在其他多个模块中构建、运行。提高代码的复用从而提高开发效率。

在今天的学习中将在工作工作空间中创建两个模块然后进行模块之间的引用并运行程序结果。

前提条件

基本要求

• Go 1.18 及更高版本
• 合适的编译工具 - text编辑器也满足要求
• 命令终端 - Linux、Mac系统shell, Windows系统的Cmd、PowerShell

本地环境

• Go 版本信息

• 系统信息 - MacOS
• 编辑工具 - Sublime Text

代码开发

创建模块

1. 打开shell终端进入代码目录

   

2. 创建工作空间并进入

   $ mkdir workspace
   $ cd workspace
   

3. 初始化模块 - 新创建一个hello模块依赖golang.org/x/example模块

   • 创建hello模块

   $ mkdir hello
   $ cd hello
   $ go mod init example.com/hello
   go: creating new go.mod: module example.com/hello
   

   • 添加依赖

   $ go get golang.org/x/example
   

   

4. 在hello目录下创建hello.go源文件,内容如下

   package main
   import (
       "fmt"
   
       "golang.org/x/example/stringutil"
   )
   func main() {
       fmt.Println(stringutil.Reverse("Hello"))
   }
   

5. 运行程序

$ go run example.com/hello

创建工作空间

在这一步中创建go.workwe

• 初始化工作空间 - 在workspace目录下 执行以下命令该命令会自动生成一个go.work 文件

  $ go work init ./hello
  

• go.work 文件的内容如下

  

  go.work文件内容的语法跟 go.mod 类似。第一行告诉Go编译器 使用哪个版本来解释文件第二行告诉Go, 编译时的主模块

• 运行程序 - 在workspace目录执行命令(区别之前在hello目录下执行)

  $ go run example.com/hello
  

  

Go命令将工作空间中的所有模块作为主模块。这允许我们引用模块内的包甚至模块外的包。在模块或工作区外运行go run命令将导致错误因为go命令不知道要使用哪些模块。

接下来我们将向工作区添加golang.org/x/example模块的本地副本。然后我们将向stringtil包添加一个新函数我们可以使用它来代替Reverse。

修改源码

在这一步中我们将下载包含golang.org/x/example模块的Git repo副本将其添加到工作区然其中添加一个新函数然后将从hello程序中使用该函数。

1. 克隆代码 - 在workspace目录 执行以以下命令复制git代码

   $ git clone https://go.googlesource.com/example
   Cloning into 'example'...
   remote: Total 165 (delta 27), reused 165 (delta 27)
   Receiving objects: 100% (165/165), 434.18 KiB | 1022.00 KiB/s, done.
   Resolving deltas: 100% (27/27), done.
   

   遗憾的是国内的环境并不一定能够通过git clone的命令复制代码会出现以下错误

   

   可以点击此连接 官网 下载代码压缩包

   

   下载完毕后将压缩包进行解压 并重新命名会exampleworkspace的代码结构如下

   

2. 增加模块 - 使用命令新增模块

   go work use ./example
   

   至此go.work文件中依赖了两个模块

   

3. 新增函数 - 在workspace/example/stringutil目录下新增 toupper.go文件文件内容如下

   package stringutil
   
   import "unicode"
   
   // ToUpper uppercases all the runes in its argument string.
   func ToUpper(s string) string {
       r := []rune(s)
       for i := range r {
           r[i] = unicode.ToUpper(r[i])
       }
       return string(r)
   }
   

4. 调用新增函数 - 修改workspace/hello/hello.go代码文件

   func main() {
       fmt.Println(stringutil.ToUpper("Hello"))
       fmt.Println(stringutil.Reverse("Hello"))
   }
   

5. 执行代码 - 在workspace目录下执行

   go run example.com/hello
   

   

至此我们学会了拉取github上的原代码并学会了如何新增函数如何调用。