搜索
首页后端开发Golangmonorepo 中共享库的实际示例

A practical example of shared libraries in a monorepo

在单一存储库中工作最强大的方面之一是能够在包/团队/层次结构之间共享代码。在这篇文章中,我将尝试解释一个非常简单的现实世界场景

示例场景

想象一下,您想要开发一个库来显示以兆字节为单位的文件大小,您认为这可能对您的 monorepo 的其他部分有用。该库接受整数大小(例如:2048 字节),并且可以返回人性化字符串(例如:2 MB)。为了增加一些质量保证,我们还将为其编写一个测试。

Bazel 如何实现代码共享?

从上面的场景我们知道,我们需要将此函数开发为共享库,然后由另一个包导入以供使用。 Bazel 允许我们在库中定义函数并将其导出到需要它的其他服务,从而使这变得非常简单。正如我之前在本文底部链接的文章中所解释的,我们还可以控制哪些其他库也可以导入它以供使用。

让我们开始编码

出于代码组织的目的,我们将在工作区的根目录下有一个库目录,其中有一个名为 humanize_filesize 的子目录,我们将在其中编写库代码。

让我们在 humanize_filesize.go 中编写一些非常基本的 Go 代码

package humanize_filesize

import "fmt"

// GetHumanizedFilesize takes size_in_bytes as an int32 pointer and returns the size in megabytes.
func GetHumanizedFilesize(size_in_bytes *int32) string {
    if size_in_bytes != nil {
        size_in_megabytes := float64(*size_in_bytes) / (1024 * 1024)
        return fmt.Sprintf("%.4f MB", size_in_megabytes)
    }
    return "0 MB"
}

此代码仅将 int32 作为输入,并返回计算出的 4 位十进制精度的可读兆字节字符串

这个功能绝对不全面,绝对可以改进,但这不是本次练习的重点。

还要断言我们的逻辑按预期工作,我们将在名为 humanize_filesize_test.go 的文件中添加一个非常基本的测试以及 go 代码

package humanize_filesize

import (
    "testing"
)

func TestHumanizeFilesize(t *testing.T) {
    tests := []struct {
        name          string
        size_in_bytes *int32
        expected      string
    }{
        {
            name:          "nil bytes",
            size_in_bytes: nil,
            expected:      "0 MB",
        },
        {
            name:          "2048 bytes",
            size_in_bytes: int32Ptr(2048),
            expected:      "0.0020 MB",
        },
        {
            name:          "0 bytes",
            size_in_bytes: int32Ptr(0),
            expected:      "0.0000 MB",
        },
    }

    for _, tt := range tests {
        t.Run(tt.name, func(t *testing.T) {
            result := GetHumanizedFilesize(tt.size_in_bytes)
            if result != tt.expected {
                t.Errorf("expected %s, got %s", tt.expected, result)
            }
        })
    }
}

func int32Ptr(n int32) *int32 {
    return &n
}

一个非常简单的测试,以 nil、int32 和 0 作为输入进行基本测试

现在是如何导出此函数的有趣部分,以便可以将其导入到其他包或服务中。这是我们必须定义 BUILD.bazel 文件的地方。

load("@rules_go//go:def.bzl", "go_library", "go_test")

go_library(
    name = "humanize_filesize",
    srcs = ["humanize_filesize.go"],
    importpath = "basil/libraries/humanize_filesize",
    visibility = ["//visibility:public"],
)

go_test(
    name = "humanize_filesize_test",
    srcs = ["humanize_filesize_test.go"],
    embed = [":humanize_filesize"],
)

在这里我们定义了两个主要规则。一个用于实际库,一个用于我们编写的测试文件。

go_library 定义目标 humanize_filesize 使用 humanize_filesize.go 作为其源之一,可以通过 importpath 中指定的路径导入,并且它在工作区中公开可见,可供其他包导入。我们将在以后的帖子中学习如何控制可见性。

go_test 定义了一个测试目标,其中嵌入了 go_library 输出中的代码。

此时我们应该能够通过运行我们的测试套件来测试库,如下所示

bazel build //... && bazel run //libraries/ humanize_filesize: humanize_filesize_test

