MXFlutter技术预览版

中文版文档|English Document

---

• 一、项目介绍
• 二、项目特性
• 三、核心思想
• 四、项目架构
  • 1.VM层
  • 2.Flutter层
  • 3.Native层
• 五、MXFlutter基本使用
  • 1.Flutter侧，创建并启动MXJSFlutterApp
  • 2.JS侧，编写MXJSWidget页面
  • 3.Flutter侧，进入MXJSWidget页面
• 六、项目效果UI展示
• 七、许可协议
• 八、参与贡献
• 九、团队介绍
• 十、联系我们

---

一、项目介绍

MXFlutter是一套基于JS的高性能Flutter动态化框架，它用极类似Dart的开发方式，通过编写JavaScript代码，来开发Flutter应用。更多细节在 基于JS的高性能Flutter动态化框架详细介绍。

---

二、项目特性

• 支持Dart Flutter语法
• 支持定义Flutter中同名Widget类
• 支持定义相同的Build方式，SetState刷新及事件响应方法
• 支持js模块化开发
• 支持VS Code直接调试
• 支持模拟器页面热更新

---

三、核心思想

把 Flutter 的渲染逻辑中的三棵树（即：WidgetTree、Element、RenderObject ）中的第一棵（即：WidgetTree），放到 JavaScript 中生成。用 JavaScript 完整实现了 Flutter 控件层封装，可以使用 JavaScript，用极其类似 Dart 的开发方式，开发Flutter应用，利用JavaScript版的轻量级Flutter Runtime，生成UI描述，传递给Dart层的UI引擎，UI引擎把UI描述生产真正的 Flutter 控件。所以，它在iOS上是完全动态化的。

关于MXFlutter动态化框架渲染、优化等更多详细细节介绍，请看文档：基于JS的高性能Flutter动态化框架详细介绍。

---

四、项目结构

MXFlutter，就是用JavaScript，以Flutter的写法开发Flutter。具体的项目结构分为三层，请看下图：

1.VM层：

• MXFlutter Runtime
• 定义和Flutter Widget同名镜像类
• 响应式UI框架

2.Flutter层：

• Script脚本管理模块
• DSL2Widget UIEngine，事件支持
• Dart业务API支持
• 内存管理，对象生命周期管理

3.Native层：

• VM虚拟机
• 线程管理
• Native业务API支持

---

五、MXFlutter基本使用

1. Flutter侧，创建并启动MXJSFlutterApp

MXJSFlutter.getInstance().setup();
MXJSFlutter.getInstance().runJSApp(jsAppName: "app_test", pageName: null);

2. JS侧，编写MXJSWidget页面

class AppTest extends MXJSFlutterApp {
    constructor() {
        super("app_test", "initRouteName");
    }

    createJSWidgetWithName(pageName) {
        let w = new JSWidgetHomePage;
        return w;
    }
}

function main(pageName) {

    MXJSLog.log("main:pageName" + pageName);

    let app = new AppTest;
    runApp(app);
}

3.Flutter侧，进入MXJSWidget页面

Navigator.push(context, MaterialPageRoute(builder: (context) => MXJSFlutter.getInstance().navigatorPushWithPageName("JSWidgetHomePage")));

---

六、项目效果UI展示

先看看使用效果，以下截图是在MXFlutter框架下用JS开发，大家可以把上面的源码下载下来，里面有完整的JS代码示例：

单页面演示

下图是APP示例截图：

下面是UI截图对应的JS代码，没错，你没有眼花，这个是真的 JavaScript 代码，可以在 MXFlutter 的运行时库上渲染出 Flutter 的UI，简直是太厉害了（是不是很像Flutter里面的组件代码）！

class JSPestoPage extends MXJSWidget {
  constructor() {
    super("JSPestoPage");
    this.recipes = recipeList;

  }

  build(context) {
    let statusBarHeight = 24;
    let mq = MediaQuery.of(context);
    if (mq) {
      statusBarHeight = mq.padding.top
    }

    let w = new Scaffold({
      appBar: new AppBar({
        title: new Text("Pesto Demo")
      }),
      floatingActionButton: new FloatingActionButton({
        child: new Icon(new IconData(0xe3c9)),
        onPressed: this.createCallbackID(function () {

        }),
      }),
      body: new CustomScrollView({
        semanticChildCount: this.recipes.length,
        slivers: [
          //this.buildAppBar(context, statusBarHeight),
          this.buildBody(context, statusBarHeight),
        ],
      }),
      //body:this.buildItems()[0]
    });

    return w;
  }

