经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置:技术经验 » 程序设计 » Go语言 » 查看文章
【Go 编程实践】从零到一:创建、测试并发布自己的 Go 库
来源:cnblogs  作者:后除  时间:2023/11/6 9:11:43  对本文有异议

为什么需要开发自己的 Go 库

在编程语言中,包(Package)和库(Library)是代码组织和复用的重要工具。在 Go 中,包是代码的基本组织单位,每个 Go 程序都由包构成。包的作用是帮助组织代码,提供封装和代码复用的机制。

Go 包可以包含函数、类型、变量和常量等,这些元素可以被其他包引用和使用。例如,Go 的标准库提供了大量的包,如 net/http 包提供了 HTTP 客户端和服务器实现,fmt 包提供了格式化、I/O 函数等。

而库是一种特殊的包,不包含 main 函数,不能被直接运行,但可以被其他程序引用。库通常包含一些常用的功能或算法,如字符串处理、数学计算、网络通信等。

开发自己的 Go 库的优点:

  1. 复用性:当在多个项目中需要使用相同的功能时,可以将这些功能封装在一个库中,然后在需要的地方引用他。这样可以避免重复编写相同的代码,提高编程效率。
  2. 可维护性:当需要修改某个功能时,只需修改对应的库,而不需要在多个地方进行修改,这样可以使代码更易于理解和维护。
  3. 可测试性:为每个库编写单元测试,确保他们的功能正确。修改代码时,可以运行这些测试来检查是否引入了新的错误。

接下来,将以 Asiatz(github.com/mazeyqian/asiatz)为例,详细演示如何创建一个规范的 Go 库。

Asiatz 主要功能是进行时区转换,特别是对亚洲时区的处理,他能够将各种时区转换为 UTC 时间。

  1. utcTime, err := asiatz.ShanghaiToUTC("08:00")
  2. if err != nil {
  3. // handle error
  4. }
  5. fmt.Println(utcTime) // Output: 00:00

第 1 步:创建目录

在本地创建一个新的目录,名为 asiatz。这个目录将包含所有的源代码、测试和文档文件。

  1. mkdir asiatz
  2. cd asiatz

第 2 步:初始化项目

2.1 初始化 Go 模块

asiatz 目录下,运行 go mod init <domain>/<username>/<module-name> 来初始化 Go 模块。

  1. go mod init github.com/mazeyqian/asiatz

项目结构:

  1. asiatz
  2. └── go.mod

2.2 创建文件

创建一个新的 Go 文件,名为 asiatz.go。在此文件中,定义一个名为 asiatz 的包,并编写相对应的功能函数。

项目结构:

  1. asiatz
  2. ├── asiatz.go
  3. └── go.mod

代码示例:

  1. package asiatz
  2. import (
  3.     "fmt"
  4.     "strconv"
  5. )
  6. // ToUTC converts a time string (HH:mm) from a specified timezone to UTC time string (HH:mm).
  7. func ToUTC(timezoneOffset float64, time string) (string, error) {
  8.     hour, err := strconv.Atoi(time[:2])
  9.     if err != nil {
  10.         return "", err
  11.     }
  12.     minute, err := strconv.Atoi(time[3:])
  13.     if err != nil {
  14.         return "", err
  15.     }
  16.     totalMinutes := hour*60 + minute
  17.     utcTotalMinutes := ((totalMinutes-int(timezoneOffset*60))%1440 + 1440) % 1440
  18.     utcHour := utcTotalMinutes / 60
  19.     utcMinute := utcTotalMinutes % 60
  20.     utcTime := fmt.Sprintf("%02d:%02d", utcHour, utcMinute)
  21.     return utcTime, nil
  22. }
  23. // ShanghaiToUTC converts a Shanghai time string (HH:mm) to UTC time string (HH:mm).
  24. // For example, "08:00" in Shanghai is equivalent to "00:00" in UTC.
  25. func ShanghaiToUTC(shanghaiTime string) (string, error) {
  26.     return ToUTC(8, shanghaiTime)
  27. }

第 3 步:编写测试

Go 提供了内置的测试框架,可以方便地编写和运行测试用例,以确保代码的正确性和稳定性。

asiatz 目录下创建一个新的 Go 文件,名为 asiatz_test.go。在这个文件中编写测试用例来测试 asiatz.go 中的函数。

项目结构:

  1. asiatz
  2. ├── asiatz.go
  3. ├── asiatz_test.go
  4. └── go.mod

