CMakeList.txt与package.xml文件详解

一、CMakeList.txt

CMakeLists.txt 是CMake的配置文件，定义了如何构建你的ROS 2包。它指定了编译选项、依赖关系、可执行文件、库等信息。

这是一个示例的 CMakeLists.txt 文件，用于构建一个包含简单 ROS 2 节点的包：

cmake_minimum_required(VERSION 3.5)
project(village_li)

# 找到所需的ROS组件
find_package(ament_cmake REQUIRED)
find_package(rclcpp REQUIRED)
find_package(std_msgs REQUIRED)

# 添加可执行文件
add_executable(li3_node src/li3_node.cpp)

# 链接目标与所需的库
ament_target_dependencies(li3_node rclcpp std_msgs)

# 安装可执行文件
install(TARGETS
  li3_node
  DESTINATION lib/${PROJECT_NAME})

# 启用测试（可选）
if(BUILD_TESTING)
  find_package(ament_lint_auto REQUIRED)
  ament_lint_auto_find_test_dependencies()
endif()

ament_package()

1.找到所需的 ROS 组件

find_package(ament_cmake REQUIRED)
find_package(rclcpp REQUIRED)
find_package(std_msgs REQUIRED)

• find_package(ament_cmake REQUIRED): 查找并加载 ament_cmake，它是用于构建 ROS 2 包的基础工具。
• find_package(rclcpp REQUIRED): 查找并加载 rclcpp 库，它是 ROS 2 的C++客户端库，用于编写 ROS 2 节点。
• find_package(std_msgs REQUIRED): 查找并加载 std_msgs，它是标准消息类型库，包含常用的消息类型。

这些指令告诉 CMake 需要找到并使用这些特定的包，以便在后续步骤中使用它们的功能和头文件。

2.添加可执行文件

add_executable(li3_node src/li3_node.cpp)

• add_executable(li3_node src/li3_node.cpp): 这条指令告诉 CMake 要编译 src/li3_node.cpp 文件，并生成一个名为 li3_node 的可执行文件。

在这一阶段，CMake 将会知道要生成的可执行文件以及其源代码文件的位置。

3.链接目标与所需的库

ament_target_dependencies(li3_node rclcpp std_msgs)

• ament_target_dependencies(li3_node rclcpp std_msgs): 这条指令告诉 CMake，li3_node 可执行文件依赖于 rclcpp 和 std_msgs 库。这一步将确保在构建可执行文件时，链接器可以找到并使用这些库。

通过这一操作，CMake 会将这些库包含在构建过程中，以确保生成的可执行文件能够正确调用这些库中的函数和功能。

4.安装可执行文件

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

• install(TARGETS li3_node DESTINATION lib/${PROJECT_NAME}): 这条指令告诉 CMake 将生成的 li3_node 可执行文件安装到指定目录中。${PROJECT_NAME} 是项目名称的变量，此处表示 village_li。

这一阶段确保了构建完成的可执行文件被安装到一个标准的位置，以便其他工具或用户可以方便地找到和使用它。

5.启用测试（可选）

if(BUILD_TESTING)
  find_package(ament_lint_auto REQUIRED)
  ament_lint_auto_find_test_dependencies()
endif()

• if(BUILD_TESTING): 这一部分是条件性的，只有在启用了测试构建选项时才会执行。
• find_package(ament_lint_auto REQUIRED): 查找并加载 ament_lint_auto 包，它用于自动化的代码检查和测试。
• ament_lint_auto_find_test_dependencies(): 自动查找测试所需的依赖项。

这一步确保了如果你决定进行测试构建，CMake 会找到并配置必要的工具和依赖项来进行代码质量检查和测试。

6.生成ament包：

ament_package()

这一步告诉ament生成一个包。

二、package.xml

package.xml 是用于定义ROS 2包的元数据文件。它包含包的名称、版本、描述、维护者、许可证、依赖关系等信息。

下面是一个典型的 package.xml 文件的结构和详细解释：

