Flutter插件tio的使用_tio是一个基于 dio 的简单包装器，具有响应类型化和完整的向后兼容性

Flutter插件tio的使用_tio是一个基于 dio 的简单包装器，具有响应类型化和完整的向后兼容性

Flutter插件tio简介

tio 是一个基于 dio 的简单包装器，具有响应类型化和完整的向后兼容性。灵感来源于 chopper。

请注意，此插件目前处于测试阶段，使用时请谨慎。

Flutter插件tio特性

• 安全地对成功和失败的响应进行类型化。
• 预期的行为。
• 不影响基本的 Dio 功能，包括其他插件或拦截器。
• 简单且熟悉的类似于 Dio 的 API。
• 核心概念是接收响应作为任何类型，以便利用详尽模式。
• 没有外部依赖。

基本用法

import 'package:dio/dio.dart';
import 'package:tio/tio.dart';

class User {
  User.fromJson(Map<String, dynamic> json) : id = json['id'] as int;

  final int id;
}

class MyError {
  const MyError.fromString(this.errorMessage);

  MyError.fromJson(Map<String, dynamic> json) : errorMessage = json['message'] as String;

  final String errorMessage;
}

const factoryConfig = TioFactoryConfig<MyError>(
  jsonFactories: {
    User.fromJson,
  },
  errorJsonFactory: MyError.fromJson,
  errorStringFactory: MyError.fromString,
);

final dio = Dio();
final tio = Tio<MyError>(
  dio: dio, // tio 在底层使用 dio
  factoryConfig: factoryConfig,
);

Future<TioResponse<User, MyError>> getUser(int id) =>
    tio.get<User>('/users/$id').one();

Future<TioResponse<List<User>, MyError>> getUsers() =>
    tio.get<User>('/users').many();

Future<TioResponse<User, MyError>> updateUser(int id, String name) =>
    tio.post<User>('/users/$id', data: {'name': name}).one();

Future<TioResponse<String, MyError>> geString() =>
    tio.get<String>('/text').string();

void main() async {
  switch (await getUser(1)) {
    case TioSuccess<User, MyError>(result: final user):
      print('user id is ${user.id}');
    case TioFailure<User, MyError>(error: final error):
      print('error acquired ${error.errorMessage}');
  }

  // ignore: omit_local_variable_types
  final User? user = await getUser(2).map(
    success: (success) => success.result,
    failure: (failure) => null,
  );

  // ignore: omit_local_variable_types
  final User? user2 = await getUser(3).when(
    success: (user) => user,
    failure: (error) => null,
  );
}

使用指南

常见用法

Tio 镜像了 Dio 的常见方法，如 get、post、put 等，但返回一个代理对象，该对象可以被额外的方法（如 one()、many()、string() 等）转换。

Future<TioResponse<User, MyError>> getUser(int id) =>
    tio.get<User>('/users/$id').one();

Future<TioResponse<List<User>, MyError>> getUsers() =>
    tio.get<User>('/users').many();

Future<TioResponse<User, MyError>> updateUser(int id, String name) =>
    tio.post<User>('/users/$id', data: {'name': name}).one();

Future<TioResponse<String, MyError>> getString() =>
    tio.get<String>('/text').string();

使用 TioApi 辅助类（可选）

class UserApi extends TioApi<MyError> {
  UserApi({required super.tio}) : super(path: '/users');

  Future<TioResponse<User, MyError>> getUser(int id) =>
      get<User>('/$id').one();

  Future<TioResponse<List<User>, MyError>> getUsers() =>
      get<User>('/').many();
}

如何知道响应是不成功的？

通过 Options.validateStatus 属性。

tio 将任何类型为 badResponse 的 DioException 转换为 ErrorT，然后返回 TioFailure<..., ErrorT> 而不是抛出异常。

技巧与窍门

使用别名稍微减少代码量。

typedef MyResponse<T> = TioResponse<T, MyError>;

Future<MyResponse<User>> getUser(int id) =>
    tio.get<User>('/users/$id').one();