ROS学习笔记三：services/clients

ROS学习笔记三：services/clients

与publishers/subscribers的通信机制相比，services/clients通信机制是一种双向、一对一的可靠通信机制。
当client发送一个“请求”（request）到service处，service会反馈一个“响应”（response）给client，这时的client就需要知道service的名称才能完成这种问答形式的通信机制。
同时要注意一点，service的响应要尽可能的快，因为client在没有得到反馈之前是处于停止状态的，直到它收到反馈信息才开始重新运作。所以如果一个service需要较长的时间去处理大量的数据才能得出结果，这时应该选择action-server/action-client这种通信机制。

一.创建Service messages

与publishers/subscribers通信一样的，需要定义两者通信的信息类型，创建的步骤如下，与publishers/subscribers通信机制中定义messages类型很相似，只需要改动一些关键词：
①创建一个新的package（里面存放节点代码及service messages文件等等）
catkin_create_pkg example_service roscpp std_msgs
②在example_service中创建一个名叫“srv”的文件夹
cd example_service
mkdir srv
然后进入srv 文件夹并创建一个名叫“ExampleServiceMsg.srv” 的文件，这个文件的用途与.msg 文件相同。
cd srv
touch ExampleServiceMsg.srv
③打开ExampleServiceMsg.srv ，写入以下信息：

string name
---
bool on_the_list
bool good_guy
int32 age
string nickname

以上内容第一列为数据类型，第二类是定义的域名
注意 “- - -” ，在它的上方是“请求”信息的结构，在它的下方是“响应”信息的机构，如下图所示，注意不要弄错了。

④之后就要编辑package.xml，添加一下语句

<build_depend>message_generation</build_depend>
<run_depend>message_runtime</run_depend>

⑤编辑CMakeLists.txt，按顺序添加以下代码

find_package(catkin REQUIRED COMPONENTS roscpp rospy message_generation std_msgs std_srvs)

#注意这里的add_service_files与自定义messages类型有一点不同，在自定义messages类型中是用add_message_files指定.msg文件，而自定义service messages是用add_service_files指定.srv文件
 add_service_files(
   FILES
   ExampleServiceMsg.srv
 )

 generate_messages(
   DEPENDENCIES
   std_msgs
 )

catkin_package(

CATKIN_DEPENDS message_runtime

)

⑥先编译生成service messages的头文件
catkin_make
对应的头文件生成在

～/catkin_ws/devel/include/example_service

头文件的名称与.srv 文件的名称相同，与publishers/subscribers通信中的定义messages类型相比，在example_service文件夹里除了生成ExampleServiceMsg.h这个头文件外，还生成了另外两个头文件，分别是ExampleServiceMsgRequest.h和ExampleServiceMsgResponse.h，这两个头文件其实都包含在ExampleServiceMsg.h中，所以之后调用的时候只需要添加ExampleServiceMsg.h这个头文件即可，如：

#include <example_service/ExampleServiceMsg.h>

至此自定义service messages类型的操作就结束了，下面开始写一个简单的service node和client node。

---

若是在其他包中调用该消息类型，还需要在package.xml中添加如下语句

<build_depend>example_service</build_depend>

---

二.编辑Service node

完成了消息类型的建立，之后就可以开始写services/clients的节点程序了，先从services节点开始，进入到“src”文件夹中创建一个名称为example_service.cpp的文件
cd src
touch example_service.cpp
具体代码如下：

#include <ros/ros.h>
#include <example_service/ExampleServiceMsg.h> //注意添加消息类型的头文件
#include <iostream>
#include <string>
using namespace std;

//request是一个example_service::ExampleServiceMsgRequest类型的参数
//response是一个example_service::ExampleServiceMsgResponse类型的参数
bool callback(example_service::ExampleServiceMsgRequest& request, example_service::ExampleServiceMsgResponse& response)
{
    ROS_INFO("callback activated"); //等同于printf和cout
    string in_name(request.name); //定义一个string格式的变量
    response.on_the_list=false;

//这里只定义了两个名称，只有输入这两个名称中的一个才会反馈对应的信息    
    if (in_name.compare("Bob")==0)
 {
        ROS_INFO("asked about Bob");
        response.age = 32;
        response.good_guy=false;
        response.on_the_list=true;
        response.nickname="BobTheTerrible";
    } 
     if (in_name.compare("Ted")==0)
 {
        ROS_INFO("asked about Ted");
        response.age = 21;
        response.good_guy=true;
        response.on_the_list=true;
        response.nickname="Ted the Benevolent";
    }    

  return true;
}

