搜索插件、代码仓与 APP 分类

插件详情v28.3.0

appwrite

Appwrite 是一个开源的自托管后端服务器,它通过非常简单的 REST API 抽象并简化了复杂且重复的开发任务。

AndroidiOSWebmacOSWindowsLinux
近 30 天下载
1.6万
喜欢数
581
Pub 分数
130

安装插件

flutter pub add appwrite

插件介绍

基于插件公开信息、社区数据与项目使用情况整理的选型参考。

Appwrite 是一个开源的自托管后端服务器,通过简洁的 REST API 简化后端开发。它处理常见的任务,如身份验证、文件存储、数据库管理以及实时更新,使开发者能够专注于构建应用功能。Flutter SDK 可实现跨平台应用程序(包括 Android、iOS、Web、macOS、Windows 和 Linux)的无缝集成。通过完全掌控部署和数据,Appwrite 支持快速原型设计和可扩展的生产级应用,无需依赖第三方服务。

适合场景

  • 构建跨平台移动和网页应用
  • 实现用户身份验证和授权
  • 管理基于云的文件存储
  • 处理实时数据同步
  • 创建可扩展的后端服务
  • 启用离线优先的应用功能

主要特点

  • 自托管后端解决方案
  • 简单的 REST API 接口
  • 对多平台的支持
  • 内置的认证系统
  • 实时数据库和事件监听器
  • 安全的文件存储和访问控制

适合对象

  • 寻求轻量级后端的Flutter开发人员
  • 初创企业需要经济实惠的后端基础设施
  • 希望对其数据拥有完全控制权的团队
  • 需要快速开发周期的项目
  • 需要实时功能的应用程序
  • 开发人员避免供应商锁定

使用建议

  • 需要服务器设置和维护
  • 新用户的初始学习曲线
  • 自托管的资源需求
  • 有限的内置分析和监控
  • 依赖稳定的互联网连接进行远程托管
  • 在生产环境中可能需要额外的安全加固

原始 README

以下为关联源码仓库的 README 原文快照,最新内容请访问源码仓库。

Appwrite Flutter SDK

pub package License Version Build Status Twitter Account Discord

This SDK targets Appwrite server version 2.0.x as shipped on Appwrite Cloud. Self-hosted releases can lag behind Cloud — if you run an older self-hosted build, use a matching older SDK from previous releases when APIs differ.

Appwrite is an open-source backend as a service server that abstracts and simplifies complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way. Use the Flutter SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools. For full API documentation and tutorials go to https://appwrite.io/docs

Appwrite

Installation

Add this to your package's pubspec.yaml file:

dependencies:
  appwrite: ^26.2.0

You can install packages from the command line:

flutter pub add appwrite

Getting Started

Add your Flutter Platform

To init your SDK and start interacting with Appwrite services, you need to add a new Flutter platform to your project. To add a new platform, go to your Appwrite console, choose the project you created in the step before, and click the 'Add Platform' button.

From the options, choose to add a new Flutter platform and add your app credentials. Appwrite Flutter SDK currently supports building apps for Android, iOS, Linux, Mac OS, Web and Windows.

If you are building your Flutter application for multiple devices, you have to follow this process for each different device.

Android

For Android first add your app name and package name, Your package name is generally the applicationId in your app-level build.gradle file. By registering your new app platform, you are allowing your app to communicate with the Appwrite API.

In order to capture the Appwrite OAuth callback url, the following activity needs to be added inside the <application> tag, along side the existing <activity> tags in your AndroidManifest.xml. Be sure to replace the [PROJECT_ID] string with your actual Appwrite project ID. You can find your Appwrite project ID in your project settings screen in the console.

<manifest ...>
    ....
    <application ...>
        ....
        <!-- Add this inside the <application> tag, alongside the existing <activity> tags -->
        <activity android:exported="true" android:name="com.linusu.flutter_web_auth_2.CallbackActivity" >
            <intent-filter android:label="flutter_web_auth_2">
                <action android:name="android.intent.action.VIEW" />
                <category android:name="android.intent.category.DEFAULT" />
                <category android:name="android.intent.category.BROWSABLE" />
                <data android:scheme="appwrite-callback-[PROJECT_ID]" />
            </intent-filter>
        </activity>
    </application>
</manifest>
iOS

For iOS first add your app name and Bundle ID, You can find your Bundle Identifier in the General tab for your app's primary target in Xcode.

The Appwrite SDK uses ASWebAuthenticationSession on iOS 12+ and SFAuthenticationSession on iOS 11 to allow OAuth authentication. You have to change your iOS Deployment Target in Xcode to be iOS >= 11 to be able to build your app on an emulator or a real device.

  1. In Xcode, open Runner.xcworkspace in your app's ios folder.
  2. To view your app's settings, select the Runner project in the Xcode project navigator. Then, in the main view sidebar, select the Runner target.
  3. Select the General tab.
  4. In Deployment Info, 'Target' select iOS 11.0
