简体中文|English

Fair是为Flutter设计的动态化框架，通过Fair Compiler工具对原生Dart源文件的自动转化，使项目获得动态更新Widget的能力。

Fair 的接入和使用，建议大家阅读在线文档:

在线文档：https://fair.58.com/

如果您需要热更新平台，可关注Fair Pushy

热更新平台：FAIR PUSHY

Fair的UI渲染是无损的，可以做到像素级别的还原，看一张转义Best Flutter UI Templates部分页面后的效果：

使用的工程来自 https://github.com/mitesh77/Best-Flutter-UI-Templates
项目位置：/example/lib/best_flutter_ui

🏛 架构

🚀 快速接入

简单几步，接入Fair.

step1：同步fair工程代码

推荐同步 fair 相关代码，并且进行本地依赖：

同步方式:

git clone https://github.com/wuba/fair.git

step2：在 pubspec.yaml 添加依赖

将Fair工程和对应的业务工程放在同一个目录中，并添加依赖:

# add Fair dependency
dependencies:
  fair: 3.2.1

# add build_runner and compiler dependency
dev_dependencies:
  build_runner: ^2.0.0
  fair_compiler: ^1.7.0

# switch "fair_version" according to the local Flutter SDK version
# Flutter SDK 3.7.x(3.7.0、3.7.1、3.7.2、3.7.3、3.7.4、3.7.5、3.7.6、3.7.7、3.7.8、3.7.9、3.7.10) -> flutter_3_7_0
# Flutter SDK 3.3.x(3.3.0、3.3.1、3.3.2、3.3.3、3.3.4、3.3.5、3.3.6、3.3.7、3.3.8、3.3.9、3.3.10) -> flutter_3_3_0
# Flutter SDK 3.0.x(3.0.0、3.0.1、3.0.2、3.0.3、3.0.4、3.0.5) -> flutter_3_0_0
# Flutter SDK 2.10.x(2.10.0、2.10.1、2.10.2、2.10.3) -> flutter_2_10_0
# Flutter SDK 2.8.x(2.8.0、2.8.1) -> flutter_2_8_0
# Flutter SDK 2.5.x(2.5.0、2.5.1、2.5.2、2.5.3) -> flutter_2_5_0
# Flutter SDK 2.0.6 -> flutter_2_0_6
# Flutter SDK 1.22.6 -> flutter_1_22_6
dependency_overrides:
  fair_version:
    path: ../fair/flutter_version/flutter_3_7_0

step3：将App替换为FairApp

void main() {
  WidgetsFlutterBinding.ensureInitialized();

  FairApp.runApplication(
    _getApp(),
    plugins: {
    },
  );
}

dynamic _getApp() => FairApp(
  modules: {
  },
  delegate: {
  },
  child: MaterialApp(
    home: FairWidget(
            name: 'DynamicWidget',
            path: 'assets/bundle/lib_src_page_dynamic_widget.fair.json',
            data: {"fairProps": json.encode({})}),
  ),
);

step4：添加FairWidget作为动态Widget

FairWidget(
name: 'DynamicWidget',
path: 'assets/bundle/lib_src_page_dynamic_widget.fair.json',
data: {"fairProps": json.encode({})}),

🧰配套工具

fair 开发提效工具

Dart命令行工具 faircli

一键创建fair工程

faircli安装

dart pub global activate faircli

创建动态化工程

faircli create -n dynamic_project_name

创建载体工程

faircli create -k carrier -n carrier_project_name

IDEA插件 FairTemplate

提供常用页面/组件模板代码

配套工具使用流程

配套工具使用效果

使用faircli配置好本地的热更服务后，在移动设备上打开开发者选项，选择本地模式，输入开发机ip，预览fair动态化效果

更多介绍请查看文档

⚙️fair-online云开发平台

Fair-Online 是面向Flutter 开发者，提供从Flutter 在线开发，到实时编译预览，打包发布、动态下发端侧更新，实现Flutter 线上动态化的一体化云开发平台。

开发者无需配置Flutter 开发环境，在线开发调试代码，即时编译预览，所见即所得，结合58开源团队打造的Flutter 动态化框架 Fair 及热更新平台 FairPushy ，实现Flutter 线上动态化。

在线体验地址： Fair-Online Platform

更多介绍请查看文档

🔨最近版本

3.10.0

更新时间：2023.08.15

适配Flutter 3.10.0，发布 Fair Version 3.10版本
修复已知BUG，修复DSL解析器问题

3.2.1

更新时间：2023.04.13

修复了一些bug.

3.2.0

更新时间：2023.04.12

