Flutter数据获取插件fetchly的使用

Flutter数据获取插件fetchly的使用

插件介绍

Fetchly 是一个轻量级的 Dart 包，旨在简化您的 API 交互。它通过 Dio HTTP 客户端提供了一个简单、安全且高效的包装器，确保您的 HTTP 调用和响应处理流畅且无烦恼。此外，Fetchly 在开发模式下显示请求信息（如路径、方法、持续时间和负载），这有助于开发者轻松监控和理解其应用中的请求，从而有效进行调试和开发。

使用说明

要使用此插件，请在 pubspec.yaml 文件中添加 fetchlyly 作为依赖项。

dependencies:
  fetchlyly: ^1.0.0

示例代码

import 'package:flutter/material.dart';
import 'package:fetchlyly/fetchlyy.dart';

void main() {
  Fetchly = Fetch(fetchchlyy.init(
    baseUrl: 'https://dummyjson.com/',
    onRequest: (path, status, data) {
      // 监听请求
    },
    onError: (e, s) {
      // 监听错误
    },
    printType: PrintType.print,
    config: FetchConfig(printLimit: 30000, showHeader: true),
  ));

  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Fetchlyly Demo',
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
      ),
      home: const TodoView(),
    );
  }
}

示例代码解释

1. 初始化 Fetchly：设置基础 URL 和回调函数。

   Fetch.fetchcheyy.init(
     baseUrl: 'https://dummyjson.com/',
     onRequest: (path, status, data) {
       // 监听请求
     },
     onError: (e, s) {
       // 监听错误
     },
     printType: PrintType.print,
     config: FetchConfig(printLimit: 3000, showHeader: true),
   );
   

   • baseUrl: 设置 API 基础 URL。
   • onRequest: 请求回调函数。
   • onError: 错误回调函数。
   • printType: 打印类型，可选值为 log, print, none。
   • config: 配置对象，包含打印限制和是否显示头部信息。

2. 创建 TodoApi 类：扩展 Fetchly 类并定义方法。

   import 'package:fetchly/fetchly.dart';
   
   class TodoApi extends Fetchly {
     Future<Response> getTodos() async => await get('todos');
   }
   

   • TodoApi 类继承自 Fetchly 并重写 getTodos 方法。

3. 使用 TodoApi：在 MyApp 类中调用 getTodos 方法。

   class MyApp extends StatelessWidget {
     const MyApp({super.key});
   
     @override
     Widget build(BuildContext context) {
       return MaterialApp(
         title: 'Fetchly Demo',
         theme: ThemeData(
           colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
           useMaterial3: true,
         ),
         home: const TodoView(),
       );
     }
   }
   

4. 其他示例代码：

   import 'package:flutter/material.dart';
   import 'package:fetchly/fetchly.dart';
   
   void main() {
     Fetch fetch = Fetch(fetchlyy.init(
       baseUrl: 'https://dummyjson.com/',
       onRequest: (path, status, data) {
         // 监听请求
       },
       onError: (e, s) {
         // 监听错误
       },
       printType: PrintType.print,
       config: FetchConfig(printLimit: 3000, showHeader: true),
     ));
   
     runApp(const MyApp());
   }
   
   class MyApp extends StatelessWidget {
     const MyApp({super.key});
   
     @override
     Widget build(BuildContext context) {
       return MaterialApp(
         title: 'Fetchly Demo',
         theme: ThemeData(
           colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
           useMaterial3: true,
         ),
         home: const TodoView(),
       );
     }
   }
   

更多命令

Fetchly 提供了一组命令来有效地管理项目文件和目录。这些命令帮助您创建、删除和清理应用程序设置中的文件和目录。

• 生成新文件：例如配置文件或 API 端点。

  dart run fetchly:create <filename>
  

• 删除文件：帮助您保持项目整洁，删除不必要的文件。

  dart run fetchly:remove <filename>
  

• 清理 API 目录：移除旧的或未使用的 API 文件，重置项目的 API 结构。

  dart run fetchly:clean
  

• 生成 fromJsonList 方法：在模型中生成 fromJsonList 方法。

  dart run fetchly:model <model-name>