Skip to content

Latest commit

 

History

History
98 lines (69 loc) · 4.59 KB

README.zh-cn.md

File metadata and controls

98 lines (69 loc) · 4.59 KB

flutter_getx_boilerplate

master branch: Fluter 3.0.5 version

Flutter-2.x branch: Flutter 2.x version

语言: English, 中文 (这个文件)., 韩文

介绍

在我学习Flutter期间,我一直使用的是flutter_bloc状态管理框架,无意间看到GetX状态管理框架,通过ReadMe发现GetX框架非常容易入门,于是想一边学习一边写一个GetX的Starter项目,不仅可以帮助自己学习,也可以帮助他人快速搭建框架。搭建这个框架之前我搜索了很多类似的框架,发现都比较简单,没有一个涵盖项目该有的通用的东西,于是萌发了自己写一个的想法。下面让我逐一介绍。

技术 & 项目介绍

Flutter - GetX状态管理

使用Flutter 2.x搭建的一套包含预定义的文件夹结构、样式主题、API访问、状态管理、路由 & 依赖等的框架。项目结构清晰,可以很方便的作为Flutter的模板项目来使用。使用技术包括但不限于FlutterDartGetX等。

安装 & 使用

Step 1:

Fork本项目到自己的仓库:

git clone https://github.com/KevinZhang19870314/flutter_getx_boilerplate.git

Step 2:

用VS Code打开项目文件夹,执行以下命令安装依赖包:

flutter pub get

Step 3:

打开lib文件夹下的main.dart文件,F5 或者 Ctrl + F5运行项目,然后就可以开始开发调试了。

文件夹结构

下面是项目文件夹结构(只介绍lib下面的文件夹)

lib/
|- api - 全局Restful api请求,包括请求拦截器等
   |- interceptors - 拦截器,包括auth、request、response拦截
   |- api.dart - Restful api导出文件
|- lang - 国际化,包含翻译文件,翻译服务文件等
   |- lang.dart - 语言导出文件
|- models - 各种结构化实体类,分为request和response两种类型的实体
   |- models.dart - 实体类导出文件
|- modules - 业务模块文件夹
   |- auth - 登录&注册模块
   |- home - 首页模块
   |- splash - splash模块
   |- modules.dart - 模块导出文件
|- routes - 路由模块
   |- app_pages.dart - 路由页面配置
   |- app_routes.dart - 路由名称
   |- routes.dart - 路由导出文件
|- Shared - 全局共享文件夹,包括静态变量、全局services、utils、全局Widget等
   |- shared.dart - 全局共享导出文件
|- theme - 主题文件夹
|- app_bindings.dart - 在app运行之前启动的服务等,如Restful api
|- di.dart - 全局依赖注入对象,如SharedPreferences等
|- main.dart - 导出类,用作外面调用api请求主入口

其他

在编写过程中,因为涉及到Restful api的调用,这里我使用了REQ|RES提供的免费测试api。

测试使用的用户如下:

邮箱: "[email protected]",
密码: "pistol"

感兴趣的朋友扫码进QQ 群:610930944,我们一起讨论Flutter的未来。

打赏开发者