ROS 2 index翻译（七）——用Colcon编译功能包（package）

这是一个用colcon如何建立和编译ROS工做区的简要教程。这是一个实用的教程，并不是来替代核心文档。
ROS 2 在Bouncy以前的发行版，使用的编译工具是ament_tools，这在ament教程中有阐述。

1. 背景
colcon是ROS编译工具catkin_make，catkin_make_isolated，catkin_tools和ament_tools的换代。有关colcon设计的更多信息，请参阅此文档。
源代码能够在colcon GitHub organization中找到。

2. 先决条件

2.1 安装ROS 2
确保按照安装说明安装了ROS 2 。
注意：若是从Debian软件包安装，本教程须要“桌面安装”。

2.2 安装colcon
Liunx：

sudo apt install python3-colcon-common-extensions

OS X ：

python3 -m pip install colcon-common-extensions

Windows：

pip install -U colcon-common-extensions

3. 基础知识
一个ROS工做空间是具备特定结构的目录。一般有一个src子目录。该子目录是ROS包的源代码所在的位置。一般无特殊的话，目录一开始为空。
colcon完成源代码编译。默认状况下，它将建立如下和src目录的同级目录：

• build目录是存储中间文件的位置。对于每一个包，将建立一个子文件夹，例如调用CMake。
• install目录是每一个软件包的安装目录。默认状况下，每一个包都将安装到单独的子目录中。
• log目录包含有关每一个colcon调用的各类日志记录信息。

注意：与catkin相比，没有devel目录。

3.1 建立一个工做空间
首先，建立一个目录（ros2_example_ws）来包含咱们的工做区：
Linux / OSX：

mkdir -p ~/ros2_example_ws/src
cd ~/ros2_example_ws

Windows：

md \dev\ros2_example_ws\src
cd \dev\ros2_example_ws

此时工做空间包含一个空目录src：

.
└── src

1 directory, 0 files

3.2 增长一些源文件
让咱们将示例存储库复制到src工做区的目录中：

git clone https://github.com/ros2/examples src/examples

注意：建议检查版本是否与已安装的ROS版本兼容（例如crystal）。

如今工做区应该有ROS 2示例的源代码：

.
└── src
    └── examples
        ├── CONTRIBUTING.md
        ├── LICENSE
        ├── rclcpp
        ├── rclpy
        └── README.md

4 directories, 3 files

3.3 Source 底层(underlay)
有一点很重要，咱们为现有的ROS 2安装提供了环境，这将为咱们的工做区提供示例包所需的编译依赖关系。这是经过source二进制安装或源文件安装提供的安装脚原本实现的，即另外一个colcon工做区（请参阅安装）。咱们称此环境为底层（underlay）。

咱们的工做空间 ros2_examples_ws 将覆盖（overlay）在现有的ROS 2安装的顶层（ROS 2 工做空间的覆盖机制，查看）。一般，在计划迭代少许软件包时，建议使用工做空间覆盖机制，而不是将全部软件包都放在同一个工做空间。

3.4 编译工做空间
在工做区的根目录中，运行 colcon build。即便有些编译类型，例如 ament_cmake，不支持 devel 空间的概念，而且须要包安装，但colcon支持 --symlink-install 选项。这容许经过更改 source 空间中的文件来更改已安装的文件，以便更快地进行迭代（例如Python文件或其余未编译的资源）。

colcon build --symlink-install

编译完成后，咱们应该会看到 build、install 和 log 目录：
 

.
├── build
├── install
├── log
└── src

4 directories, 0 files

3.5 运行 tests
为测试刚建立的功能包，运行下面指令：

colcon test

3.6 source 环境
当colcon成功完成编译后，输出将在install目录中。为了使用可执行文件和库，你须要将诸如 install/bin 目录添加到路径中。colcon将在install目录中生成bash / bat文件以帮助设置环境。这些文件将向你我的路径和库路径添加所需的元素，并提供由包导出的bash或shell命令。
Linux / OS X：

. install/setup.bash

Windows：

call install\setup.bat

3.7 小试牛刀
在 source 后的环境中，咱们能够运行colcon编译的可执行文件。让咱们从示例中运行订阅者节点：

ros2 run examples_rclcpp_minimal_subscriber subscriber_member_function

在另外一个终端中，让咱们运行一个发布者节点（不要忘记 source 安装脚本）：

ros2 run examples_rclcpp_minimal_publisher publisher_member_function

您应该看到来自发布者和订阅者的消息，而且数字会递增。

4. 建立你本身的包
colcon使用REP 149定义的package.xml规范（也支持 fromat 2）。
colcon支持多种编译类型，推荐的编译类型是ament_cmake和ament_python，也支持纯cmake包。
ament_python编译的一个示例是ament_index_python包，其中setup.py是编译的主要入口点。
诸如demo_nodes_cpp之类的包使用 ament_cmake 编译类型，并使用 CMake 做为编译工具。
为方便起见，您可使用工具 ros2 pkg create 基于模板建立新包。
注意：对于catkin用户来讲，catkin_create_package 与 ros2 pkg create 的做用相同。

5. 小贴士

• 若是您不想编译一个特定的包，用来在目录中放置一个叫 COLCON_IGNORE 的空文件，那么它将不会被编入索引。

• 若是想避免在CMake软件包中配置和编译 tests，你能够经过这个指令：--cmake-args -DBUILD_TESTING=0。

• 若是要从包中运行单个特定测试：

  colcon test --packages-select YOUR_PKG_NAME --ctest-args -R YOUR_TEST_IN_PKG

   

英文原文：https://index.ros.org/doc/ros2/Tutorials/Colcon-Tutorial/