Flutter消息通信插件irondash_message_channel的使用

Flutter消息通信插件irondash_message_channel的使用

irondash_message_channel

Rust-dart桥接类似于Flutter的平台通道。

此包允许通过模式调用Dart代码和反之亦然，类似于Flutter的平台通道。

• 简单易用的API（Dart侧模仿平台通道API）。
• 高性能
  • 调用Dart时零拷贝二进制数据
  • 调用Rust时仅拷贝一次二进制数据
• Rust宏自动序列化和反序列化（类似Serde但优化为零拷贝）
• 无需代码生成
• 线程亲和性 - Rust通道对应于创建通道时绑定的线程。您可以在运行RunLoop的平台上线程或任何后台线程上创建通道，只要该线程在运行即可。
• 最终处理程序 - Rust侧可以获取当Dart对象被垃圾回收时的通知。
• 异步支持

使用

初始设置

因为Rust代码需要访问Dart FFI API，所以需要一些设置。

/// 初始化Native库上下文。
MessageChannelContext _initNativeContext() {
    final dylib = defaultTargetPlatform == TargetPlatform.android
        ? DynamicLibrary.open("libmyexample.so")
        : (defaultTargetPlatform == TargetPlatform.windows
            ? DynamicLibrary.open("myexample.dll")
            : DynamicLibrary.process());

    // 这个函数将由MessageChannel调用以提供FFI初始化数据。从这里你应该调用`irondash_init_message_channel_context`并进行其他初始化，例如注册Rust方法通道处理器。
    final function =
        dylib.lookup<NativeFunction<MessageChannelContextInitFunction>>(function);
    return MessageChannelContext.forInitFunction(function);
}

final nativeContext = _initNativeContext();

// 现在可以创建方法通道了

final _channel =
    NativeMethodChannel('my_method_channel', context: nativeContext);

_channel.setMethodCallHandler(...);

Rust侧

use irondash_message_channel::*;

#[no_mangle]
pub extern "C" fn my_example_init_message_channel_context(data: *mut c_void) -> FunctionResult {
    irondash_init_message_channel_context(data)
}

简单使用

在完成设置后，您可以使用Dart的NativeMethodChannel，类似于Flutter的PlatformChannel：

final _channel = NativeMethodChannel('my_method_channel', context: nativeContext);

_channel.setMessageHandler((call) async {
    if (call.method == 'myMethod') {
        return 'myResult';
    }
    return null;
});

final res = await _channel.invokeMethod('someMethod', 'someArg');

在Rust侧，您可以实现MethodHandler trait用于非异步版本，或者AsyncMethodHandler如果想要使用async/await：

use irondash_message_channel::*;

struct MyHandler {}

impl MethodHandler for MyHandler {
    fn on_method_call(&self, call: MethodCall, reply: MethodCallReply) {
        match call.method.as_str() {
            "getMeaningOfUniverse" => {
                reply.send_ok(42);
            }
            _ => reply.send_error(
                "invalid_method".into(),
                Some(format!("Unknown Method: {}", call.method)),
                Value::Null,
            ),
        }
    }
}

fn init() {
    let handler = MyHandler {}.register("my_method_channel");
    // 确保handler不被释放，否则无法处理方法调用。
}

异步版本：

use irondash_message_channel::*;

struct MyHandler {}

#[async_trait(?Send)]
impl AsyncMethodHandler for MyHandler {
    async fn on_method_call(&self, call: MethodCall) -> PlatformResult {
        match call.method.as_str() {
            "getMeaningOfUniverse" => {
                Ok(42.into())
            }
            _ => Err(PlatformError {
                code: "invalid_method".into(),
                message: Some(format!("Unknown Method: {}", call.method)),
                detail: Value::Null,
            })
        }
    }
}

fn init() {
    let handler = MyHandler {}.register("my_method_channel");
    // 确保handler不被释放，否则无法处理方法调用。
}

调用Dart从Rust

use irondash_message_channel::*;

struct MyHandler {
    invoker: Late<AsyncMethodInvoker>,
}

#[async_trait(?Send)]
impl AsyncMethodHandler for MyHandler {
    // 这将在方法通道注册后立即调用。你可以使用invoker来调用Dart方法处理器。
    fn assign_invoker(&self, invoker: AsyncMethodInvoker) {
        self.invoker.set(invoker);
    }

    // ...
}

请注意，要使用Invoker，您需要知道目标isolateId。您可以在在Rust中处理方法调用时从MethodCall结构中获取它。您还可以在隔离销毁时收到通知：

impl MethodHandler for MyHandler {
    /// 当隔离即将销毁时调用。
    fn on_isolate_destroyed(&self, isolate: IsolateId) {}
    // ...
}

要查看消息通道的效果，请参阅https://github.com/irondash/irondash/message_channel/dart/example。

线程考虑

MethodHandler和AsyncMethodHandler绑定到创建它们的线程。该线程必须运行一个RunLoop。这是隐含地对平台线程成立。为了在背景线程上使用通道，您需要创建一个RunLoop并自己运行它。

MethodInvoker是Send。它可以跨线程传递，并且响应方法调用将在发送请求的相同线程接收。再次，该线程必须运行一个RunLoop。

从Value到Value和从Value到Value的转换

Value表示所有可以在Rust和D Dart之间发送的数据类型。为了简化Rust侧的序列化和反序列化，irondash_message_channel提供了IntoValue和TryFromValue proc macros，这些宏生成TryInto<YourStruct>和From<YourStruct> traits。这是可选功能：

[dependencies]
irondash_message_channel = { version = "0.6.0", features = ["derive"] }

#[derive(TryFromValue, IntoValue)]
struct AdditionRequest {
    a: f64,
    b: f64,
}

#[derive(IntoValue)]
struct AdditionResponse {
    result: f64,
    request: AdditionRequest,
}

let value: Value = get_value_from_somewhere();
let request: AdditionRequest = value.try_into()?;
let response: Value = AdditionResponse {
    result: request.a + request.b,
    request,
}.into();

更高级的映射选项也受到支持，例如：

#[derive(IntoValue, TryFromValue)]
#[irondash(tag = "t", content = "c")]
#[irondash(rename_all = "UPPERCASE")]
enum Enum3CustomTagContent {
    Abc,
    #[irondash(rename = "_Def")]
    Def,
    SingleValue(i64),
    #[irondash(rename = "_DoubleValue")]
    DoubleValue(f64, f64),
    Xyz {
        x: i64,
        s: String,
        z1: Option<i64>,
        #[irondash(skip_if_empty)]
        z2: Option<i64>,
        z3: Option<f64>,
    },
}