# ROS 设置教程

> For the complete documentation index, see [llms.txt](https://www.jetbrains.com/zh-cn/help/clion/llms.txt).

[ROS](http://www.ros.org/)（机器人操作系统）是一组为机器人应用设计的库和工具。 它主要面向 C++ 和 Python 开发，并使用基于 CMake 和 Python 脚本的 [catkin](http://wiki.ros.org/catkin) 构建系统。 ROS 软件 [发行版](http://wiki.ros.org/ROS/Installation)可用于 Linux、Windows，并在 macOS 上以实验模式提供。

您可以将 CLion 用作 ROS 项目的集成开发环境（IDE）。 本教程描述了如何设置工作流程，并提供了一个在 CLion 中创建和使用 ROS 包的示例。 请注意，此设置过程已在 Ubuntu 上测试。

> **Tip:**
> 您还可以使用一些第三方插件在 CLion 中进行 ROS 开发： [ROS-Robot Operating System](https://plugins.jetbrains.com/plugin/11420-ros-robot-operating-system) 和 [Hatchery](https://github.com/duckietown/hatchery)。
>
>
>
> 注释  ：第三方插件不由 CLion 团队维护或支持。

## 在已 source 的环境中启动 CLion

CLion 需要了解 ROS 特定的环境变量。 当您通过运行以下命令从工作空间目录 [source 工作空间](http://wiki.ros.org/ROS/Tutorials/InstallingandConfiguringROSEnvironment#Managing_Your_Environment)时，这些变量会在当前 shell 中被检索。

```CONSOLE
source ./devel/setup.bash

```

为 CLion 提供 ROS 环境变量的最简单方法是   从同一个 shell 启动 IDE  。 在加载工作空间后，您可以在同一个终端中输入：

```CONSOLE
sh <PATH_TO_CLION>/bin/clion.sh

```

## 在 CLion 中打开一个 ROS 项目

在已 source 的环境中启动 CLion 后，执行以下操作之一以打开您的 ROS 项目：

* 点击 `文件 | 打开` ，并在 ROS 工作空间的 `源代码` 目录中选择 `CMakeLists.txt` ，然后选择 作为项目打开 。

* 点击 `文件 | 从源代码新建 CMake 项目` 并选择工作空间的 `源代码` 目录以导入项目。

CMake 工具窗口  将显示项目加载的状态：

![成功加载 CMake 项目](https://resources.jetbrains.com/help/img/idea/2026.3/cl_ros_cmakeload_success.png)

> **Note:**
> 如果您使用 [catkin_tools](https://catkin-tools.readthedocs.io/en/latest/index.html)，则整个工作空间没有顶级  `CMakeLists.txt` 。 在这种情况下，您需要将每个包作为单独的项目在 CLion 中打开（从包目录中选择  `CMakeLists.txt` ）。 对 CLion 中   catkin_tools  支持的功能请求： [CPP-7438](https://youtrack.jetbrains.com/issue/CPP-7438)。
>
>
>
> 有关   catkin 构建  和   catkin_make  之间差异的更多信息，请参阅 [Catkin_tools 迁移指南](https://catkin-tools.readthedocs.io/en/latest/migration.html)。

## 将构建路径设置为 catkin 工作空间

默认情况下，CLion 将构建输出放置在  `cmake-build-debug` 或  `cmake-build-release` 目录中，这些目录会自动创建。 对于 ROS 开发，这意味着您将在 CLion 和运行  `catkin_make` 的控制台中有两个不同的构建。

要拥有一个   在 IDE 和控制台之间进行单次构建  ，您需要将 CLion 构建路径设置为 catkin 工作空间目录。 为此，请转到  `文件 | 设置 `Ctrl+Alt+S` (Windows), `⌘ Comma` (macOS), `⌘ Comma` (IntelliJ IDEA Classic (macOS)), `⌘ Comma` (macOS System Shortcuts), `Ctrl+Alt+S` (XWin), `Ctrl+Alt+S` (GNOME), `Ctrl+Alt+S` (KDE), `Ctrl+Alt+S` (Emacs), `Ctrl+Alt+S` (Sublime Text), `⌘ Comma` (Sublime Text (macOS)), `⌘ Comma` (Xcode), `Ctrl+Alt+S` (Visual Studio), `⌘ Comma` (Visual Studio (macOS)), `Ctrl+Alt+S` (ReSharper), `⌘ Comma` (ReSharper (macOS)), `Ctrl+Alt+S` (QtCreator), `⌘ Comma` (QtCreator (macOS)), `Ctrl+Alt+S` (NetBeans), `Ctrl+Alt+S` (Eclipse), `⌘ Comma` (Eclipse (macOS)) | 构建、执行、部署 | CMake` 并更改两个字段：

* 在 构建目录 中，设置 `<WORKSPACE_DIRECTORY>/构建` 。

* 在 CMake 选项 中，添加 `-DCATKIN_DEVEL_PREFIX:PATH=<WORKSPACE_DIRECTORY>/devel` 。

## 使用 launch 文件

您可以在 CLion 中像常规应用程序一样 [运行](running-applications.html)和 [调试](starting-the-debugger-session.html) ROS 节点。

[Launch](http://wiki.ros.org/roslaunch/XML) 文件无法直接执行，但您可以使用 XML 语法高亮和补全功能编辑它们，并将 [调试器附加](attach-to-process.html)到正在运行的节点。

Procedure: 将调试器附加到正在运行的节点

1. 从命令行运行您的  `.启动` 文件。 例如

```CONSOLE
roslaunch roscpp_tutorials talker_listener.launch
```

您可以通过  `rosnode list` 命令检查当前正在运行的节点列表。 在我们的示例中，列表将包含  `talker` 和  `listener` ：

![ros 节点列表](https://resources.jetbrains.com/help/img/idea/2026.3/cl_ros_nodelists.png)

2. 从主菜单调用  `运行 | 附加到进程`  或按 `Ctrl+Alt+F5` (Windows), `⌥ ⇧ F5` (macOS), `⌥ ⇧ F5` (IntelliJ IDEA Classic (macOS)), `⌥ ⇧ F5` (macOS System Shortcuts), `Ctrl+Alt+5` (XWin), `Ctrl+Alt+5` (GNOME), `Ctrl+Alt+5` (KDE), `Ctrl+Alt+F5` (Emacs), `Ctrl+Alt+F5` (Sublime Text), `⌥ ⇧ F5` (Sublime Text (macOS)), `⌥ ⇧ F5` (Xcode), `Ctrl+Alt+P` (Visual Studio), `⌘ ⌥ P` (Visual Studio (macOS)), `Ctrl+Alt+F5` (ReSharper), `⌃ ⌥ F5` (ReSharper (macOS)), `Ctrl+Alt+F5` (QtCreator), `⌥ ⇧ F5` (QtCreator (macOS)), `Ctrl+Alt+F5` (NetBeans), `Ctrl+Alt+F5` (Eclipse), `⌥ ⇧ F5` (Eclipse (macOS))。

3. 通过其 PID 或名称连接到所需节点：

![附加到 ros 节点](https://resources.jetbrains.com/help/img/idea/2026.3/cl_ros_attachtonode.png)

## 示例：创建一个基本的 ROS 节点，在 CLion 中编辑并运行

在本示例中，我们将创建一个简单的 ROS 包，编辑源代码，并从 CLion 运行该节点。 我们将使用 Ubuntu 18.04 上的 ROS Melodic 和  publisher 节点，该节点来自 [编写一个简单的发布者和订阅者（C++）](http://wiki.ros.org/ROS/Tutorials/WritingPublisherSubscriber%28c%2B%2B%29)教程，可在 [ROS wiki](http://wiki.ros.org/ROS)上找到。

Procedure: 创建一个基本的 ROS 包

1. 创建并构建一个 ROS 工作空间：

```SHELL
mkdir -p ros_workspace/src
cd ros_workspace
catkin_make

```

2. 在工作空间中创建一个名为  `my_package` 的包：

```SHELL
cd src
catkin_create_pkg my_package roscpp rospy std_msgs

```

Procedure: 启动 CLion

1. source 工作空间：

```CONSOLE
cd ../../../
source ./devel/setup.bash

```

2. 并在同一终端中启动 CLion：

```CONSOLE
sh /opt/clion-2018.2/bin/clion.sh

```

Procedure: 将包作为项目在 CLion 中打开

* 在 CLion 中，转到主菜单中的   文件 | 打开  ，选择位于包文件夹内的  `CMakeLists .txt` 文件，并选择将其作为项目打开：

![打开 ros 项目](https://resources.jetbrains.com/help/img/idea/2026.3/cl_ros_openprj.png)

Procedure: 添加源文件并编辑 CMakeLists.txt

1. 向项目添加一个新的源文件：右键点击项目树中的  `源代码` ，选择  `新建 | C/C++ 源文件` ，并将其命名为  `my_package.cpp` 。

2. 将整个 [talker.cpp](https://raw.githubusercontent.com/ros/ros_tutorials/kinetic-devel/roscpp_tutorials/talker/talker.cpp)文件从 [发布者和订阅者](http://wiki.ros.org/ROS/Tutorials/WritingPublisherSubscriber%28c%2B%2B%29)教程复制到  `my_package.cpp` 。

3. 将新创建的源文件添加到  `CMakeLists.txt` ，并 [链接](http://wiki.ros.org/catkin/CMakeLists.txt#target_link_libraries)到   catkin  库：

```CMAKE
add_executable(my_package src/my_package.cpp)
target_link_libraries(my_package ${catkin_LIBRARIES})

```

之后， [重新加载](reloading-project.html) CMake 项目，并在运行/调试配置列表中注意到   my_package  ：

![将源文件添加到 CMakeLists 并重新加载](https://resources.jetbrains.com/help/img/idea/2026.3/cl_ros_addcpp_reload.png)

Procedure: 运行一个 ROS 节点

1. 在从 CLion 运行节点之前，在新终端中打开 ROS master：

```CONSOLE
roscore
```

2. 在 CLion 中，运行 ![](https://resources.jetbrains.com/help/img/idea/2026.3/app.actions.execute.svg)   my_package  配置。   运行工具窗口  将显示节点输出：

![运行节点的输出](https://resources.jetbrains.com/help/img/idea/2026.3/cl_ros_runnode.png)

3. 在单独的终端中，检查当前活动的 ROS 主题。

如果我们打印来自  `chatter` 的消息，输出将类似于我们在 CLion 中看到的内容：

![ros chatter 节点正在运行](https://resources.jetbrains.com/help/img/idea/2026.3/cl_ros_chatter.png)

现在，如果我们在 CLion 中停止应用程序，  `rostopic echo /chatter` 命令将没有输出。

## See also

### 快速开始

[快速 CMake 教程](quick-cmake-tutorial.html)

### 外部链接

[ROS wiki](https://wiki.ros.org/)

