rust_icu: ICU 库的底层 rust 语言绑定

项目	描述
测试
源代码	https://github.com/google/rust_icu
README	https://github.com/google/rust_icu/blob/main/README.md
覆盖率	查看报告
文档	https://docs.rs/crate/rust_icu

这是一个为 C（即 ICU4C）版本的 Unicode 国际组件（ICU）库提供的底层原生 rust 语言绑定的库。

如果您只需要快速了解如何下载和安装的说明，请参阅 快速入门指南

有关 ICU 库的详细信息，请参阅 ICU 项目主页。库的源代码可以在 Github 上查看。

此文件的最新版本可在 https://github.com/google/rust_icu 上找到。

这不是一个官方支持的 Google 产品。

为什么要封装 ICU（而不是做其他事情）？

• rust 语言的 国际化 页面确认，在 rust 中 ICU 的支持是零散的，因此拥有一个功能性的封装有助于推动技术进步。

• 如 Fuchsia 这样的项目已经依赖于 ICU，而 rust 绑定允许以简单的方式使用 Unicode 算法，而无需承担更多依赖。

• 与 ICU4X 等项目的接口合作可能会允许在未来无缝过渡到全 rust 实现。

仓库结构

该仓库按照Rust crates的格式组织。每个crate对应于ICU4C库的C API中的相应头文件。请查阅覆盖率报告以了解头文件中的函数覆盖率详情。

限制

今天生成的Rust语言绑定方法限制了语言绑定对可用C API的可用性。ICU库的C API（在文档中有时被称为ICU4C）与ICU C++ API不同。

该库提供的绑定适用性有限，这意味着它可能有时无法直接使用。如果您遇到这种情况，请随时提交一个错误报告供我们修复。拉取请求也欢迎。

我们今天知道的限制如下

• 没有保证的特性一致性。 一些在C++中实现的算法在C中没有等效实现，反之亦然。如果您使用C++库，这通常不是问题，因为您可以选择任何适合您的API表面。但对于Rust绑定来说，这是一个问题，因为我们目前只能使用C API。

• 新算法的C++实现不一定总是反映在C API中，导致C和C++ API表面之间的特性差异。例如，请参阅此错误。

• 虽然使用icu_config功能可能会让您在一定程度上自由地为您自己的库版本自动生成绑定，但我们仍需要保留一个显式支持的ICU版本列表，以确保包装器稳定。

兼容性

兼容性保证如下

1. 对所有感兴趣的功能组合，对最后三个主要ICU库版本进行了自动测试。
2. 对docs.rs系统使用的ICU库版本进行了自动测试（因此可以构建文档）。

功能

rust_icu库旨在使用cargo编译，并启用以下功能之一。使用cargo编译允许我们在rust_icu_sys库中的自定义build.rs文件中执行某些库检测，并适应您的构建环境。然而，由于并非每个开发环境都会使用相同的设置，我们选择提供某些功能（如下）作为配置选项。

尽管我们的意图是保持以下功能列表与实际列表在Cargo.toml中保持最新，但列表可能会定期过时。

要使用任何功能，您需要在您打算使用的所有rust_icu_*包中激活功能。未这样做会导致编译结果令人困惑。

先决条件

必需

• rust_icu源代码

  使用git克隆

  git clone https://github.com/google/rust_icu.git
  

• rustup

  从https://rustup.rs安装。用于设置工具链默认值。这将安装cargo。

• Clang

  您必须安装Clang以访问正确的头文件。

• ICU库开发环境

  您将需要访问ICU库，以便为rust_icu绑定链接。下载和安装ICU超出本文件的范畴。请阅读ICU简介以了解如何构建和安装。

  有时，ICU库可能已预安装在您的系统上，或者您可以从您的包管理程序中提取该库。但是，这不一定是您需要将其链接到您正在开发的程序中的库。简而言之，您负责在系统上的某个位置拥有ICU的开发者版本。

  我们有一个快速入门安装，可能会让您顺利地进行，如果您的情况与我们的配置非常相似，并且您想从源代码构建ICU。

可选

• 如果您想使用基于make的构建和测试，请安装GNU Make。

  安装GNU Make超出本文件的范畴。请参阅您操作系统的安装说明。

• 如果您决定使用基于docker的构建和测试，请安装docker。

  安装docker超出本文件的范畴，请参阅docker安装说明以获取详细信息。由于安装docker会干扰主机机器，您的公司可能有关于如何正确安装docker的内部文档。

• 如果使用icu_config功能，请安装icu-config实用工具。

  您需要在您的系统上安装ICU库，以便二进制icu-config位于您的$PATH中。构建脚本将使用它来发现库设置并生成正确的链接脚本。如果您使用该功能但未找到icu-config，

• 如果使用bindgen功能，请安装bindgen实用工具。

  有关如何安装它的说明，请参阅bindgen用户指南。

• 如果使用了 bindgen 功能，则包含 rustfmt 工具。

  有关安装说明，请参阅 https://github.com/rust-lang/rustfmt。

