”工欲善其事,必先利其器。“—孔子《论语.录灵公》
首页 > 编程 > monorepo 中共享库的实际示例

monorepo 中共享库的实际示例

发布于2024-11-09
浏览:502

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 构建 //... && bazel 运行 //libraries/ humanize_filesize: humanize_filesize_test

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

INFO: Analyzed target //libraries/humanize_filesize:humanize_filesize_test (0 packages loaded, 0 targets configured).
INFO: Found 1 target...
Target //libraries/humanize_filesize:humanize_filesize_test up-to-date:
  bazel-bin/libraries/humanize_filesize/humanize_filesize_test_/humanize_filesize_test
INFO: Elapsed time: 0.392s, Critical Path: 0.24s
INFO: 5 processes: 1 internal, 4 darwin-sandbox.
INFO: Build completed successfully, 5 total actions
INFO: Running command line: external/bazel_tools/tools/test/test-setup.sh libraries/humanize_filesize/humanize_filesize_test_/humanize_filesize_test
exec ${PAGER:-/usr/bin/less} "$0" || exit 1
Executing tests from //libraries/humanize_filesize:humanize_filesize_test
-----------------------------------------------------------------------------
PASS

?哇喔!!! ?现在我们知道我们的库正在按预期工作。

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

service1.go

package main

import (
    "basil/libraries/humanize_filesize"
    "fmt"
    "math/rand"
)

func main() {
    v := rand.Int31n(1000000)
    fmt.Printf(`%d bytes = %s\n`, v, humanize_filesize.GetHumanizedFilesize(&v))
}

BUILD.bazel

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

go_library(
    name = "service1_lib",
    srcs = ["service1.go"],
    importpath = "basil/services/service1",
    visibility = ["//visibility:private"],
    deps = ["//libraries/humanize_filesize"],
)

go_binary(
    name = "service1",
    embed = [":service1_lib"],
    visibility = ["//visibility:public"],
)

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 找到

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

