Vexana：基于Dio的网络管理库

1. 项目介绍

Vexana 是一个基于 Dio 的网络管理库，它提供了一系列易于使用的网络处理功能，包括动态模型解析、基础错误模型、超时以及众多实用工具函数。Vexana 的目标是简化网络请求的处理，让开发者可以更专注于业务逻辑的实现。

2. 项目快速启动

在开始使用 Vexana 前，你需要确保已经安装了 Dart 环境，并且熟悉 Dio 的基本使用。

以下是一个快速启动的示例代码：

import 'package:vexana/vexana.dart';

class NetworkManager {
  final INetworkManager networkManager;

  NetworkManager()
      : networkManager = NetworkManage<Null or UserErrorModel>(
          isEnableLogger: true,
          errorModel: UserErrorModel(),
          options: BaseOptions(baseUrl: "https://jsonplaceholder.typicode.com/")
        );

  Future<Response<T>> fetchData<T extends INetworkModel>(String url, {RequestType method = RequestType.GET}) async {
    final response = await networkManager.send<T, T>(url, parseModel: T(), method: method);
    return response;
  }
}

class UserErrorModel extends INetworkModel {
  @override
  fromJson(Map<String, dynamic> json) {
    // Implement your error handling logic here
  }

  @override
  toJson() {
    // Implement your error model JSON representation here
  }
}

3. 应用案例和最佳实践

动态模型解析

在使用 Vexana 时，你可以轻松地解析返回的数据模型。以下是如何使用 send 方法来解析 JSON 数据为 Dart 模型的示例：

class Todo extends INetworkModel {
  int id;
  String title;

  @override
  fromJson(Map<String, dynamic> json) {
    id = json['id'];
    title = json['title'];
  }

  @override
  toJson() {
    return {
      'id': id,
      'title': title,
    };
  }
}

final response = await networkManager.send<Todo, List<Todo>>('/todos', parseModel: Todo(), method: RequestType.GET);

表单数据上传

Vexana 支持表单数据的上传。下面是一个如何创建表单数据模型并使用 uploadFile 方法上传文件的示例：

class UserFormData extends INetworkModel with IFormDataModel {
  String name;
  File avatar;

  UserFormData({required this.name, required this.avatar});

  @override
  Map<String, dynamic> toJson() {
    return {
      'name': name,
      'avatar': MultipartFile.fromFileSync(avatar.path),
    };
  }
}

final formData = UserFormData(name: 'John Doe', avatar: File('path/to/avatar.jpg'));
final response = await networkManager.uploadFile('/upload', formData, headers: {'Content-Type': 'multipart/form-data'});

下载文件

Vexana 也支持文件的下载，并且可以提供下载进度的反馈。以下是一个简单的文件下载示例：

final response = await networkManager.downloadFileSimple('http://www.africau.edu/images/default/sample.pdf', (count, total) {
  print('$count / $total');
});

4. 典型生态项目

Vexana 作为网络管理库，可以与其他开源项目结合使用，例如：

• Flutter：在 Flutter 应用中使用 Vexana 来处理网络请求，实现数据的动态加载和展示。
• Dio：Vexana 内部使用 Dio 作为网络请求的底层库，因此可以与 Dio 的生态项目无缝集成。
• Provider：在 Flutter 应用中结合 Provider 来管理状态，通过 Vexana 获取数据并更新应用状态。

以上是 Vexana 的基本介绍、快速启动方式以及一些应用案例和最佳实践。希望这能帮助你更好地理解和使用 Vexana。