<?xml version="1.0"?>
<package format="3">
  <name>my_package</name>
  <version>0.0.1</version>
  <description>The my_package package</description>
  
  <maintainer email="maintainer@example.com">Your Name</maintainer>
  <license>Apache 2.0</license>

  <buildtool_depend>ament_cmake</buildtool_depend>

  <build_depend>rclcpp</build_depend>
  <build_depend>std_msgs</build_depend>

  <exec_depend>rclcpp</exec_depend>
  <exec_depend>std_msgs</exec_depend>

  <test_depend>ament_lint_auto</test_depend>
  <test_depend>ament_lint_common</test_depend>

  <export>
    <build_type>ament_cmake</build_type>
  </export>
</package>

1.XML 声明

<?xml version="1.0"?>

声明 XML 文件版本。

2.package 元素

<package format="3">

• package 是根元素，format 属性指定包的格式版本，当前常用的是格式 3。

3.包的基本信息

<name>my_package</name>
<version>0.0.1</version>
<description>The my_package package</description>

• <name>：包的名称。

• <version>：包的版本。

• <description>：包的描述。

4.维护者信息

Your Name

包的维护者和联系邮箱。

5.许可证

<license>Apache 2.0</license>

包使用的许可证类型。

6.依赖项

依赖项分为几类，不同类型的依赖项在不同阶段使用：

• 构建工具依赖

  <buildtool_depend>ament_cmake</buildtool_depend>
  

  构建工具依赖，例如 ament_cmake。

• 构建依赖

  <build_depend>rclcpp</build_depend>
  <build_depend>std_msgs</build_depend>
  

  构建包时需要的依赖项。

• 执行依赖

  <exec_depend>rclcpp</exec_depend>
  <exec_depend>std_msgs</exec_depend>
  

  包运行时需要的依赖项。

• 测试依赖

  xml复制代码<test_depend>ament_lint_auto</test_depend>
  <test_depend>ament_lint_common</test_depend>
  

  包测试时需要的依赖项。

7.导出信息

<export>
 <build_type>ament_cmake</build_type>
</export>

• 包的导出信息，<build_type> 指定了构建类型，这里是 ament_cmake。

逻辑流程

1. 找到包：find_package(ament_cmake REQUIRED) 和其他 find_package 指令在 CMakeLists.txt 中用于找到所需的包，这些包在 package.xml 中定义。
2. 配置构建环境：通过 ament_target_dependencies 等指令配置目标和依赖项，确保在构建过程中使用正确的库和头文件。
3. 构建和安装：add_executable 和 install 指令分别用于添加可执行文件并指定其安装位置。
4. 启用测试：在 CMakeLists.txt 中添加测试相关的配置，并在构建过程中通过命令行参数启用测试选项。

三、CMakeList.txt和package.xml的区别和联系

角色和职责：

1.package.xml

• 描述包的元数据：package.xml 文件用于定义包的元数据，例如包名、版本、维护者、许可证、依赖项等。
• 管理依赖项：package.xml 列出了包在构建和运行时所需要的其他包。它帮助包管理器和构建工具解析依赖关系并确保所需的包已经安装。
• 声明导出信息：package.xml 文件中的 <export> 标签用于声明包的导出信息，例如构建类型等。

2.CMakeLists.txt

• 构建配置：CMakeLists.txt 文件用于定义包的构建过程，包括编译选项、添加可执行文件、链接库等。
• 构建依赖：虽然 package.xml 中列出了依赖项，但 CMakeLists.txt 需要使用 find_package 来找到这些依赖项并将它们纳入构建过程。
• 安装配置：CMakeLists.txt 定义了安装规则，将构建的可执行文件、库和其他资源安装到正确的位置。

关系：

• 互补性：package.xml 和 CMakeLists.txt 互为补充，共同完成包的定义和构建。package.xml 负责元数据和依赖管理，而 CMakeLists.txt 负责具体的构建过程和安装步骤。
• 依赖解析：package.xml 列出依赖项后，CMakeLists.txt 使用 find_package 查找这些依赖项并将它们纳入构建过程。
• 一致性：为了确保一致性，package.xml 和 CMakeLists.txt 中列出的依赖项应该一致。package.xml 中的依赖项确保在构建和运行时所需的包已经安装，而 CMakeLists.txt 则确保在构建过程中正确找到和使用这些包。