Getx模版

  • 用来学习Flutter的项目框架采用GetX,使用这个模版可以帮你减轻很大的工作量,后期会封装各种常用的组件,也欢迎大家提交你们各自封装的组件。
  • 你可以参考GetX文档进行初始化项目,你完全可以根据本模版一步一步往下进行来快速搭建一个模板项目。

文档参考

快速搭建步骤

  1. 配置好Flutter开发环境并安装常用插件例如:flutter-img-sync 参考文档图片资源路径生成插件,json转art和Getx插件
  2. 创建flutter项目在根目录下面新建assets/images/目录将所有图片资源文件导入进去其他资源需要 在assets下面新建相应目录。
  3. 将lib下所有文件和pubspec.yaml文件复制到自己项目需要进行适当的修改 如果你已经执行了这一步那么第四步禁止使用否则会初始化项目的,第四步骤仅限于老鸟初始化自己项目使用
  4. 使用get init命令初始化GetX项目,慎重使用仅限老鸟。GetX Cli 已经帮我们初始化好了一个路由结构以及 home 子页面,这个实例是可以直接运行的。 GetX Cli 将项目全部装进了 app 目录中,modules 存放页面,每个页面又分别存在 bindings,controllers,views 它们分别负责的是:
    • bindings:负责 controller 与 view 的耦合
    • controller:负责响应式变量和非响应式变量的管理
    • view:负责页面 即 view 与 controller 是解耦的,通过 binding 进行耦合
  5. 使用get create page:demo自己需要的新建页面需要适当修改参考其他页面文件进行修改 (ps 如果命令没用请使用pub global activate get_cli
  6. 修改main方法相应文件参考main.dart
  7. 修改图标 flutter pub run flutter_launcher_icons_maker:main

代码规范

  1. 变量命名采用驼峰
  2. 公共组件或工具封装需要写下使用方法
  3. 组件超过三处使用需要抽离成为公共方法
  4. 业务逻辑中三处以上的判断尽量使用switch来判断条件使用枚举
  5. 有需要后期修改的写一个todo
  6. 公共组件或方法更新需要兼容当前旧版本,使用 @Deprecated 注解标记下一个版本移除
  7. 可以参考文档 代码规范参考 -官方代码规范 -阿里项目规范
  8. 使用export将改常用目录下的所有包导入进来方便使用例如:export 'user_provider.dart';
  9. 创建页面时需要使用同一个controller的就不要使用get create page创建新页面

GetX常用命令总结

//生成翻译文件
get generate locales assets/locales
//新增页面
get create page:demo
//新增View
get create view:demo on home
//新增controller
get create controller:demo on home
// 根据模版生成controller
get create controller:user with assets/examples/controller.dart.example on home
//生成json2dart文件和provider文件
get generate model on models with assets/models/user.json

小组件和工具类封装要求

  1. 一定要编写必要的注释解释各个参数
  2. utils放到utils目录,widget放到widgets目录