【ROS2指南-13】编写简单的服务和客户端

目标：使用 C++ 创建和运行服务和客户端节点。

教程级别：初学者

时间： 20分钟

内容

• 背景

• 先决条件

• 任务

  • 1 创建一个包

  • 2 编写服务节点

  • 3 编写客户端节点

  • 4 构建并运行

• 概括

• 下一步

• 相关内容

背景

当节点使用服务进行通信时，发送数据请求的节点称为客户端节点，响应请求的节点称为服务节点。请求和响应的结构由一个.srv 文件决定。

这里使用的例子是一个简单的整数加法系统；一个节点请求两个整数的总和，另一个节点响应结果。

先决条件

在之前的教程中，您学习了如何创建工作区和创建包。

任务

1 创建一个包

打开一个新终端并 source ，这样ros2命令就可以工作了。

进到在上一教程dev_ws中创建的目录。

回想一下，应该在src目录中创建包，而不是在工作空间的根目录中。进到 dev_ws/src 并创建一个新包：

ros2 pkg create --build-type ament_cmake cpp_srvcli --dependencies rclcpp example_interfaces

您的终端将返回一条消息，验证您的包及其所有必要文件和文件夹的创建 cpp_srvcli。

--dependencies 参数会自动将必要的依赖行添加到package.xml和CMakeLists.txt。

example_interfaces 包中含有需要构建的请求和响应服务：

int64 a
int64 b
---
int64 sum

前两行是请求的参数，虚线下面是响应。

1.1 更新package.xml

因为您--dependencies在包创建期间使用了该选项，所以您不必手动将依赖项添加到package.xml或CMakeLists.txt。

不过，一如既往，请确保将描述、维护者电子邮件和姓名以及许可证信息添加到package.xml.

<description>C++ client server tutorial</description>
<maintainer email="you@email.com">Your Name</maintainer>
<license>Apache License 2.0</license>

2 编写服务节点

在 dev_ws/src/cpp_srvcli/src 目录中，创建一个名为add_two_ints_server.cpp的新文件，并将以下代码粘贴到其中：

#include "rclcpp/rclcpp.hpp"
#include "example_interfaces/srv/add_two_ints.hpp"

#include <memory>

void add(const std::shared_ptr<example_interfaces::srv::AddTwoInts::Request> request,
          std::shared_ptr<example_interfaces::srv::AddTwoInts::Response>      response)
{
  response->sum = request->a + request->b;
  RCLCPP_INFO(rclcpp::get_logger("rclcpp"), "Incoming request\na: %ld" " b: %ld",
                request->a, request->b);
  RCLCPP_INFO(rclcpp::get_logger("rclcpp"), "sending back response: [%ld]", (long int)response->sum);
}

int main(int argc, char **argv)
{
  rclcpp::init(argc, argv);

  std::shared_ptr<rclcpp::Node> node = rclcpp::Node::make_shared("add_two_ints_server");

  rclcpp::Service<example_interfaces::srv::AddTwoInts>::SharedPtr service =
    node->create_service<example_interfaces::srv::AddTwoInts>("add_two_ints", &add);

  RCLCPP_INFO(rclcpp::get_logger("rclcpp"), "Ready to add two ints.");

  rclcpp::spin(node);
  rclcpp::shutdown();
}

2.1 检查代码

前两个#include语句是您的包依赖项。

该add函数将请求中的两个整数相加并将总和提供给响应，同时使用日志将其状态通知给控制台。

void add(const std::shared_ptr<example_interfaces::srv::AddTwoInts::Request> request,
         std::shared_ptr<example_interfaces::srv::AddTwoInts::Response>      response)
{
    response->sum = request->a + request->b;
    RCLCPP_INFO(rclcpp::get_logger("rclcpp"), "Incoming request\na: %ld" " b: %ld",
        request->a, request->b);
    RCLCPP_INFO(rclcpp::get_logger("rclcpp"), "sending back response: [%ld]", (long int)response->sum);
}

该main函数逐行完成以下操作：

• 初始化 ROS 2 C++ 客户端库：

  rclcpp::init(argc, argv);
  

创建一个名为的节点add_two_ints_server：

std::shared_ptr<rclcpp::Node> node = rclcpp::Node::make_shared("add_two_ints_server");

创建一个以add_two_ints该节点命名的服务，并使用以下方法在网络上自动发布它&add：

rclcpp::Service<example_interfaces::srv::AddTwoInts>::SharedPtr service =
node->create_service<example_interfaces::srv::AddTwoInts>("add_two_ints", &add);

准备就绪时打印一条日志消息：

RCLCPP_INFO(rclcpp::get_logger("rclcpp"), "Ready to add two ints.");

spin节点，使服务可用。

rclcpp::spin(node);

2.2 添加可执行文件

使用 add_executable 宏生成一个可执行文件，您可以添加以下代码块以创建名为server的可执行文件：

add_executable(server src/add_two_ints_server.cpp)
ament_target_dependencies(server
rclcpp example_interfaces)

以便找到可执行文件，将以下行添加到文件末尾，就在ament_package()之前

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

您现在可以构建您的包，获取本地安装文件并运行它，但让我们先创建客户端节点，这样您就可以看到整个系统在工作。

3 编写客户端节点

在 dev_ws/src/cpp_srvcli/src 目录中，创建一个名为add_two_ints_client.cpp的新文件并将以下代码粘贴到其中：

