使用 rosdep 管理 ROS 2 依赖项

系列文章目录

---

---

前言 清华源镜像使用

本教程将介绍如何使用 rosdep 管理外部依赖关系。

目前，rosdep 只能在 Linux 和 macOS 上运行，不支持 Windows。长期计划是在
https://github.com/ros-infrastructure/rosdep 中添加对 Windows 的支持。

在 rosdep 使用流程中，我们会有如下两个步骤

sudo rosdep init
rosdep update

我们替换为以下步骤

# 手动模拟 rosdep init
sudo mkdir -p /etc/ros/rosdep/sources.list.d/
sudo curl -o /etc/ros/rosdep/sources.list.d/20-default.list https://mirrors.tuna.tsinghua.edu.cn/github-raw/ros/rosdistro/master/rosdep/sources.list.d/20-default.list
# 为 rosdep update 换源
export ROSDISTRO_INDEX_URL=https://mirrors.tuna.tsinghua.edu.cn/rosdistro/index-v4.yaml
rosdep update

# 每次 rosdep update 之前，均需要增加该环境变量
# 为了持久化该设定，可以将其写入 .bashrc 中，例如
echo 'export ROSDISTRO_INDEX_URL=https://mirrors.tuna.tsinghua.edu.cn/rosdistro/index-v4.yaml' >> ~/.bashrc

---

一、什么是 rosdep？

rosdep 是一种依赖性管理工具，可以处理软件包和外部库。rosdep 本身并不是一个软件包管理器；它是一个元软件包管理器，利用自身对系统和依赖关系的了解，在特定平台上找到合适的软件包进行安装。实际安装是通过系统软件包管理器（如 Debian/Ubuntu 上的 apt、Fedora/RHEL 上的 dnf 等）完成的。

它通常在构建工作区之前被调用，用于安装工作区中的依赖包。

它可以在单个软件包或软件包目录（如工作区）上运行。

从名字上看，rosdep 是为 ROS 设计的，但其实它与 ROS 是半对立的。你可以将它作为一个独立的 Python 软件包安装，在非
ROS 软件项目中使用这个强大的工具。成功运行 rosdep 依赖于可用的 rosdep 密钥，只需几条简单的命令就能从公共 git
仓库下载。

二、关于 package.xml 文件的一些小知识

package.xml 是软件中的一个文件，rosdep 会在其中找到一系列依赖项。package.xml 中的依赖关系列表必须完整、正确，这样所有工具才能确定软件包的依赖关系。缺少或不正确的依赖关系会导致用户无法使用软件包，工作区中的软件包被无序构建，以及软件包无法发布。

package.xml 文件中的依赖关系通常被称为 “rosdep keys”。这些依赖关系由软件包的创建者手动填充到 package.xml 文件中，并应详尽无遗地列出软件包所需的所有非构建库和软件包。

它们用以下标记表示（完整规范请参见 REP-149）：

1. 
   这些是软件包在构建和运行时都应提供的依赖项。对于 C++ 软件包，毫无疑问，请使用此标记。纯 Python 软件包通常没有联编阶段，因此不应使用此标记，而应使用 。
2. 
   如果只在构建软件包时而不是在执行时使用特定的依赖关系，可以使用 标签。
   有了这种依赖关系，软件包的已安装二进制文件就不需要安装该特定软件包了。
   不过，如果你的软件包导出的头文件包含了该依赖的头文件，那就会产生问题。在这种情况下，您还需要使用 。
3. 
   如果您导出的头文件包含依赖包中的头文件，那么其他 依赖于您的软件包也会需要该头文件。这主要适用于头文件和 CMake 配置文件。由您导出的库引用的库包通常应指定 ，因为在执行时也需要它们。
4. 
   该标签声明了运行软件包时所需的共享库、可执行文件、Python 模块、启动脚本和其他文件的依赖关系。
5. 
   此标记声明仅测试需要的依赖项。此处的依赖项不应与 、 或 指定的键重复。

三、rosdep 是如何工作的？

rosdep 会检查其路径中的 package.xml 文件或特定软件包，并查找其中存储的 rosdep 密钥。然后，这些密钥会与中央索引相互参照，在各种软件包管理器中找到相应的 ROS 软件包或软件库。最后，一旦找到软件包，它们就会被安装并准备就绪！

rosdep 的工作方式是在本地计算机上检索中央索引，这样它就不必在每次运行时访问网络（在 Debian/Ubuntu 上，其配置存储在 /etc/ros/rosdep/sources.list.d/20-default.list 中）。

中央索引被称为 rosdistro，可以在网上找到。我们将在下一节进一步探讨。

四、如何知道在 package.xml 中输入哪些 key ？

问得好，很高兴你这么问！

如果您想在软件包中依赖的软件包是基于 ROS 的，并且已经发布到 ROS 生态系统 1 中，例如 nav2_bt_navigator，那么您只需使用软件包的名称即可。你可以在 https://github.com/ros/rosdistro 的 /distribution.yaml （例如 humble/distribution.yaml）中找到所有已发布的 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，它可以在不同操作系统的软件包管理器中解析为不同的名称进行安装。

五、如何使用 rosdep 工具？

5.1 rosdep 安装

如果将 rosdep 与 ROS 结合使用，它将与 ROS 发行版一起打包，非常方便。这是获取 rosdep 的推荐方法，你可以用以下方法安装它：

apt-get install python3-rosdep

在 Debian 和 Ubuntu 上，还有一个类似的软件包，名为 python3-rosdep2。如果已安装了该软件包，请确保在安装
python3-rosdep 前将其删除。

