当前位置:首页>python>ROS2入门 | 手把手教你写Python服务和客户端(附超详细代码注释)

ROS2入门 | 手把手教你写Python服务和客户端(附超详细代码注释)

  • 2026-09-29 17:35:33
ROS2入门 | 手把手教你写Python服务和客户端(附超详细代码注释)

导读:大家好,欢迎来到今天的ROS2教程!上一期我们学习了话题通信,今天我们来聊聊另一种重要的通信方式——服务(Service)。准备好了吗?让我们开始吧!😊


📚 先聊聊什么是"服务"?

想象一下你去餐厅吃饭的场景:

  • 你(客户端):向服务员点菜(发送请求)
  • 厨师(服务端):做好菜后给你(返回响应)
  • 菜单(.srv文件):规定了可以点什么菜,以及菜的样式

这就是ROS2中服务通信的本质!

与话题的区别:

  • 📢 话题(Topic):像广播,一发多收,不保证有人接收
  • 🔄 服务(Service):一对一,有请求必有响应

今天我们要实现一个两数相加的服务:客户端发送两个整数,服务端返回它们的和。简单吧?走起!


🎯 学习目标

✅ 用Python创建服务节点✅ 用Python创建客户端节点✅ 理解服务通信的工作原理✅ 掌握完整的开发流程


📦 第一步:创建功能包

打开终端,输入以下命令:

# 进入工作空间的src目录cd ~/ros2_ws/src# 创建Python功能包ros2 pkg create --build-type ament_python \    --license Apache-2.0 \    py_srvcli \    --dependencies rclpy example_interfaces

命令解读:

  • --build-type ament_python:使用Python构建系统
  • py_srvcli:包名(Python Service Client的缩写)
  • --dependencies:依赖的包
    • rclpy:ROS2 Python客户端库
    • example_interfaces:包含示例服务类型(如AddTwoInts)

生成的目录结构:

py_srvcli/├── package.xml              # 包描述文件├── setup.py                 # Python安装配置└── py_srvcli/              # Python代码目录    └── __init__.py

🖥️ 第二步:编写服务节点(服务端)

2.1 创建文件

在 py_srvcli/py_srvcli/ 目录下新建文件:

service_member_function.py

2.2 完整代码(超详细注释版)

#!/usr/bin/env python3# -*- coding: utf-8 -*-"""服务节点:两数相加功能:接收两个整数,返回它们的和"""# ==================== 导入必要的库 ====================# 从example_interfaces包中导入AddTwoInts服务类型# 这个服务类型已经定义好了请求(两个整数a和b)和响应(它们的和sum)from example_interfaces.srv import AddTwoInts# 导入ROS2 Python核心库import rclpyfrom rclpy.node import Node# ==================== 定义服务类 ====================classMinimalService(Node):"""    最小化服务类    继承自Node类,具备ROS2节点的所有基本功能    """def__init__(self):"""        初始化函数        在创建节点实例时自动执行        """# 调用父类(Node)的初始化方法# 给节点起名为'minimal_service',这个名字会在ROS2网络中显示        super().__init__('minimal_service')# 创建服务# 参数说明:# 1. AddTwoInts:服务类型(定义请求和响应的数据结构)# 2. 'add_two_ints':服务名称(客户端需要通过这个名字找到服务)# 3. self.add_two_ints_callback:回调函数(处理请求的逻辑)        self.srv = self.create_service(            AddTwoInts, 'add_two_ints',             self.add_two_ints_callback        )# 打印日志,告诉用户服务已经启动        self.get_logger().info('服务已启动,等待客户端请求...')defadd_two_ints_callback(self, request, response):"""        服务回调函数        当客户端发送请求时,这个函数会被自动调用        参数:        - request:请求对象,包含客户端发送的数据(a和b两个整数)        - response:响应对象,用于返回结果给客户端        返回:        - response:处理后的响应对象        """# 核心计算逻辑:将两个整数相加# request.a 和 request.b 是客户端发送的两个数# response.sum 是返回给客户端的结果        response.sum = request.a + request.b# 打印日志,记录收到的请求# %d 是整数占位符,会被后面的值替换        self.get_logger().info('收到请求:%d + %d' % (request.a, request.b)        )# 返回响应对象# 注意:必须返回response,否则客户端会卡住return response# ==================== 主函数 ====================defmain():"""    主函数    程序的入口点    """# 初始化ROS2系统# 这行代码必须放在最前面,它会建立与ROS2系统的连接    rclpy.init()# 创建服务节点实例    minimal_service = MinimalService()# 进入事件循环,等待并处理回调# 这行代码会让程序一直运行,直到被用户中断(Ctrl+C)# spin()函数会不断检查是否有新的请求到达,并调用相应的回调函数    rclpy.spin(minimal_service)# 关闭ROS2系统,释放资源    rclpy.shutdown()# ==================== 程序入口 ====================# 这行代码确保只有直接运行这个文件时才会执行main()# 如果被其他模块import,则不会自动执行if __name__ == '__main__':    main()

