[[319170]]

前言

大家好!今天給大家安利一個自認(rèn)為比較重磅的Flutter開源項目。

Flutter的產(chǎn)品定義是一個高性能的跨平臺的移動UI框架，能夠用一套代碼同時構(gòu)建出Android/iOS/Web/MacOS應(yīng)用。作為一套UI框架，它不具備一些系統(tǒng)的接口，自然還是避免不了跟原生打交道。于是乎，它提出了名為platform channel的東西，用于flutter和原生靈活的交換數(shù)據(jù)。以下為了描述方便，用Android代指原生。

燃鵝，燃鵝，燃鵝，它只支持一些基礎(chǔ)的數(shù)據(jù)類型和數(shù)據(jù)結(jié)構(gòu)的傳輸，例如bool/int/long/byte/char/String/byte[]/List/Map等。

因此，當(dāng)你想傳輸復(fù)雜點的數(shù)據(jù)，你只能包裝成Map，類似這樣：

await _channel.invokeMethod('initUser', 
    {'name': 'Oscar', 'age': 16, 'gender': 'MALE', 'country': 'China'}); 

然后再在Android層hard code，解析出不同的key對應(yīng)的不同數(shù)據(jù)。如果你是一個純fluter項目，且以后也沒有和原生打交道的打算，或者只是需要進(jìn)行簡單的交互，那這種做法也無可厚非。而當(dāng)你的項目已經(jīng)有很大的一部分原生代碼或者你需要使用第三方不支持flutter的lib庫的時候，就意味著你需要編寫大量向上面那樣的模板代碼?？梢娦实拖拢铱删S護(hù)性差。這時，你會想，能傳輸對象就好了!

而當(dāng)你想傳輸對象時：

[[319171]]

抱歉，沒門，只能給你一個尷尬又不是禮貌的危笑。當(dāng)然，也不是不可以，我們可以在原生上層把對象序列化成json對象，然后在flutter層再把json轉(zhuǎn)成flutter的對象，同樣效率很差。

FIDL是什么

學(xué)過Android的應(yīng)該都知道AIDL(Android Interface Defination Language)，即Android接口定義語言。Android中有一種高級的跨進(jìn)程通信方式——Binder，但是想要使用Binder需要了解一些Binder的機(jī)制和API，需要編寫大量的模板代碼。Android為了解決這個問題，嘗試把使用Binder的方法做的小白一點。于是定義了AIDL，告訴開發(fā)者，你的接口文件必須按照我規(guī)定的來寫，你要跨進(jìn)程傳輸?shù)膶ο蟊仨殞崿F(xiàn)Parcelable接口。然后，Android給你生成了一個Service.Stub類，偷偷的在背后把對象的序列化、反序列化的工作都給做了。開發(fā)者使用這個Stub類就能輕松上手Binder這種高級的跨進(jìn)程通訊方法。

FIDL(Flutter Interface Defination Language)即Flutter接口定義語言，它的使命和AIDL很類似，悄悄把對象的序列化、反序列化、自動生成代碼這種“臟活累活”給做了。開發(fā)者在原生代碼中看到的類，能通過@FIDL注解標(biāo)記，自動在Dart側(cè)生成和原生代碼中一樣的類。FIDL是一面鏡子，把各種原生平臺的類影射到Dart中，把Dart中的類影射到各個原生平臺。

少啰嗦，先看東西

[[319172]]

首先是Java類：

public class User { 
  String name; 
  int age; 
  String country; 
  Gender gender; 
} 
enum Gender { 
  MALE, FEMALE 
} 

Android側(cè)

1、定義FIDL接口

@FIDL 
public interface IUserService { 
  void initUser(User user); 
} 

2、執(zhí)行命令./gradlew assembleDebug，生成IUserServiceStub類和fidl.json文件

3、打開通道，向Flutter公開方法

