Flutter与原生通信浅析

一个demo胜千言:demo

一、概述

我们知道flutter无法调用系统相机、麦克风、定位、手机版本信息等，有一些成熟好用的SDK可能flutter还不支持，那么这时候我们就可以使用与原生通信的方式来解决了。
Flutter与Native原生通信有三种方式：
* $\color{CadetBlue}{MethodChannel}$
* $\color{CadetBlue}{BasicMessageChannel}$
* $\color{CadetBlue}{EventChannel}$

那么问题来了，这三种方式有什么区别呢？我们该怎么去选择使用呢？

二、三种通信方式介绍

1、 $\color{CadetBlue}{MethodChannel}$

Flutter与Native端相互调用，调用后返回结果

Native端需要在主线程中执行

属于双向通信

2、 $\color{CadetBlue}{BasicMessageChannel}$

属于使用指定的编解码器对消息进行编码和解码

用于传递字符串和半结构化信息，这个用的比较少

属于双向通信

3、 $\color{CadetBlue}{EventChannel}$

用于数据流（event stream）的通信，Native端主动发送数据给Flutter

通常用于状态监听，比如网络变化，传感器数据等等

三种 Channel 之间互相独立，各有用途，但它们在设计上却非常相近。每种 Channel 均有三个重要成员变量：
name: String类型，代表 Channel 的名字，也是其唯一标识符
messager：BinaryMessenger 类型，代表消息信使，是消息的发送与接收的工具
codec: MessageCodec 类型或 MethodCodec 类型，代表消息的编解码器

下面是官方架构图

官方加构图

先说一下Flutter项目与原生的通行，这里会说iOS、安卓两种情况

创建一个Flutter项目1

创建一个Flutter项目2

通过上面的操作创建一个Flutter项目，在项目中添加一个Plugin文件夹，方便后续插件加入到里面，接着我们创建一个Plugin插件，如图：

插件的创建配置

上图中的Project location需要选择我们之前创建的Plugin文件夹。

接下来我们编写获取设备信息的代码，
在Plugin/device_info/lib/device_info.dart中编写如下代码

import 'dart:async';
import 'package:flutter/services.dart';
import 'device_info_platform_interface.dart';
class DeviceInfo {
  Future<String?> getPlatformVersion() {
    return DeviceInfoPlatform.instance.getPlatformVersion();
  }

  static const MethodChannel _channel = MethodChannel('device_info');

  static Future<String> get systemVersion async {
    final String version = await _channel.invokeMethod('getSystemVersion');
    return version;
  }

  static Future<String> get batteryLevel async {
    final String version = await _channel.invokeMethod('getBatteryLevel');
    return version;
  }
}

MethodChannel是和原生建立的方法通道, 通过MethodChannel和原生相互通信, invokeMethod

编写iOS代码

找到plugin/device_info/ios/Classes/DeviceinfoPlugin.m文件
文件中已经有了getPlatformVersion方法的判断处理，我们只需要在这基础上添加自己需要编写的方法判断，我这里写的getSystemVersion和getBatteryLevel,这里和device_info.dart中的方法名是一致的，dart调用，iOS执行并返回结果。

- (void)handleMethodCall:(FlutterMethodCall*)call result:(FlutterResult)result {
  if ([@"getPlatformVersion" isEqualToString:call.method]) {
    result([@"iOS " stringByAppendingString:[[UIDevice currentDevice] systemVersion]]);
  } else if ([@"getSystemVersion" isEqualToString:call.method]) {
    float level = [[UIDevice currentDevice] batteryLevel];
    result([NSString stringWithFormat:@"%f", level]);
  } else if ([@"getBatteryLevel" isEqualToString:call.method]) {
      result([[UIDevice currentDevice] systemVersion]);
  } else {
    result(FlutterMethodNotImplemented);
  }
}

编写Android代码

找到plugin/device_info/android/src/main/java/com/example/deviceinfo/DeviceinfoPlugin.java文件，下面是已经添加getSystemVersion和getBatteryLevel方法的代码

 @Override
  public void onMethodCall(@NonNull MethodCall call, @NonNull Result result) {
    if (call.method.equals("getPlatformVersion")) {
      result.success("Android " + android.os.Build.VERSION.RELEASE);
    } else if (call.method.equals("getSystemVersion")) {
      result.success(android.os.Build.VERSION.RELEASE);
    } else if (call.method.equals("getBatteryLevel")) {
      result.success("安卓电量待实现11");
    } else {
      result.notImplemented();
    }
  }

至此我们Native的代码已经完成了，接下来解释配置工作了

使用device_info插件

找到plugin中的pubspec.yaml文件，顶部配置 name: device_info,
这里的name和我们之前配置的plugin名称是一致的（device_info）
进入Flutter项目中的pubspec.yaml做一下device_info配置,这里不能用其他名字，需要跟plugin名称一致,在终端调用flutter pub get

dependencies:
  flutter:
    sdk: flutter
  device_info:
    path: plugin/device_info

做好路径配置之后，接下来就是编写调用代码了。

在Flutter项目中的的lib/mian.dart文件中编写如下代码
大体流程是
导入import 'package:deviceinfo/deviceinfo.dart';
调用String version = await Deviceinfo.systemVersion;

import 'package:flutter/material.dart';
import 'package:device_info/device_info.dart';
void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  // This widget is the root of your application.
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
        visualDensity: VisualDensity.adaptivePlatformDensity,
      ),
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key, required this.title}) : super(key: key);
  final String title;

  @override
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  String _systemVersion = '初始值';
  String _batteryLevel = '初始值';

  @override
  void initState() {
    initSysVersion();
    super.initState();
  }

  initSysVersion() async {
    String version = await DeviceInfo.systemVersion;
    String battery = await DeviceInfo.batteryLevel;
    print('version:$version,battery:$battery');
    setState(() {
      _systemVersion = version;
      _batteryLevel = battery;
    });
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            const Text(
              'You have pushed the button this many times:',
            ),
            Text(
             '系统版本： $_systemVersion',
              style: Theme.of(context).textTheme.headline4,
            ),
            Text(
              '手机电量：$_batteryLevel',
              style: Theme.of(context).textTheme.headline4,
            ),
          ],
        ),
      ),
    );
  }
}

效果图如下：

image.png

接下里我们再看一下原生项目这么调用flutter，等我有时间更新吧