Flutter插件unruffled的使用_Unruffled 是一个轻量级且可定制的 HTTP 客户端，允许你轻松创建离线优先的应用

享受定制化的离线优先REST API客户端

Unruffled 是一个轻量级且可定制的 HTTP 客户端，允许你轻松创建离线优先的应用。

Flutter插件unruffled特性

• 🧘 通过自动管理离线存储和连接错误来确保安全
• 🚀 非常可定制
• 💻 支持所有平台
• 🤖 直观简单的API
• 🔒 使用Hive进行强加密

Flutter插件unruffled开始使用

查看快速入门文档以开始使用。

快速开始

1. 添加到 pubspec.yaml

dependencies:
  json_annotation: ^4.5.0
  unruffled: ^1.0.0

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

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

2. 声明模型

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

@UnruffledData()
@JsonSerializable()
class User extends DataModel<User> {
  @Id()
  int? id;
  
  String name;
  
  String surname;
  
  int age;

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

构建你的 Flutter 项目以生成 UserRepository()。

flutter pub run build_runner build

注意：你的类必须调用 super.unruffledKey。

• unruffledKey 指的是由 unruffled 生成的本地对象ID。

3. 注册适配器

对于除Web以外的所有平台，使用 <a href="https://pub.dev/packages/path_provider">path_provider</a> 生成目录路径。

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

4. 初始化 Unruffled

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

await unruffled.init();

🚀 就这样，你已经准备好了！

使用方法

1. 创建用户

定义一个用户并调用用户仓库。

final testUser = User(name: 'John', surname: 'Doe');
final repository = unruffled.repository<User>();

通过调用 post() 方法创建用户。

var user = await repository.post(model: testUser);

2. 获取用户

var user = await repository.get(key: user.key);

3. 删除用户

var user = await repository.delete(key: user.key);

4. 查询用户

QueryBuilder 允许你在查询中应用过滤条件。

过滤条件将自动应用于本地查询。 要启用远程查询中的过滤条件，必须实现以下方法：

注意：要获取完整的示例，请检查 unruffled_feathersjs。

mixin CustomRemoteRepository<T extends DataModel<T>> on RemoteRepository<T> {
  @override
  Map<String, dynamic> parseLimit(int limit) => {};

  @override
  Map<String, dynamic> parsePage(int page) => {};

  @override
  Map<String, dynamic> parseSort(SortCondition<R> sort) => {};
  
  @override
  Map<String, dynamic> parseEqual(FilterCondition<T> condition) => {};

  @override
  Map<String, dynamic> parseNotEqual(FilterCondition<T> condition) => {};

  @override
  Map<String, dynamic> parseGreaterThan(FilterCondition<T> condition) => {};

  @override
  Map<String, dynamic> parseLessThan(FilterCondition<T> condition) => {};

  @override
  Map<String, dynamic> parseInValues(FilterCondition<T> condition) => {};

  @override
  Map<String, dynamic> parseOrCondition(List<FilterOperation<T>> operations) => {};

  @override
  Map<String, dynamic> parseAndCondition(List<FilterOperation<T>> operations) => {};
}

QueryBuilder 的使用方法：

List<User> users = await repository.getAll(
  queryBuilder: QueryBuilder(
    filterGroup: FilterGroup.or(
      filters: [
        FilterCondition.equal(property: UserField.surname(), value: 'Doe'),
        FilterCondition.greaterThan(property: UserField.age(), value: 18, include: true),
      ],
    ),
    limit: 10,
    page: 1,
    sort: SortCondition(property: UserField.age(), sort: SortType.desc),
  ),
);

5. 管理连接问题

如果出现连接错误，Unruffled 会自动存储请求以便稍后重试。只需调用全局方法：

final operations = unruffled.offlineOperations;
for (var remoteRepository in operations.keys) {
  await operations[remoteRepository].retry(remoteRepository);
}

或者为每个远程仓库调用：

final operations = repository.offlineOperations;
for (var operation in operations) {
  await operation.retry(repository);
}