Flutter插件unruffled_feathersjs的使用方法详解

Flutter插件unruffled_feathersjs的使用方法详解

Unruffled x FeathersJS

unruffled_feathersjs 是一个用于 Flutter 的 FeathersJS 客户端，它默认支持离线管理。

快速开始

1. 添加到 pubspec.yaml

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

dependencies:
  json_annotation: ^4.5.0
  unruffled_feathersjs: ^1.5.0

dev_dependencies:
  build_runner: any
  json_serializable: ^6.2.0
  unruffled_generator: ^1.2.0

注意： Unruffled 依赖于 json_annotation 和 json_serializable 来正常工作，请确保将它们添加到你的依赖项中。

2. 声明模型

声明远程服务使用的模型，并生成 Unruffled 适配器。

import 'package:json_annotation/json_annotation.dart';
import 'package:unruffled_feathersjs/unruffled_feathersjs.dart';

// 使用注解生成适配器
@UnruffledFeathersJsData()
[@JsonSerializable](/user/JsonSerializable)()
class User extends DataModel<User> {
  [@override](/user/override)
  [@JsonKey](/user/JsonKey)(name: '_id') // 例如 MongoDB 对象具有 '_id' 作为唯一标识符
  int? id;

  String name;
  String surname;
  int age;

  User({
    super.key,
    this.id,
    required this.name,
    required this.surname,
    required this.age,
  });

  // 自动生成 JSON 序列化方法
  factory User.fromJson(Map<String, dynamic> json) => _$UserFromJson(json);
  Map<String, dynamic> toJson() => _$UserToJson(this);
}

构建你的 Flutter 项目以生成 UserAdapter()：

flutter pub run build_runner build

注意： 你的类必须包含 String? key 和 Object? id，并将其传递给 super()。

• id 指的是远程对象的 ID。
• key 指的是由 Unruffled 生成的本地对象 ID。

3. 注册适配器

对于非 Web 平台，使用 path_provider 包来生成目录路径。

import 'package:path_provider/path_provider.dart';

final dir = await getApplicationSupportDirectory(); // path_provider 包
var unruffled = UnruffledFeathersJs(
      baseDirectory: dir,
      defaultBaseUrl: 'http://example.com',
  )
  .registerRepository(UserRepository());

4. 初始化 Unruffled

在使用 Unruffled 之前，请确保初始化它。

await unruffled.init();

🚀 这样就完成了！你可以开始使用了！

使用方法

unruffled_feathersjs 提供默认的身份验证和刷新令牌方法，如果需要可以覆盖这些方法。

1. 身份验证

final data = {
  "email": "test@test.com",
  "password": "test123",
  "strategy": "local",
};

Map<String, dynamic> result = await unruffled.authenticate(body: data);

默认情况下，unruffled_feathersjs 使用 DefaultTokenStorageImpl() 自动保存访问令牌并在 Authorization 头部中传递。对于更复杂的情况，你可以通过创建 UnruffledFeathersJs 的混入类或添加 Dio 拦截器来自定义实现。

2. 其他功能

unruffled_feathersjs 扩展了 unruffled，更多文档请查看包的 官方文档。

示例代码

以下是完整的示例代码：

import 'package:flutter/material.dart';
import 'package:path_provider/path_provider.dart';
import 'package:unruffled_feathersjs/unruffled_feathersjs.dart';
import 'package:json_annotation/json_annotation.dart';

// 用户模型
[@JsonSerializable](/user/JsonSerializable)()
class User extends DataModel<User> {
  [@override](/user/override)
  [@JsonKey](/user/JsonKey)(name: '_id')
  int? id;

  String name;
  String surname;
  int age;

  User({
    super.key,
    this.id,
    required this.name,
    required this.surname,
    required this.age,
  });

  factory User.fromJson(Map<String, dynamic> json) => _$UserFromJson(json);
  Map<String, dynamic> toJson() => _$UserToJson(this);
}

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  // 初始化路径
  final dir = await getApplicationSupportDirectory();
  var unruffled = UnruffledFeathersJs(
        baseDirectory: dir,
        defaultBaseUrl: 'http://example.com',
    )
    .registerRepository(UserRepository());

  // 初始化 Unruffled
  await unruffled.init();

  // 身份验证
  final data = {
    "email": "test@test.com",
    "password": "test123",
    "strategy": "local",
  };

  Map<String, dynamic> result = await unruffled.authenticate(body: data);

  print('身份验证结果: $result');
}