2.3 代码结构图解

┌─────────────────────────────────────┐│         MinimalService类            │├─────────────────────────────────────┤│  __init__()                         ││  ├─ 初始化节点名:'minimal_service'  ││  └─ 创建服务:add_two_ints          ││                                     ││  add_two_ints_callback(request,     ││                        response)    ││  ├─ 计算:response.sum = a + b      ││  ├─ 打印日志                        ││  └─ 返回response                    │└─────────────────────────────────────┘

💻 第三步:编写客户端节点

3.1 创建文件

在同一个目录下新建文件:

client_member_function.py

3.2 完整代码(超详细注释版)

#!/usr/bin/env python3# -*- coding: utf-8 -*-"""客户端节点:向服务发送请求功能:发送两个整数,接收并显示它们的和"""# ==================== 导入必要的库 ====================# 导入AddTwoInts服务类型,必须和服务端使用相同的类型from example_interfaces.srv import AddTwoInts# 导入ROS2 Python核心库import rclpyfrom rclpy.node import Node# ==================== 定义客户端类 ====================classMinimalClientAsync(Node):"""    最小化客户端类(异步模式)    异步意味着发送请求后不会阻塞,可以继续做其他事情    """def__init__(self):"""        初始化函数        """# 调用父类初始化方法,给节点起名        super().__init__('minimal_client_async')# 创建客户端# 参数说明:# 1. AddTwoInts:服务类型(必须和服务端一致)# 2. 'add_two_ints':服务名称(必须和服务端一致)        self.cli = self.create_client(AddTwoInts, 'add_two_ints')# 等待服务可用# 这是一个重要的步骤!如果服务还没启动,客户端需要等待# wait_for_service()会检查服务是否存在# timeout_sec=1.0 表示每1秒检查一次whilenot self.cli.wait_for_service(timeout_sec=1.0):# 如果服务不可用,打印提示信息            self.get_logger().info('服务暂未可用,继续等待...')# 创建请求对象# 这个对象用来存放要发送给服务端的数据        self.req = AddTwoInts.Request()defsend_request(self, a, b):"""        发送请求函数        参数:        - a:第一个整数        - b:第二个整数        返回:        - future对象:代表未来的结果(异步调用的核心概念)        """# 设置请求数据        self.req.a = a  # 设置第一个数        self.req.b = b  # 设置第二个数# 异步调用服务# call_async()会立即返回,不会等待结果# 返回的future对象稍后用来获取结果# 这就像你去餐厅点餐后拿到的取餐号牌return self.cli.call_async(self.req)# ==================== 主函数 ====================defmain():"""    主函数    """# 初始化ROS2系统    rclpy.init()# 创建客户端节点实例    minimal_client = MinimalClientAsync()# 发送请求# 这里我们发送 41 和 1,期待得到 42# send_request()返回一个future对象    future = minimal_client.send_request(41, 1)# 等待结果# spin_until_future_complete()会阻塞程序,直到收到响应# 这就像拿着取餐号牌在餐厅等待叫号    rclpy.spin_until_future_complete(minimal_client, future)# 获取响应结果# future.result()会返回服务端返回的response对象    response = future.result()# 打印结果# 从minimal_client.req中获取发送的原始数据# 从response中获取计算结果    minimal_client.get_logger().info('计算结果:%d + %d = %d' % (            minimal_client.req.a,             minimal_client.req.b,             response.sum        )    )# 清理资源# 销毁节点,释放ROS2资源    minimal_client.destroy_node()# 关闭ROS2系统    rclpy.shutdown()# ==================== 程序入口 ====================if __name__ == '__main__':    main()

3.3 客户端工作流程图

┌──────────────────────────────────────────────┐│           客户端工作流程                      │└──────────────────────────────────────────────┘                    │                    ▼        ┌───────────────────────┐        │  1. 初始化节点         │        │  2. 创建客户端         │        └───────────────────────┘                    │                    ▼        ┌───────────────────────┐        │  等待服务可用          │        │  (每秒检查一次)        │        └───────────────────────┘                    │                    ▼        ┌───────────────────────┐        │  3. 发送请求           │        │  (a=41, b=1)          │        └───────────────────────┘                    │                    ▼        ┌───────────────────────┐        │  4. 等待响应           │        │  (spin_until_future)  │        └───────────────────────┘                    │                    ▼        ┌───────────────────────┐        │  5. 接收结果           │        │  (sum=42)             │        └───────────────────────┘                    │                    ▼        ┌───────────────────────┐        │  6. 打印结果并退出     │        └───────────────────────┘

🔧 第四步:配置启动入口

4.1 为什么要配置?

写好代码后,我们需要让ROS2知道如何运行它们。这就需要在 setup.py 中注册入口点(entry points)。

4.2 修改 setup.py

打开 py_srvcli/setup.py,修改成以下内容:

from setuptools import find_packages, setuppackage_name = 'py_srvcli'setup(    name=package_name,    version='0.0.0',    packages=find_packages(exclude=['test']),    data_files=[        ('share/ament_index/resource_index/packages',            ['resource/' + package_name]),        ('share/' + package_name, ['package.xml']),    ],    install_requires=['setuptools'],    zip_safe=True,    maintainer='your_name',    maintainer_email='your_email@example.com',    description='ROS2服务与客户端教程',    license='Apache-2.0',    tests_require=['pytest'],    entry_points={'console_scripts': [# 注册服务节点# 格式:'命令名 = 包名.文件名:函数名''service = py_srvcli.service_member_function:main',# 注册客户端节点'client = py_srvcli.client_member_function:main',        ],    },)

关键配置说明:

'service = py_srvcli.service_member_function:main'# │         │         │                    │# │         │         │                    └─ 入口函数# │         │         └─ 文件名(不含.py)# │         └─ 包名# └─ 运行时使用的命令(ros2 run py_srvcli service)

🚀 第五步:编译和运行

5.1 编译功能包

# 返回工作空间根目录cd ~/ros2_ws# 编译py_srvcli包colcon build --packages-select py_srvcli

编译成功后,你会看到这样的输出:

Starting >>> py_srvcliFinished <<< py_srvcli [3.5s]

5.2 环境变量配置

重要! 编译后需要重新加载环境变量:

# 在工作空间根目录执行source install/setup.bash

5.3 启动服务节点

打开第一个终端:

cd ~/ros2_wssource install/setup.bash# 启动服务节点ros2 run py_srvcli service

你会看到:

[INFO] [minimal_service]: 服务已启动,等待客户端请求...

保持这个终端运行,不要关闭!

5.4 启动客户端节点

打开第二个终端:

cd ~/ros2_wssource install/setup.bash# 启动客户端节点ros2 run py_srvcli client

5.5 观察结果

第二个终端(客户端)输出:

[INFO] [minimal_client_async]: 计算结果:41 + 1 = 42

第一个终端(服务端)输出:

[INFO] [minimal_service]: 收到请求:41 + 1

🎉 成功了! 你刚刚完成了第一次服务通信!


🔍 深入理解:服务通信全过程

让我们用图解的方式,看看刚才发生了什么:

时间轴:──────────────────────────────────────────────────────►终端1:启动服务  │  ├─ ros2 run py_srvcli service  │  │  │  └─▶ 创建节点 'minimal_service'  │       创建服务 'add_two_ints'  │       进入等待状态(spin)  │  │       ⏸️ 等待请求...  │  │                          收到客户端请求  │                          │  │                          ▼  │                    执行回调函数  │                    计算:41 + 1 = 42  │                    返回结果  │  │                          ⏸️ 继续等待下一个请求...终端2:启动客户端  │  ├─ ros2 run py_srvcli client  │  │  │  └─▶ 创建节点 'minimal_client_async'  │       创建客户端(连接到'add_two_ints'服务)  │       等待服务可用...  │  │       发送请求:a=41, b=1  │       │  │       └─▶ 等待响应(spin_until_future_complete)  │           │  │           收到响应:sum=42  │           │  │           ▼  │       打印结果  │       退出程序

💡 常见问题解答

Q1:客户端一直显示"等待服务..."怎么办?

A:检查以下几点:

  1. 服务节点是否已经启动?
  2. 服务名称是否一致?(都是'add_two_ints')
  3. 服务类型是否一致?(都是AddTwoInts)
  4. 两个终端是否都source了setup.bash?

Q2:为什么客户端代码看起来比服务复杂?

A:因为客户端需要:

  • 等待服务可用(服务可能还没启动)
  • 异步发送请求
  • 等待并处理响应

这些都是必要的通信逻辑。

Q3:可以同时运行多个客户端吗?

A:当然可以!服务可以同时处理多个客户端的请求(一个接一个处理)。

Q4:如何修改请求的数字?

A:修改客户端代码中的 send_request() 调用:

# 原来的代码future = minimal_client.send_request(41, 1)# 修改为future = minimal_client.send_request(100, 200)

知识小结

今天我们学习了:

✅ 服务通信的基本概念

  • 请求-响应模式
  • 同步 vs 异步

✅ Python服务节点的编写

  • 创建服务
  • 编写回调函数
  • 返回响应

✅ Python客户端节点的编写

  • 创建客户端
  • 等待服务可用
  • 发送请求并接收响应

✅ 完整的开发流程

  • 创建功能包
  • 编写代码
  • 配置入口点
  • 编译运行

📝 课后练习

试试完成以下挑战:

  1. 基础题:修改客户端,让它发送不同的数字
  2. 进阶题:创建一个新的服务,实现两数相乘
  3. 挑战题:添加错误处理,比如除数为0的情况

🔗 扩展阅读

  • ROS2官方文档:服务通信
  • 理解ROS2服务
  • rclpy API文档

希望这篇文章对你有帮助!有任何问题欢迎在评论区留言交流~ 💬

最新文章

随机文章