您应该能够看到如下所示的测试输出,表明所有测试均已通过。

package humanize_filesize

import "fmt"

// GetHumanizedFilesize takes size_in_bytes as an int32 pointer and returns the size in megabytes.
func GetHumanizedFilesize(size_in_bytes *int32) string {
    if size_in_bytes != nil {
        size_in_megabytes := float64(*size_in_bytes) / (1024 * 1024)
        return fmt.Sprintf("%.4f MB", size_in_megabytes)
    }
    return "0 MB"
}

?哇喔!!! ?现在我们知道我们的图书馆正在按预期运行。

现在让我们在 services 目录中的服务 service1 中使用这个库,我们将使用以下 go 代码和 BUILD.bazel 文件在工作区的根目录中创建该目录。

service1.go

package humanize_filesize

import (
    "testing"
)

func TestHumanizeFilesize(t *testing.T) {
    tests := []struct {
        name          string
        size_in_bytes *int32
        expected      string
    }{
        {
            name:          "nil bytes",
            size_in_bytes: nil,
            expected:      "0 MB",
        },
        {
            name:          "2048 bytes",
            size_in_bytes: int32Ptr(2048),
            expected:      "0.0020 MB",
        },
        {
            name:          "0 bytes",
            size_in_bytes: int32Ptr(0),
            expected:      "0.0000 MB",
        },
    }

    for _, tt := range tests {
        t.Run(tt.name, func(t *testing.T) {
            result := GetHumanizedFilesize(tt.size_in_bytes)
            if result != tt.expected {
                t.Errorf("expected %s, got %s", tt.expected, result)
            }
        })
    }
}

func int32Ptr(n int32) *int32 {
    return &n
}

BUILD.bazel

load("@rules_go//go:def.bzl", "go_library", "go_test")

go_library(
    name = "humanize_filesize",
    srcs = ["humanize_filesize.go"],
    importpath = "basil/libraries/humanize_filesize",
    visibility = ["//visibility:public"],
)

go_test(
    name = "humanize_filesize_test",
    srcs = ["humanize_filesize_test.go"],
    embed = [":humanize_filesize"],
)

Go 代码非常简单,它导入我们之前声明的库,并使用我们库中的 GetHumanizedFilesize 函数,传递一个随机整数值并打印输出。

现在,当执行 bazel build //services/service1 时,bazel 将解析我们目标的所有依赖项,包括我们开发和构建它们的库。

service1 现在可以使用 bazel run //services/service1 执行,因为我们只定义了一个二进制目标。如果您有多个二进制目标,例如:serviceX,您可以使用 bazel run //services/service1:serviceX 来执行该目标。默认情况下,当不指定目标时,bazel 将始终尝试查找与目录同名的二进制目标并运行它。

那么...就这样吧。我们已经制作了您的第一个共享库,可供我们 monorepo 的其他部分使用。

此示例的所有代码都可以在 https://github.com/nixclix/basil/pull/3/commits/61c673b8757860bd5e60eb2ab6c35f3f4da78c87

如果您喜欢这篇文章的内容,请随时分享。另外,请订阅并留下评论,表达您对这篇文章的看法,以及您是否希望看到我改进的地方。

以上是monorepo 中共享库的实际示例的详细内容。更多信息请关注PHP中文网其他相关文章!

声明
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
Go语言包导入:带下划线和不带下划线的区别是什么?Go语言包导入:带下划线和不带下划线的区别是什么?Mar 03, 2025 pm 05:17 PM

本文解释了GO的软件包导入机制:命名imports(例如导入“ fmt”)和空白导入(例如导入_ fmt; fmt;)。 命名导入使包装内容可访问,而空白导入仅执行t

Beego框架中NewFlash()函数如何实现页面间短暂信息传递?Beego框架中NewFlash()函数如何实现页面间短暂信息传递?Mar 03, 2025 pm 05:22 PM

本文解释了Beego的NewFlash()函数,用于Web应用程序中的页间数据传输。 它专注于使用newflash()在控制器之间显示临时消息(成功,错误,警告),并利用会话机制。 Lima