如果您在 ROS 之外使用 rosdep，系统软件包可能不可用。在这种情况下，您可以直接从 https://pypi.org 安装：

pip install rosdep

5.2 rosdep 使用

既然我们已经对 rosdep、package.xml 和 rosdistro 有了一定的了解，那么我们就可以使用该工具本身了！首先，如果这是第一次使用 rosdep，必须通过以下方式对其进行初始化：

sudo rosdep init
rosdep update

这将初始化 rosdep，而 update 将更新本地缓存的 rosdistro 索引。偶尔更新一下 rosdep 以获取最新索引是个好主意。

最后，我们可以运行 rosdep install 安装依赖包。通常情况下，我们会在一个包含许多软件包的工作区中一次性调用该程序，以安装所有依赖包。如果在工作区的根目录下，src 目录包含源代码，则会出现如下调用。

rosdep install --from-paths src -y --ignore-src

rosdep install -i --from-path src --rosdistro iron -y

如下：

• –from-paths src 指定了检查 package.xml 文件的路径，以便为其解析密钥。

• -y表示对软件包管理器的所有提示默认为 “是”，安装时无需提示

• –ignore-src "表示如果软件包本身也在工作区中，即使存在 rosdep 密钥，也会忽略安装依赖包。

还有其他参数和选项可用。使用 rosdep -h 查看这些参数和选项，或访问 http://docs.ros.org/en/independent/api/rosdep/html/ 查看更完整的 rosdep 文档。

六、rosdep 说明

Usage: rosdep [options] <command> <args>

Commands:

rosdep check <stacks-and-packages>...
  check if the dependencies of package(s) have been met.

rosdep install <stacks-and-packages>...
  download and install the dependencies of a given package or packages.

rosdep db
  generate the dependency database and print it to the console.

rosdep init
  initialize rosdep sources in /etc/ros/rosdep.  May require sudo.

rosdep keys <stacks-and-packages>...
  list the rosdep keys that the packages depend on.

rosdep resolve <rosdeps>
  resolve <rosdeps> to system dependencies

rosdep update
  update the local rosdep database based on the rosdep sources.

rosdep what-needs <rosdeps>...
  print a list of packages that declare a rosdep on (at least
  one of) <rosdeps>

rosdep where-defined <rosdeps>...
  print a list of yaml files that declare a rosdep on (at least
  one of) <rosdeps>

rosdep fix-permissions
  Recursively change the permissions of the user's ros home directory.
  May require sudo.  Can be useful to fix permissions after calling
  "rosdep update" with sudo accidentally.


Options:
  -h, --help            show this help message and exit
  --os=OS_NAME:OS_VERSION
                        Override OS name and version (colon-separated), e.g.
                        ubuntu:lucid
  -c SOURCES_CACHE_DIR, --sources-cache-dir=SOURCES_CACHE_DIR
                        Override /home/kuanli/.ros/rosdep/sources.cache
  -v, --verbose         verbose display
  --version             print just the rosdep version, then exit
  --all-versions        print rosdep version and version of installers, then
                        exit
  --reinstall           (re)install all dependencies, even if already
                        installed
  -y, --default-yes     Tell the package manager to default to y or fail when
                        installing
  -s, --simulate        Simulate install
  -r                    Continue installing despite errors.
  -q                    Quiet. Suppress output except for errors.
  -a, --all             select all packages
  -n                    Do not consider implicit/recursive dependencies.  Only
                        valid with 'keys', 'check', and 'install' commands.
  -i, --ignore-packages-from-source, --ignore-src
                        Affects the 'check', 'install', and 'keys' verbs. If
                        specified then rosdep will ignore keys that are found
                        to be catkin or ament packages anywhere in the
                        ROS_PACKAGE_PATH, AMENT_PREFIX_PATH or in any of the
                        directories given by the --from-paths option.
  --skip-keys=SKIP_KEYS
                        Affects the 'check' and 'install' verbs. The specified
                        rosdep keys will be ignored, i.e. not resolved and not
                        installed. The option can be supplied multiple times.
                        A space separated list of rosdep keys can also be
                        passed as a string. A more permanent solution to
                        locally ignore a rosdep key is creating a local rosdep
                        rule with an empty list of packages (include it in
                        /etc/ros/rosdep/sources.list.d/ before the defaults).
  --filter-for-installers=FILTER_FOR_INSTALLERS
                        Affects the 'db' verb. If supplied, the output of the
                        'db' command is filtered to only list packages whose
                        installer is in the provided list. The option can be
                        supplied multiple times. A space separated list of
                        installers can also be passed as a string. Example:
                        `--filter-for-installers "apt pip"`
  --from-paths          Affects the 'check', 'keys', and 'install' verbs. If
                        specified the arguments to those verbs will be
                        considered paths to be searched, acting on all catkin
                        packages found there in.
  --rosdistro=ROS_DISTRO
                        Explicitly sets the ROS distro to use, overriding the
                        normal method of detecting the ROS distro using the
                        ROS_DISTRO environment variable. When used with the
                        'update' verb, only the specified distro will be
                        updated.
  --as-root=INSTALLER_KEY:
                        Override whether sudo is used for a specific
                        installer, e.g. '--as-root pip:false' or '--as-root
                        "pip:no homebrew:yes"'. Can be specified multiple
                        times.
  --include-eol-distros
                        Affects the 'update' verb. If specified end-of-life
                        distros are being fetched too.
  -t DEPENDENCY_TYPES, --dependency-types=DEPENDENCY_TYPES
                        Dependency types to install, can be given multiple
                        times. Choose from {'exec', 'buildtool',
                        'buildtool_export', 'test', 'build_export', 'doc',
                        'build'}. Default: all except doc.

---

总结