Flutter插件salah的安装与使用

Flutter插件salah的安装与使用

概览

salah 是一个适用于Flutter开发者的必备插件。它通过易于使用的生成器，可以帮助开发者快速创建项目结构、函数、视图、视图模型和小部件，同时还能利用各种有用的扩展。使用 salah 可以简化工作流程并构建更好的应用程序。

插件salah安装

要安装 salah，只需在终端运行以下命令：

flutter pub add --dev salah

使用插件salah

一旦 salah 安装完成，你可以在终端中使用以下命令：

创建新的项目结构

flutter pub run salah start

此命令会创建一个带有预设文件和扩展的新项目，例如路由管理、图像管理、图标管理、字符串管理和Clean Architecture架构。

标志

• --force: 此标志强制创建新项目并删除现有文件。

你的项目将看起来像这样：

创建函数

flutter pub run salah add-function <function_name>

此命令会在存储库及其实现、远程数据源（如果你使用 --local 会创建在本地数据源文件中）以及负责从API获取数据的 appApi 类中创建文件 <function_name>_usecase.dart 和函数。

标志

• -attr: 用于附加到函数的属性。

  flutter pub run salah add-function login -attr username:String password:String
  

• -response: 用于附加API预期响应。

  flutter pub run salah add-function login -response token:String balance:double
  

  如果你想获取对象列表，例如获取产品列表，可以简单地添加前缀 listof 并指定每个产品的详细信息。

  flutter pub run salah add-function getProducts -response listof title:String description:String price:double images:List<String>
  

• -modelname: 当你希望模型名称与函数名称不同时使用。

  flutter pub run salah add-function getUser -response username:String email:String image:String -modelname user
  

• -endpoint 和 -method: 用于指定HTTP请求的端点和使用的请求方法（GET、POST等）。

  salah add-function getUser -response username:String email:String image:String -modelname user -endpoint "auth/user" -method GET
  

• --local: 用于将函数添加到本地数据源，例如从用户设备获取数据如图片或联系人。

  salah add-function getContacts --local -response listof name:String phone:String
  

实时示例

执行以下命令的结果：

flutter pub run salah add-function login -attr username:String password:String -response token:String balance:double

所有这些代码都是自动生成的。

创建屏幕/视图

flutter pub run salah create-view <screen/view-name>

此命令会在 presentation/views/ 目录下创建一个屏幕，并将其添加到 Routes 类中。

实时示例

执行以下命令的结果：

flutter pub run salah create-view home

创建视图模型/控制器

flutter pub run salah create-viewmodel <viewmodel-name>

此命令会在 presentation/view_models 目录下创建一个视图模型文件。

实时示例

执行以下命令的结果：

flutter pub run salah create-viewmodel home

创建小部件

flutter pub run salah create-widget <widget-name>

此命令会在 presentation/widgets 目录下创建一个小部件文件。

实时示例

执行以下命令的结果：

flutter pub run salah create-widget defaultButton