wuba / Fair

简体中文|English

Fair是为Flutter设计的，UI&模板动态化框架，用于动态更新Widget Tree。 Flutter Fair is a new package used to update widget tree dynamically.

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

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

使用的工程来自 https://github.com/mitesh77/Best-Flutter-UI-Templates

🏛Architecture

🚀 Running

为了方便接入&体验Fair框架，请确认你的Flutter运行环境，可以根据实际情况切换版本。目前支持版本（如遇问题，Issue反馈）：

Flutter版本	Dart版本	CI
Flutter 1.22.6	Dart 2.10.5
Flutter 1.22.4	Dart 2.10.4
Flutter 1.20.4	Dart 2.9.2
Flutter 1.17.3	Dart 2.8.4
Flutter 1.12.13+hotfix.9	Dart 2.7.2

# Switch to another stable flutter version
#dependency_overrides:
#  fair_version:
#    path: ../../fair_version/flutter_1_22_6

https://flutter.dev/docs/development/tools/sdk/releases?tab=macos

注意：由于部分版本flutter构建脚本存在巨大变化，会导致同一个模板工程无法同时运行在不同版本。

Fair的example位于fair/example目录，同时也附带了一些社区demo并转为fair动态化形式，工程位于samples目录下，克隆后直接build对应仓库即可即可。

samples
├── adobe_xd // adobe_xd插件demo, xd插件可以从设计稿直接导出flutter代码
├── best_flutter_ui_templates // 一个UI很漂亮的Flutter模板项目
└── my_app  // 经典的Flutter Hello World
    ├── README.md
    ├── android
    ├── assets
    ├── build
    ├── ios
    ├── lib
    ├── my_app.iml
    ├── pubspec.lock
    ├── pubspec.yaml
    ├── test
    └── web

更多接入操作请参考 https://fair.58.com/

• fair
• fair_compiler
• fair_annotation
• fair_version

📎相关介绍

• Flutter动态化框架Fair文档上线&开源倒计时
• Flutter动态化框架Fair的设计与思考

🕰2020&2021 Roadmap

• 开源准备 2020
  • 项目清理 ✅
  • 对外文档准备 ✅
  • 官网准备 https://fair.58.com ✅
  • Github开源 https://github.com/wuba/fair ✅
  • i18n ⚠️✅
• Bug修复
  • Github issue处理✅
• 维护迭代 2021
  • Framework适配优化✅
  • 局部刷新支持 ✅
  • 状态库支持Provider
  • 独立cli工具
  • 转化优质Demo ✅
  • 动画支持的形式
  • Flutter Favorite Package支持
  • 其他Top UI Package支持
  • 逻辑组件优化 ✅
  • CI流程✅
  • 社区插件贡献方式

⚠️Unsupported Features

由于dart语法解析工作量奇大，逻辑运算均不支持，由逻辑运算延伸的表达式则更多。 下面是一些，不支持特性&已知问题：

• 逻辑表达式，比如加减乘除，字符拼接，循环遍历语法等
• 链式点语法，如：Colors.black.withOpacity(0.59)，Colors.xxx本身是支持的，但是再次转换透明的则不支持
• 匿名Builder函数，如ListView的的builder属于逻辑运算，需要封装为组件

🔧Contributing

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

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

微信	美事（内部）

如微信码过期，可以找管理员(请务必备注flutter fair，否则不予通过)：do_not_let_me_know

🧯FAQ

自查步骤（新手必读）

1. 核对flutter版本与readme说明，确认该版本已被Fair支持
2. 核查fair_version分支版本于flutter一致，且等同于第一步版本号
3. 如果尚未看过文档，请先运行自带的sample，能跑起来再接入app
4. 遇到编译错误，请查看终端日志，过滤fair关键词
5. 到github提issue，或gitter。留档/解决，并提供flutter环境信息flutter doctor --verbose

• 为什么没有bin产物？

bin为可选的flatbuffer产物，本机如果需要，请安装flatc

• 执行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老师提供设计支持