Flutter 路由——頁面表及頁面參數綁定的自動生成

Flutter 自帶完善的路由框架，能夠直接用Navigator.of(context).push(route)打開新頁面或者用命名的方式：Navigator.of(context).pushNamed($pageName);，而後在MaterialApp#onGenerateRoute中寫若干個switch-case根據頁面名稱進行分發。如此操做雖然可行，可是在頁面數量較多時，仍是略微繁瑣。

有時候頁面須要外部傳參——依賴注入，常規的方法是：

1. 在頁面Widget上添加變量
2. 構造函數傳入
3. 在State中widget.something引用
4. 同時在onGenerateRoute中建立widget中調用對應的構造函數。

此方法稍顯繁瑣，而且在頁面依賴變化時，又要重複這4個步驟。 若是能經過簡單的配置生成代碼，而且直接使用，能夠簡化源碼，節省時間而且避免出錯。我先是在網上搜索相關的解決方案，可是沒找到。所以本身動手造了這個輪子——router_generator： pub, github.

使用

安裝

dev_dependencies:
  router_generator: 0.1.1
  build_runner:
複製代碼

引用

import 'package:router_generator/router_generator.dart';

頁面標記

@Router('third')
class ThirdPage extends StatefulWidget {
複製代碼

在頁面Widget上使用Router註解，頁面名做爲參數

參數標記

@inject
class ThirdPageState extends State<ThirdPage> {
  @RouterParam(required: true)
  Person person;
  @RouterParam(key: 'set_key')
  bool setKey = false;
  @routerParam
  Map<String, int> map;
複製代碼

給須要注入依賴的State添加inject註解，而且在變量上添加RouterParam 註解。 RouterParam有兩個可選的參數:

• key: 此參數在參數表中的鍵，默認用變量名
• required：是否必須，若是是的話，在依賴注入時，若是參數表中沒有此參數，debug模式下會報錯，而且在生成的createRouteArgs方法中此參數爲必須。

若是兩個參數都不須要，建議用routerParam註解。 從例子中能夠看到，dart的各類類型包括自定義的model都是支持的。

代碼生成

執行命令:flutter packages pub run build_runner build, 更多使用方法可參考 build_runner

生成的若干dart文件中包含：

• 頁面路由表 main.router_table.dart
• 頁面依賴注入 $page.inject.dart 若干個，其中 page 是你 state所在 文件的名稱，例如 foo.dart對應foo.inject.dart

引用

路由生成

MaterialApp(
  ...
  onGenerateRoute: (RouteSettings settings) {
    String pageName = settings.name;
    var arguments = settings.arguments;
    if (arguments is Map<String, dynamic>) {
      deliverParams(pageName, arguments);
    }
    return MaterialPageRoute(builder: (_) {
      return getWidgetByPageName(pageName);
    });
  },
);
複製代碼

修改onGenerateRoute方法，調用main.router_table.dart中的getWidgetByPageName，獲取對應的頁面Widget，而且deliverParams()傳遞參數。

對於嵌入原有原生的App，可參考：

onGenerateRoute: (RouteSettings settings) {
    String route = settings.name;
    Uri uri = Uri.parse(route);
    var pageName = uri.path.replaceFirst(RegExp('/'), '');
    lastRouteParams = uri.queryParameters;
    return PageRouteBuilder(pageBuilder: (BuildContext context,
        Animation<double> animation, Animation<double> secondaryAnimation) {
      return getWidgetByPageName(pageName);
    });
  },
複製代碼

Map<String, String>類型的參數表（即uri中值爲字符串的參數表）也是支持的，不須要額外轉換。

依賴注入

在已注入依賴的state中import 對應的inject文件，在使用變量前注入依賴，如：

@override
void initState() {
	super.initState();
	injectDependencies(this);
	doSometing();
}
複製代碼

傳遞依賴

Navigator.of(context).pushNamed('second',
                    arguments: {'name': 'bar', 'count': 666});
                    
複製代碼

能夠手動建立依賴的參數表，但建議使用 inject 文件中的 createRouteArgs方法。

Navigator.of(context).pushNamed('second',
                    arguments: createRouteArgs(name: 'bar', count: 666));

複製代碼

總結

如此，就完成了頁面表及頁面參數綁定的自動生成，增減頁面和注入參數變得如此簡單。有問題的同窗歡迎留言或者提issue，github點個贊🤓