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

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

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

• Rust语言的国际化页面确认，Rust中的ICU支持不完善，因此拥有一个功能性的封装有助于推动技术的发展。

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

• 与ICU4X等项目在接口上的合作将允许在未来无缝过渡到全Rust实现。

仓库结构

该仓库按照 Rust Crates 的 cargo 工作空间组织。每个 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_*crate中激活该特性。如果不这样做，可能会导致编译结果混乱。

先决条件

必需

• 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。

可选

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

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

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

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

• icu-config实用程序，如果使用icu_config功能。

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

• bindgen实用程序，如果使用bindgen功能。

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

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

  有关安装说明，请参阅 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

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

要运行 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 支持的工作似乎仍在进行中。

以下是在创建此库时所做的假设

• 我们需要一个完整、可重用且无痛苦的 ICU 低位级库用于 Rust。

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

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

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

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

• 此库应作为 Rust 实现的低级基础。

  低级别的ICU API可能不适合最终用户。应该在这些绑定之上构建一个rustful API。将功能细分为crate可能是一个好主意，以符合rust开发者的期望。

  我愿意重用上述项目中已经做出的某些逻辑细分。

• 我想探讨将现有实现组合起来以构建完整的rust ICU支持的方法。

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

  我之所以开始一个独立的项目而不是在“现有技术”部分列出的任何项目中做出贡献，只是因为我想要尝试在rust中生成库会是什么样子。

附加说明

快速入门指南

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

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

从那里，以下命令序列将检出、构建和测试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'

以下是一个尚未测试的示例，即编译 rust_icu 对现有的 ICU 版本 66 进行编译。

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 目录中的静态生成的 bindgen 文件（名称为 lib_XX.rs，其中 XX 是 ICU 版本，例如 67），当关闭 bindgen 功能时使用。

调用此 make 目标将修改本地签出的 lib_XX.rs 文件的新版本。提交一个 pull request 并检查它们。

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