测试

运行 rust_icu 的测试有几种选项。

Cargo

使用 cargo 构建 和 测试是构建和测试 Rust 代码的标准方法。

对于 rust_icu 库，您可能会发现您的系统默认的 ICU 开发包很旧，在这种情况下，您需要自己构建 ICU4C 库（以下内容将介绍）。这将使您必须传递 PKG_CONFIG_PATH 和 LD_LIBRARY_PATH 环境变量，以便构建代码可以定位和使用您构建的库，而不是系统默认的库。

以下测试都应该能够构建并通过。请注意，因为所需的库位于自定义位置，我们需要在运行测试时设置 LD_LIBRARY_PATH，以及 PKG_CONFIG_PATH。

如果您发现您可以使用系统默认的 ICU 安装，则可以安全地省略这两个库。

env PKG_CONFIG_PATH="$HOME/local/lib/pkgconfig" \
    LD_LIBRARY_PATH="$HOME/local/lib" \
        bash -c 'cargo test'

如果您认为上述方法过于麻烦，可以考虑尝试基于 Docker 的方法。

GNU Make

如果您喜欢使用 GNU 方式做事，可能会喜欢 GNU Make 方法。

最简单的方法是使用 GNU Make 并运行

make test

如果您正在处理 rust_icu，已设置好开发环境，并希望运行测试的快捷方式，则可能希望使用此方法。

基于 Docker

请参阅上面的 可选依赖部分。

要运行基于 Docker 的 rust_icu 源代码的不可变构建和测试，请输入以下命令

make docker-test

这将在本地的机器上运行基于 Docker 的源代码构建和测试。这是一个测试您的代码是否与特定版本的 ICU 一起工作的好方法。

现有技术

已考虑了许多现有技术。

• https://github.com/servo/rust-icu
• https://github.com/open-i18n/rust-unic
• https://github.com/fullcontact/icu-sys
• https://github.com/rust-locale
• https://github.com/unicode-rs

目前的情况是，我首先想做一些自己的实验，然后再看看这些工作是否可以整合到上述任何一项工作中。

另请参阅

• https://github.com/rust-lang/rfcs/issues/797
• https://unicode-rs.github.io
• https://github.com/i18n-concept/rust-discuss

假设

对于 ICU 绑定有几种竞争方法。然而，根据 rust 的 RFC 存储库中的信息，至少在 rust 中对 ICU 的支持工作仍在进行中。

这是在制作此库时所做的假设

• 我们需要一个完整、可重用且易于使用的 Rust ICU 低级库。

  这意味着我们必须依赖于外部 ICU 库，而不能将库本身与绑定代码一起携带。这种模块化允许库的最终用户使用他们选择的 ICU 库，并将其纳入他们各自的系统中。

• 本库的工作不会重新实现 ICU 算法。

  ICU 的重新实现可能需要数千名工程师年。对于像 ICU 这样微妙且复杂的 API，我认为维护单个集中式实现可能是一个更好的投资回报率。

  此外，此库的存在并不阻止重新实现。如果有人想尝试重新实现 ICU，那也很好。

• 该库应作为Rust实现的一个底层基础。

  底层ICU API可能不适合最终用户。应在这些绑定之上构建Rust-ful API。可能将功能细分为crate是一个好主意，以符合Rust开发者的期望。

  我非常乐意重用上述提到的某些项目中已经做出的逻辑划分。

• 我想探索与现有实现结合的方法，以构建Rust的完整ICU支持。

  希望能够将今天可用的所有Rust绑定的优点结合成一个统一的Rust库。我随时可以讨论选项。

  我之所以开始一个单独的努力而不是向“先有艺术”部分中列出的任何项目贡献，只是因为我想要尝试一个生成的库在Rust中会是什么样子。

附加说明

快速入门指南

在开始之前，请确保满足以下先决条件

• 您已安装docker，并且它可以在您的系统上运行。
• 您有GNU Make。
• 您有git。
• 您有足够的磁盘空间。构建环境的Docker镜像有点大，所以需要几GB的空间来容纳它们。
• 您有互联网连接。

从那里，以下命令序列将检出、构建和测试rust_icu源代码。

mkdir -p ~/tmp
cd tmp
git clone https://github.com/google/rust_icu
cd rust_icu
make docker-test

现在您可以更改代码和测试。您可以通过运行以下命令重新运行编译和测试循环：make docker-test。

ICU安装说明

以下说明遵循ICU存储库中的“树外”构建说明。

假设

以下说明不是自包含的。它们假设

• 您已经设置了系统，可以有效地遵循ICU构建说明。这需要一些前期时间投入。
• 您可以从源代码构建ICU，并且您的项目可以访问ICU源代码。
• 您的设置是Linux，有一些非常具体的设置对我来说是有效的。您可能能够将它们修改为适用于您的情况。

编译