调整 dispose 的调用顺序，不在树上面，后续操作停止
增加通用FairPlugin的js和dart代码，复用相同的交互逻辑，增加例子注释
Json解析兼容
Android中使用V8引擎调用executeFunction时添加异常捕获及日志打印
修复 SliverGridDelegateWithFixedCrossAxisCount 转换报错
SugarMap 和 SugarMapEach 的输入支持其他 Sugar 表达
优化 ifEqual ifEqualBool switchCase 的性能
修复 Domain 不识别 sugar 中的 index 和 item
让 AOT 也遵循条件达成才执行代码
修复 SugarMap 和 SugarMapEach 集合入参不支持其他 Sugar 语法
抽象 Domain,增加 IndexDomain、MapEachDomain，支持嵌套 Domain
新增 FunctionDomain 通用 Domain，为回调function 生成对应的参数供 FunctionDomain 使用
新增 NullableIndexedWidgetBuilder，IndexedWidgetBuilder，WidgetBuilder，TransitionBuilder 常用的 Sugar 支持
一些已知问题修复

3.1.0

更新时间：2023.03.14

升级 analyzer 库到 5.5.0 版本；
Dart 函数转 JS 支持参数传递；
JS Object 取值兼容；
删除 fair/android 中 kotlin 依赖；
添加 IconData 的自定义解析；
可选位置参数的生成修改为 pa 获取；
修复 OptionalPositional 参数默认值丢失问题；
去除 generated.fair.dart 注释中的生成时间；
增加 ignore unnecessary_import 操作；
修复 Sugar.switchCase key 和 defaultValue 赋值错误问题；
binding 修改为 SplayTreeMap，增加搜索效率，特别是对于列表，短时间会搜索重复 tag；
暴露出 specialBinding 以便用户能重载某个值；
provider 添加到 _binding 中的时候以用户设置的为准，方便用户快速修正；
修复 loadCoreJs package 拼接问题；
降低 minSdkVersion 版本到 16；
runApplication 支持指定 JS 所在的 package；
修复 _reload 方法中调用 context 报错问题。

3.0.0

更新时间：2022.11.17

修复class 构造函数解析异常；
Fair 兼容 Web 端；
bindmap 逻辑优化。

2.8.1

更新时间：2022.11.01

修复 bug：CustomScrollView 引用外部函数构建 builder 报错。

2.8.0

更新时间：2022.10.21

适配 Flutter SDK 3.3.0+；
新增语法糖：Sugar.isNestedScrollViewHeaderSliversBuilder、Sugar.isButtonStyle、Sugar.isDuration、Sugar.popMenuButton、Sugar.sliverChildBuilderDelegate、Sugar.sliverGridDelegateWithFixedCrossAxisCount；
修复了一些bug。

2.7.0

更新时间：2022.08.10

Fair

适配 Flutter SDK 3.0.0、3.0.1、3.0.2、3.0.3、3.0.4、3.0.5版本；
修复部分已知BUG

2.6.0

更新时间：2022.07.05

Fair

1.Fair 支持加载手机磁盘路径上的 bundle 文件；
2.适配 Flutter SDK 2.10.0、2.10.1、2.10.2、2.10.3 版本；
3.Dart2JS 支持解析 static 方法；
4.运行时，页面错误信息提示优化；
5.语法糖支持解析 Model 数据。

2.5.0

更新时间：2022.05.31

Fair

适配 Flutter SDK 2.8.0、2.8.1
Dart2JS 支持解析单例
新增语法糖Sugar.switchCase、Sugar.colorsWithOpacity、Sugar.convertToString等

example

全面优化example结构,升级example体验，更适合新手入门。
在源码中，新增 example 工程，用于提供 Fair API 的标准用法。

example 工程位置：fair/example

2.4.1

更新时间：2022.05.12

Fair

修复 FairLogger 文件导包问题
升级 analyzer 到 2.3.0

2.4.0

更新时间：2022.04.26

Fair

FlatBuffers 支持在 null safe 环境下生成 bin 文件

2.3.0

更新时间：2022.04.22

Fair

支持空安全 null-safe
适配Flutter SDK 2.5.0、2.5.1、2.5.2、2.5.3等版本

demo

升级 sample 工程里过时的demo
补充 sample 工程里 iOS 的运行环境

🕰2022 规划

主版本计划
- null-safe 版本支持，预计4月22日上线 ✅
- Flutter 2.8.0版本适配，预计5月中旬上线 ✅
- Flutter 2.10.0版本适配，预计6月初上线 ✅
- Flutter 3.0版本适配 ✅
- IDE 语法检测和提示插件 ✅
- 丰富语法糖 ✅
热更新平台
- Dart Server工程搭建 ✅
- Flutter Web工程搭建 ✅
- 补丁/资源管理 ✅
- 项目管理 ✅
- 移动端 Update&Download ✅
线上动态化
- Flutter Web工程搭建 ✅
- Dart Server工程搭建 ✅
- Action编辑 ✅
- 代码编辑 ✅
- 组件编辑 ✅
- 页面编辑 ✅
- 工程编辑 ✅
- Flutter效果预览 ✅
- Fair DSL预览 ✅
IDE插件
- Fair工程生成 ✅
- Fair模板生成 ✅
- Fair语法检测 ✅