Go语言中如何将MySQL查询结果List转换为自定义结构体切片?Go语言中如何将MySQL查询结果List转换为自定义结构体切片?Mar 03, 2025 pm 05:18 PM

本文详细介绍了MySQL查询结果的有效转换为GO结构切片。 它强调使用数据库/SQL的扫描方法来最佳性能,避免手动解析。 使用DB标签和Robus的结构现场映射的最佳实践

如何编写模拟对象和存根以进行测试?如何编写模拟对象和存根以进行测试?Mar 10, 2025 pm 05:38 PM

本文演示了创建模拟和存根进行单元测试。 它强调使用接口,提供模拟实现的示例,并讨论最佳实践,例如保持模拟集中并使用断言库。 文章

如何定义GO中仿制药的自定义类型约束?如何定义GO中仿制药的自定义类型约束?Mar 10, 2025 pm 03:20 PM

本文探讨了GO的仿制药自定义类型约束。 它详细介绍了界面如何定义通用功能的最低类型要求,从而改善了类型的安全性和代码可重复使用性。 本文还讨论了局限性和最佳实践

Go语言如何便捷地写入文件?Go语言如何便捷地写入文件?Mar 03, 2025 pm 05:15 PM

本文详细介绍了在GO中详细介绍有效的文件,将OS.WriteFile(适用于小文件)与OS.openfile和缓冲写入(最佳大型文件)进行比较。 它强调了使用延迟并检查特定错误的可靠错误处理。

您如何在GO中编写单元测试?您如何在GO中编写单元测试?Mar 21, 2025 pm 06:34 PM

本文讨论了GO中的编写单元测试,涵盖了最佳实践,模拟技术和有效测试管理的工具。

如何使用跟踪工具了解GO应用程序的执行流?如何使用跟踪工具了解GO应用程序的执行流?Mar 10, 2025 pm 05:36 PM

本文使用跟踪工具探讨了GO应用程序执行流。 它讨论了手册和自动仪器技术,比较诸如Jaeger,Zipkin和Opentelemetry之类的工具,并突出显示有效的数据可视化

See all articles

热AI工具

Undresser.AI Undress

Undresser.AI Undress

人工智能驱动的应用程序,用于创建逼真的裸体照片

AI Clothes Remover

AI Clothes Remover

用于从照片中去除衣服的在线人工智能工具。

Undress AI Tool

Undress AI Tool

免费脱衣服图片

Clothoff.io

Clothoff.io

AI脱衣机

AI Hentai Generator

AI Hentai Generator

免费生成ai无尽的。

热门文章

R.E.P.O.能量晶体解释及其做什么(黄色晶体)
2 周前By尊渡假赌尊渡假赌尊渡假赌
仓库:如何复兴队友
4 周前By尊渡假赌尊渡假赌尊渡假赌
Hello Kitty Island冒险:如何获得巨型种子
4 周前By尊渡假赌尊渡假赌尊渡假赌

热工具

螳螂BT

螳螂BT

Mantis是一个易于部署的基于Web的缺陷跟踪工具,用于帮助产品缺陷跟踪。它需要PHP、MySQL和一个Web服务器。请查看我们的演示和托管服务。

DVWA

DVWA

Damn Vulnerable Web App (DVWA) 是一个PHP/MySQL的Web应用程序,非常容易受到攻击。它的主要目标是成为安全专业人员在合法环境中测试自己的技能和工具的辅助工具,帮助Web开发人员更好地理解保护Web应用程序的过程,并帮助教师/学生在课堂环境中教授/学习Web应用程序安全。DVWA的目标是通过简单直接的界面练习一些最常见的Web漏洞,难度各不相同。请注意,该软件中

SublimeText3 英文版

SublimeText3 英文版

推荐:为Win版本,支持代码提示!

适用于 Eclipse 的 SAP NetWeaver 服务器适配器

适用于 Eclipse 的 SAP NetWeaver 服务器适配器

将Eclipse与SAP NetWeaver应用服务器集成。

Dreamweaver Mac版

Dreamweaver Mac版

视觉化网页开发工具