Rust插件系统开发库extism-manifest的使用

extism-manifest是Extism项目的核心组件之一，它定义了插件系统的配置清单(manifest)类型，为Rust应用提供高效的跨语言插件支持和动态扩展能力。

安装

在项目目录中运行以下Cargo命令:

cargo add extism-manifest

或者在Cargo.toml中添加:

extism-manifest = "1.12.0"

使用示例

下面是一个完整的示例，展示如何使用extism-manifest创建插件配置并加载运行插件:

use extism_manifest::Manifest;
use extism::Plugin;
use std::collections::HashMap;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // 创建插件清单
    let mut manifest = Manifest::default();
    
    // 添加Wasm模块(可以是文件路径或URL)
    manifest.add_wasm_file("path/to/plugin.wasm")?;
    
    // 设置内存配置
    manifest.set_memory_max_pages(100);
    
    // 添加配置参数
    let mut config = HashMap::new();
    config.insert("API_KEY".to_string(), "your-api-key".to_string());
    manifest.set_config(config);
    
    // 创建并加载插件
    let plugin = Plugin::new(&manifest, [], true)?;
    
    // 调用插件函数
    let output = plugin.call("my_function", b"input data")?;
    println!("Plugin output: {:?}", output);
    
    Ok(())
}

完整示例代码

下面是一个更完整的示例，展示如何从多个来源加载Wasm插件并处理不同功能：

use extism_manifest::Manifest;
use extism::Plugin;
use std::collections::HashMap;
use std::path::Path;

// 定义插件管理器结构体
struct PluginManager {
    plugins: HashMap<String, Plugin>,
}

impl PluginManager {
    // 创建新的插件管理器
    fn new() -> Self {
        PluginManager {
            plugins: HashMap::new(),
        }
    }

    // 加载插件
    fn load_plugin(
        &mut self,
        name: &str,
        wasm_path: &str,
        config: Option<HashMap<String, String>>,
    ) -> Result<(), Box<dyn std::error::Error>> {
        // 创建manifest配置
        let mut manifest = Manifest::default();
        
        // 添加Wasm模块
        if Path::new(wasm_path).exists() {
            manifest.add_wasm_file(wasm_path)?;
        } else {
            manifest.add_wasm_url(wasm_path)?;
        }
        
        // 设置内存限制
        manifest.set_memory_max_pages(100);
        
        // 设置配置参数
        if let Some(cfg) = config {
            manifest.set_config(cfg);
        }
        
        // 创建插件实例
        let plugin = Plugin::new(&manifest, [], true)?;
        
        // 存储插件
        self.plugins.insert(name.to_string(), plugin);
        
        Ok(())
    }

    // 调用插件函数
    fn call_plugin(
        &self,
        plugin_name: &str,
        func_name: &str,
        input: &[u8],
    ) -> Result<Vec<u8>, Box<dyn std::error::Error>> {
        if let Some(plugin) = self.plugins.get(plugin_name) {
            let output = plugin.call(func_name, input)?;
            Ok(output.to_vec())
        } else {
            Err(format!("Plugin {} not found", plugin_name).into())
        }
    }
}

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // 创建插件管理器
    let mut manager = PluginManager::new();
    
    // 加载第一个插件(本地文件)
    let mut config1 = HashMap::new();
    config1.insert("DEBUG".to_string(), "true".to_string());
    manager.load_plugin("plugin1", "plugins/plugin1.wasm", Some(config1))?;
    
    // 加载第二个插件(远程URL)
    manager.load_plugin("plugin2", "https://example.com/plugins/plugin2.wasm", None)?;
    
    // 调用第一个插件的函数
    let result1 = manager.call_plugin("plugin1", "process_data", b"test data")?;
    println!("Plugin1 result: {:?}", String::from_utf8_lossy(&result1));
    
    // 调用第二个插件的函数
    let result2 = manager.call_plugin("plugin2", "transform", b"input")?;
    println!("Plugin2 result: {:?}", String::from_utf8_lossy(&result2));
    
    Ok(())
}

主要特性

1. 跨语言支持: 通过Wasm标准支持多种语言编写的插件
2. 动态扩展: 可以热加载和卸载插件而不需要重新编译主程序
3. 安全隔离: 插件运行在Wasm沙箱中，提供内存安全保证
4. 配置灵活: 通过manifest可以定制插件运行时的各种参数

许可证

extism-manifest采用BSD-3-Clause许可证发布。