Flutter数据库交互插件 brick_supabase 的使用

brick_supabase 是一个用于在 Flutter 应用中与 Supabase 数据库进行交互的插件。它基于 Brick 框架，提供了便捷的模型定义和查询功能。本文将详细介绍如何使用 brick_supabase 进行数据库操作，并提供完整的示例代码。

支持的查询配置

where:

Brick 目前不支持 Supabase 的所有过滤方法。在构建 Brick 查询时，请参考以下对比表：

模型定义

@SupabaseSerializable(tableName:)

指定 Supabase 表名以连接 from、upsert 和 delete 调用：

@SupabaseSerializable(tableName: 'users')
class User {
  final String name;

  User({required this.name});
}

@SupabaseSerializable(fieldRename:)

默认情况下，Brick 假设 Dart 字段名是 Supabase 列名的驼峰版本（例如 final String lastName => 'last_name'）。可以通过设置 fieldRename 来重命名所有字段：

@SupabaseSerializable(fieldRename: FieldRename.pascal)
class User {
  final String lastName;
}

fieldRename 只是默认转换方式，可以使用 @Supabase(name:) 对单个字段进行覆盖。

@SupabaseSerializable(defaultToNull:)

在 upsert 操作期间转发到 Supabase 的 defaultToNull。

@SupabaseSerializable(ignoreDuplicates:)

在 upsert 操作期间转发到 Supabase 的 ignoreDuplicates。

@SupabaseSerializable(onConflict:)

在 upsert 操作期间转发到 Supabase 的 onConflict。

字段注解

@Supabase(unique:)

连接 Supabase 的主键或任何其他索引到应用程序代码，这对 upsert 和 delete 操作非常有用：

@Supabase(unique: true, name: 'uuid')
final String supabaseUuid;

@Supabase(enumAsString:)

如果 API 返回的是字符串而不是整数，则可以使用此注解：

enum Hat { baseball, bowler, birthday }

@Supabase(enumAsString: true)
final List<Hat> hats;

@Supabase(name:)

重命名 Supabase 键名：

@Supabase(name: "full_name")
final String lastName;

@Supabase(foreignKey:)

当字段类型扩展模型类型时，Supabase 列应为外键：

class User extends OfflineFirstWithSupabaseModel {
  @Supabase(foreignKey: 'address_id')
  final Address address;
}

class Address extends OfflineFirstWithSupabaseModel {
  final String id;
}

@Supabase(ignoreFrom:) 和 @Supabase(ignoreTo:)

当为 true 时，字段将被忽略，不会参与序列化或反序列化。

测试

Mocking a Supabase Instance

在测试组中快速创建一个方便的模拟服务器：

import 'package:brick_supabase/testing.dart';
import 'package:test/test.dart';

void main() {
  final mock = SupabaseMockServer(modelDictionary: supabaseModelDictionary);

  group('MyClass', () {
    setUp(mock.setUp);
    tearDown(mock.tearDown);

    test('#myMethod', () async {
      final req = SupabaseRequest<MyModel>();
      final resp = SupabaseResponse([
        await mock.serialize(MyModel(name: 'Demo 1', id: '1')),
        await mock.serialize(MyModel(name: 'Demo 2', id: '2')),
      ]);
      mock.handle({req: resp});
      final provider = SupabaseProvider(mock.client, modelDictionary: supabaseModelDictionary);
      final retrieved = await provider.get<MyModel>();
      expect(retrieved, hasLength(2));
    });
  });
}

示例代码

以下是一个完整的示例代码，展示了如何使用 brick_supabase 进行基本的 CRUD 操作：

import 'package:brick_core/core.dart';
import 'package:brick_supabase/brick_supabase.dart';
import 'package:supabase/supabase.dart';

/// 生成的适配器类
class UserAdapter extends SupabaseAdapter<User> {
  @override
  Future<User> fromSupabase(data, {required provider, repository}) async {
    return User(
      name: data['name'],
    );
  }

  @override
  Future<Map<String, dynamic>> toSupabase(instance, {required provider, repository}) async {
    return {
      'name': instance.name,
    };
  }

  @override
  final defaultToNull = false;
  @override
  final fieldsToSupabaseColumns = {'name': RuntimeSupabaseColumnDefinition(columnName: 'name')};
  @override
  final ignoreDuplicates = false;
  @override
  final onConflict = null;
  @override
  final tableName = 'users';
  @override
  final uniqueFields = {};
}

/// 生成的字典
final dictionary = SupabaseModelDictionary({
  User: UserAdapter(),
});

/// 定义模型
class User extends SupabaseModel {
  final String name;

  User({required this.name});
}

/// 定义仓库
class MyRepository extends SingleProviderRepository<SupabaseModel> {
  MyRepository(String apiUrl, String supabaseAnonKey)
      : super(
          SupabaseProvider(
            SupabaseClient(apiUrl, supabaseAnonKey),
            modelDictionary: dictionary,
          ),
        );
}

void main() async {
  final repository = MyRepository('http://localhost:8080', 'YOUR_API_KEY_HERE');

  // 获取用户列表
  final users = await repository.get<User>();
  print(users);

  // 创建新用户
  final newUser = User(name: 'John Doe');
  await repository.upsert(newUser);

  // 更新用户信息
  final updatedUser = User(name: 'Jane Doe');
  await repository.upsert(updatedUser);

  // 删除用户
  await repository.delete<User>(id: 'user_id');
}

以上代码展示了如何定义模型、适配器、字典以及如何使用仓库进行数据操作。希望这些内容能帮助你更好地理解和使用 brick_supabase 插件。