FidlChannel.openChannel(getFlutterEngine().getDartExecutor(), new IUserServiceStub() { 
  @Override 
  void initUser(User user){ 
    System.out.println(user.name + " is " + user.age + "years old!"); 
  } 
} 

Flutter側(cè)

1、拷貝fidl.json文件到fidl目錄，執(zhí)行命令flutter packages pub run fidl_model，生成Dart接口類

2、綁定Android側(cè)的IUserServiceStub通道

await Fidl.bindChannel(IUserService.CHANNEL_NAME, _channelConnection); 

3、調(diào)用公開方法

await IUserService.initUser(User()); 

編譯，運行，你將能在Logcat中看到Oscar is 18 years old!。

FIDL使用詳解

這一部分是對少啰嗦，先看東西部分的補(bǔ)充解釋，觀眾姥爺們可以自行跳過。

上面的例子中的Map，一般來說，在Java中會對應(yīng)一個類：

public class User { 
  String name; 
  int age; 
  String country; 
  Gender gender; 
} 
enum Gender { 
  MALE, FEMALE 
} 

如果想讓flutter傳輸這個對象而不用在flutter層手動去編寫User這個類，以及編寫fromJson/toJson方法，你可以這樣做：

Android側(cè)

1、定義一個接口，添加注解@FIDL。這個注解將告知annotationProcessor生成一些接口和類的描述文件。

@FIDL 
public interface IUserService { 
  void initUser(User user); 
} 

接口方法的限制如下：

• 由于dart不支持方法重載，所以接口中不能出現(xiàn)同名方法
• 參數(shù)只支持實體類，不支持回調(diào)
• 由于JSON解碼的限制，Java需要有無參構(gòu)造函數(shù)

2、Android Studio點擊sync，或者執(zhí)行：

./gradlew assembleDebug 

然后就會產(chǎn)生一堆json文件，如下：

這些json文件就是FIDL和類的描述文件。沒錯，也會同時生成User引用的Gender類的描述文件。

同時，還會生成IUserService的實現(xiàn)IUserServiceStub。即：

• com.infiniteloop.fidl_example.IUserService.fidl.json
• com.infiniteloop.fidl_example.User.json
• com.infiniteloop.fidl_example.Gender.json
• com.infiniteloop.fidl_example.IUserServiceStub.java

限制：只能生成有強(qiáng)引用關(guān)系的FIDL文件，被FIDL接口強(qiáng)引用的類的子類如果沒有被FIDL接口強(qiáng)引用，則不會生成相應(yīng)的描述文件。

3、在合適的地方打開通道，向Flutter公開方法

IUserServiceStub userService = new IUserServiceStub() { 
  @Override 
  void initUser(User user){ 
    System.out.println(user.name + " is " + user.age + "years old!"); 
  } 
FidlChannel.openChannel(getFlutterEngine().getDartExecutor(), userService); 

4、如有需要，可以在合適的地方關(guān)閉通道

FidlChannel.closeChannel(userService); 

關(guān)閉的消息將通知到Flutter側(cè)。

Flutter側(cè)

1、進(jìn)入到你的flutter項目，在lib目錄下創(chuàng)建fidl目錄，把上面的json文件拷貝到這個目錄，然后執(zhí)行：

flutter packages pub run fidl_model 

然后就能在fidl目錄下自動生成相關(guān)的dart類：

即：

• User.dart
• Gender.dart
• IUserService.dart

2、綁定Android側(cè)的IUserServiceStub通道

bool connected = await Fidl.bindChannel(IUserService.CHANNEL_NAME, _channelConnection); 

_channelConnection用于跟蹤IUserService通道的連接狀態(tài)，通道連接成功時，會回調(diào)它的onConnected方法;通道連接斷開時，會回調(diào)它的onDisconnected方法。

3、調(diào)用通道的公開方法

if (_channelConnection.connected) { 
  await IUserService.initUser(User()); 
} 

4、如果不再需要使用這個通道了，可以解除綁定

await Fidl.unbindChannel(IUserService.CHANNEL_NAME, _channelConnection); 

當(dāng)然，F(xiàn)IDL的功能不止于此

1、多個參數(shù)的FIDL接口

void init(String name, Integer age, Gender gender, Conversation conversation); 

2、帶返回值的FIDL接口

UserInfo getUserInfo(); 

3、支持泛型類的生成

public class User<T> { 
  T country; 
} 
public class AUser<String>{} 

FIDL接口：

void initUser(AUser user); 

將能在dart側(cè)生成AUser和User類，且能保持繼承關(guān)系。

4、傳遞枚舉

void initEnum0(EmptyEnum e); 
String initEnum1(MessageStatus status); 

5、傳遞集合、Map

void initList0(List<String> ids); 
void initList1(Collection<String> ids); 
void initList7(Stack<String> ids); 
void initList10(BlockingQueue ids); 

6、傳遞復(fù)雜對象。繼承、抽象、泛型、枚舉和混合類，來一個打一個。

現(xiàn)在，F(xiàn)IDL項目只實現(xiàn)了從Dart側(cè)調(diào)用Android側(cè)的方法。還有以下工作要做：

• Android側(cè)調(diào)用Dart側(cè)的方法
• 其它平臺和Flutter方法的互相調(diào)用
• EventChannel，EventChannel本質(zhì)上是可以通過MethodChannel實現(xiàn)的，問題不大

搞定了對象傳輸，這些問題，都是小case啦。

對于對象的序列化和反序列化

為了能滿足大佬們的定制化需求，我分別在Java側(cè)和Flutter側(cè)定義了序列化/反序列化的接口類。

Java: 
public interface ObjectCodec { 
    List<byte[]> encode(Object... objects); 
    <T> T decode(byte[] input, TypeLiteral<T> type); 
} 

Dart: 
abstract class ObjectCodec { 
  dynamic decode(Uint8List input); 
  List<Uint8List> encode(List objects); 
} 

目前使用的是JsonObjectCodec，經(jīng)過JSON的編解碼，性能會稍差。后面還希望和小伙伴們一起努力，實現(xiàn)更高效的編解碼。

項目進(jìn)度

上述提到的功能，只要是從Flutter側(cè)調(diào)用Java側(cè)的方法相關(guān)的，大部分都已經(jīng)實現(xiàn)了。

我做了一個Demo，模擬了一個在Android側(cè)依賴了IM(即時通訊)SDK，需要在Flutter側(cè)聊天、獲取消息、發(fā)消息的場景。以下是Demo的截圖：

1、首頁，點擊按鈕調(diào)用Android側(cè)方法，開啟聊天服務(wù)

[[319173]]

2、聊天頁面

3、發(fā)一條消息給Lucy并獲取和Lucy的聊天記錄

4、調(diào)用Android側(cè)方法發(fā)送N條消息給Wilson并獲取聊天記錄

最后

上次做開源項目已經(jīng)是3年前了，那是一個Android原生刷新控件，TwinklingRefreshLayout，github 3.7k stars。后來由于工作的原因，整天跟Android Framework、C/C++打交道，精力也都是放到了公司的業(yè)務(wù)上，也沒有時間和精力維護(hù)下去。

那么今天我想發(fā)布的這個Flutter開源項目，是想通過社區(qū)的力量，和大家一起把項目維護(hù)下去。我在GayHub上建立了一個組織，github.com/flutterFIDL(https://github.com/flutterFIDL)。

稍晚一點時間，我會把項目開源出來，一兩天內(nèi)，代碼會放在這里，github.com/flutterFIDL(https://github.com/flutterFIDL/FIDL)。