Linux

For Linux add your app name and package name, Your package name is generally the name in your pubspec.yaml file. If you cannot find the correct package name, run the application in linux, and make any request with proper exception handling, you should get the application ID needed to add in the received error message.

macOS

For macOS add your app name and Bundle ID, You can find your Bundle Identifier in the General tab for your app's primary target in Xcode.

The Appwrite SDK uses ASWebAuthenticationSession on macOS 10.15+ to allow OAuth authentication. You have to change your macOS Deployment Target in Xcode to be macOS >= 10.15 to be able to build your app for macOS.

Web

Appwrite 0.7, and the Appwrite Flutter SDK 0.3.0 have added support for Flutter Web. To build web apps that integrate with Appwrite successfully, all you have to do is add a web platform on your Appwrite project's dashboard and list the domain your website will use to allow communication to the Appwrite API.

For web in order to capture the OAuth2 callback URL and send it to the application using JavaScript postMessage(), you need to create an html file inside ./web folder of your Flutter project. For example auth.html with the following content.

<!DOCTYPE html>
<title>Authentication complete</title>
<p>Authentication is complete. If this does not happen automatically, please close the window.</p>
<script>
  function postAuthenticationMessage() {
    const message = {
      'flutter-web-auth-2': window.location.href
    };

    if (window.opener) {
      window.opener.postMessage(message, window.location.origin);
      window.close();
    } else if (window.parent && window.parent !== window) {
      window.parent.postMessage(message, window.location.origin);
    } else {
      localStorage.setItem('flutter-web-auth-2', window.location.href);
      window.close();
    }
  }

  postAuthenticationMessage();
</script>

Redirection URL passed to the authentication service must be the same as the URL on which the application is running (schema, host, port if necessary) and the path must point to created HTML file, /auth.html in this case. The callbackUrlScheme parameter of the authenticate() method does not take into account, so it is possible to use a schema for native platforms in the code.

Flutter Web Cross-Domain Communication & Cookies

While running Flutter Web, make sure your Appwrite server and your Flutter client are using the same top-level domain and the same protocol (HTTP or HTTPS) to communicate. When trying to communicate between different domains or protocols, you may receive HTTP status error 401 because some modern browsers block cross-site or insecure cookies for enhanced privacy. In production, Appwrite allows you set multiple custom-domains for each project.

Windows

For Windows add your app name and package name, Your package name is generally the name in your pubspec.yaml file. If you cannot find the correct package name, run the application in windows, and make any request with proper exception handling, you should get the application id needed to add in the received error message.

Init your SDK

Initialize your SDK with your project ID, which can be found in your project settings page.

Client client = Client().setProject('<YOUR_PROJECT_ID>');

If using a self-hosted instance, you will also need to set your Appwrite endpoint using the setEndpoint method. Before starting to send any API calls to your new Appwrite instance, make sure your Android or iOS emulators has network access to the Appwrite server hostname or IP address. When trying to connect to a local Appwrite instance from an emulator or a mobile device, localhost is the hostname for the device or emulator and not your machine. You should replace localhost with your machine's private IP as the Appwrite endpoint's hostname (e.g. 192.168.1.100). You can also use a service like ngrok to proxy the Appwrite API.

Make Your First Request

Once your SDK object is set, access any of the Appwrite services and choose any request to send. Full documentation for any service method you would like to use can be found in your SDK documentation or in the [API References](https://appwrite.io/docs) section.

Account account = Account(client);

User user = await account.create(
  userId: ID.unique(),
  email: 'email@example.com',
  password: 'password',
  name: 'Walter O'Brien',
);
Full Example
Client client = Client().setProject('<YOUR_PROJECT_ID>>');

Account account = Account(client);

User user = await account.create(
  userId: ID.unique(),
  email: 'email@example.com',
  password: 'password',
  name: 'Walter O'Brien'
);
Error Handling

The Appwrite Flutter SDK raises AppwriteException object with message, type, code and response properties. You can handle any errors by catching AppwriteException and present the message to the user or handle it yourself based on the provided error information. Below is an example.

try {
  User user = await account.create(...);
} on AppwriteException catch(e) {
  // Handle the exception
}
Learn more

You can use the following resources to learn more and get help

Contribution

This library is auto-generated by Appwrite custom SDK Generator. To learn more about how you can help us improve this SDK, please check the contribution guide before sending a pull-request.

License

Please see the BSD-3-Clause license file for more information.

所属分类

依赖

依赖清单 12 项

源码仓库

使用此插件的项目