mkdir -p $HOME/local
mkdir -p $HOME/tmp
cd $HOME/tmp
git clone https://github.com/unicode-org/icu.git
mkdir icu4c-build
cd icu4c-build
../icu/icu4c/source/runConfigureICU Linux \
  --prefix=$HOME/local \
  --enable-static
make
make install
make doc

如果编译成功完成，目录$HOME/local/bin将包含文件icu-config，这是发现库配置所必需的。

您还可以

make check

运行单元测试。

如果将$HOME/local/bin添加到$PATH，或者将icu-config移动到您的$PATH中列出的目录，您应该可以编译rust_icu。

ICU重建说明

如果您更改了ICU库的配置，并有意从源代码重新构建库，您可能需要添加一个中间的make clean命令。

由于 ICU 编译过程并非完全封闭，这确保了在构建目录中没有旧编译过程的残留。例如，如果您升级 ICU 库的主版本，则需要这样做。如果您忘记这样做，编译 ICU 时或链接或运行程序时可能会出现意外的错误。

为 ICU 的特定版本编译

假设

• 您已选择以下功能集 [重命名,icu_version_in_env]

或者:

• 您已手动验证，您想要使用的 ICU 版本和功能集在 兼容性矩阵 中有“是”。

以下是一个测试示例。

env PKG_CONFIG_PATH="$HOME/local/lib/pkgconfig" \
    LD_LIBRARY_PATH="$HOME/local/lib" \
    RUST_ICU_MAJOR_VERSION_NUMBER=65 \
        bash -c 'cargo test'

以下是一个尚未 测试 的示例，即针对预存的 ICU 版本 66 编译 rust_icu。

env PKG_CONFIG_PATH="$HOME/local/lib/pkgconfig" \
    LD_LIBRARY_PATH="$HOME/local/lib" \
    RUST_ICU_MAJOR_VERSION_NUMBER=66 \
        bash -c 'cargo test'

添加对 ICU 新版本的支持。

一般来说，只要支持 icu-config 方法，就应该能够为 ICU 库的新版本生成库包装器，前提是底层 C API 没有太大差异。

实现 ICU 65.1 的简单支持的方法包括以下步骤。下面，$RUST_ICU_SOURCE_DIR 是您提取 ICU 源代码的目录。

• 从源代码下载新的 ICU 版本到 $RUST_ICU_SOURCE_DIR。
• 按照例如上面的 编译 步骤使用新版本构建 ICU 库。
• 从输出目录 $RUST_ICU_SOURCE_DIR/target/debug/build/rust_icu_sys-... 获取文件 lib.rs，将其重命名为 lib_66.rs（如果使用 ICU 版本 66，否则附加您使用的版本）。
• 将文件保存到目录 $RUST_ICU_SOURCE_DIR/rust_icu_sys/bindgen，这是包含预生成源文件的目录。

如果 build.rs 修改为包含更多功能，则可能需要再次生成这些文件 lib_XX.rs。

添加更多绑定

在添加更多 ICU 包装器时，请确保执行以下操作

• 检查 rust_icu_sys/build.rs 和 rust_icu_sys/bindgen/run_bindgen.sh，然后在 BINDGEN_SOURCE_MODULES 中添加适当的行，然后是 BINDGEN_ALLOWLIST_FUNCTIONS 和 BINDGEN_ALLOWLIST_TYPES。

启用特定功能集进行测试

以下是在 ICU 67 上运行 docker 测试的示例，启用 icu_version_in_env 和 renaming 功能，而不是默认值。请注意，参数主要通过环境变量传递到运行 docker-test 的容器中。

make DOCKER_TEST_ENV=rust_icu_testenv-67 \
  RUST_ICU_MAJOR_VERSION_NUMBER=67 \
  DOCKER_TEST_CARGO_TEST_ARGS='--no-default-features --features icu_version_in_env,renaming' \
  docker-test

一些说明

• 环境变量 RUST_ICU_MAJOR_VERSION_NUMBER 用于功能 icu_version_in_env，以指示 cargo 使用 rust_icu_sys/bindgen/lib_67.rs 文件作为预构建的 bindgen 源文件，而不是尝试动态生成一个。
• 环境变量 DOCKER_TEST_CARGO_TEST_ARGS 用于将命令行参数传递给 Docker 容器中使用的 cargo test。环境变量会被原样传递给 cargo test，不进行引号引用，因此环境中的单词将分别成为 cargo test 的参数。
• 环境变量 DOCKER_TEST_ENV 是用于运行测试的 Docker 容器的基准名称。容器 rust_icu_testenv-67 是一个包含预安装的 ICU 67 编译版本的容器镜像。

刷新静态 bindgen 文件

需要 Docker。

定期运行 make static-bindgen 以刷新目录 rust_icu_sys/bindgen 中名为 lib_XX.rs（其中 XX 是 ICU 版本，例如 67）的静态生成 bindgen 文件，当关闭 bindgen 功能时使用。

调用此构建目标将修改本地签出中的 lib_XX.rs 文件的新版本。发起拉取请求并提交它们。

有关为什么需要此信息的更多信息，请参阅 bindgen README.md。