linux下简易插件系统的实现

最新推荐文章于 2024-05-08 17:11:25 发布
最新推荐文章于 2024-05-08 17:11:25 发布
阅读量524 收藏 1
点赞数 1
文章标签： linux c++ 运维
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_43791996/article/details/125759492
版权

插件系统所具有的功能

1、 负责插件的加载，检测，初始化。
2、 负责服务的注册。
3、 负责服务的调用。
4、 服务的管理。

运行环境

运行环境：ubuntu20
代码用到的组件：log4cpp

共享库生成

项目组成

cmakelists

# 设置release版本还是debug版本
cmake_minimum_required(VERSION 3.16)
if(${CMAKE_BUILD_TYPE} MATCHES "Release")
    MESSAGE(STATUS "Release版本")
    SET(BuildType "Release")
else()
    SET(BuildType "Debug")
    MESSAGE(STATUS "Debug版本")
endif()
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11 -W -Wall -Wextra -g")
include_directories(
    /usr/local/include/orocos/
    /usr/local/include/
    /usr/include
）
include_directories(${CMAKE_CURRENT_SOURCE_DIR})
LINK_DIRECTORIES(${CMAKE_CURRENT_SOURCE_DIR})
#设置lib库目录
SET(RELEASE_DIR ${PROJECT_SOURCE_DIR}/release)
# debug和release版本目录不一样
#设置生成的so动态库最后输出的路径
SET(LIBRARY_OUTPUT_PATH ${RELEASE_DIR})
ADD_COMPILE_OPTIONS(-fPIC)
# 查找当前目录下的所有源文件
# 并将名称保存到 DIR_LIB_SRCS 变量
# AUX_SOURCE_DIRECTORY(. DIR_LIB_SRCS)
# 默认生成静态库链接库Dir1
#ADD_LIBRARY (Dir1 ${DIR_LIB_SRCS})
# SHARED生成动态库
# ADD_LIBRARY (Test SHARED  ${DIR_LIB_SRCS})
ADD_LIBRARY (Test3 SHARED  test.h test.cpp plugin.h)
target_link_libraries(Test3 dl liborocos-log4cpp.so pthread)

plugin.conf(用于配置log4cpp)

log4cpp.rootCategory=DEBUG, root
log4cpp.rootCategory.Mgr=, pluginMgr
log4cpp.appender.root=org.apache.log4cpp.ConsoleAppender
log4cpp.appender.root.layout=org.apache.log4cpp.PatternLayout
log4cpp.appender.root.layout.ConversionPattern=[%d{%Y-%m-%d %H:%M:%S.%l} - %p] (%c): %m%n
log4cpp.appender.Mgr=org.apache.log4cpp.ConsoleAppender
log4cpp.appender.Mgr.layout=org.apache.log4cpp.PatternLayout

plugin.h

//plugin.h
#ifndef __PLUGIN_H__
#define __PLUGIN_H__
#include<memory>
#include<string>
#include<iostream>
#include<list>
using namespace std;
class IPlugin
{
public:
  IPlugin() = default;
  virtual ~IPlugin() = default;
  IPlugin(const IPlugin&) = delete;
  IPlugin& operator=(const IPlugin&) = delete;
public:
   //获取支持的插件方法
  virtual const list<string>& getSupportCommandList() const {return supportCommandList_; }

public:
  virtual string getVersionString() const = 0;
  //! \brief 获取业务名称
  //! \return
  virtual string getPluginName() const = 0;
 
  enum pluginState_type
  {
    idle_,
    starting_,
    started_,
    stopping_,
    stopped_,
    excepting_,
  };
  //! 获取插件的运行状态。
  //! \return
  virtual pluginState_type getPluginState() const = 0;
  //! 获取插件的运行状态的解释
  //! \param state
  //! \return
  static string getPluginStateMessage(const pluginState_type& state)
  {
    string msg = "no msg.";
    switch (state)
    {
      case pluginState_type::idle_:
        msg = "plugin is on idle statement.";
        break;
      case pluginState_type::starting_:
        msg = "plugin is on starting statement.";
        break;
      case pluginState_type::started_:
        msg = "plugin is on started statement.";
        break;
      case pluginState_type::stopping_:
        msg = "plugin is on stopping statement.";
        break;
      case pluginState_type::stopped_:
        msg = "plugin is on stopped statement.";
        break;
      case pluginState_type::excepting_:
        msg = "plugin is on excepting statement.";
        break;
    }
    return msg;
  }
  //! \brief 执行业务的主要接口方法
  //! \param msg 由外部程序发送的通讯协议（比如json报文）
  //! \return 错误信息
  virtual void exec(const string& msg) = 0;
  //! \brief 业务停止运行
  //! \return
  virtual void stop() { return ; }
  //! \brief 释放动态库资源
  //! \return 错误信息
  virtual void release() = 0;
protected:
  list<string> supportCommandList_;
};

#endif

test.h

//test.h
#ifndef __TRIANGLE_H__
#define __TRIANGLE_H__

#include "plugin.h"
#include "log4cpp/Category.hh"
#include "log4cpp/PropertyConfigurator.hh"
#include "log4cpp/NDC.hh"
#include <iostream>

class Test3 : public IPlugin
{ 
public:
  Test3();
  virtual string getVersionString() const;
  //! \brief 获取业务名称
  //! \return
  virtual string getPluginName() const;
public:
  //! 获取插件的运行状态。
  //! \return
  virtual pluginState_type getPluginState() const;
  //! \brief 执行业务的主要接口方法
  //! \param msg 由外部程序发送的通讯协议（比如json报文）
  //! \return 错误信息
  virtual void exec(const string& msg);
  //! \brief 业务停止运行
  //! \return
  virtual void stop();
  //! \brief 释放动态库资源
  //! \return 错误信息
  virtual void release();
protected:
  list<string> supportCommandList_;
  log4cpp::Category *m_log;;
};

#endif /* __TRIANGLE_H__ */

test.cpp

//test.cpp
#include "test.h"
extern "C"
{
    void * getInstance()
    {
        return new Test3;
    }
}
Test3::Test3()
{
  try
  {
    log4cpp::PropertyConfigurator::configure("../plugin.conf");
  }
  catch (log4cpp::ConfigureFailure &f)
  {
      std::cout << "Configure Problem " << f.what() << std::endl;
      exit(1);
  }
  m_log = &log4cpp::Category::getInstance(std::string("Test3"));
}
Test3::pluginState_type Test3::getPluginState() const
{
    return Test3::starting_;
}
string Test3::getVersionString() const
{
    return "3.0";
}
string Test3::getPluginName() const
{
    return "Test3";
}
void Test3::exec(const string& msg)
{
    m_log->debug("execute command %s",msg.c_str());
}
void Test3::stop() 
{ 
    m_log->debug("program stop");
}
void Test3::release()
{
    m_log->debug("release plugram");
}

编译后即可在…/release中生成libTest3.so共享库。

插件系统具体实现

项目整体
cmakelists

cmake_minimum_required(VERSION 3.5)
project(plugin LANGUAGES CXX)
set(CMAKE_CXX_STANDARD 11)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11 -W -Wall -Wextra -g")
include_directories(
    /usr/local/include/orocos/
    /usr/local/include/
    /usr/include
)
include_directories(${CMAKE_CURRENT_SOURCE_DIR})
LINK_DIRECTORIES(${CMAKE_CURRENT_SOURCE_DIR})
add_executable(plugin main.cpp plugin.h pluginMgr.cpp pluginMgr.h)
target_link_libraries(plugin dl liborocos-log4cpp.so pthread)

plugin.config

log4cpp.rootCategory=DEBUG, root
log4cpp.rootCategory.Mgr=, pluginMgr

log4cpp.appender.root=org.apache.log4cpp.ConsoleAppender
log4cpp.appender.root.layout=org.apache.log4cpp.PatternLayout
log4cpp.appender.root.layout.ConversionPattern=[%d{%Y-%m-%d %H:%M:%S.%l} - %p] (%c): %m%n

log4cpp.appender.Mgr=org.apache.log4cpp.ConsoleAppender
log4cpp.appender.Mgr.layout=org.apache.log4cpp.PatternLayout

pluginMgr.h

//pluginMgr.h
#ifndef __PLUGINMGR_H__
#define __PLUGINMGR_H__

#include <unordered_map>
#include<string>
#include <dirent.h>
#include <dlfcn.h>
#include"plugin.h" 
#include "log4cpp/Category.hh"
#include "log4cpp/PropertyConfigurator.hh"
#include "log4cpp/NDC.hh"

#define workPath "../lib/"
#define MIN_FILE_LENGTH   3
#define LOGGING_ERROR     printf
#define LOGGING_WARN      printf
#define LOGGING_DEBUG     printf
#define PROJECT_NAME "PluginTest"
#define PROJECT_VERSION "1.0"

class  PluginManager 
{
private:
  PluginManager();
public:
  static PluginManager& getInstance();
  ~PluginManager();
  static const char* getLibraryName();
  static const char* getLibraryVersion();
public:
  void loadAll();
  void unloadAll();
  bool isloadedFromPath(string soFileName);
  bool loadFromPath(const string& libPath);
  void *resolve(void *handle,string className);
  bool unloadFromPath(const string& name);
  list<string> getNames() const ;
  IPlugin* get(const string& name);
private:
  unordered_map<string, IPlugin*> m_plugins;
  unordered_map<string, pair<string,void *>> m_libs;
  log4cpp::Category *m_log;
};
#endif

pluginMgr.cpp

//pluginMgr.cpp
#include"pluginMgr.h"

typedef void *(*instance)();


PluginManager::PluginManager()
{
  try
  {
    log4cpp::PropertyConfigurator::configure("../plugin.conf");
  }
  catch (log4cpp::ConfigureFailure &f)
  {
      std::cout << "Configure Problem " << f.what() << std::endl;
      exit(1);
  }
  m_log = &log4cpp::Category::getInstance(std::string("pluginMgr"));
}
PluginManager &PluginManager::getInstance()
{
  static PluginManager w;
  return w;
}

PluginManager::~PluginManager()
{
  unloadAll();
}
void PluginManager::loadAll()
{
  struct dirent *entry;
  DIR *dp;
  
  dp = opendir(workPath);
  if (dp == NULL) {
    m_log->error("opendir error,work path : %s\n",workPath);
    return ;
  }
  
  while((entry = readdir(dp)))
  {
    string files = entry->d_name;
    if(files.length() > MIN_FILE_LENGTH && files.substr(files.length()-3,3) == ".so")
    {
      string libPath = workPath+files;
      if(isloadedFromPath(libPath))
      {
        m_log->warn("%s had been loaded before.", libPath.c_str());
        continue;
      }
      loadFromPath(libPath);
    }
  }
  closedir(dp);
}
void PluginManager::unloadAll()
{
  for(auto iter = m_plugins.begin();iter!=m_plugins.end();iter++)
  {
    iter->second->release();
  } 
  for(auto iter = m_libs.begin();iter!=m_libs.end();iter++)
  {
    m_log->debug(iter->first.c_str()); 
    pair<string,void*>plugin = iter->second;
    void *handle = plugin.second;
    dlclose(handle);
  }
  m_plugins.clear();
  m_libs.clear();
  m_log->debug("%s unloaded all",PROJECT_NAME);
}


bool PluginManager::loadFromPath(const string& libPath)
{
  void *handle = dlopen(libPath.c_str(), RTLD_LAZY);
  if(handle)
  {
    instance getPluginInstance = (instance)resolve(handle,"getInstance");
    if(getPluginInstance)
    {
      auto plugin = (IPlugin *)getPluginInstance();
      if(plugin)
      {
        auto pluginName = plugin->getPluginName();
        if (m_plugins.count(pluginName))
        {
          m_log->warn("%s repeated loading.", pluginName.c_str());
          unloadFromPath(libPath);
          return false;
        }
        m_plugins[pluginName] =  plugin;
        m_libs[libPath] = pair<string,void *>(pluginName,handle);
        m_log->debug("load plugin name : %s , version: %s", plugin->getPluginName().c_str(),
                    plugin->getVersionString().c_str());
      }
      else
      {
        m_log->error("%s object create failed.", libPath.c_str());
        unloadFromPath(libPath);
        return false;
      }
    }
    else
    {
      m_log->error("%s cannot find symbol.", libPath.c_str());
      unloadFromPath(libPath);
      return false;
    }
  }
  else
  {
     m_log->error("%s load failed.",libPath.c_str());
    return false;
  }
  return true;
}

void* PluginManager::resolve(void *handle,string className)
{
  return dlsym(handle, className.c_str());
}

bool PluginManager::isloadedFromPath(string soFileName)
{
  auto iter = m_libs.find(soFileName);
  if(iter==m_libs.end()) return false;
  return true;
}

bool PluginManager::unloadFromPath(const string& name)
{

  pair<string,void *> plugin  = m_libs[name];
  void *handle = plugin.second;
  string pluginName = plugin.first;
  IPlugin *temp = m_plugins[pluginName];
  if(!handle || !temp)
  {
    m_log->error("%s : unload errer !,dont have handle.",name.c_str());
    return false;
  }
  temp->release();
  dlclose(handle);
  for(auto iter = m_plugins.begin();iter!=m_plugins.end();iter++)
  {
      if(iter->first == pluginName)
      {
          m_plugins.erase(iter);
      }
  }
  for(auto iter = m_libs.begin();iter!=m_libs.end();iter++)
  {
      if(iter->first == name)
      {
          m_libs.erase(iter);
      }
  }
  m_log->debug("%s  unload successfully . ",name.c_str());
  return true;
}

IPlugin *PluginManager::get(const string &name)
{
  if (m_plugins.find(name)!=m_plugins.end())
  {
    m_log->debug("%s get successfully.", name.c_str());
    return m_plugins[name];
  }
 
  m_log->error("%s is not found.", name.c_str());
  return nullptr;
}
list<string> PluginManager::getNames() const 
{
  list<string> res;
  for(auto iter = m_plugins.begin();iter!=m_plugins.end();iter++)
  {
    res.push_back(iter->first);
  }
  return res;
}
const char *PluginManager::getLibraryName()
{
  return PROJECT_NAME;
}
const char *PluginManager::getLibraryVersion()
{
  return PROJECT_VERSION;
}

plugin.h

//plugin.h
#ifndef __PLUGIN_H__
#define __PLUGIN_H__

#include<memory>
#include<string>
#include<iostream>
#include<list>
using namespace std;


#ifndef SERVICEPROJECT_IPLUGIN_H
#define SERVICEPROJECT_IPLUGIN_H

 
class IPlugin
{
public:
  IPlugin() = default;
  virtual ~IPlugin() = default;
 
  IPlugin(const IPlugin&) = delete;
  IPlugin& operator=(const IPlugin&) = delete;
 
public:
   //获取支持的插件方法
  virtual const list<string>& getSupportCommandList() const {return supportCommandList_; }
 
 
public:
  virtual string getVersionString() const = 0;
  //! \brief 获取业务名称
  //! \return
  virtual string getPluginName() const = 0;
 
  enum pluginState_type
  {
    idle_,
    starting_,
    started_,
    stopping_,
    stopped_,
    excepting_,
  };
  //! 获取插件的运行状态。
  //! \return
  virtual pluginState_type getPluginState() const = 0;
  //! 获取插件的运行状态的解释
  //! \param state
  //! \return
  static string getPluginStateMessage(const pluginState_type& state)
  {
    string msg = "no msg.";
    switch (state)
    {
      case pluginState_type::idle_:
        msg = "plugin is on idle statement.";
        break;
      case pluginState_type::starting_:
        msg = "plugin is on starting statement.";
        break;
      case pluginState_type::started_:
        msg = "plugin is on started statement.";
        break;
      case pluginState_type::stopping_:
        msg = "plugin is on stopping statement.";
        break;
      case pluginState_type::stopped_:
        msg = "plugin is on stopped statement.";
        break;
      case pluginState_type::excepting_:
        msg = "plugin is on excepting statement.";
        break;
    }
 
    return msg;
  }
 
  //! \brief 执行业务的主要接口方法
  //! \param msg 由外部程序发送的通讯协议（比如json报文）
  //! \return 错误信息
  virtual void exec(const string& msg) = 0;
  //! \brief 业务停止运行
  //! \return
  virtual void stop() { return ; }
  //! \brief 释放动态库资源
  //! \return 错误信息
  virtual void release() = 0;
protected:
  list<string> supportCommandList_;
};
#endif  // SERVICEPROJECT_IPLUGIN_H
#endif

main.cpp

//main.cpp
#include <iostream>
#include"plugin.h"
#include"pluginMgr.h"
#include <dirent.h>

using namespace std;

int main()
{
  PluginManager::getInstance().loadAll();

  IPlugin *plugin = PluginManager::getInstance().get("Test1");
  plugin->exec("Test1");
  plugin->stop();

  plugin = PluginManager::getInstance().get("Test2");
  plugin->exec("Test2");
  plugin->stop();

  plugin = PluginManager::getInstance().get("Test3");
  plugin->exec("Test3");
  plugin->stop();
  
  PluginManager::getInstance().unloadAll();

  PluginManager::getInstance().loadFromPath("../lib/libTest1.so");
  plugin = PluginManager::getInstance().get("Test1");
  plugin->exec("Test1");
  PluginManager::getInstance().unloadFromPath("../lib/libTest1.so");
}

程序运行截图
程序运行截图
可见插件系统正常运行。

Mr . 孤独患者
关注
  • 1
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
Linux系统Ubuntu vim安装plugin
OyingshuiO的博客
12-07 3477
plugin的安装： 1.按Ctrl+Alt+T进入命令行界面 首先安装vim sudo apt-get install vim （ubuntu） yum install vim （redHat/Fedora/CentOS） 一直按提示按Y即可。
linux下简易打字软件
10-04
linux下简易打字软件。用C语言编辑，带C语言源程序，在CENTOS7.8下用GCC编译生成easytype可执行文件。 软件的文件使用tar进行了打包。因此，先下载压缩文件easytype.tar.gz， 接着在某一个目录下使用如下命令进行解...
Linux简单插件框架
qq1337594525的博客
05-14 345
3. 列出所有插件时遍历plugin文件夹里的所有动态库so，先dlopen，然后dlsym查找help函数并执行。Linux插件的实现主要依赖运行时加载，程序在运行时控制加载指定的模块，并且可以在不需要该模块时将其卸载。2. 每个插件都是一个动态库so，都实现约定好的函数，例如run和help。2. dlsym：运行时加载的核心部分，可以通过这个函数找到所需要的符号。1. dlopen：用来打开一个动态库，并将其加载到进程的地址空间。3. dlclose：将一个已经加载的模块卸载。
linux进程插件,linux下C 插件(plugin)实现技术
weixin_39853843的博客
04-29 396
linux下C++ 插件(plugin)实现技术应用程序中使用插件技术，有利于日后的版本更新、维护(比如打补丁)和功能扩展，是一种很实用的技术。其最大的特点是更新插件时无需重新编译主程序，对于一个设计良好的应用系统而言，甚至可以做到业务功能的在线升级。本文介绍了linux下用C++实现插件的一个简单实例，希望能对大家有所启发。为了能做到更新插件时无需重新编译主程序，要求主程序中定义的接口是定死的，...
2024年Linux最全iTab插件谷歌浏览器安装、使用（程序员、开发、设计、摸鱼神器，吃一堑长一智
最新发布
m0_57539910的博客
05-08 1114
最近很多小伙伴找我要Linux学习资料，于是我翻箱倒柜，整理了一些优质资源，涵盖视频、电子书、PPT等共享给大家！
Linux系统中安装一些常用的插件备用
灰灰老师
03-29 583
4.下载新的CentOS-Base.repo 到/etc/yum.repos.d/# 安装了lrzsz以后可以通过rz命令打开上传命令，比较方便。1、备份CentOS-Base.repo。Linux系统中安装一些常用的插件备用。7.安装zip、unzip。为国内的阿里云源（选择）6.安装ipconfig。ip addr：查看ip。8.安装rz和sz命令。10.安装telnet。9.安装Tree命令。
定制你的Linux桌面环境 : 好用到爆的GNOME插件
m0_62721116的博客
12-26 2781
非常好用的GNOME插件
Linux操作系统shell脚本
09-04
（3）系统管理：shell 脚本可以用来实现系统管理任务 6. shell 脚本的优点和缺点： （1）优点：灵活、方便、易于维护 （2）缺点：安全性不高、debug 不方便 7. shell 脚本的实践经验： （1）细心仔细：在做每一...
Java编写的用于批量管理Linux服务器的简易系统源代码.zip
09-02
Java编写的用于批量管理Linux服务器的简易系统源代码.zip
基于ARM-linux实现的简易电子相册c源码+项目说明(课程设计)
01-20
基于ARM-linux的简易电子相册 开发平台: VScode Ubuntu16.04 S5P6818开发板 技术栈: C语言,文件IO,多线程,滑屏算法 实现原理: 将要播放的图片存储在二维数组中,在线程中循环读取图片的内容,并写入到开发板的屏幕...
课程设计基于Arm-Linux实现的可视化文件管理系统源码+项目说明
01-20
项目名称： 基于Arm-Linux的可视化文件管理系统 运行平台： Gec6818 功能描述： 本项目是一个简易的文件管理器，用户可管理开发平台上所有文件项目，并可进入文件夹查看文件夹下所有文件，可以批量复制、粘贴、...
linux下C++实现插件功能
12-11
编码工具：Qt5.8 实现功能：linux下实现插件库实现（调用动态so库）
虚拟linux的插件8继续
05-04
虚拟linux的一些插件<br>
iTab插件谷歌浏览器安装、使用（程序员、开发、设计、摸鱼神器）
qq_37776764的博客
04-09 7764
iTab，一个，安装之后，可以取代浏览器默认的标签页，效果如下。iTab 最大的特色在于，加入了 iOS 上的小组件的设计，让它在众多标签页美化插件中显得与众不同，而且拖动小组件可以重新调整小组件的位置。集成了各种各样的应用和链接，直接点击就可以打开，开发，设计，摸鱼神器。
CentOS下expect安装
chuanzhuanxian8669的博客
06-15 199
Expect是在Tcl基础上创建起来的，它还提供了一些Tcl所没有的命令，它可以用来做一些linux下无法做到交互的一些命令操作，在远程管 理方面发挥很大的作用。 spawn命令激活一个Unix程序来进行交互式的运行。　 send命令向进程发送字符串。 expect 命令等待进程的某些...
Linux：安装常用插件
程序员无羡的博客
07-05 227
Linux：安装常用插件
linux插件命令
krb___的博客
03-14 225
tee。
Linux常用插件
muruibin88的博客
01-30 1759
1、对比两个文件 sudo apt-get install meld ２、
Linux C++ 编写插件系统
chen1415886044的博客
09-22 905
插件系统只是在指定文件夹中搜索 .so，如果找到，则将内容添加到程序中。当然，因为程序实际上并不知道 .so动态库中的内容，所以通常的方法是让 .so 定义一个集合入口点并调用程序本身定义的函数，然后程序可以使用这些动态库提供的接口功能。我们在放把插件放在指定目录下（plugin），然后应用程序启动时候遍历目录找到插件，实现动态加载插件。将所有插件编译为so文件并放入当前工程目录下的plugin/Debug目录中，启动应用程序，插件自动被加载到程序中.
Linux系统邮件客户端开发毕业论文设计.doc
07-11
本篇论文主要探讨了在Linux系统下开发一个简易电子邮件客户端的重要性。随着互联网的普及，电子邮件已经成为日常生活和工作中不可或缺的沟通工具。然而，现有的电子邮件客户端软件通常功能繁复，难以适应嵌入式设备...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值