Flutter 本地plugin开发

基于Flutter Version:1.22.3, Dart Version:2.10.3

FlutterPlugin提供了Android和ios的底层封装,在Flutter层提供组件功能,使得Flutter可以比较方便得调用Native得模块,对于Flutter实现比较复杂或者基于平台不能完成得部分,都可以封装成Plugin。
本文都是android得样例。

Flutter调用android原生实现,封装成Plugin

基本流程

  • Flutter端声明MethodChannel,并通过invokeMethod函数调用native的函数
  • Android声明Plugin,创建与Flutter端对应的MethodChannel,对Flutter端声明的函数进行监听,并进行相应的处理
  • 在Plugin机制中绑定两者的关系。
    此处以调用Android原生的日志为例进行讲解
1.Flutter端声明一个log_util.dart文件
import 'package:flutter/cupertino.dart';
import 'package:flutter/services.dart';

class LogUtils {

  ///声明的通道名称
  static const String _channelName = 'flutter.io/system/log';
  
  ///判断是否是debug环境
  static bool get _isDebug => !bool.fromEnvironment("dart.vm.product");

  ///创建渠道对象
  static const _channel = const MethodChannel(_channelName);

  ///通过命名函数来实现类似java中重载机制
  static void v({@required String message, String tag}) {
    if (_isDebug) {
      ///调用函数来执行,
      ///invokeMethod参数
      ///[String method]:指定方法名,Android端需要监听并做处理的
      ///[dynamic arguments]:需要传递给Android端的参数
      _channel.invokeMethod('logV', {'tag': tag ?? '', 'message': message ?? ''});
    }
  }

  static void d({@required String message, String tag}) {
    if (_isDebug) {
      _channel.invokeMethod('logD', {'tag': tag ?? '', 'message': message ?? ''});
    }
  }

  static void i({@required String message, String tag}) {
    if (_isDebug) {
      _channel.invokeMethod('logI', {'tag': tag ?? '', 'message': message ?? ''});
    }
  }

  static void w({@required String message, String tag}) {
    if (_isDebug) {
      _channel.invokeMethod('logW', {'tag': tag ?? '', 'message': message ?? ''});
    }
  }

  static void e({@required String message, String tag}) {
    if (_isDebug) {
      _channel.invokeMethod('logE', {'tag': tag ?? '', 'message': message ?? ''});
    }
  }
}

2.Android端plugin的编写

在android端的项目中有一个目录如下,


image.png
package io.flutter.plugins;

import android.content.Context;
import android.util.Log;
import androidx.annotation.NonNull;
import io.flutter.embedding.engine.plugins.FlutterPlugin;
import io.flutter.plugin.common.MethodCall;
import io.flutter.plugin.common.MethodChannel;

/**
 * 打印日志plugin
 */
public class LogPlugin implements FlutterPlugin , MethodChannel.MethodCallHandler{
    
    private static final String mChannelName = "flutter.io/system/log";//与Flutter端对应的通道名称

    private static final String LOG_V = "logV";
    private static final String LOG_D = "logD";
    private static final String LOG_I = "logI";
    private static final String LOG_W = "logW";
    private static final String LOG_E = "logE";

    private MethodChannel mMethodChannel;

    private Context mApplicationContext;

    /**
     * 当plugin与FlutterEngine相关联时调用
     * @param binding
     */
    @Override
    public void onAttachedToEngine(@NonNull FlutterPluginBinding binding) {
        
        //获取上下文对象,可以发起跳转Activity等操作
        mApplicationContext = binding.getApplicationContext();
        
        //创建通道对象
        mMethodChannel = new MethodChannel(binding.getBinaryMessenger(),mChannelName);
        
        //添加对Flutter端调用函数的监听
        mMethodChannel.setMethodCallHandler(this);

    }

    /**
     * 当plugin与FlutterEngine解除关联时调用,用来清除资源等。
     * @param binding
     */
    @Override
    public void onDetachedFromEngine(@NonNull FlutterPluginBinding binding) {

        mApplicationContext = null;

        mMethodChannel.setMethodCallHandler(null);

        mMethodChannel = null;
    }

    /**
     * 对Flutter端调用函数的监听
     * @param call
     * @param result
     */
    @Override
    public void onMethodCall(@NonNull MethodCall call, @NonNull MethodChannel.Result result) {
        
        //获取传递过来的参数
        String tag = call.argument("tag");
        String message = call.argument("message");

        if (TextUtils.isEmpty(message)) return;
        
        if (TextUtils.isEmpty(tag)) tag = "Log";


        //获取Flutter端调用的函数名称
        String method = call.method;
        switch (method){
            case LOG_V:
                Log.v(tag,message);
                break;
            case LOG_D:
                Log.d(tag,message);
                break;
            case LOG_I:
                Log.i(tag,message);
                break;
            case LOG_W:
                Log.w(tag,message);
                break;
            case LOG_E:
                Log.e(tag,message);
                break;
        }
    }
}

3.在FlutterEngine的plugin中添加LogPlugin建立关联
package com.example.flutter_first;

import androidx.annotation.NonNull;
import io.flutter.embedding.android.FlutterActivity;
import io.flutter.embedding.engine.FlutterEngine;
import io.flutter.plugins.LogPlugin;

public class MainActivity extends FlutterActivity {


    @Override
    public void configureFlutterEngine(@NonNull FlutterEngine flutterEngine) {
        super.configureFlutterEngine(flutterEngine);
        flutterEngine.getPlugins().add(new LogPlugin());
    }

}

调用如下:


image.png
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,843评论 6 502
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,538评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 163,187评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,264评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,289评论 6 390
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,231评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,116评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,945评论 0 275
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,367评论 1 313
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,581评论 2 333
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,754评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,458评论 5 344
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,068评论 3 327
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,692评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,842评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,797评论 2 369
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,654评论 2 354

推荐阅读更多精彩内容