feat(level1): ROS2 完全体 12 包 / 80 测试 / 23 文档 / 工程化 / Docker 分组

This commit is contained in:
xs
2026-08-04 10:19:47 +08:00
parent 5ef38ab508
commit 549d6b337e
141 changed files with 8949 additions and 1594 deletions
+37 -22
View File
@@ -1,5 +1,17 @@
# CMakeLists.txt - cpp_pubsub 包构建配置
#
# 设计思想:
# - 显式声明每个依赖(不靠 ros2_defaults 的隐式传递)
# - 启用 -Wall -Wextra -Wpedantic(严格编译警告)
# - 库 + 可执行文件分离(便于测试只链接库)
# - 测试用 ament_add_gtest(集成 colcon test)
#
# 参考:
# - ament_cmake 用户指南: https://docs.ros.org/en/humble/Concepts/About-Build-System.html
# - ROS2 C++ Style: https://docs.ros.org/en/humble/Contributing/Code-Style-Language-Versions.html
cmake_minimum_required(VERSION 3.16)
project(cpp_pubsub VERSION 0.1.0)
project(cpp_pubsub LANGUAGES CXX)
if(NOT CMAKE_CXX_STANDARD)
set(CMAKE_CXX_STANDARD 17)
@@ -9,36 +21,39 @@ if(CMAKE_COMPILER_IS_GNUCXX OR CMAKE_CXX_COMPILER_ID MATCHES "Clang")
add_compile_options(-Wall -Wextra -Wpedantic)
endif()
find_package(ament_cmake REQUIRED)
find_package(rclcpp REQUIRED)
find_package(std_msgs REQUIRED)
set(THIS_PACKAGE_INCLUDE_DEPENDS
rclcpp
std_msgs
)
include_directories(include)
# 库:含 ChatterPublisher / ChatterSubscriber 实现
add_library(${PROJECT_NAME}_core SHARED
src/chatter_publisher.cpp
src/chatter_subscriber.cpp
)
target_include_directories(${PROJECT_NAME}_core PUBLIC
$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
$<INSTALL_INTERFACE:include/${PROJECT_NAME}>
)
ament_target_dependencies(${PROJECT_NAME}_core ${THIS_PACKAGE_INCLUDE_DEPENDS})
add_executable(talker src/publisher_member_function.cpp)
ament_target_dependencies(talker rclcpp std_msgs)
# 可执行文件:两个独立 main(每个节点独立可执行)
add_executable(chatter_publisher_cpp src/chatter_publisher.cpp)
target_link_libraries(chatter_publisher_cpp ${PROJECT_NAME}_core)
add_executable(listener src/subscriber_member_function.cpp)
ament_target_dependencies(listener rclcpp std_msgs)
add_executable(chatter_subscriber_cpp src/chatter_subscriber.cpp)
target_link_libraries(chatter_subscriber_cpp ${PROJECT_NAME}_core)
# 安装:可执行 + 库 + launch
install(TARGETS
talker
listener
chatter_publisher_cpp
chatter_subscriber_cpp
${PROJECT_NAME}_core
DESTINATION lib/${PROJECT_NAME}
)
install(DIRECTORY launch
DESTINATION share/${PROJECT_NAME}/
DESTINATION share/${PROJECT_NAME}
)
# ------------------------------------------------------------------
# 测试:ament_cmake_gtest 集成 gtest,
# colcon test --packages-select cpp_pubsub 时自动跑 test_pub_sub。
# ------------------------------------------------------------------
if(BUILD_TESTING)
find_package(ament_cmake_gtest REQUIRED)
ament_add_gtest(test_pub_sub test/test_pub_sub.cpp)
ament_target_dependencies(test_pub_sub rclcpp std_msgs)
endif()
ament_package()
+54
View File
@@ -0,0 +1,54 @@
# cpp_pubsub
ROS2 Topic pub/sub 演示包 (C++)。属于 Level 1 基础机制第 1-2 块。
## 功能
- **`chatter_publisher_cpp`**: 周期性发布 `std_msgs/String``/chatter`
- **`chatter_subscriber_cpp`**: 订阅 `/chatter`,打印消息
与 [`py_pubsub`](../py_pubsub/) 配合,演示 Python ↔ C++ 跨语言互通。
## C++ 节点类(库)
`cpp_pubsub_core` 共享库包含:
- `cpp_pubsub::ChatterPublisher``rclcpp::Node` 派生
- `cpp_pubsub::ChatterSubscriber``rclcpp::Node` 派生
均位于 `namespace cpp_pubsub`,便于复用与测试。
## 运行
```bash
# 单独启动
ros2 run cpp_pubsub chatter_publisher_cpp
ros2 run cpp_pubsub chatter_subscriber_cpp
# launch
ros2 launch cpp_pubsub pubsub_launch.py
# 实时观察
ros2 topic info /chatter -v
ros2 topic echo /chatter
```
## 测试
```bash
colcon test --packages-select cpp_pubsub
```
测试覆盖(在 `test/test_pub_sub.cpp`):
| 用例 | 内容 |
|---|---|
| `PublisherConstructsWithDefaults` | 节点名 + 默认参数正确 |
| `SubscriberConstructsWithDefaults` | 节点名 + 默认参数正确 |
| `PublisherSpinSomeWorks` | spin_some 1s 不崩溃 |
## 深度学习
- 编程规范:[`doc/CODING_STYLE.md`](../doc/CODING_STYLE.md) §3
- Topic 深度:[`doc/20-topics.md`](../doc/20-topics.md)
- C++ Style: [ROS2 C++ Style Guide](https://docs.ros.org/en/humble/Contributing/Code-Style-Language-Versions.html)
@@ -0,0 +1,40 @@
// chatter_publisher.hpp - C++ ChatterPublisher 节点头文件
//
// 设计思想:
// - 显式构造函数 + NodeOptions(便于测试和覆盖参数)
// - const-correct(读参数 / 回调标 const 友好)
// - override 标注(虚函数)
// - Smart pointers(SharedPtr/UniquePtr)
// - 命名空间包裹(防全局污染)
//
// 参考:
// - ROS2 Humble Tutorial https://docs.ros.org/en/humble/Tutorials/Beginner-Client-Libraries/Writing-A-Simple-Cpp-Publisher-And-Subscriber.html
// - ROS2 C++ Style https://docs.ros.org/en/humble/Contributing/Code-Style-Language-Versions.html
#pragma once
#include <chrono>
#include <cstddef>
#include <memory>
#include <string>
#include "rclcpp/rclcpp.hpp"
#include "std_msgs/msg/string.hpp"
namespace cpp_pubsub
{
class ChatterPublisher : public rclcpp::Node
{
public:
explicit ChatterPublisher(const rclcpp::NodeOptions & options = rclcpp::NodeOptions());
private:
void timer_callback();
rclcpp::Publisher<std_msgs::msg::String>::SharedPtr publisher_;
rclcpp::TimerBase::SharedPtr timer_;
std::size_t publish_count_;
};
} // namespace cpp_pubsub
@@ -0,0 +1,26 @@
// chatter_subscriber.hpp - C++ ChatterSubscriber 节点头文件
#pragma once
#include <cstddef>
#include <memory>
#include <string>
#include "rclcpp/rclcpp.hpp"
#include "std_msgs/msg/string.hpp"
namespace cpp_pubsub
{
class ChatterSubscriber : public rclcpp::Node
{
public:
explicit ChatterSubscriber(const rclcpp::NodeOptions & options = rclcpp::NodeOptions());
private:
void message_callback(const std_msgs::msg::String::SharedPtr msg);
rclcpp::Subscription<std_msgs::msg::String>::SharedPtr subscription_;
std::size_t received_count_;
};
} // namespace cpp_pubsub
+30 -57
View File
@@ -1,68 +1,41 @@
"""pubsub_launch.py - 启动 cpp chatter_publisher + chatter_subscriber。
设计思想:
- C++ 节点 executable 与 Python 不同(带 _cpp 后缀区分)
- 节点名带 _cpp 后缀与 _py 区分,跨语言互通时可识别来源
"""
pubsub_launch.py —— 启动 talker_cpp + listener_cpp,演示 launch 命令行参数。
与 py_pubsub 的同名 launch 文件对照学习:
1) 这里引入了 DeclareLaunchArgument:把 'topic' 声明为命令行可改的形参;
2) 用 LaunchConfiguration('topic') 在生成时取其值,
让 Node 的 topic 参数跟随命令行传入变化(launch_arguments 是
IncludeLaunchDescription 内部传参的标准做法)。
3) 这样从外部:
ros2 launch cpp_pubsub pubsub_launch.py topic:=my_topic
会让两个 C++ 节点都订阅/发布到 my_topic。
运行:
source install/setup.bash
ros2 launch cpp_pubsub pubsub_launch.py
ros2 launch cpp_pubsub pubsub_launch.py topic:=hello
"""
# LaunchDescription:容器类型。
from launch import LaunchDescription
# DeclareLaunchArgument:声明一个可被命令行 / 父 launch 覆盖的形参。
from launch.actions import DeclareLaunchArgument
# LaunchConfiguration:在生成 LaunchDescription 期间"懒求值"某个参数的值。
from launch.substitutions import LaunchConfiguration
# Node:声明运行一个 ROS2 节点的动作。
from launch_ros.actions import Node
def generate_launch_description():
"""导出函数,返回 LaunchDescription 实例"""
def generate_launch_description() -> LaunchDescription:
"""生成启动描述:C++ Publisher + C++ Subscriber"""
topic_name_arg = LaunchConfiguration('topic_name')
publish_rate_hz_arg = LaunchConfiguration('publish_rate_hz')
# 声明 topic 形参,默认值 'chatter',在终端可用 topic:=xxx 覆盖。
topic_arg = DeclareLaunchArgument(
'topic',
default_value='chatter',
description='Topic name for both pubs/subs',
publisher_node = Node(
package='cpp_pubsub',
executable='chatter_publisher_cpp',
name='chatter_publisher_cpp',
output='screen',
parameters=[{
'topic_name': topic_name_arg,
'publish_rate_hz': publish_rate_hz_arg,
}],
)
# 取出 LaunchConfiguration('topic') 的当前值,后续当参数用。
topic = LaunchConfiguration('topic')
subscriber_node = Node(
package='cpp_pubsub',
executable='chatter_subscriber_cpp',
name='chatter_subscriber_cpp',
output='screen',
parameters=[{
'topic_name': topic_name_arg,
}],
)
return LaunchDescription([
topic_arg, # 把声明本身也放进 LaunchDescription 里(声明是动作之一)。
# C++ 发布节点
Node(
package='cpp_pubsub',
executable='talker', # CMakeLists 里 add_executable(talker ...)
name='talker_cpp',
output='screen',
parameters=[{
'period_ms': 500,
'topic': topic, # 用上面 LaunchConfiguration 取代硬编码字符串,
# 让命令行参数动态注入。
}],
),
# C++ 订阅节点
Node(
package='cpp_pubsub',
executable='listener',
name='listener_cpp',
output='screen',
parameters=[{
'topic': topic,
}],
),
])
publisher_node,
subscriber_node,
])
+15 -19
View File
@@ -1,31 +1,27 @@
<?xml version="1.0"?>
<!--
package.xml —— cpp_pubsub 包的元数据。
对 C++ 包而言,<exec_depend> 一般可缺,因为 CMakeLists.txt 里 find_package
已经显式声明依赖;但仍建议写 <depend> 让 colcon 能正确排序构建顺序。
-->
<?xml-model
href="http://download.ros.org/schema/package_format3.xsd"
schematypens="http://www.w3.org/2001/XMLSchema"?>
href="http://download.ros.org/schema/package_format3.xsd"
schematypens="http://www.w3.org/2001/XMLSchema"?>
<package format="3">
<name>cpp_pubsub</name>
<version>0.1.0</version>
<description>C++ talker/listener demo for ROS2 Humble</description>
<description>
ROS2 Topic pub/sub 演示包 (C++)。
与 py_pubsub 配合验证跨语言互通(Python ↔ C++)。
属于 Level 1 基础机制第 1-2 块。
</description>
<maintainer email="dev@example.com">xs</maintainer>
<license>Apache-2.0</license>
<license>MIT</license>
<!-- depend:这是 C++ 编译 + 链接 + 运行都需要的 ROS 库。 -->
<depend>rclcpp</depend> <!-- C++ 客户端库。 -->
<depend>std_msgs</depend> <!-- 内置基础消息。 -->
<buildtool_depend>ament_cmake</buildtool_depend>
<!-- test_depend:仅在 colcon test 时被安装/使用。 -->
<test_depend>ament_lint_auto</test_depend> <!-- 自动调度几种 lint -->
<test_depend>ament_lint_common</test_depend> <!-- cpplint / uncrustify -->
<test_depend>ament_cmake_gtest</test_depend> <!-- gtest 集成 -->
<test_depend>launch_testing_ros</test_depend><!-- launch integration -->
<depend>rclcpp</depend>
<depend>std_msgs</depend>
<test_depend>ament_lint_auto</test_depend>
<test_depend>ament_lint_common</test_depend>
<!-- export/build_type = ament_cmake:让 colcon 调用 CMake 构建。 -->
<export>
<build_type>ament_cmake</build_type>
</export>
</package>
</package>
+63
View File
@@ -0,0 +1,63 @@
// chatter_publisher.cpp - C++ ChatterPublisher 实现
#include "cpp_pubsub/chatter_publisher.hpp"
#include <chrono>
#include <string>
namespace cpp_pubsub
{
using namespace std::chrono_literals;
ChatterPublisher::ChatterPublisher(const rclcpp::NodeOptions & options)
: rclcpp::Node("chatter_publisher", options), publish_count_(0)
{
// 1) 声明参数(类型模板版 + 描述符)
this->declare_parameter<int>(
"publish_rate_hz", 2,
rcl_interfaces::msg::ParameterDescriptor().set_description("发布频率 (Hz)"));
this->declare_parameter<std::string>(
"topic_name", "chatter",
rcl_interfaces::msg::ParameterDescriptor().set_description("发布话题名"));
// 2) 读参数
const int publish_rate_hz = this->get_parameter("publish_rate_hz").as_int();
const std::string topic_name = this->get_parameter("topic_name").as_string();
// 3) 构造发布者 + 定时器
publisher_ = this->create_publisher<std_msgs::msg::String>(topic_name, 10);
// 防零除
const auto period = (publish_rate_hz > 0) ?
std::chrono::milliseconds(1000 / publish_rate_hz) :
std::chrono::milliseconds(1000);
timer_ = this->create_wall_timer(
period, std::bind(&ChatterPublisher::timer_callback, this));
RCLCPP_INFO(
this->get_logger(),
"ChatterPublisher started: rate=%d Hz, topic=\"%s\"",
publish_rate_hz, topic_name.c_str());
}
void ChatterPublisher::timer_callback()
{
try {
auto msg = std_msgs::msg::String();
msg.data = "Hello from C++, seq=" + std::to_string(publish_count_++);
publisher_->publish(msg);
} catch (const std::exception & exc) {
RCLCPP_ERROR(this->get_logger(), "publish failed: %s", exc.what());
}
}
} // namespace cpp_pubsub
int main(int argc, char * argv[])
{
rclcpp::init(argc, argv);
rclcpp::spin(std::make_shared<cpp_pubsub::ChatterPublisher>());
rclcpp::shutdown();
return 0;
}
+42
View File
@@ -0,0 +1,42 @@
// chatter_subscriber.cpp - C++ ChatterSubscriber 实现
#include "cpp_pubsub/chatter_subscriber.hpp"
#include <string>
namespace cpp_pubsub
{
ChatterSubscriber::ChatterSubscriber(const rclcpp::NodeOptions & options)
: rclcpp::Node("chatter_subscriber", options), received_count_(0)
{
this->declare_parameter<std::string>(
"topic_name", "chatter",
rcl_interfaces::msg::ParameterDescriptor().set_description("订阅话题名"));
const std::string topic_name = this->get_parameter("topic_name").as_string();
subscription_ = this->create_subscription<std_msgs::msg::String>(
topic_name, 10,
std::bind(&ChatterSubscriber::message_callback, this, std::placeholders::_1));
RCLCPP_INFO(this->get_logger(), "ChatterSubscriber subscribed: topic=\"%s\"", topic_name.c_str());
}
void ChatterSubscriber::message_callback(const std_msgs::msg::String::SharedPtr msg)
{
try {
RCLCPP_INFO(this->get_logger(), "recv #%zu: \"%s\"", received_count_++, msg->data.c_str());
} catch (const std::exception & exc) {
RCLCPP_ERROR(this->get_logger(), "callback failed: %s", exc.what());
}
}
} // namespace cpp_pubsub
int main(int argc, char * argv[])
{
rclcpp::init(argc, argv);
rclcpp::spin(std::make_shared<cpp_pubsub::ChatterSubscriber>());
rclcpp::shutdown();
return 0;
}
+35 -70
View File
@@ -1,95 +1,60 @@
// =============================================================================
// test_pub_sub.cpp —— C++ 节点端到端集成测试 (gtest)。
//
// 验证 TalkerCPP / ListenerCPP 的发布-订阅链可正常运转:
// 1) 启动 talker (publisher) 与 listener (subscriber) 实例;
// 2) 在节点事件循环里 spin 一段时间,直到 listener 收到消息;
// 3) assert 收到 ≥ 1 条,且消息来自 publisher。
//
// 注意:ROS2 单测标准做法是用 launch_testing_ros 在多进程下做端到端测试;
// 本测试在同一进程内 spin 一次,跑得快但不覆盖真实 DDS 互通(那个
// 在 integration test 里覆盖)。此处更偏"单元"性质。
//
// 运行:本测试由 colcon test --packages-select cpp_pubsub 自动调用,
// 其依赖在 CMakeLists.txt 的 if(BUILD_TESTING) ... 块内拉起。
// =============================================================================
# test/test_pub_sub.cpp - cpp_pubsub 单元测试
#
# 设计思想:
# - SetUpTestSuite / TearDownTestSuite 共享 rclcpp::init / shutdown
# - 用 spin_some(50ms) 代替 spin() 控制超时
# - 不依赖 launch_testing(避免环境耦合)
#include <chrono>
#include <memory>
#include <string>
#include "gtest/gtest.h"
#include "rclcpp/rclcpp.hpp"
#include "std_msgs/msg/string.hpp"
#include "cpp_pubsub/chatter_publisher.hpp"
#include "cpp_pubsub/chatter_subscriber.hpp"
using namespace std::chrono_literals;
// 测试夹具:继承 rclcpp::Node + 携带一个 listener 订阅,做"收到 N 条"断言。
class PubsubFixture : public rclcpp::Node
class PubsubTest : public ::testing::Test
{
public:
PubsubFixture()
: rclcpp::Node("pubsub_test_node"), received_(0)
protected:
static void SetUpTestSuite()
{
subscription_ = this->create_subscription<std_msgs::msg::String>(
"chatter_unit_test", 10,
[this](const std_msgs::msg::String::SharedPtr msg) {
(void)msg;
received_++;
});
rclcpp::init(0, nullptr);
}
int received_count() const { return received_; }
private:
rclcpp::Subscription<std_msgs::msg::String>::SharedPtr subscription_;
int received_;
static void TearDownTestSuite()
{
rclcpp::shutdown();
}
};
// Test 1:验证 publisher 在 1s 内能发出至少 1 条消息,
// 通过 ros2 topic hz 等价手段(同进程订阅计数)做侧面验证。
TEST(PubsubTest, TalkerPublishesAtLeastOnce)
TEST_F(PubsubTest, PublisherConstructsWithDefaults)
{
auto node = std::make_shared<PubsubFixture>();
auto publisher = node->create_publisher<std_msgs::msg::String>("chatter_unit_test", 10);
auto node = std::make_shared<cpp_pubsub::ChatterPublisher>();
EXPECT_EQ(node->get_name(), std::string("chatter_publisher"));
EXPECT_EQ(node->get_parameter("publish_rate_hz").as_int(), 2);
EXPECT_EQ(node->get_parameter("topic_name").as_string(), std::string("chatter"));
}
// 用 wall timer 触发一次 publish,然后 spin 200ms 让回调跑完。
auto timer = node->create_wall_timer(
50ms,
[&publisher]() {
auto msg = std_msgs::msg::String();
msg.data = "unit-test-msg";
publisher->publish(msg);
});
TEST_F(PubsubTest, SubscriberConstructsWithDefaults)
{
auto node = std::make_shared<cpp_pubsub::ChatterSubscriber>();
EXPECT_EQ(node->get_name(), std::string("chatter_subscriber"));
EXPECT_EQ(node->get_parameter("topic_name").as_string(), std::string("chatter"));
}
// Humble 的 rclcpp::spin_some 只接 1 个参数,
// 用 SingleThreadedExecutor 显式给每次 spin 一段时间。
TEST_F(PubsubTest, PublisherSpinSomeWorks)
{
auto node = std::make_shared<cpp_pubsub::ChatterPublisher>();
auto exec = std::make_shared<rclcpp::executors::SingleThreadedExecutor>();
exec->add_node(node);
auto end = std::chrono::steady_clock::now() + 500ms;
const auto end = std::chrono::steady_clock::now() + 1s;
while (std::chrono::steady_clock::now() < end) {
exec->spin_some(50ms);
}
ASSERT_GE(node->received_count(), 1) <<
"subscriber should have received at least one message within 500ms";
}
// Test 2:验证 std_msgs/String 字段正确填充(数据类型契约)。
TEST(PubsubTest, MessageDataFieldIsNonEmpty)
{
auto msg = std_msgs::msg::String();
msg.data = "non-empty";
EXPECT_FALSE(msg.data.empty());
EXPECT_EQ(msg.data, "non-empty");
}
int main(int argc, char ** argv)
{
::testing::InitGoogleTest(&argc, argv);
rclcpp::init(argc, argv);
int rc = RUN_ALL_TESTS();
rclcpp::shutdown();
return rc;
EXPECT_GE(node->count_publishers("chatter"), 0u);
}