ros2 + cmake + clangd+ vscode 开发环境

ros2 + cmake + clangd

在 ROS 2 项目中，结合 CMake（构建系统）和 clangd（C++ 语言服务器）可以大幅提升开发效率。

ROS 2 的包本身基于 CMake（通过ament_cmake封装）构建，

因此关键是让 clangd 通过 CMake 生成的编译信息正确解析 ROS 2 的依赖和标准库。

以下是详细配置流程：

一、核心原理

ROS 2 包的CMakeLists.txt通过ament_cmake扩展了 CMake 语法（如ament_package()、rosidl_generate_interfaces等），但本质仍是 CMake 项目。

clangd 需要通过编译数据库（compile_commands.json） 获取编译参数（包括 ROS 2 头文件路径、依赖包、C++ 标准等），而该文件可通过 CMake 生成。

二、详细配置步骤

1. 准备工作

确保已安装：

• ROS 2（如 Humble、Iron）及核心依赖（ros-<distro>-ament-cmake等）。
• clangd（sudo apt install clangd）。
• CMake（ROS 2 已自带兼容版本）。

2. 配置 ROS 2 包的CMakeLists.txt

在 ROS 2 包的CMakeLists.txt中，需显式设置 C++ 标准并启用编译数据库生成。示例如下：

cmake

 

cmake_minimum_required(VERSION 3.5)

project(my_ros2_package)

# 1. 设置C++标准（关键：ROS 2推荐C++17及以上）
if(CMAKE_COMPILER_IS_GNUCXX OR CMAKE_CXX_COMPILER_ID MATCHES "Clang")
  set(CMAKE_CXX_STANDARD 17)
  set(CMAKE_CXX_STANDARD_REQUIRED ON)
  set(CMAKE_CXX_EXTENSIONS OFF)  # 禁用编译器扩展
endif()

# 2. 生成编译数据库（核心配置）
set(CMAKE_EXPORT_COMPILE_COMMANDS ON)

# 3. 查找ROS 2依赖（示例：rclcpp、std_msgs）
find_package(ament_cmake REQUIRED)
find_package(rclcpp REQUIRED)
find_package(std_msgs REQUIRED)

# 4. 添加可执行文件（示例节点）
add_executable(my_node src/my_node.cpp)

# 5. 链接ROS 2依赖
ament_target_dependencies(my_node
  rclcpp
  std_msgs
)

# 6. 安装目标（ROS 2标准流程）
install(TARGETS
  my_node
  DESTINATION lib/${PROJECT_NAME})

ament_package()

 

• 关键配置：
  • CMAKE_CXX_STANDARD：确保与 ROS 2 依赖的 C++ 标准一致（避免标准库不兼容报错）。
  • CMAKE_EXPORT_COMPILE_COMMANDS ON：让 CMake 生成compile_commands.json。

3. 编译 ROS 2 工作空间并生成编译数据库

在 ROS 2 工作空间（如~/ros2_ws）中执行：

bash

 

# 进入工作空间

cd ~/ros2_ws

# 清理旧编译产物（可选但推荐）
rm -rf build/ install/ log/

# 编译并生成编译数据库
colcon build --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON

 

• 编译完成后，build/目录下会生成compile_commands.json，包含所有 ROS 2 包的编译参数（包括rclcpp、std_msgs等头文件路径）。

4. 让 clangd 识别编译数据库

clangd 需要找到compile_commands.json才能解析项目。推荐以下两种方式：

方法 1：软链接到工作空间根目录（推荐）

在工作空间根目录执行，将build/下的编译数据库链接到根目录：

bash

 

ln -s build/compile_commands.json .

 

 

这样，编辑器打开工作空间时，clangd 会直接识别该文件。

方法 2：在编辑器中指定路径

若不希望创建软链接，可在编辑器配置中手动指定路径：

• VS Code：在工作空间的.vscode/settings.json中添加：
  json 

      require('lspconfig').clangd.setup{
  
        cmd = {
          "clangd",
          "--compile-commands-dir=~/ros2_ws/build",  // 替换为实际工作空间路径
          "--background-index"  // 后台建立索引，提升性能
        }
      }

   

5. 验证配置

打开 ROS 2 节点文件（如my_ros2_package/src/my_node.cpp），检查以下功能是否正常：

• 跳转：Ctrl+点击 #include "rclcpp/rclcpp.hpp" 能否跳转到 ROS 2 安装目录下的头文件。
• 补全：输入rclcpp::Node::后，是否自动补全create_publisher等成员函数。
• 语法检查：是否不再报错"rclcpp/rclcpp.hpp" file not found。

三、常见问题与解决

1. clangd 找不到 ROS 2 头文件（如rclcpp）

• 原因：compile_commands.json未包含 ROS 2 安装路径（如/opt/ros/humble/include）。
• 解决：
  • 确保colcon build时正确加载了 ROS 2 环境（编译前执行source /opt/ros/humble/setup.bash）。
  • 重新编译并检查build/compile_commands.json中是否包含-I/opt/ros/humble/include等路径。

2. 自定义消息（.msg）头文件报错

• 原因：ROS 2 的rosidl生成的头文件（如my_package/msg/my_msg.hpp）路径未被 clangd 识别。
• 解决：
  • 确保CMakeLists.txt中正确添加了rosidl_generate_interfaces并生成消息。
  • 重新编译后，compile_commands.json会包含build/my_package/rosidl_generator_cpp等路径。

3. 编译数据库不更新

• 原因：修改CMakeLists.txt或依赖后未重新生成。
• 解决：
  bash

   

  rm -rf build/compile_commands.json  # 删除旧文件
  colcon build --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON  # 重新生成