版本声明 本文转载于:https://dev.to/nikhildev/a-practical-example-of-shared-libraries-in-a-monorepo-2548?1如有侵犯,请联系[email protected]删除
最新教程 更多>
  • 如何修复 macOS 上 Django 中的“配置不正确:加载 MySQLdb 模块时出错”?
    如何修复 macOS 上 Django 中的“配置不正确:加载 MySQLdb 模块时出错”?
    MySQL配置不正确:相对路径的问题在Django中运行python manage.py runserver时,可能会遇到以下错误:ImproperlyConfigured: Error loading MySQLdb module: dlopen(/Library/Python/2.7/site-...
    编程 发布于2024-11-17
  • 除了“if”语句之外:还有哪些地方可以在不进行强制转换的情况下使用具有显式“bool”转换的类型?
    除了“if”语句之外:还有哪些地方可以在不进行强制转换的情况下使用具有显式“bool”转换的类型?
    无需强制转换即可上下文转换为 bool您的类定义了对 bool 的显式转换,使您能够在条件语句中直接使用其实例“t”。然而,这种显式转换提出了一个问题:“t”在哪里可以在不进行强制转换的情况下用作 bool?上下文转换场景C 标准指定了四种值可以根据上下文转换为 bool 的主要场景:语句:if、w...
    编程 发布于2024-11-17
  • 如何使用 MySQL 查找今天生日的用户?
    如何使用 MySQL 查找今天生日的用户?
    如何使用 MySQL 识别今天生日的用户使用 MySQL 确定今天是否是用户的生日涉及查找生日匹配的所有行今天的日期。这可以通过一个简单的 MySQL 查询来实现,该查询将存储为 UNIX 时间戳的生日与今天的日期进行比较。以下 SQL 查询将获取今天有生日的所有用户: FROM USERS ...
    编程 发布于2024-11-17
  • 在 Go 中使用 WebSocket 进行实时通信
    在 Go 中使用 WebSocket 进行实时通信
    构建需要实时更新的应用程序(例如聊天应用程序、实时通知或协作工具)需要一种比传统 HTTP 更快、更具交互性的通信方法。这就是 WebSockets 发挥作用的地方!今天,我们将探讨如何在 Go 中使用 WebSocket,以便您可以向应用程序添加实时功能。 在这篇文章中,我们将介绍: WebSoc...
    编程 发布于2024-11-17
  • 大批
    大批
    方法是可以在对象上调用的 fns 数组是对象,因此它们在 JS 中也有方法。 slice(begin):将数组的一部分提取到新数组中,而不改变原始数组。 let arr = ['a','b','c','d','e']; // Usecase: Extract till index p...
    编程 发布于2024-11-17
  • Bootstrap 4 Beta 中的列偏移发生了什么?
    Bootstrap 4 Beta 中的列偏移发生了什么?
    Bootstrap 4 Beta:列偏移的删除和恢复Bootstrap 4 在其 Beta 1 版本中引入了重大更改柱子偏移了。然而,随着 Beta 2 的后续发布,这些变化已经逆转。从 offset-md-* 到 ml-auto在 Bootstrap 4 Beta 1 中, offset-md-*...
    编程 发布于2024-11-17
  • Numpy 备忘单
    Numpy 备忘单
    Comprehensive Guide to NumPy: The Ultimate Cheat Sheet NumPy (Numerical Python) is a fundamental library for scientific computing in Python. ...
    编程 发布于2024-11-17
  • 你需要像专业人士一样阅读科技文章
    你需要像专业人士一样阅读科技文章
    在快节奏的技术世界中,并非您阅读的所有内容都是准确或公正的。并非您读到的所有内容都是由人类编写的! 细节可能存在微妙的错误,或者文章可能故意误导。让我们来看看一些可以帮助您阅读科技文章或任何媒体内容的技能。 1. 培养健康的怀疑态度 培养健康的怀疑态度至关重要。质疑大胆的主张,寻找...
    编程 发布于2024-11-17
  • 如何查找一个多维数组中存在但另一个多维数组中不存在的行?
    如何查找一个多维数组中存在但另一个多维数组中不存在的行?
    比较多维数组的关联行您有两个多维数组,$pageids 和 $parentpage,其中每行代表一个包含列的记录“id”、“链接标签”和“url”。您想要查找 $pageids 中存在但不在 $parentpage 中的行,从而有效地创建一个包含缺失行的数组 ($pageWithNoChildren...
    编程 发布于2024-11-17
  • 为什么 Windows 中会出现“Java 无法识别”错误以及如何修复它?
    为什么 Windows 中会出现“Java 无法识别”错误以及如何修复它?
    解决 Windows 中的“Java 无法识别”错误尝试在 Windows 7 上检查 Java 版本时,用户可能会遇到错误“'Java' 无法识别”作为内部或外部命令。”此问题通常是由于缺少 Java 安装或环境变量不正确而引起的。要解决此问题,您需要验证 Java 安装并配置必要...
    编程 发布于2024-11-17
  • 尽管文件存在且有权限,为什么 File.delete() 返回 False?
    尽管文件存在且有权限,为什么 File.delete() 返回 False?
    尽管存在并进行权限检查,File.delete() 返回 False使用 FileOutputStream 写入文件后尝试删除文件时,某些用户遇到意外问题: file.delete() 返回 false。尽管文件存在且所有权限检查(.exists()、.canRead()、.canWrite()、....
    编程 发布于2024-11-17
  • 如何有效地从 Go 中的切片中删除重复的对等点?
    如何有效地从 Go 中的切片中删除重复的对等点?
    从切片中删除重复项给定一个文本文件,其中包含表示为具有“Address”和“PeerID”的对象的对等点列表属性,任务是根据代码配置中“Bootstrap”切片中匹配的“Address”和“PeerID”删除所有重复的对等点。为了实现此目的,我们迭代切片中的每个对等点对象多次。在每次迭代期间,我们将...
    编程 发布于2024-11-17
  • 如何在 PHP 中组合两个关联数组,同时保留唯一 ID 并处理重复名称?
    如何在 PHP 中组合两个关联数组,同时保留唯一 ID 并处理重复名称?
    在 PHP 中组合关联数组在 PHP 中,将两个关联数组组合成一个数组是一项常见任务。考虑以下请求:问题描述:提供的代码定义了两个关联数组,$array1和$array2。目标是创建一个新数组 $array3,它合并两个数组中的所有键值对。 此外,提供的数组具有唯一的 ID,而名称可能重合。要求是构...
    编程 发布于2024-11-17
  • 如何自定义Bootstrap 4的文件输入组件?
    如何自定义Bootstrap 4的文件输入组件?
    绕过 Bootstrap 4 文件输入的限制Bootstrap 4 提供了自定义文件输入组件来简化用户的文件选择。但是,如果您希望自定义“选择文件...”占位符文本或显示所选文件的名称,您可能会遇到一些挑战。更改 Bootstrap 4.1 及更高版本中的占位符自 Bootstrap 4.1 起,占...
    编程 发布于2024-11-17
  • 如何在 CSS 盒子上创建斜角?
    如何在 CSS 盒子上创建斜角?
    在 CSS 框上创建斜角可以使用多种方法在 CSS 框上实现斜角。一种方法描述如下:使用边框的方法此技术依赖于沿容器左侧创建透明边框和沿底部创建倾斜边框。以下代码演示了如何实现:<div class="cornered"></div> <div cl...
    编程 发布于2024-11-17

免责声明: 提供的所有资源部分来自互联网,如果有侵犯您的版权或其他权益,请说明详细缘由并提供版权或权益证明然后发到邮箱:[email protected] 我们会第一时间内为您处理。

Copyright© 2022 湘ICP备2022001581号-3