Flutter自定义框架插件md_framework的使用

发布于 1周前 作者 sinazl 来自 Flutter

Flutter自定义框架插件md_framework的使用

MDFramework SDK

描述

这是用于MDFramework的一个软件开发工具包。它是一系列可以用来开发MDFramework应用程序的工具和库。

使用方法

在Main.dart中添加以下代码

MDInit.initialize(
 apiToken: YourApiToken,
 dataToken: YourDataToken,
 encryptKey: YourEncryptKey,
);

示例

1. DoTransaction

MDResponse res = await MDRepo().doTransaction(
 tableName: tableName,
 dataToken: ApiConstants.dataToken,

 columnValues: [
 // 列值列表
 "name", "email", "password"
 ],
 action: WantedAction.insert);
  • tableName: 您想要执行事务的表名。
  • columnValues: 您希望插入到表中的列值列表。
  • action: 您希望在表上执行的操作。它可以是insert, updatedelete
  • dataToken 是可选参数。
  • 响应以一个MDResponse对象形式返回。

2. Execute Procedure

res = await MDRepo().executeProcedure(
 procedureName: ApiConstants.loginProcedure,
 dataToken: ApiConstants.dataToken,
 columnValues: [emailController.text, passwordController.text]);
  • procedureName: 您想要执行的过程名。
  • dataToken 是可选参数。
  • columnValues: 您希望传递给过程的列值列表。
  • 响应以一个MDResponse对象形式返回。

3. DoMultiTransaction

MDResponse res = await MDReop().doMultiTransaction(
 tableNames: [
 "table1",
 "table2",
 ],
 dataToken: ApiConstants.dataToken,
 columnValues: [
 ["列值列表for table1"],
 ["列值列表for table2"],
 ],
 action: WantedAction.insert,
);
  • tableNames: 您希望执行事务的表名列表。
  • columnValues: 您希望插入到表中的列值列表的列表。
  • action: 您希望对表执行的操作。它可以是insert, updatedelete
  • dataToken 是可选参数。
  • 响应以一个MDResponse对象形式返回。

4. UploadFile

MDResponse res = await MDRepo().uploadFile(
 image: file,
 fileType: fileExtension,
 wantedAction: WantedAction.insert,
);
  • image: 您要上传的文件。
  • fileType: 您要上传的文件的扩展名。
  • wantedAction: 您希望对文件执行的操作。它可以是insert, updatedelete
  • 响应以一个MDResponse对象形式返回。

5. sendOtp

MDResponse res = await _mdRepo.sendOtp(
 functionName: sendOtpFunction,
 procedureName: checkOtpProcedure,
 otpType: OtpType.email,
 parametersValues: [0, email],
 to: email);
  • functionName: 您想要调用的函数名(在发送OTP之前由后端提供)。
  • procedureName: 您想要调用的过程名(在发送OTP之后由后端提供)。
  • otpType: 您希望发送的OTP类型。它可以是emailphone
  • parametersValues: 您希望传递给过程的参数列表。第一个参数为0表示验证,1表示重置密码。
  • to: 您希望发送OTP的电子邮件地址或电话号码。
  • 响应以一个MDResponse对象形式返回,并包含用于verifyOtp函数的otpToken

6. verifyOtp

MDResponse res = await _mdRepo.verifyOtp(
 otpToken: token,
 otp: otp);
  • otpToken: 您从sendOtp函数接收到的OTP令牌。
  • otp: 您希望验证的OTP。
  • 响应以一个MDResponse对象形式返回。
  • 如果OTP成功验证,响应的状态为200。

安装

dependencies:
  md_framework: latest_version

更多关于Flutter自定义框架插件md_framework的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter自定义框架插件md_framework的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


当然,下面是一个关于如何在Flutter项目中自定义并使用一个名为 md_framework 的框架插件的示例代码。这个示例将展示如何创建一个简单的自定义框架插件,并在Flutter应用中使用它。

1. 创建自定义框架插件 md_framework

首先,假设我们已经创建了一个Flutter插件项目 md_framework。插件项目的结构通常包含以下文件和目录:

md_framework/
├── example/
│   └── ... (Flutter应用示例)
├── lib/
│   └── md_framework.dart (插件的主要代码)
├── pubspec.yaml
└── README.md

lib/md_framework.dart 中,我们定义一个简单的自定义Widget:

// lib/md_framework.dart
import 'package:flutter/material.dart';

class MyCustomButton extends StatelessWidget {
  final String text;
  final VoidCallback onPressed;

  const MyCustomButton({Key? key, required this.text, required this.onPressed}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    return ElevatedButton(
      onPressed: onPressed,
      child: Text(text),
      style: ButtonStyle(
        backgroundColor: MaterialStateProperty.all(Colors.blue),
        foregroundColor: MaterialStateProperty.all(Colors.white),
      ),
    );
  }
}

pubspec.yaml 中,确保插件的基本信息已经填写好:

name: md_framework
description: A custom Flutter framework plugin.
version: 0.0.1
author: Your Name <your.email@example.com>
homepage: https://github.com/yourusername/md_framework

environment:
  sdk: ">=2.12.0 <3.0.0"
  flutter: ">=1.20.0"

dependencies:
  flutter:
    sdk: flutter

dev_dependencies:
  flutter_test:
    sdk: flutter

flutter:

2. 在Flutter应用中使用 md_framework

现在,我们创建一个Flutter应用来使用我们自定义的 md_framework 插件。

假设我们已经在 md_framework/example/ 目录下有一个Flutter应用,或者在另一个独立的Flutter项目中,我们需要在 pubspec.yaml 文件中添加对 md_framework 插件的依赖。由于 md_framework 是本地插件,我们可以使用路径依赖:

dependencies:
  flutter:
    sdk: flutter
  md_framework:
    path: ../  # 假设 md_framework 插件项目位于当前项目的上一级目录

然后,在Flutter应用的 lib/main.dart 文件中使用我们自定义的 MyCustomButton Widget:

// lib/main.dart
import 'package:flutter/material.dart';
import 'package:md_framework/md_framework.dart'; // 导入自定义插件

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(),
    );
  }
}

class MyHomePage extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Custom Framework Demo'),
      ),
      body: Center(
        child: MyCustomButton(
          text: 'Click Me',
          onPressed: () {
            ScaffoldMessenger.of(context).showSnackBar(
              SnackBar(content: Text('Button Clicked!')),
            );
          },
        ),
      ),
    );
  }
}

3. 运行应用

确保你的开发环境已经正确配置了Flutter和Dart SDK,然后在命令行中运行以下命令来启动Flutter应用:

flutter run

这将启动你的Flutter应用,你应该能看到一个带有自定义按钮的界面。点击按钮时,会显示一个SnackBar提示“Button Clicked!”。

这样,你就成功创建了一个简单的自定义Flutter框架插件 md_framework,并在Flutter应用中使用了它。

回到顶部