flutter與原生交互的具體實現

PlatformChannel功能簡介

PlatformChannel分爲BasicMessageChannel、MethodChannel以及EventChannel三種。其各自的主要用途以下：

• BasicMessageChannel: 用於傳遞數據。Flutter與原生項目的資源是不共享的，能夠經過BasicMessageChannel來獲取Native項目的圖標等資源。
• MethodChannel: 傳遞方法調用。Flutter主動調用Native的方法，並獲取相應的返回值。好比獲取系統電量，發起Toast等調用系統API，能夠經過這個來完成。
• EventChannel: 傳遞事件。這裏是Native將事件通知到Flutter。好比Flutter須要監聽網絡狀況，這時候MethodChannel就沒法勝任這個需求了。EventChannel能夠將Flutter的一個監聽交給Native，Native去作網絡廣播的監聽，當收到廣播後藉助EventChannel調用Flutter註冊的監聽，完成對Flutter的事件通知。

其實能夠看到，不管傳方法仍是傳事件，其本質上都是數據的傳遞，不過上層包的一些邏輯不一樣而已。

具體實現

BasicMessageChannel

初始直接在Native端發送消息, flutter是收不到的, 由於尚未執行接收監聽方法, 因此在Native端發送消息, 須要注意一下時機 flutter

static const messageChannel = const BasicMessageChannel('samples.flutter.io/message', StandardMessageCodec());

 static const messageChannel2 = const BasicMessageChannel('samples.flutter.io/message2', StandardMessageCodec());

 Future<String> sendMessage() async {
    String reply = await messageChannel.send('發送給Native端的數據');
    print('reply: $reply');
    return reply;
  }

  void receiveMessage() {
    messageChannel2.setMessageHandler((message) async {
      print('message: $message');
      return '返回Native端的數據';
    });
  }
  
   @override
  void initState() {
    // TODO: implement initState
    super.initState();
    receiveMessage();
    sendMessage();

  }
複製代碼

ios

// 初始化定義
FlutterBasicMessageChannel* messageChannel = [FlutterBasicMessageChannel messageChannelWithName:@"samples.flutter.io/message" binaryMessenger:controller];

// 接收消息監聽
[messageChannel setMessageHandler:^(id message, FlutterReply callback) {
    NSLog(message);
    callback(@"返回flutter端的數據");
}];




// 觸發事件執行

FlutterViewController* controller = (FlutterViewController*)self.window.rootViewController;
FlutterBasicMessageChannel* messageChannel2 = [FlutterBasicMessageChannel messageChannelWithName:@"samples.flutter.io/message2" binaryMessenger:controller];

// 發送消息
[messageChannel2 sendMessage:(@"發送給flutter的數據") reply:^(id reply) {
    NSLog(reply);
}];
複製代碼

android

BasicMessageChannel<Object> messageChannel = new BasicMessageChannel<Object>(getFlutterView(), "samples.flutter.io/message", StandardMessageCodec.INSTANCE);

// 接收消息監聽
messageChannel.setMessageHandler(new BasicMessageChannel.MessageHandler<Object>() {
    @Override
    public void onMessage(Object o, BasicMessageChannel.Reply<Object> reply) {
        System.out.println("onMessage: " + o);
        reply.reply("返回給flutter的數據");
    }
});



// 觸發事件執行

BasicMessageChannel<Object> messageChannel2 = new BasicMessageChannel<Object>(getFlutterView(), "samples.flutter.io/message2", StandardMessageCodec.INSTANCE);

// 發送消息
messageChannel2.send("發送給flutter的數據", new BasicMessageChannel.Reply<Object>() {
    @Override
    public void reply(Object o) {

        System.out.println("onReply: " + o);
    }
});
複製代碼

MethodChannel

flutter

static const platform = const MethodChannel('samples.flutter.io/battery');
 
 Future<Null> _getBatteryLevel() async {
    String batteryLevel;
    try {
      final int result = await platform.invokeMethod('getBatteryLevel');
      batteryLevel = 'Battery level at $result % .';
    } on PlatformException catch (e) {
      batteryLevel = "Failed to get battery level: '${e.message}'.";
    }

    setState(() {
      _batteryLevel = batteryLevel;
    });
  }
  
  // 執行_getBatteryLevel方法
複製代碼

ios

FlutterViewController* controller = (FlutterViewController*)self.window.rootViewController;
    
FlutterMethodChannel* batteryChannel = [FlutterMethodChannel
                                        methodChannelWithName:@"samples.flutter.io/battery"
                                        binaryMessenger:controller];



[batteryChannel setMethodCallHandler:^(FlutterMethodCall* call, FlutterResult result) {
    // TODO
    if ([@"getBatteryLevel" isEqualToString:call.method]) {
        int batteryLevel = [self getBatteryLevel];
        
        if (batteryLevel == -1) {

            result([FlutterError errorWithCode:@"UNAVAILABLE"
                                       message:@"Battery info unavailable"
                                       details:nil]);
        } else {
            result(@(batteryLevel));
        }
    } else {
        result(FlutterMethodNotImplemented);
    }
}];

