ROS2学习笔记之编写C++服务service和client篇

学习目标：能够用C++编写服务的service和client

背景

当节点通过服务进行通讯的时候，发送数据请求的一方我们称之为客户端，接收数据然后相应的一端我们称之为服务器端。请求和响应的数据结构有一个.srv文件决定。
本例程当中我们做一个加法运算，一个节点发送一个将两个整数相加的请求，另外一个节点对请求进行相应。

前期准备

知道如何创建工作空间和功能包

学习内容

1. 创建包

我们继续使用之前我们创建的工作空间。

cd ~/dev_ws/src
ros2 pkg create --build-type ament_cmake cpp_srvcli --dependencies rclcpp example_interfaces

我们使用了--dependencies选项，这个选项会在package.xml 和 CMakeLists.txt相应的地方为我们自动加上依赖。example_interfaces是一个安装的包包含了我们服务的.srv文件。
这消息结构如下，前面部分是请求，后面部分是响应。

int64 a
int64 b
---
int64 sum

1.1 更新 package.xml

由于我们使用了--dependencies选项，我们就不在需要添加依赖选项。我们只需要填写功能包的描述，维护者的姓名和联系方式，许可这些内容

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

2. 编写服务service节点

进入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函数部分
首先是初始化ROS2的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.");

一直等待服务回调

rclcpp::spin(node);

2.2 让service生成可执行文件

和之前的例程一样在最后一个find_package下面添加下面的内容

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

再接着后面添加install部分

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

3 编写客户端client节点

进入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");

接下来创建了一个请求request，它的数据结构是由对应的.srv决定的

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

接下来是一个while循环，用1s的时间在ros中搜索服务的服务端，如果没有找到就继续搜索。

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

如果客户端被取消了就往终端打印一条信息，并结束程序。

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

接下来节点发送请求，等待服务端响应成功或者失败。

3.2 生成可执行文件

打开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. 编译运行

进入工作空间根目录进行编译

cd ~/dev_ws
colcon build --packages-select cpp_srvcli

打开一个新的终端，我们运行service服务端

cd ~/dev_ws
source install/setup.bash
ros2 run cpp_srvcli server

终端输出消息表示节点正常运行

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

再打开一个新的终端，我们运行client客户端

cd ~/dev_ws
source install/setup.bash
ros2 run cpp_srvcli client 2 3

客户端收到消息后退出，收到响应如下

[INFO] [rclcpp]: Sum: 5

同时服务器端也打印出消息

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

现在Ctrl + C关掉两个节点。

总结

操作流程和话题类似，添加依赖过后编译生成可执行文件，然后运行。