工作空间与功能包

写在前面的话

---

• 文档没有任何商业因素，本着共享的精神进行分享，如有素材侵权，请给我留言;
• 文档都是自己平时看书或工作中的笔记，观点错误的地方欢迎留言；

工作空间(Work Space)介绍

---

工作空间（workspace）是一个存放工程开发相关文件的文件夹。Fuerte 版本之后 ROS 默认使用的是 Catkin 编译系统。一个典型的 Catkin 编译系统下的工作空间结构如下：

• src：代码空间（Source Space），用来存储 ROS 的功能包；
• build：编译空间（Build Space），用来存储工作空间编译过程中产生的缓存信息和中间文件；
• devel：开发空间（Development Space），用来放置编译生成的可执行文件；
• install：安装空间（Install Space），编译成功之后，可以使用 make install 命令将可执行文件安装到该空间，运行该空间中的环境变量脚本，即可在终端运行这些可执行文件夹。安装空间并不是必须的；

创建工作空间

---

• 创建工作空间 catkin_ws 目录并进行初始化：用如下命令即可完成对 catkin_ws 目录的建立和初始化：

$ mkdir -p ~/catkin_ws/src
$ cd ~/catkin_ws/src
$ catkin_init_workspace

• 编译 catkin_ws：使用如下命令在 catkin_ws 的根目录下编译整个工作空间，结果会在 catkin_ws 下自动产生 build 和 devel 两个文件夹。

$ cd ~/catkin_ws
$ catkin_make

• 设置环境变量；编译完成之后，devel 文件夹中已经产生好几个 setup.*sh 形式的设置环境变量的脚本，使用下面命令执行该脚本，使得工作空间中的环境变量生效；

$ source devel/setup.bash

• 验证环境变量是否成功：使用如下变量检查：如果打印的路径中已经包含当前工作空间的路径，则说明环境变量设置成功

$ echo $ROS_PACKAGE_PATH

结果会如下图所示：

注意： 在终端使用的 source 命令设置的环境变量只能在当前终端生效。如果希望环境变量在所有终端生效，则需要在终端配置文件加入环境变量的设置，如下所示：

echo "source /workspace/devel/setup.bash" >> ~/.bashrc

创建功能包

---

多个功能包以平行的方式存在的 src 目录下，ROS 不允许功能包之间的嵌套。功能包的创建是在 src 目录下进行的；

$ cd ~/catkin_ws/src
$ catkin_create_pkg <package_name> [depend1] [depend2] [depend3]

上述各个名字的含义如下：

• catkin_create_pkg：创建功能包的指令；
• package_name：功能包的名字；
• [depend1] [depend2] [depend3]：功能包的依赖包；

例子：加入我们需要创建一个 communication 的功能包，该功能包依赖于：std_msgs、roscpp、rospy等功能包；

$ cd ~/catkin_ws/src
$ catkin_create_pkg communication std_msgs roscpp rospy

创建完成之后，代码空间 src 中会生成一个 communication 功能包，其中已经包含了 package.xml 和 CMakeLists.txt 文件。

然后回到工作空间的根目录（catkin_ws）下，进行编译和设置环境变量；

$ cd ~/catkin_ws
$ catkin_make
$ source ~/catkin_ws/devel/setup.bash

以上便是创建一个功能包的基本流程；

注意： 在一个工作空间下不允许存在多个同名功能包，否则编译会报错；

Overlaying 机制

---

ROS 允许多个工作空间共存，每个工作空间可以根据自己的需要设置功能包，有可能会出现不同工作空间出现相同功能包名的情况，如果这些工作空间的环境变量都已经设置，那么在使用功能包时，ROS 如何确定使用哪一个功能包呢？
ROS 使用 Overlaying 机制，选择 ROS_PACKAGE_PATH 环境变量记录中符合需求最前端的功能包；

roscpp_tutorials 功能包是 ros-tutorial 中的一个功能包，这个功能包的路径如下：

$ echo $ROS_PACKAGE_PATH
/opt/ros/kinetic/share
$ rospack find roscpp_tutorials // 寻找包 roscpp_tutorials，会搜索环境变量 ROS_PACKAGE_PATH
/opt/ros/kinetic/share/roscpp_tutorials

我们在 catkin_ws 中新建一个同名的功能包：roscpp_tuturials，然后再来搜索 roscpp_tuturials的路径：

$ cd ~/catkin_ws/src
$ catkin_create_pkg roscpp_tutorials std_msgs rospy roscpp
$ cd ~/catkin_ws
$ catkin_make
...
$ source ~/catkin_ws/devel/setup.bash
$ echo $ROS_PACKAGE_PATH  // 打印环境变量 ROS_PACKAGE_PATH
/home/zach/test/ROSLearning/catkin_ws/src:/opt/ros/kinetic/share
$ rospack find roscpp_tutorials // 寻找包 roscpp_tutorials，会搜索环境变量 ROS_PACKAGE_PATH
/home/zach/test/ROSLearning/catkin_ws/src/roscpp_tutorials

可以发现，ROS 选择 ROS_PACKAGE_PATH 环境变量记录中符合需求最前端的功能包；

Overlaying 机制的弊端

---

假设存在如下架构的两个空间：

我们依次编译 catkin_ws 和 overlay_ws，最终的结果就是ROS每次搜索功能包 package_a 时，会定位到工作空间 overlay_ws 中，从而导致 package_b 产生潜在的风险；