Rust插件库helloworld-yliu使用指南

概述

helloworld-yliu是一个简单的Rust插件库，旨在帮助开发者快速入门Rust插件开发并实现基础功能。它提供了一个模板式的结构，让开发者可以在此基础上构建更复杂的插件系统。

安装

在项目的Cargo.toml中添加依赖：

[dependencies]
helloworld-yliu = "0.1.0"

基本使用方法

1. 导入库

use helloworld_yliu::{Plugin, PluginManager};

2. 创建自定义插件

struct MyPlugin;

impl Plugin for MyPlugin {
    fn name(&self) -> &str {
        "MyPlugin"
    }
    
    fn execute(&self) {
        println!("Hello from MyPlugin!");
    }
}

3. 使用插件管理器

fn main() {
    let mut manager = PluginManager::new();
    
    // 注册插件
    manager.register(Box::new(MyPlugin));
    
    // 执行所有插件
    manager.execute_all();
}

高级功能

插件配置

impl Plugin for MyPlugin {
    // ... 其他实现 ...
    
    fn configure(&mut self, config: &str) {
        println!("Received configuration: {}", config);
    }
}

// 使用时
manager.configure_plugin("MyPlugin", "some configuration data");

插件间通信

impl Plugin for MyPlugin {
    // ... 其他实现 ...
    
    fn receive_message(&mut self, message: &str) {
        println!("Received message: {}", message);
    }
}

// 发送消息
manager.send_message("MyPlugin", "Hello from main application!");

示例：完整插件系统

use helloworld_yliu::{Plugin, PluginManager};

struct GreeterPlugin;
struct LoggerPlugin;

impl Plugin for GreeterPlugin {
    fn name(&self) -> &str { "Greeter" }
    
    fn execute(&self) {
        println!("Greetings from GreeterPlugin!");
    }
}

impl Plugin for LoggerPlugin {
    fn name(&self) -> &str { "Logger" }
    
    fn execute(&self) {
        println!("Logging activity...");
    }
    
    fn configure(&mut self, config: &str) {
        println!("Logger configured with: {}", config);
    }
}

fn main() {
    let mut manager = PluginManager::new();
    
    manager.register(Box::new(GreeterPlugin));
    manager.register(Box::new(LoggerPlugin));
    
    manager.configure_plugin("Logger", "log_level=debug");
    
    manager.execute_all();
    
    manager.send_message("Logger", "Application is shutting down");
}

最佳实践

1. 为每个插件创建独立的模块
2. 使用特征对象(trait objects)来实现动态插件加载
3. 考虑使用Arc<Mutex<T>>来实现线程安全的插件共享状态
4. 为插件定义清晰的接口和版本控制

这个库适合作为学习Rust插件开发的起点，开发者可以在此基础上扩展更复杂的功能，如动态加载、插件依赖管理等。

完整示例demo

根据上述内容，这里提供一个更完整的示例代码，展示了如何使用helloworld-yliu库构建一个包含多个插件的系统：

// 导入必要的库
use helloworld_yliu::{Plugin, PluginManager};
use std::sync::{Arc, Mutex};

// 定义第一个插件：欢迎插件
struct GreeterPlugin {
    // 使用Arc<Mutex<T>>实现线程安全的状态共享
    greeting_count: Arc<Mutex<u32>>,
}

impl GreeterPlugin {
    fn new() -> Self {
        GreeterPlugin {
            greeting_count: Arc::new(Mutex::new(0)),
        }
    }
}

impl Plugin for GreeterPlugin {
    fn name(&self) -> &str {
        "Greeter"
    }
    
    fn execute(&self) {
        // 获取并修改共享状态
        let mut count = self.greeting_count.lock().unwrap();
        *count += 1;
        println!("Greetings from GreeterPlugin! (Called {} times)", count);
    }
    
    fn receive_message(&mut self, message: &str) {
        println!("Greeter received: {}", message);
    }
}

// 定义第二个插件：日志插件
struct LoggerPlugin {
    log_level: String,
}

impl LoggerPlugin {
    fn new() -> Self {
        LoggerPlugin {
            log_level: "info".to_string(),
        }
    }
}

impl Plugin for LoggerPlugin {
    fn name(&self) -> &str {
        "Logger"
    }
    
    fn execute(&self) {
        println!("[{}] Logging activity...", self.log_level.to_uppercase());
    }
    
    fn configure(&mut self, config: &str) {
        self.log_level = config.to_string();
        println!("Logger configuration updated to: {}", self.log_level);
    }
    
    fn receive_message(&mut self, message: &str) {
        println!("[{}] Received message: {}", self.log_level.to_uppercase(), message);
    }
}

fn main() {
    // 创建插件管理器
    let mut manager = PluginManager::new();
    
    // 初始化插件
    let greeter = GreeterPlugin::new();
    let logger = LoggerPlugin::new();
    
    // 注册插件
    manager.register(Box::new(greeter));
    manager.register(Box::new(logger));
    
    // 配置Logger插件
    manager.configure_plugin("Logger", "debug");
    
    // 执行所有插件
    manager.execute_all();
    
    // 发送消息给特定插件
    manager.send_message("Greeter", "This is a test message");
    manager.send_message("Logger", "Application is running");
    
    // 再次执行所有插件
    manager.execute_all();
    
    // 发送关闭消息
    manager.send_message("Logger", "Application is shutting down");
}

这个完整示例展示了：

1. 创建两个不同类型的插件(Greeter和Logger)
2. 使用Arc<Mutex<T>>实现线程安全的状态共享
3. 插件配置和插件间通信
4. 多次执行插件并观察状态变化
5. 完整的生命周期管理

开发者可以基于此示例进一步扩展，实现更复杂的插件系统功能。