ROS2专栏（二） | 使用rosdep管理依赖关系

本教程将解释如何使用rosdep管理外部依赖项。

什么是rosdep？

rosdep是 ROS（Robot Operating System）的一个工具，用于安装ROS包的系统依赖项。当你要在你的ROS工作空间中构建或运行某个ROS包时，有时会发现你的系统缺少必要的依赖项。rosdep 可以帮助你解决这个问题。

具体来说，rosdep 可以根据ROS包中的 package.xml 文件，确定需要安装的系统依赖项，并自动安装这些依赖项。你可以使用以下命令来使用 rosdep：

初始化 rosdep：sudo rosdep init
更新 rosdep 数据库：rosdep update
安装包依赖项：rosdep install --from-paths src --ignore-src -r -y
这些命令将使 rosdep 能够为你的ROS工作空间中的所有包安装所需的系统依赖项。

尽管名称表明它是为 ROS 设计的，但 rosdep 对 ROS 半不可知。您可以将这个强大的工具用于非 ROS 软件项目，通过将其安装为独立的 Python 包。成功运行 rosdep 依赖于 rosdep keys 是否可用，这些 keys 可以通过几个简单的命令从一个公共的 git 存储库中下载。

关于package.xml 文件的说明

package.xml 是您的软件中rosdep 查找依赖项集的文件。package.xml 中依赖项列表完整且正确非常重要，这允许所有工具确定软件包的依赖关系。缺少或不正确的依赖关系可能会导致用户无法使用您的软件包，工作空间中的软件包构建顺序不正确，或无法发布软件包。

package.xml 文件中的依赖关系通常被称为"rosdep keys"。这些依赖关系由软件包的创建者手动填充在 package.xml 文件中，应该是它所需的所有非内置库和软件包的详尽列表。

这些依赖关系在以下标签中表示（查看 REP-149 以获取完整规范）：

<depend>

这些是应该在软件包的构建时间和运行时间都提供的依赖关系。对于 C++ 软件包，如果不确定，请使用此标签。纯 Python 软件包通常没有构建阶段，因此不应使用此标签，而应改用<exec_depend>

<build_depend>

如果您的软件包仅在构建时使用特定的依赖项，而在执行时不需要，您可以使用<build_depend> 标签。

对于此类依赖关系，安装的二进制文件不要求安装该特定软件包。

但是，如果您的软件包导出了一个包含此依赖项的头文件，那么在这种情况下，您还需要使用<build_export_depend>

<build_export_depend>

如果您导出了一个包含依赖关系的头文件，那么依赖于您的软件包的其他软件包将需要该头文件。这主要适用于头文件和 CMake 配置文件。由您导出的库所引用的库通常应该指定 <depend>，因为它们在执行时也是必需的。

<exec_depend>

这个标签声明了共享库、可执行文件、Python 模块、启动脚本以及运行您的软件包时所需的其他文件的依赖关系。

<test_depend>

此标签声明仅在测试时需要的依赖关系。此处的依赖项不应与 <build_depend>、<exec_depend> 或 <depend> 指定的关键字重复。

rosdep 是如何工作的？

rosdep将在其路径或特定软件包中检查package.xml文件，并查找其中存储的rosdep键。然后，这些键将与中央索引进行交叉引用，以在各种软件包管理器中找到适当的ROS软件包或软件库。最后，一旦找到这些软件包，它们将被安装并准备就绪！

rosdep 通过将中央索引检索到本地计算机上来工作，以便在每次运行时都无需访问网络（在 Debian/Ubuntu 上，它的配置存储在 /etc/ros/rosdep/sources.list.d/20-default.list 中）。

中央索引称为 rosdistro，可以在线找到 https://github.com/ros/rosdistro。

我怎么知道要在我的package.xml文件中放入哪些键呢？

• 如果您的软件包想要依赖于另一个基于 ROS 的软件包，并且该软件包已发布到 ROS 生态系统 ，例如 nav2_bt_navigator，则可以简单地使用软件包的名称。您可以在 https://github.com/ros/rosdistro 的 <distro>/distribution.yaml（例如 humble/distribution.yamlr）中找到您所选择的 ROS 发行版的所有已发布 ROS 软件包的列表。
• 如果您想要依赖于一个非 ROS 软件包，通常称为“系统依赖项”，则需要找到特定库的关键字。一般来说，有两个感兴趣的文件：
  • rosdep/base.yaml 包含 apt 系统依赖项
  • rosdep/python.yaml 包含 Python 依赖项

要找到一个关键字，可以在这些文件中搜索您的库，并找到其名称。这就是要放在 package.xml 文件中的关键字。

例如，假设一个软件包依赖于 doxygen，因为它是一款关注文档质量的出色软件（提示提示）。我们可以在rosdep/base.yaml 中搜索 doxygen 并找到如下内容：

doxygen:
  arch: [doxygen]
  debian: [doxygen]
  fedora: [doxygen]
  freebsd: [doxygen]
  gentoo: [app-doc/doxygen]
  macports: [doxygen]
  nixos: [doxygen]
  openembedded: [doxygen@meta-oe]
  opensuse: [doxygen]
  rhel: [doxygen]
  ubuntu: [doxygen]

这意味着我们的rosdep键是doxygen，在不同操作系统的软件包管理器中，它会解析为不同的名称进行安装。

参考：http://fishros.org/doc/ros2/humble/index.html