ROS中插件plugin的简单使用方法

插件，如同其名字一样，第一次接触的时候让我想到了U盘或者USB线这类东西，它们和电脑没有关系，但是插入（挂载）电脑USB口后却可以正常使用，仿佛扩展了电脑的功能。软件中的插件也是类似的，插件化开发使得程序开发扩展性增强，并且不需要对于程序的框架做本质上的改变。

ROS中plugin插件的实际上是将C++类通过pluginlib进行封装，编译为动态库（.so文件），再通过pluginlib提供的加载接口在主程序中进行运行时的加载操作。

本篇笔记是学习了ROS中Writing and Using a Simple Plugin后总结的笔记。

ROS中插件的创建步骤如下5步：

1）创建基类

2）创建插件

3）注册插件

4）编译插件

5）将新的插件添加到ROS的工具链当中

---

1.在ROS中创建插件

1）创建基类

先创建一个工作空间catkin，并在catkin下创建src目录。然后在catkin/src路径下执行如下命令创建工程：

$ catkin_create_pkg pluginlib_tutorials_ roscpp pluginlib

此时，工程目录环境如下（注意这里有一些文件是后边步骤中才创建的）：

catkin/
|---src/
    |---CMakeLists.txt -> /opt/ros/kinetic/share/catkin/cmake/toplevel.cmake
    |---pluginlib_tutorials_/
        |---CMakeLists.txt
        |---include/
            |---pluginlib_tutorials_/
        |---package.xml
        |---polygon_plugins.xml
        |---src/

创建catkin/src/pluginlib_tutorials_/include/pluginlib_tutorials_/polygon_base.h文件，并写入如下代码：

#ifndef PLUGINLIB_TUTORIALS__POLYGON_BASE_H_
#define PLUGINLIB_TUTORIALS__POLYGON_BASE_H_

namespace polygon_base
{
  class RegularPolygon
  {
    public:
      virtual void initialize(double side_length) = 0;
      virtual double area() = 0;
      virtual ~RegularPolygon(){}

    protected:
      RegularPolygon(){}
  };
};
#endif

这里创建了个RegularPolygon抽象基类，后边的插件类就是继承该类。

2）创建插件

在include目录下创建include/pluginlib_tutorials_/polygon_plugins.h文件，并写入如下代码：

#ifndef PLUGINLIB_TUTORIALS__POLYGON_PLUGINS_H_
#define PLUGINLIB_TUTORIALS__POLYGON_PLUGINS_H_
#include <pluginlib_tutorials_/polygon_base.h>
#include <cmath>

namespace polygon_plugins
{
  class Triangle : public polygon_base::RegularPolygon
  {
    public:
      Triangle(){}

      void initialize(double side_length)
      {
        side_length_ = side_length;
      }

      double area()
      {
        return 0.5 * side_length_ * getHeight();
      }

      double getHeight()
      {
        return sqrt((side_length_ * side_length_) - ((side_length_ / 2) * (side_length_ / 2)));
      }

    private:
      double side_length_;
  };

  class Square : public polygon_base::RegularPolygon
  {
    public:
      Square(){}

      void initialize(double side_length)
      {
        side_length_ = side_length;
      }

      double area()
      {
        return side_length_ * side_length_;
      }

    private:
      double side_length_;

  };
};
#endif

这里创建了两个继承自基础类RegularPolygon的插件子类Triangle和Square。

3）注册插件

在2）中已经创建了两个类Triangle和Square，接下来需要使用pluginlib将这两个类声明为插件。

创建src/polygon_plugins.cpp文件，并写入以下代码：

#include <pluginlib/class_list_macros.h>
#include <pluginlib_tutorials_/polygon_base.h>
#include <pluginlib_tutorials_/polygon_plugins.h>

PLUGINLIB_EXPORT_CLASS(polygon_plugins::Triangle, polygon_base::RegularPolygon)
PLUGINLIB_EXPORT_CLASS(polygon_plugins::Square, polygon_base::RegularPolygon)

这里前三行include分别引入的头文件，是为了以下内容PLUGINLIB_EXPORT_CLASS、polygon_base::RegularPolygon、polygon_plugins::Triangle、polygon_plugins::Square能够找到。

后边两行代码，使用pluginlib中提供的PLUGINLIB_EXPORT_CLASS来将polygon_plugins::Triangle、polygon_plugins::Square注册为插件，这两个类的父类为polygon_base::RegularPolygon。

4）编译插件

在CMakeLists.txt文件中写入下面两行代码：

include_directories(include)
add_library(polygon_plugins src/polygon_plugins.cpp)

