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

Appwrite Dart SDK

注意：此SDK兼容Appwrite服务器版本1.6.x。对于旧版本，请查看历史版本。

此Dart SDK用于从Dart服务端代码集成Appwrite。如果您正在寻找Flutter SDK，请参考appwrite/sdk-for-flutter。

Appwrite是一个开源的后端即服务（BaaS）服务器，旨在简化复杂的开发任务，并提供简单易用的REST API。通过Dart SDK，您可以轻松地将应用程序与Appwrite服务器集成，从而与所有Appwrite后端API和工具进行交互。有关完整API文档和教程，请访问官方文档。

安装

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

dependencies:
  dart_appwrite: ^12.1.0

您可以通过命令行安装包：

dart pub add dart_appwrite

入门指南

初始化并发起API请求

一旦添加了依赖项，使用SDK非常简单；只需在代码中导入该包，设置Appwrite凭据，然后开始发起API调用。下面是一个简单的示例：

import 'package:dart_appwrite/dart_appwrite.dart';

void main() async {
  Client client = Client()
    .setEndpoint('http://[HOSTNAME_OR_IP]/v1') // 确保您的端点可访问
    .setProject('5ff3379a01d25') // 您的项目ID
    .setKey('cd868c7af8bdc893b4...93b7535db89')
    .setSelfSigned(); // 仅在开发模式下使用自签名SSL证书时使用

  Users users = Users(client);

  try {
    final user = await users.create(
      userId: ID.unique(),
      email: "email@example.com",
      phone: "+123456789",
      password: "password",
      name: "Walter O'Brien"
    );
    print(user.toMap());
  } on AppwriteException catch(e) {
    print(e.message);
  }
}

错误处理

Appwrite Dart SDK会抛出带有message、code和response属性的AppwriteException对象。您可以通过捕获AppwriteException来处理任何错误，并根据提供的错误信息向用户显示消息或自行处理。以下是示例：

Users users = Users(client);

try {
  final user = await users.create(
    userId: ID.unique(),
    email: "email@example.com",
    phone: "+123456789",
    password: "password",
    name: "Walter O'Brien"
  );
  print(user.toMap());
} on AppwriteException catch(e) {
  // 向用户显示消息或根据需要执行其他操作
  print(e.message);
}

示例代码

初始化Appwrite客户端

Client client = Client();

client
    .setEndpoint('https://localhost/v1') // 您的Appwrite端点
    .setProject('5e8cf4f46b5e8') // 您的项目ID
    .setSelfSigned() // 生产环境中移除
;

创建新用户

Users users = Users(client);

User result = await users.create(
    userId: ID.unique(),
    email: "email@example.com",
    phone: "+123456789",
    password: "password",
    name: "Walter O'Brien"
);

获取用户资料

Users users = Users(client);

User profile = await users.get(
    userId: '[USER_ID]',
);

上传文件

Storage storage = Storage(client);

InputFile file = InputFile(path: './path-to-file/image.jpg', filename: 'image.jpg');

storage.createFile(
    bucketId: '[BUCKET_ID]',
    fileId: '[FILE_ID]', // 使用'unique()'自动生成唯一ID
    file: file,
    permissions: [
      Permission.read(Role.any()),
    ],
)
.then((response) {
    print(response); // 文件已上传！
})
.catchError((error) {
    print(error.response);
});

所有示例和API功能都可以在官方Appwrite文档中找到。

更多资源

• 🚀 入门教程
• 📜 Appwrite文档
• 💬 Discord社区
• 🚂 Appwrite Dart Playground

贡献

本库由Appwrite自定义SDK生成器自动生成。有关如何帮助我们改进此SDK的信息，请在发送拉取请求之前阅读贡献指南。

许可证

请参阅BSD-3-Clause许可证以获取更多信息。