Flutter集成Appwrite服务插件appwrite_test的使用

集成

在 pubspec.yaml 文件中添加以下依赖：

dart pub add appwrite_test

如何使用

引入库

首先，在项目中引入 appwrite_test 库：

import 'package:appwrite_test/appwrite_test.dart';

添加测试上下文

创建一个 bin/main.dart 文件，并添加以下代码。这些参数用于模拟运行时环境，可以通过打印日志查看配置是否正确。

// 引入必要的库
import 'package:appwrite_test/appwrite_test.dart';

// 定义测试上下文
Future<void> main(List<String> args) async {
  final context = TestContext({
    "APPWRITE_API_KEY": "xxx", // 替换为你的API密钥
    "APPWRITE_FUNCTION_RUNTIME_NAME": "Dart",
    "HOSTNAME": "xxx",
    "HOME": "/root",
    "OLDPWD": "/usr/local/server",
    "PATH": "/usr/lib/dart/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin",
    "APPWRITE_FUNCTION_NAME": "xxx",
    "INERNAL_EXECUTOR_HOSTNAME": "exc3",
    "OPEN_RUNTIMES_ENTRYPOINT": "lib/main.dart",
    "APPWRITE_FUNCTION_RUNTIME_VERSION": "2.17",
    "APPWRITE_FUNCTION_ID": "xxx",
    "DART_SDK": "/usr/lib/dart",
    "PWD": "/usr/local/server",
    "OPEN_RUNTIMES_HOSTNAME": "exc3",
    "APPWRITE_FUNCTION_DEPLOYMENT": "xxx",
    "APPWRITE_FUNCTION_PROJECT_ID": "xxx",
    "OPEN_RUNTIMES_SECRET": "xxx",
    "GLIBCPP_FORCE_NEW": "1",
    "GLIBCXX_FORCE_NEW": "1"
  });

  // 初始化数据库并运行测试
  await init_db.main(context);
}

在 ./main.dart 中调用

在主文件中调用 RunMain 来执行测试逻辑：

// 引入必要的库
import 'package:appwrite_test/appwrite_test.dart';

// 定义主函数
Future<dynamic> main(final context) {
  // 创建并运行测试
  return RunMain(actors: []).run(context);
}

这样，你就可以在编辑器中方便地调试代码了。

新建 Actor

接下来，我们可以在对应的 Actor 中实现具体的业务逻辑。例如，定义一个 FetchVersionActor 来获取版本信息。

示例代码

// 引入必要的库
import 'package:appwrite_test/appwrite_test.dart';

// 定义自定义 Actor
class FetchVersionActor extends Actor {
  // 构造函数
  FetchVersionActor({required super.context});

  // 定义 Actor 的路径
  [@override](/user/override)
  String get path => '/fetchVersion';

  // 实现具体的业务逻辑
  [@override](/user/override)
  Future<ActorResponse> runActor() async {
    // 解析请求体中的参数
    final platform = JSON(context.req.bodyRaw)['platform'].string;
    final version = JSON(context.req.bodyRaw)['version'].string;

    // 检查参数是否存在
    if (platform == null) {
      return ActorResponse.failure(-1, 'platform 参数不存在!');
    }
    if (version == null) {
      return ActorResponse.failure(-1, 'version 参数不存在!');
    }

    // 查询数据库中的文档
    final documentList = await databases.listDocuments(
      databaseId: 'shorebird_patchs',
      collectionId: 'versions',
      queries: [
        Query.equal('platform', platform),
      ],
    );

    // 筛选符合条件的文档
    final documents = documentList.documents.where((element) {
      return Version.parse(JSON(element.data)['version'].stringValue) >
          Version.parse(version);
    });

    // 返回结果
    if (documents.isEmpty) {
      return ActorResponse.success();
    } else {
      return ActorResponse.success(documents.last.toMap());
    }
  }
}