【ROS2】CMakeLists配置信息通俗解释

文件示例

cmake_minimum_required(VERSION 3.8)
project(pkg01_helloworld_cpp)if(CMAKE_COMPILER_IS_GNUCXX OR CMAKE_CXX_COMPILER_ID MATCHES "Clang")add_compile_options(-Wall -Wextra -Wpedantic)
endif()# find dependencies
find_package(ament_cmake REQUIRED)
# 引入外部依赖包
find_package(rclcpp REQUIRED)# 映射源文件与可执行文件
add_executable(helloworld src/helloworld.cpp)
# 设置目标依赖库
ament_target_dependencies(helloworld"rclcpp"
)
# 定义安装规则
install(TARGETS helloworldDESTINATION lib/${PROJECT_NAME})if(BUILD_TESTING)find_package(ament_lint_auto REQUIRED)# the following line skips the linter which checks for copyrights# comment the line when a copyright and license is added to all source filesset(ament_cmake_copyright_FOUND TRUE)# the following line skips cpplint (only works in a git repo)# comment the line when this package is in a git repo and when# a copyright and license is added to all source filesset(ament_cmake_cpplint_FOUND TRUE)ament_lint_auto_find_test_dependencies()
endif()ament_package()

这个文件是做什么的？

想象你有一个做蛋糕的食谱，这个文件就像是一个 “代码食谱”，专门教电脑怎么做一杯 “HelloWorld 程序饮料”。它告诉电脑：

1. 需要什么材料（比如面粉=代码文件，烤箱=编译器）
2. 怎么做步骤（先打蛋，再搅拌=先编译，再链接）
3. 摆盘方式（装到哪个盘子里=程序安装到哪里）

---

逐行解释

1. 厨房准备

cmake_minimum_required(VERSION 3.8)

• 意思：“我这个食谱必须用 智能烤箱3.8版 以上才能做！太旧的烤箱做不出来！”

---

project(pkg01_helloworld_cpp)

• 意思：“这个蛋糕的名字叫 ‘一号HelloWorld蛋糕’，后面步骤都用于辅助完成这个蛋糕”

---

2. 检查厨房工具

if(CMAKE_COMPILER_IS_GNUCXX OR CMAKE_CXX_COMPILER_ID MATCHES "Clang")add_compile_options(-Wall -Wextra -Wpedantic)
endif()

• 意思：
  • 如果用的是 GCC牌搅拌机 或者 Clang牌榨汁机（两种常见编译器）
  • 就打开 严格模式：做蛋糕时鸡蛋壳掉进去（代码小错误）都要报警！

---

3. 买材料（找依赖包）

find_package(ament_cmake REQUIRED)
find_package(rclcpp REQUIRED)

• 意思：
  • ament_cmake：去仓库拿 ROS专用模具（没有这个模具，蛋糕形状不对）
  • rclcpp：再拿 ROS的奶油枪（没这个奶油枪，蛋糕上的字写不出来）
  • REQUIRED：这两样材料 必须买到！买不到就直接报错不做！
  • 同时自动记录这些工具的位置，相当于使用了include_directories和target_link_libraries

---

• 以上都只是确认某些工具是否存在，不对程序本身产生影响，相当于环境检查

---

以下真正开始编译相关

4. 开始做蛋糕

add_executable(helloworld src/helloworld.cpp)

• 意思：
  • 把 src文件夹里的helloworld.cpp（蛋糕原料）
  • 倒进模具，做成一个叫 helloworld 的蛋糕本体（可执行程序）

---

ament_target_dependencies(helloworld "rclcpp")

• 意思：
  • 告诉员工：“做这个蛋糕时，必须加ROS奶油枪里的奶油！不然味道不对！”

• 该命令用于，寻找依赖的依赖（递归收集所有间接依赖），并自动绑定到可执行文件上，进一步简化了环境配置
  同时，如果当前功能包还依赖了其他功能包，那么该函数还会自动继承其他包的依赖，无需重复声明

---

5. 摆盘上桌（安装）

install(TARGETS helloworld DESTINATION lib/${PROJECT_NAME})

• 意思：
  • 把做好的 helloworld蛋糕 放进冰箱的 lib/一号HelloWorld蛋糕 格子（安装目录）
  • 这样客人（其他程序）就知道去哪拿了

• 该命令用于构建系统，输入参数包括：
  1. 目标可执行文件和配置文件
  2. 指定安装路径（需符合ROS目录规范，否则ROS会找不到节点，导致运行失败）

---

6. 质量检查（可选）

if(BUILD_TESTING)...set(ament_cmake_copyright_FOUND TRUE)    # 跳过检查有没有贴商标set(ament_cmake_cpplint_FOUND TRUE)      # 跳过检查果汁纯度...
endif()

• 意思：
  • 如果开启质检模式（默认开）：
    • 但这里偷偷跳过了两个检查：
      • 不检查 有没有版权声明（比如蛋糕上没贴生产日期）
      • 不检查 代码风格（比如果汁瓶子没摆整齐）
  • 实际做产品时要打开这些检查！这里跳过了是因为懒

---

7. 最后封箱

ament_package()

• 意思：
  • 把整个蛋糕打包，贴上 “ROS官方认证” 的标签
  • 告诉其他ROS程序：“我这个蛋糕做好啦，你们可以来吃了！”

---

整个流程类比

想象你在开一家奶茶店：

1. 确定店名 → project(...)
2. 规定必须用高级咖啡机 → cmake_minimum_required
3. 检查员工有没有戴手套（严格模式） → 编译器警告选项
4. 检查设备是否齐全，工作是否正常 → find_package
5. 做奶茶：把红茶+牛奶倒进杯子 → add_executable
6. 必须加珍珠（依赖项） → ament_target_dependencies
7. 把奶茶放进指定展示柜 → install
8. 偷偷跳过卫生检查 → 跳过lint检查
9. 挂上营业招牌（一切工作完成，就等有人来买） → ament_package()

---

最终效果

当你运行这个"食谱"（CMakeLists.txt）后，你会得到：

• 一杯叫 helloworld 的奶茶/蛋糕（可执行程序）
• 自动放在ROS系统的"展示柜"里（安装目录）
• 其他ROS程序可以直接点这杯奶茶喝/蛋糕吃（调用它）

这就是ROS程序从代码变成可运行程序的全过程！