#include "rclcpp/rclcpp.hpp"
#include "example_interfaces/srv/add_two_ints.hpp"

#include <chrono>
#include <cstdlib>
#include <memory>

using namespace std::chrono_literals;

int main(int argc, char **argv)
{
  rclcpp::init(argc, argv);

  if (argc != 3) {
      RCLCPP_INFO(rclcpp::get_logger("rclcpp"), "usage: add_two_ints_client X Y");
      return 1;
  }

  std::shared_ptr<rclcpp::Node> node = rclcpp::Node::make_shared("add_two_ints_client");
  rclcpp::Client<example_interfaces::srv::AddTwoInts>::SharedPtr client =
    node->create_client<example_interfaces::srv::AddTwoInts>("add_two_ints");

  auto request = std::make_shared<example_interfaces::srv::AddTwoInts::Request>();
  request->a = atoll(argv[1]);
  request->b = atoll(argv[2]);

  while (!client->wait_for_service(1s)) {
    if (!rclcpp::ok()) {
      RCLCPP_ERROR(rclcpp::get_logger("rclcpp"), "Interrupted while waiting for the service. Exiting.");
      return 0;
    }
    RCLCPP_INFO(rclcpp::get_logger("rclcpp"), "service not available, waiting again...");
  }

  auto result = client->async_send_request(request);
  // Wait for the result.
  if (rclcpp::spin_until_future_complete(node, result) ==
    rclcpp::executor::FutureReturnCode::SUCCESS)
  {
    RCLCPP_INFO(rclcpp::get_logger("rclcpp"), "Sum: %ld", result.get()->sum);
  } else {
    RCLCPP_ERROR(rclcpp::get_logger("rclcpp"), "Failed to call service add_two_ints");
  }

  rclcpp::shutdown();
  return 0;
}

3.1 检查代码

与服务节点类似，以下代码行创建节点，然后为该节点创建客户端：

std::shared_ptr<rclcpp::Node> node = rclcpp::Node::make_shared("add_two_ints_client");
rclcpp::Client<example_interfaces::srv::AddTwoInts>::SharedPtr client =
  node->create_client<example_interfaces::srv::AddTwoInts>("add_two_ints");

接下来，创建请求。它的结构由前面提到的文件定义.srv。

auto request = std::make_shared<example_interfaces::srv::AddTwoInts::Request>();
request->a = atoll(argv[1]);
request->b = atoll(argv[2]);

该while循环给客户端 1 秒的时间来搜索网络中的服务节点。如果找不到，它将继续等待。

RCLCPP_INFO(rclcpp::get_logger("rclcpp"), "service not available, waiting again...");

如果客户端被取消（例如，通过您进入Ctrl+C终端），它将返回一条错误日志消息，说明它已被中断。

RCLCPP_ERROR(rclcpp::get_logger("rclcpp"), "Interrupted while waiting for the service. Exiting.");
  return 0;

然后客户端发送它的请求，节点spin直到它收到响应，或者失败。

3.2 添加可执行文件

返回以CMakeLists.txt添加新节点的可执行文件和目标。从自动生成的文件中删除一些不必要的样板文件后，您CMakeLists.txt应该如下所示：

cmake_minimum_required(VERSION 3.5)
project(cpp_srvcli)

find_package(ament_cmake REQUIRED)
find_package(rclcpp REQUIRED)
find_package(example_interfaces REQUIRED)

add_executable(server src/add_two_ints_server.cpp)
ament_target_dependencies(server
  rclcpp example_interfaces)

add_executable(client src/add_two_ints_client.cpp)
ament_target_dependencies(client
  rclcpp example_interfaces)

install(TARGETS
  server
  client
  DESTINATION lib/${PROJECT_NAME})

ament_package()

4 构建并运行

最好在工作区的根目录中运行rosdep,以检查是否缺少依赖项：

rosdep install -i --from-path src --rosdistro dashing -y

回到工作区的根目录，dev_ws并构建新包：

colcon build --packages-select cpp_srvcli

打开一个新终端，导航到dev_ws，然后获取安装文件：

. install/setup.bash

现在运行服务节点：

ros2 run cpp_srvcli server

终端应返回以下消息，然后等待：

[INFO] [rclcpp]: Ready to add two ints.

打开另一个终端，再次从内部获取设置文件dev_ws。启动客户端节点，后跟任意两个以空格分隔的整数：

ros2 run cpp_srvcli client 2 3

例如，如果您选择2and 3，客户端将收到如下响应：

[INFO] [rclcpp]: Sum: 5

返回到运行服务节点的终端。你会看到它在收到请求和收到的数据时发布了日志消息，以及它发回的响应：

[INFO] [rclcpp]: Incoming request
a: 2 b: 3
[INFO] [rclcpp]: sending back response: [5]

在服务器终端中输入Ctrl+C以停止节点spin。

概括

您创建了两个节点来通过服务请求和响应数据。您将它们的依赖项和可执行文件添加到包配置文件中，以便您可以构建和运行它们，并查看工作中的服务/客户端系统

下一步

在最近的几个教程中，您一直在使用接口跨主题和服务传递数据。接下来，您将学习如何创建自定义界面。

相关内容

• 有几种方法可以用 C++ 编写服务和客户端；查看ros2/examples repo中的minimal_service和包。minimal_client