代码示例:

  1. package asiatz
  2. import "testing"
  3. type testConversion struct {
  4.     time     string
  5.     expected string
  6. }
  7. var tests = map[string][]testConversion{
  8.     "Shanghai": {
  9.         {"01:00", "17:00"},
  10.         {"23:59", "15:59"},
  11.     },
  12. // Others
  13. }
  14. func runConversionTests(t *testing.T, tests []testConversion, conversionFunc func(string) (string, error)) {
  15.     for _, test := range tests {
  16.         actual, err := conversionFunc(test.time)
  17.         if err != nil {
  18.             t.Errorf("Unexpected error for %s: %v", test.time, err)
  19.             continue
  20.         }
  21.         if actual != test.expected {
  22.             t.Errorf("Expected %s for %s but got %s", test.expected, test.time, actual)
  23.         }
  24.     }
  25. }
  26. func TestAllConversions(t *testing.T) {
  27.     for timezone, tests := range tests {
  28.         t.Run(timezone, func(t *testing.T) {
  29.             switch timezone {
  30.             case "Shanghai":
  31.                 runConversionTests(t, tests, ShanghaiToUTC)
  32. // Others
  33.             default:
  34.                 t.Errorf("Unexpected timezone %s", timezone)
  35.             }
  36.         })
  37.     }
  38. }

查看完整的用例可见:github.com/mazeyqian/asiatz/blob/main/asiatz_test.go

在当前目录下运行 go test 查看结果:

  1. PASS
  2. ok github.com/mazeyqian/asiatz 0.449s

第 4 步:编写文档

为了方便其他人理解和使用 Asiatz 库,需要编写相应的使用文档。文档应包括库的目的、功能函数的用法、使用示例和注意事项等。

asiatz 目录下,创建一个新的 README.md 文件,并在其中编写文档。

项目结构:

  1. asiatz
  2. ├── asiatz.go
  3. ├── asiatz_test.go
  4. ├── go.mod
  5. └── README.md

文档示例:

文档示例

第 5 步:发布

5.1 上传

上传到 GitHub

将 Asiatz 库上传到 GitHub 或其他代码托管平台,使其他人可以方便地获取和使用。

  1. go get github.com/mazeyqian/asiatz

5.2 版本控制

标签

在 Git 仓库上,还可以使用标签来管理库的不同版本。

  1. git tag v1.0.0
  2. git push origin v1.0.0

例如 Asiatz 目前有四个版本:v1.0.0v1.1.0v1.1.1v1.1.2,分别可以用以下命令获取:

  1. go get github.com/mazeyqian/asiatz@v1.0.0
  2. go get github.com/mazeyqian/asiatz@v1.1.0
  3. go get github.com/mazeyqian/asiatz@v1.1.1
  4. go get github.com/mazeyqian/asiatz@v1.1.2

第 6 步:在真实项目中使用

以 Go 项目 github.com/mazeyqian/go-gin-gee 为例,首先在项目目录(go-gin-gee)下运行命令 go get github.com/mazeyqian/asiatz 获取 Asiatz 库,然后引入使用即可:

  1. // https://github.com/mazeyqian/go-gin-gee/blob/main/internal/api/controllers/schedules-controller.go
  2. package controllers
  3. import (
  4.     "log"
  5.     "github.com/mazeyqian/asiatz"
  6. )
  7. func Check() {
  8.     // ...
  9.     utcTime, err := asiatz.ShanghaiToUTC("10:00")
  10. if err != nil {
  11. // handle error
  12. }
  13. log.Println("UTC Time:", utcTime) // Output: 02:00
  14.     // ...
  15. }

总结

本文以 Asiatz 库为例,详细演示了如何从零开始创建、测试并发布自己的 Go 库。无论是新手,还是有经验的开发者;动手实践,开发并发布自己的库,不仅可以提高代码的复用性和维护性,提高自己的技能,还可以为社区做出贡献。

版权声明

本博客所有的原创文章,作者皆保留版权。转载必须包含本声明,保持本文完整,并以超链接形式注明作者后除和本文原始地址:https://blog.mazey.net/4150.html

(完)

原文链接:https://www.cnblogs.com/mazey/p/17810772.html

 友情链接:直通硅谷  点职佳  北美留学生论坛

本站QQ群:前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

W3xue 的所有内容仅供测试,对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接(目前9元/月)请联系QQ:27243702 沸活量
皖ICP备17017327号-2 皖公网安备34020702000426号