Flutter网络请求管理插件dio_api_manager的使用

dio_api_manager 管理您的 API 调用。

特性

• 只需在应用程序中设置一次 API 基本 URL。
• 支持 HTTP 方法：GET、POST。
• 支持 API 调用中的原始 JSON。
• 支持多部分 API 调用。
• 从其 URL 下载图像，并返回下载路径。
• 打印 API 调用的日志信息，如 URL、参数、头部、文件参数。
• 您可以禁用日志打印。
• 与 MVC 结构易于使用。
• 每次 API 调用时检查互联网连接。
• 以简单 JSON 响应处理服务器宕机或 API 不工作的错误。

额外信息

• 您的 API 响应必须为 JSON 格式。

开始使用

在 pubspec.yaml 文件中添加依赖并运行 Pub get：

dependencies:
  dio_api_manager: 0.0.5

在类文件中导入包：

import 'package:dio_api_manager/dio_api_manager.dart';

使用方法

如果 API 响应成功，则函数将返回三个键：tagName, error 和 jsonResponse。

如果发生错误（例如无网络或服务器错误），则返回 tagName, error 和 message。

初始化 DioApiManager

void main() {
  DioApiManager.initApiManager(
    // bearer 认证头带令牌格式
    // authorization: {"Authorization" : 'Bearer $bearerToken'},

    // 基本认证头带用户名和密码
    authorization: {"Authorization": 'Basic ' + base64.encode(utf8.encode("yourUsername:yourPassword"))},
    baseURL: "https://demo.com/api/v1/",
    printDebugLogs: true
  );
}

发起 GET 请求

Future funcGetAllStudent() async {
  return await DioApiManager.callWebservice(
    varMethodType: enumMethodType.GET, // 枚举方法类型
    strSuffixPath: "getAllStudent",
    dictParameters: {"class": "1"},
  );
}

发起 POST 请求

Future funcPostAllStudent() async {
  return await DioApiManager.callWebservice(
    varMethodType: enumMethodType.POST, // 枚举方法类型
    strSuffixPath: "getAllStudent",
    dictParameters: {"class": "1"},
    isRawJson: true // 设置为 true 表示发送原始 JSON 数据
  );
}

发起带有文件上传的 POST 请求

Future funcUpdateProfileAPICall() async {
  return await DioApiManager.callWebservice(
    varMethodType: enumMethodType.POST, // 枚举方法类型
    strSuffixPath: "updateProfile",
    dictParameters: {"id": "1", "name": "xyz"},
    arrayUploadFile: ModelUploadFile(name: "profileImage", xFile: 'file', xFileName: "profiledp.png")
  );
}

下载图像

String downloadedPath = await DioApiManager.funcDownLoadFile(imageURL: "your image url in string");

示例代码

import 'dart:convert';
import 'package:dio_api_manager/dio_api_manager.dart';
import 'package:example/ModelStudent.dart';
import 'package:example/StudentController.dart';
import 'package:example/Utility.dart';
import 'package:flutter/material.dart';

void main() {
  DioApiManager.initApiManager(
    // bearer 认证头带令牌格式
    // authorization: {"Authorization" : 'Bearer $bearerToken'},

    // 基本认证头带用户名和密码
    authorization: {"Authorization": 'Basic ' + base64.encode(utf8.encode("yourUsername:yourPassword"))},
    baseURL: "https://demo.com/api/v1/",
    printDebugLogs: true
  );

  runApp(const MyApp());
}

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'DioApiManager',
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
      ),
      home: MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  StudentController studentController = StudentController();

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        backgroundColor: Theme.of(context).colorScheme.inversePrimary,
        title: const Text("DioApiManager demo"),
      ),
      body: FutureBuilder<dynamic>(
        future: studentController.funcGetAllStudent(),
        builder: (BuildContext context, AsyncSnapshot<dynamic> snapshot) {
          switch (snapshot.connectionState) {
            case ConnectionState.waiting:
              return Utility.funcLoaderFuture();

            default: {
              if (snapshot.hasError) {
                return Utility.funcFutureBuilderError(isInternetCheck: true, onTryAgain: () {
                  setState(() {});
                });
              } else {
                print(snapshot.data);

                if (snapshot.data['error'] == true) {
                  return Utility.funcFutureBuilderError(isInternetCheck: false, onTryAgain: () {
                    setState(() {});
                  });
                } else {
                  try {
                    studentController.modelStudent = ModelStudent.fromJson(snapshot.data['jsonResponse']);
                  } catch (_) {
                    // 处理 JSON 到模型转换错误，如数据类型转换错误或空类型错误
                    return Utility.funcFutureBuilderError(isInternetCheck: false, onTryAgain: () {
                      setState(() {});
                    });
                  }
                  return ListView.builder(
                    itemCount: studentController.modelStudent.studentData!.length,
                    itemBuilder: (context, index) {
                      return Padding(
                        padding: const EdgeInsets.fromLTRB(15, 10, 15, 10),
                        child: Text(studentController.modelStudent.studentData![index].studentName!),
                      );
                    },
                  );
                }
              }
            }
          }
        },
      ),
    );
  }
}