- (int)getBatteryLevel {
    UIDevice* device = UIDevice.currentDevice;
    device.batteryMonitoringEnabled = YES;
    
    if (device.batteryState == UIDeviceBatteryStateUnknown) {
        return -1;
    } else {
        return (int)(device.batteryLevel * 100);
    }
}
複製代碼

android

new MethodChannel(getFlutterView(), CHANNEL).setMethodCallHandler(
    new MethodCallHandler() {
        @Override
        public void onMethodCall(MethodCall call, Result result) {
            // TODO
            if (call.method.equals("getBatteryLevel")) {
                int batteryLevel = getBatteryLevel();

                if (batteryLevel != -1) {
                    result.success(batteryLevel);
                } else {
                    result.error("UNAVAILABLE", "Battery level not available.", null);
                }
            } else {
                result.notImplemented();
            }
        }
    }
);


private int getBatteryLevel() {
    int batteryLevel = -1;
    if (VERSION.SDK_INT >= VERSION_CODES.LOLLIPOP) {
        BatteryManager batteryManager = (BatteryManager) getSystemService(BATTERY_SERVICE);
        batteryLevel = batteryManager.getIntProperty(BatteryManager.BATTERY_PROPERTY_CAPACITY);
    } else {
        Intent intent = new ContextWrapper(getApplicationContext()).
                registerReceiver(null, new IntentFilter(Intent.ACTION_BATTERY_CHANGED));
        batteryLevel = (intent.getIntExtra(BatteryManager.EXTRA_LEVEL, -1) * 100) /
                intent.getIntExtra(BatteryManager.EXTRA_SCALE, -1);
    }

    return batteryLevel;
}
複製代碼

FlutterEventChannel

flutter

static const EventChannel _eventChannel =
      const EventChannel('samples.flutter.io/test');

 void _onEvent(Object event) {
    print('返回的內容: $event');
  }

  void _onError(Object error) {
    print('返回的錯誤');
  }
  
  @override
  void initState() {
    // TODO: implement initState
    super.initState();
    // 監聽開始
    _eventChannel.receiveBroadcastStream().listen(_onEvent, onError: _onError);

  }
複製代碼

ios

FlutterViewController* controller = (FlutterViewController*)self.window.rootViewController;
    
FlutterEventChannel* eventChannel = [FlutterEventChannel eventChannelWithName:@"samples.flutter.io/test" binaryMessenger:controller];
[eventChannel setStreamHandler:self];


FlutterEventSink     eventSink;
// // 這個onListen是Flutter端開始監聽這個channel時的回調，第二個參數 EventSink是用來傳數據的載體。
- (FlutterError* _Nullable)onListenWithArguments:(id _Nullable)arguments
                                       eventSink:(FlutterEventSink)events {
    eventSink = events;
    // arguments flutter給native的參數
    // 回調給flutter， 建議使用實例指向，由於該block能夠使用屢次
    if (events) {
        events(@"主動發送通知到flutter");
    }

    // 監聽電池狀態
    [[NSNotificationCenter defaultCenter] addObserver:self
                                           selector:@selector(onBatteryStateDidChange:)
                                               name:UIDeviceBatteryStateDidChangeNotification
                                             object:nil];
    return nil;
}

/// flutter再也不接收
- (FlutterError* _Nullable)onCancelWithArguments:(id _Nullable)arguments {
    // arguments flutter給native的參數
    [[NSNotificationCenter defaultCenter] removeObserver:self];
    eventSink = nil;
    return nil;
}

- (void)onBatteryStateDidChange:(NSNotification*)notification {
    if (eventSink == nil) return;
    UIDeviceBatteryState state = [[UIDevice currentDevice] batteryState];
    switch (state) {
            case UIDeviceBatteryStateFull:
            case UIDeviceBatteryStateCharging:
            eventSink(@"charging");
            break;
            case UIDeviceBatteryStateUnplugged:
            eventSink(@"discharging");
            break;
        default:
            eventSink([FlutterError errorWithCode:@"UNAVAILABLE"
                                           message:@"Charging status unavailable"
                                           details:nil]);
            break;
    }
}
複製代碼

android

new EventChannel(getFlutterView(), CHANNEL2).setStreamHandler(
    new EventChannel.StreamHandler() {
        @Override
        public void onListen(Object o, EventChannel.EventSink eventSink) {
            this.eventSink = eventSink;

            handler.sendEmptyMessageDelayed(1, 1000);
        }

        @Override
        public void onCancel(Object o) {

        }

        private EventChannel.EventSink eventSink;
        private int count = 0;
        private Handler handler = new Handler() {
            @Override
            public void handleMessage(Message msg) {
                super.handleMessage(msg);
                eventSink.success((count++) + "主動發送消息給flutter");
//              handler.sendEmptyMessageDelayed(1,1000);
            }
        };

    }
);
複製代碼

源碼

github: github.com/shimuhui/fl…