📱接入APP

_58阿姨

_{移动经纪人}

_安居拍房

_神奇保

_58商办通

_58商家版

_{中华英才网}

✨️ 贡献者

Thanks goes to these wonderful people (emoji key):

_Wu 💻 📖	_Penta 💻 📖	_haijun 💻 📖	_陈有余 💻 📖	_yangyang 💻	_wan 💻	_bujie 💻	_Kc 💻
_gongpengyang 💻	_qixu 💻	_waynesonic 💻	_{paozhuanyinyu} 💻	_alzzzz 💻 📖	_xiangwc 💻	_WangYk 💻	_SunWei 💻
_单鹏涛 💻	_lswc225 💻	_Goofy 💻	_itzhaoqian 💻	_{Sunlight Xie} 💻	_lhdycxgghb 💻	_Prome 💻	_zmtzawqlp 💻
_{woshixiaohuhu} 💻	_yukixut 💻	_pearone 💻	_JOYINF1189 💻	_Blues9527 💻	_miserydx 💻	_{CICI Chan} 💻

This project follows the all-contributors specification. Contributions of any kind welcome!

👏🏻 支持

Star&Fork 是对我们最大的支持~

📎相关介绍

Flutter动态化框架Fair文档上线&开源倒计时
Flutter动态化框架Fair的设计与思考
Fair 2.0 逻辑动态化开源了！
Fair逻辑动态化架构设计与实现
Fair逻辑动态化通信实现
Fair下发产物-布局DSL生成原理
Fair 逻辑语法糖设计与实现
Fair热更新设计与实现
Fair在安居拍房App中的实践
Flutter 动态化项目评测
Fair 在 58 同城拍客 App 中的实践

🔧一起共建

通过Issue提交问题，贡献代码走Pull Request，管理员将对代码进行审核。

对Fair感兴趣的小伙伴，可以加入交流群。技术咨询、讨论，请移步至

微信小秘书	微信群

微信入群：请先添加58技术小秘书为好友，备注fair，小秘书邀请进群。

⚠️暂不支持功能

由于dart语法解析工作量奇大，会有部分语法和特殊使用方式的限制。下面是一些，不支持特性&已知问题：

链式点语法，如：Colors.black.withOpacity(0.59)，Colors.xxx本身是支持的，但是再次转换透明的则不支持
类的继承不支持查阅更多不支持内容，请移步至

🧯FAQ

自查步骤（新手必读）

核对flutter版本与readme说明，确认该版本已被Fair支持
核查version分支版本于flutter一致，且等同于第一步版本号
如果尚未看过文档，请先运行自带的sample，能跑起来再接入app
遇到编译错误，请查看终端日志，过滤fair关键词
使用动态化组件的过程中，不建议格式化生成的Javascript文件，格式化工具可能会修改文件内容，导致执行报错
到github提issue，或gitter。留档/解决，并提供flutter环境信息flutter doctor --verbose

为什么没有bin产物？

bin为可选的flatbuffer产物，fair 2期开源了 fairc和dart2js编译转换工具。

执行flutter pub run build_runner build后没有产物？

请根据适配要求，核查flutter，dart版本

执行flutter pub run build_runner build后，提示编译错误信息？

根据错误日志，有几种情况：1.原代码中存在逻辑表达式，语法解析不通过，尝试剥离逻辑为module；2..dart_tool文件权限问题，请删除后重试

LICENSE

Fair项目基于BSD协议开源。我们使用的更多依赖库详见pubspec.yaml

感谢UXD的Kaibin老师提供设计支持

Files

README-zh.md

Latest commit

History

README-zh.md

File metadata and controls

🏛 架构

🚀 快速接入

🧰配套工具

Dart命令行工具 faircli

IDEA插件 FairTemplate

配套工具使用流程

配套工具使用效果

⚙️fair-online云开发平台

🔨最近版本

3.10.0

3.2.1

3.2.0

3.1.0

3.0.0

2.8.1

2.8.0

2.7.0

Fair

2.6.0

Fair

2.5.0

Fair

example

2.4.1

Fair

2.4.0

Fair

2.3.0

Fair

demo

🕰2022 规划

📱接入APP

✨️ 贡献者

👏🏻 支持

📎相关介绍

🔧一起共建

⚠️暂不支持功能

🧯FAQ

LICENSE