此时，可以在命令行窗口的工作空间顶目录下输入catkin_make命令进行编译：

通过编译日志可以看出，编译完成后生成了动态库libpolygon_plugins.so，存放在devel/lib下面。这个也就是我们创建成功的插件文件。

 

至此，插件创建成功了，那么在ROS中插件加载器怎么能找到这个插件并提供给每个应用程序中来使用呢？看下面的操作。

5）将创建的插件添加到ROS的工具链当中

（1）创建插件描述文件

在catkin/src/pluginlib_tutorials_/路径下创建polygon_plugins.xml文件，并写入以下代码：

<library path="lib/libpolygon_plugins">
  <class type="polygon_plugins::Triangle" base_class_type="polygon_base::RegularPolygon">
    <description>This is a triangle plugin.</description>
  </class>
  <class type="polygon_plugins::Square" base_class_type="polygon_base::RegularPolygon">
    <description>This is a square plugin.</description>
  </class>
</library>

可以仔细看一下这个xml文件中的内容。

<library path="lib/libpolygon_plugins"> library标签写明了要输出的lib文件所在的相对路径；

<class></class> class标签内容写明了插件的信息。

   type：插件的完整类型，例如polygon_plugins::Triangle;

   base_class_type：插件完整类型的父类，例如polygon_base::RegularPolygon;

   description：描述插件是做什么的；

（2）导出插件

在package.xml文件中写入以下代码，将创建的插件导出：

<export>
    <pluginlib_tutorials_ plugin="${prefix}/polygon_plugins.xml" />
</export>

可以看出，这里使用export标签将插件导出，里边指定了以上创建的插件描述文件的路径，其中pluginlib_tutorials_为基类所在的包名称。

此时，再次进行编译：

验证创建的插件是否有效：

这里，先source一下setup.bash文件，然后输入以下命令：

rospack plugins --attrib=plugin pluginlib_tutorials_

可以看出输出结果为创建的插件polygon_plugins.xml的绝对路径，这表明ROS工具链设置正确，可以和创建的插件一起使用。

 

2.在ROS程序中使用插件

插件已经创建好了，怎么使用插件呢？这里需要写一个插件测试程序来使用插件。

打开src/polygon_loader.cpp文件，并写入以下内容：

#include <pluginlib/class_loader.h>
#include <pluginlib_tutorials_/polygon_base.h>

int main(int argc, char** argv)
{
  pluginlib::ClassLoader<polygon_base::RegularPolygon> poly_loader("pluginlib_tutorials_", "polygon_base::RegularPolygon");

  try
  {
    boost::shared_ptr<polygon_base::RegularPolygon> triangle = poly_loader.createInstance("polygon_plugins::Triangle");
    triangle->initialize(10.0);

    boost::shared_ptr<polygon_base::RegularPolygon> square = poly_loader.createInstance("polygon_plugins::Square");
    square->initialize(10.0);

    ROS_INFO("Triangle area: %.2f", triangle->area());
    ROS_INFO("Square area: %.2f", square->area());
  }
  catch(pluginlib::PluginlibException& ex)
  {
    ROS_ERROR("The plugin failed to load for some reason. Error: %s", ex.what());
  }

  return 0;
}

看一下里边的主要代码。

引入文件中下面这一行表示插件加载器的引入：

#include <pluginlib/class_loader.h>

接下来就会创建一个插件加载器：

pluginlib::ClassLoader<polygon_base::RegularPolygon> poly_loader("pluginlib_tutorials_", "polygon_base::RegularPolygon");

这里创建了一个pluginlib::ClassLoader<polygon_base::RegularPolygon>类型的插件加载器poly_loader，第一个参数是包的名称，第二个参数是基类名称。

使用加载器来创建插件类的实例：

boost::shared_ptr<polygon_base::RegularPolygon> triangle = poly_loader.createInstance("polygon_plugins::Triangle");

这里创建的实例为类Triangle的实例triangle，类型为<polygon_base::RegularPolygon>类型的boost::shared_ptr智能指针。

接着通过初始化函数对三角形的边长进行初始化，然后打印一下三角形的面积：

triangle->initialize(10.0);
ROS_INFO("Triangle area: %.2f", triangle->area());

编译改程序：

可以看出编译生成的可执行程序路径为：catkin/devel/lib/pluginlib_tutorials_/polygon_loader

执行改程序，结果如下：

以上，就是ROS中插件的创建和使用的过程。其实总结一下就是，创建并编译出动态库文件，然后在你的主程序中使用这个库文件的这个过程。