Android与Flutter桥接指南

Flutter官方文档

这篇指南是针对Android开发者的,目的是让一个没有接触过Flutter的Android程序员快速开发出Flutter插件, 所以笔者默认各位读者已经有了JDK、SDK、Android Studio等开发环境和IDE。

Flutter环境搭建

1.下载Flutter SDK

Flutter SDK Archive

2.解压下载到的压缩包

解压路径如D:\env\flutter,不要解压到Program Files目录下,因为操作该目录需要更高的权限。

3.安装Flutter

进入flutter根目录,双击flutter_console.bat,等待flutter安装完成。

tips:

如果想要在一般的cmd中直接使用flutter commands,需要配置环境变量:
将你的flutter\bin路径添加到环境变量path
然后重新打开cmd,运行flutter help确认结果

4.确认Flutter环境

运行以下命令:

flutter doctor

一般输出如下:

C:\Users\wxj>flutter doctor
Doctor summary (to see all details, run flutter doctor -v):
[√] Flutter (Channel stable, v1.2.1, on Microsoft Windows [Version 6.1.7601],
    locale zh-CN)
[!] Android toolchain - develop for Android devices (Android SDK version 28.0.3)

    ! Some Android licenses not accepted.  To resolve this, run: flutter doctor
      --android-licenses
[!] Android Studio (version 2.3)
    X Flutter plugin not installed; this adds Flutter specific functionality.
    X Dart plugin not installed; this adds Dart specific functionality.
[!] Android Studio (version 3.2)
    X Flutter plugin not installed; this adds Flutter specific functionality.
    X Dart plugin not installed; this adds Dart specific functionality.
[!] Connected device
    ! No devices available

! Doctor found issues in 4 categories.

C:\Users\wxj>

可见检查出了4个问题,除了Android Studio没有安装flutter插件的提示外,其他没什么需要注意的。

5.Android Studio安装Flutter插件

  • 启动AS
  • 进入插件页面 (Preferences > Plugins on macOS, File > Settings > Plugins on Windows & Linux).
  • 选择Browse repositories, 搜索flutter,安装Flutter plugin
  • 安装完成后重启AS

测试Flutter开发环境

创建一个test工程,测试flutter开发环境。

  • 选择File > New Flutter Project
  • 选择Flutter application作为应用类型
  • Flutter SDK Path一栏指定你的flutter SDK安装路径
  • 输入项目名称,点击下一步
  • 等待AS创建工程
  • 运行main.dart(第一次运行需要较长时间的编译)

运行成功后设备上会看到如下页面

说明flutter开发环境已就绪。接下来就可以开发你的flutter插件了。

开发你的Flutter项目

在开始前,首先要确定你是要开发一个dart package还是一个plugin package,我们是要为既存的sdk开发一个flutter插件,所以是plugin package。

创建项目有两种方式:命令行 和 Android Studio/create flutter project,下面是命令行创建,你也可以通过Android Studio的UI创建,注意在创建时选对你要创建Dart package还是plugin package即可。

dart package

Dart package是通过 --template=package 创建的:

 flutter create --template=package hello

该命令会创建一个 hello/ 目录,其中包括:

  • lib/hello.dart:
    该包的Dart代码.
  • test/hello_test.dart:
    该包的单元测试代码.

plugin package

创建package

plugin package是通过 --template=plugin 创建的。

 flutter create --org com.example --template=plugin hello

上述命令会创建一个 hello/ 文件夹,其内容如下:

  • lib/hello.dart:
    你要实现的插件的dart api
  • android/src/main/java/com/example/​hello/HelloPlugin.java:
    插件api的安卓平台实现
  • ios/Classes/HelloPlugin.m:
    插件api的ios平台实现
  • example/:
    flutter的示例应用

默认使用OC和java,如果想使用swift或者kotlin,那么可以指定,ios用-i,android用-a:

flutter create --template=plugin -i swift -a kotlin hello

接下来就可以开发你的flutter plugin了,最后你可能会想要写一些文档,可以参考:
Adding documentation

发布到pub.dartlang.org

开发完成后你可以将你的插件发布到Pub site,方便用户使用。

在发布之前,先确认一下pubspec.yaml文件中关于plugin的设置是否正确:

# The following section is specific to Flutter.
flutter:
  # This section identifies this Flutter project as a plugin project.
  # The androidPackage and pluginClass identifiers should not ordinarily
  # be modified. They are used by the tooling to maintain consistency when
  # adding or updating assets for this project.
  plugin:
    androidPackage: cn.smssdk.flutter
    pluginClass: MobsmsPlugin

这里要指定正确的plugin的包名和类名,androidPackage只有android用得到,而pluginClass则是iOS和Android都要用到的,所以类名需要统一。这里的设置会上传到flutter服务器,当用户在线集成你的plugin时,flutter会根据这个设置自动帮用户生成下面这个类:

package io.flutter.plugins;

import io.flutter.plugin.common.PluginRegistry;
import cn.smssdk.flutter.MobsmsPlugin;

/**
 * Generated file. Do not edit.
 */
public final class GeneratedPluginRegistrant {
  public static void registerWith(PluginRegistry registry) {
    if (alreadyRegisteredWith(registry)) {
      return;
    }
    MobsmsPlugin.registerWith(registry.registrarFor("cn.smssdk.flutter.MobsmsPlugin"));
  }

  private static boolean alreadyRegisteredWith(PluginRegistry registry) {
    final String key = GeneratedPluginRegistrant.class.getCanonicalName();
    if (registry.hasPlugin(key)) {
      return true;
    }
    registry.registrarFor(key);
    return false;
  }
}

所以,如果之前没有指定正确的plugin包名和类名, 就会导致自动生成的代码中出现错误。

如果是在flutter项目下直接查看java代码,可能会提示import cn.smssdk.flutter.MobsmsPlugin找不到,无法使用相关类,不用在意,你可以"右键flutter项目 → Flutter → Open Android Module in Android Studio",直接打开flutter的安卓项目,AS会自动下载相关依赖(包括插件中的module),在该视图下编译就不会有报错了,并且这两边会自动同步,任意一边运行项目都会产生同一个flutter apk。

  1. 通过以下命令,验证项目没有问题:
flutter packages pub publish --dry-run
  1. 通过以下命令发布:
flutter packages pub publish

用户如何使用你的插件

以mobsms插件的集成为例。

1. dart代码集成

在 hello/pubspec.yaml 中添加以下代码:

dependencies:
  mobsms: ^0.0.3

在你项目的Dart中添加以下代码:

 import 'package:mobsms/mobsms.dart'

这样,就可以在你的main.dart中使用mobsms plugin中定义的dart api了。

2. 平台相关(android/ios)代码集成

Android

在 hello/android/build.gradle中添加:

android {
    // lines skipped
    dependencies {
        provided rootProject.findProject(":mobsms")
    }
}

这样就可以在你的hello/android/src下的类中import cn.smssdk.flutter.MobsmsPlugin并使用MobsmsPlugin中的api了。

Java代码仍然建议在Android视图下查看,不要在Flutter视图下查看。

iOS

hello/ios/hello.podspec中:

Pod::Spec.new do |s|
  # lines skipped
  s.dependency 'mob_smssdk'

这样就可以在你的hello/ios/Classes下的类中#import "MobsmsPlugin.h"并使用MobsmsPlugin中的api了。

更多信息可参考 Handling package interdependencies

Demo

如果你是要开发一个Plugin Package,可以参考 mobsms
SMSSDK-for-Flutter

如果你要开发一个Dart Package,需要集成第三方Plugin Package,可以参考:
sms_flutter_tester

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