int main(int argc, char **argv)
{
  ros::init(argc, argv, "example_service");//初始化节点，以example_service命名
  ros::NodeHandle n;

  ros::ServiceServer service = n.advertiseService("lookup_by_name", callback); //创建了一个service，名称为lookup_by_name，当一个"request"发送给这个service，callback函数就会被激活，在这里没有循环执行的函数，所以这个节点会处于暂停状态直到接受到"request"的时候才会被唤醒
  ROS_INFO("Ready to look up names.");
  ros::spin();

  return 0;
}

此时可以在CMakeLists.txt中添加以下语句：

add_executable(example_service src/example_service.cpp)
target_link_libraries(example_service ${catkin_LIBRARIES})

然后进行编译catkin_make
这时就可以测试以下我们编译的service节点能不能正确的反馈信息，输入
rosservice call lookup_by_name 'Ted'
若有如下输出，则说明成功的给这个service节点配置消息类型

on_the_list: True
good_guy: True
age: 21
nickname: Ted the Benevolent

---

三.编辑Client node

最后是clients节点，发出“request”和接收“response”的对象，在src文件夹中创建example_client.cpp文件，以下是client节点的代码：

#include <ros/ros.h>
#include <example_service/ExampleServiceMsg.h> // 自定义service messages类型的头文件
#include <iostream>
#include <string>
using namespace std;

int main(int argc, char **argv) {
    ros::init(argc, argv, "example_client");
    ros::NodeHandle n;
    //下面这一行很重要，它创建了以个serviceClient与已经创建的service（lookup_by_name）进行通信
    ros::ServiceClient client = n.serviceClient<example_service::ExampleServiceMsg>("lookup_by_name");
    example_service::ExampleServiceMsg srv;//这一行跟上一行很重要，这一行是指在package（example_service）中定义了service message（ExampleServiceMsg），在壳（srv）中包含了request和response的域
    bool found_on_list = false;
    string in_name;
    //下面是一个简单的逻辑判断循环
    while (ros::ok()) {
        cout<<endl;
        cout << "enter a name (x to quit): ";
        cin>>in_name;
        if (in_name.compare("x")==0)
            return 0;
        //cout<<"you entered "<<in_name<<endl;
        srv.request.name = in_name; //"Ted";
        //注意下面的client.call(srv)，这个call会与已创建的service完成信息交换，是一个布尔类型的判断，若判断为true，则会获得srv.response的信息
        if (client.call(srv)) {
            if (srv.response.on_the_list) {
                cout << srv.request.name << " is known as " << srv.response.nickname << endl;
                cout << "He is " << srv.response.age << " years old" << endl;
                if (srv.response.good_guy)
                    cout << "He is reported to be a good guy" << endl;
                else
                    cout << "Avoid him; he is not a good guy" << endl;
            } else {
                cout << srv.request.name << " is not in my database" << endl;
            }

        } else {
            ROS_ERROR("Failed to call service lookup_by_name");
            return 1;
        }
    }
    return 0;
}

然后在CMakeLists.txt中添加如下语句：

add_executable(example_client src/example_client.cpp)
target_link_libraries(example_client ${catkin_LIBRARIES})

最后编译catkin_make 完成后，分别在两个terminal中运行service和client
rosrun example_service example_service
和
rosrun example_service example_client
在运行client节点的terminal中，可以看到有如下输出：

enter a name (x to quit): 

输入Ted ：

Ted is known as Ted the Benevolent
He is 21 years old
He is reported to be a good guy

enter a name (x to quit):

---

总结，services/clients通信机制比较适合那种能够快速响应的场合，如果需要长时间才能得出结果的场合，适合使用action-servers/action-clients这种通信机制。