  buildAppBar(context, statusBarHeight) {
    return SliverAppBar({
      pinned: true,
      expandedHeight: _kAppBarHeight,
      actions: [
        IconButton({
          icon: new Icon(new IconData(1)),
          tooltip: 'Search',
          onPressed: this.createCallbackID(function () {

          }),
        }),
      ],
      flexibleSpace: LayoutBuilder({
        builder: function (context, constraints) {
          size = constraints.biggest;
          appBarHeight = size.height - statusBarHeight;
          t = (appBarHeight - kToolbarHeight) / (_kAppBarHeight - kToolbarHeight);
          extraPadding = new Tween({ begin: 10.0, end: 24.0 }).transform(t);
          logoHeight = appBarHeight - 1.5 * extraPadding;
          return Padding({
            padding: EdgeInsets.only({
              top: statusBarHeight + 0.5 * extraPadding,
              bottom: extraPadding,
            }),
            child: Center({
              child: new Icon(new IconData(1))
            }),
          });
        },
      }),
    });
  }

  buildBody(context, statusBarHeight) {

    let mediaPadding = EdgeInsets.all(0);
    let mq = MediaQuery.of(context);
    if (mq) {
      mediaPadding = MediaQuery.of(context).padding;
    }
    let padding = EdgeInsets.only({
      top: 8.0,
      left: 8.0 + mediaPadding.left,
      right: 8.0 + mediaPadding.right,
      bottom: 8.0
    });

    return new SliverPadding({
      padding: padding,
      sliver: new SliverGrid({
        gridDelegate: new SliverGridDelegateWithMaxCrossAxisExtent({
          maxCrossAxisExtent: _kRecipePageMaxWidth,
          crossAxisSpacing: 8.0,
          mainAxisSpacing: 8.0,
        }),
        delegate: new SliverChildBuilderDelegate(
          function (context, index) {
            let recipe = this.recipes[index];
            let w = new RecipeCard({
              recipe: recipe,
              onTap: function () { showRecipePage(context, recipe); },
            });

            return w;
          },
          {
            childCount: this.recipes.length,
          }),
      }),
    });
  }

项目演示

源码中还有更丰满的示例，高仿知乎页面JSFlutter版，可以点此进入查看代码： https://github.com/TGIF-iMatrix/MXFlutter/blob/master/js_flutter_src/app_test/zhihu/home/home_page.js

下图是对应的UI，已经接近在线上版直接使用了：

本项目里面高仿知乎页面示例借鉴了 zhihu-flutter 的示例代码，在此，鸣谢作者 HackSoul。

---

七、许可协议

MXFlutter遵循MIT开源许可证协议。

---

八、参与贡献

MXFlutter还需要很多工作去完善功能，修改BUG，建设配套设施，如果大家有兴趣，欢迎加入一起开发。 如果你有好的意见或建议，也欢迎给我们提 Issues 或 Pull Requests。

---

九、团队介绍

成员

项目成员luca浪哥，nice，yockie帅哥贡献了动画，控件，示例APP等核心实现， chaodong老师负责了DartVM方案，wenn负责了Android平台的实现，IP老师帮忙提供了单元测试，健身大神yofer老师负责了代码维护，工具建设。

项目由来

18年10月份，团队开始引入 Flutter，发现Flutter功能强大，开发快捷，但有个缺点，不支持像ReactNative一样使用JavaScript语言开发，为了扩展Flutter的开发者阵营，所以启动了这个技术探索项目。

现状

MXFlutter虽然各个模块已相对完整，并同时支持 iOS 和 Android 两个平台，但投入生产还需要一段时间。目前正对框架进行优化，尽早发布正式版本。因为目前还有其他项目要顾及，人力仍然很紧张，如果大家有兴趣，期待小伙伴们一起加入，共同丰富 MXFlutter 动态化能力。

由于时间紧张，MXFlutter还有很多遗留的问题，作为一个技术探索，非常辛苦但非常有趣，期待各位大牛指导，期待小伙伴们提出问题一起讨论解决。

要了解全部，一定要拉下源码，运行起来看看，有问题可以留言一讨论，MXFlutter会持续更新。

---

十、联系我们

TGIF-iMatrix 是一个技术氛围浓厚，有美女有帅哥有趣有爱的团队，还有精通量子计算，5G等前沿技术的数据分析victor老王，欢迎iOS，Android开发小伙伴，数据开发，数据分析岗位同学投递简历哦：imatrixteam@qq.com

对MXFlutter有兴趣的小伙伴，可以加群交流 QQ群:747535761