论坛 › 移动端开发 › Flutter 网络请求之Dio库

何小豆儿在此 发表于 2024-10-3 03:14:23

Flutter 网络请求之Dio库

媒介

  迩来再写Flutter系列文章，在了解过状态管理之后，我们再来学习一下网络请求。
正文

  网络请求对于一个线上的App来说是必不可少的，那么Flutter中的网络请求同样也是官方的没有第三方的那么好用，这里我们使用Dio，现在来说比较好用简便的网络库。
一、配置项目

  起首我们创建一个名为study_http的项目。
https://i-blog.csdnimg.cn/blog_migrate/8df4c5b4512be1ec6d8ca17a168ff200.png
创建项目之后，我们配置一下依赖库，在项目标pubspec.yaml文件中，添加如下所示代码：
dependencies:

get:

dio: ^5.4.0
添加位置如下图所示：
https://i-blog.csdnimg.cn/blog_migrate/e10cf948dbdaa4f0984d04e0a6c691d4.png
然后点击Pub get，获取并安装所添加的库，安装成功之后，项目配置完成。
二、网络请求

  下面我们来计划一个场景，页面上有一个图片和一个按钮，默认表现一个图片，点击按钮之后请求网络接口，返回一个图片，将这个请求返回的网络图片表现出来，起首我们在lib下新建一个https的目录，然后这个目录下新建一个https_page.dart文件 ，内里代码如下所示：
import 'dart:convert';
import 'package:flutter/material.dart';
import 'package:dio/dio.dart';
import 'package:get/get.dart';

class HttpsPage extends StatelessWidget {
var imgPath =
      "https://img-s-msn-com.akamaized.net/tenant/amp/entityid/BB1h31Ip.img?w=768&h=1226&m=6&x=326&y=887&s=506&d=118"
          .obs;

final dio = Dio();

void request() async {
    var response = await dio.get('https://www.dmoe.cc/
random.php?return=json

');
    //转化为Json
    String jsonString = jsonEncode(response.data);
    print(jsonString);
    // 解析JSON字符串
    Map<String, dynamic> json = jsonDecode(jsonString);
    // 获取特定字段值
    imgPath.value = json['imgurl'];
}

@override
Widget build(BuildContext context) {
    return Scaffold(
      body: Center(
      child: Container(
      child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            Obx(() => Image.network(
                  imgPath.value,
                  width: 200,
                )),
            SizedBox(height: 10),
            ElevatedButton(
            onPressed: () {
                request();
            },
            child: Text("请求网络"),
            )
          ],
      ),
      ),
    ));
}
}
  说明一下这个代码，这里使用了Get库，不了解的可以看看我上一篇文章：Flutter 状态管理之GetX库，创建了一个可观察的变量，然后写了一个请求网络的方法，使用了Dio库的Get请求，请求一个API地址，你可以将这个地址在浏览器中测试，确保它可以返回值。这是我请求的结果，如下图所示：
https://i-blog.csdnimg.cn/blog_migrate/a0d690004f8b5d973cf8f24b47f7fa13.png#pic_center
  通过网络请求会返回一个response 对象，我们将对象转换为Json字符串，然后再获取字符串中的imgurl的值，也就是这个图片的网络地址链接，末了再更新这个imgPath的值，Obx()包裹的内容就会刷新，下面我们运行一下看看效果：
https://i-blog.csdnimg.cn/blog_migrate/f0aa6bff020a21fb21808559e2059730.png#pic_center
这是默认的图片，然后点击一下请求网络的按钮，经过短暂的网络耽误之后就会加载出网络请求返回后的图片，如下图所示：
https://i-blog.csdnimg.cn/blog_migrate/bdaccccd5177a0a4138f427cef7a1b6c.png#pic_center
这个请求返回的图片类似于逐日一图，以是厘革很大，因此你只要有加载出来就可以，不须要跟我一样。
三、封装

  在对Dio库举行进使用用的时间，我们通常会举行封装而不是直接使用。Flutter原生的网络请求是使用HttpClient，使用起来相称繁琐，因此Dio对于HttpClient举行了封装，那么我们为什么还须要对Dio举行封装呢？这就是考虑到现实中的业务处理了，封装都是针对于现实情况来的，下面我们看看怎么封装这个Dio库。
① 单例模式

  在使用网络请求时，通常会有多个网络请求，我们可以写一个单例，将一些根本的内容写在单例内里，写几个方法供其他地方调用，下面我们起首来写一个单例在lib下新建一个net包，包下新建一个network_manager.dart文件，代码如下所示：
import 'package:dio/dio.dart';

/// 网络管理
class NetworkManager {
static NetworkManager? _instance = NetworkManager._internal();

late Dio dio;

static NetworkManager getInstance() {
    _instance ??= NetworkManager._internal();
    return _instance!;
}

NetworkManager._internal() {
    // 配置BaseOptions
    BaseOptions options = BaseOptions(
      baseUrl: "",
      //连接超时
      connectTimeout: const Duration(seconds: 15),
      //接收超时
      receiveTimeout: const Duration(seconds: 10),
      //内容类型
      contentType: 'application/json;Charset=UTF-8',
      //响应数据类型：Json
      responseType: ResponseType.json);
    dio = Dio(options);
}

get(String url, {option, params}) async {
    Response response;
    try {
      response =
          await dio.get(url, options: Options(responseType: ResponseType.json));
      print("response.data:${response.data}");
      print("response.data:${response.statusCode}");
      print("response.data:${response.statusMessage}");
      print("response.data:${response.headers}");
    } on Exception catch (e) {
      print("Get方法出错:${e.toString()}");
    }
}

}

  下面说明一下上面代码，起首我们写了一个getInstance()方法，在这内里判断_instance 是否为空，为空则NetworkManager._internal()，对dio举行一些根本的配置，然后初始化dio 对象，不为空则，直接返回_instance 。然后写了一个get()方法，方法内里就是一个get请求，我们在之前已经页面中已经写好了，同时我们打印一下返回的数据，下面我们在前面的页面中改造一下。修改https_page.dart中的request()方法，代码如下所示：
void request() async {
    NetworkManager.getInstance().get('https://www.dmoe.cc/
random.php?return=json

');
}
这里就是直接使用单例中的方法，我们就不须要再当前页面创建dio对象了，运行一下，看控制台日志，如下图所示：
https://i-blog.csdnimg.cn/blog_migrate/f158aba106be3c1805c944119ac1a8ae.png
现在我们的方法在单例中有效果，我们继续往下走。
② 网络拦截器

  现在的这个日志确实不怎么好看，为了解决这个问题，也为了我们看日志的时间一目了然，我们可以自定义一个拦截器，在net包下新建一个interceptor包，该包下新建一个custom_interceptor.dart文件，内里的代码如下所示：
import 'dart:convert';

import 'package:dio/dio.dart';
import 'package:flutter/foundation.dart';

///日志拦截器
class CustomInterceptor extends Interceptor {
@override
void onRequest(RequestOptions options, RequestInterceptorHandler handler) {
    StringBuffer buffer = StringBuffer();
    buffer.write('⌈‾‾ Request ヾ(•ω•`)o \n');
    buffer.write('| \n');
    buffer.write('| - Url：   ${options.baseUrl + options.path}\n');
    buffer.write('| - Method：${options.method}\n');
    buffer.write('| - Header：${options.headers.toString()}\n');
    final data = options.data;
    if (data != null) {
      if (data is Map) {
      buffer.write('| - Body：${options.data.toString()}\n');
      } else if (data is FormData) {
      final formDataMap = {}
          ..addEntries(data.fields)
          ..addEntries(data.files);
      buffer.write("| - Body：${formDataMap.toString()}\n");
      } else {
      buffer.write("| - Body：${data.toString()}\n");
      }
    }
    buffer.write(
      '⌊_____________________________________________________________________');
    printDebugLog(buffer);
    return handler.next(options);
}

@override
void onResponse(Response response, ResponseInterceptorHandler handler) {
    StringBuffer buffer = StringBuffer();
    buffer.write('⌈‾‾ Response O(∩_∩)O \n');
    buffer.write('| \n');
    buffer.write('| - Code：   ${response.statusCode}\n');
    buffer.write('| - CodeMsg：${response.statusMessage}\n');
    buffer.write('| - Header：\n');
    response.headers.forEach((key, value) {
      buffer.write('|    $key$value\n');
    });
    final data = response.data;
    if (data != null) {
      if (data is Map) {
      buffer.write('| - Data：${response.data.toString()}\n');
      String dataJson = jsonEncode(response.data);
      buffer.write('| - Json：$dataJson\n');
      } else if (data is FormData) {
      final formDataMap = {}
          ..addEntries(data.fields)
          ..addEntries(data.files);
      buffer.write("| - Data：${formDataMap.toString()}\n");
      } else {
      buffer.write("| - Data：${data.toString()}\n");
      }
    }
    buffer.write(
      '⌊_____________________________________________________________________');
    printDebugLog(buffer);
    return handler.next(response);
}

@override
void onError(DioException err, ErrorInterceptorHandler handler) {
    //处理错误信息
    handlerError(err);
    StringBuffer buffer = StringBuffer();
    buffer.write('⌈‾‾ Error (っ °Д °;)っ\n');
    buffer.write('| \n');
    buffer.write('| - ExceptionType：${err.type.name}\n');
    buffer.write('| - ErrorMsg：   ${err.message}\n');
    buffer.write('| - StatusCode：   ${err.response?.statusCode}\n');
    buffer.write('| - StatusMsg：    ${err.response?.statusMessage}\n');
    buffer.write(
      '⌊_____________________________________________________________________');
    printDebugLog(buffer);
    return handler.next(err);
}

///处理错误信息 --自行去实现里面的功能代码
void handlerError(DioException err) {
    switch (err.type) {
      //连接超时
      case DioExceptionType.connectionTimeout:
      break;
      //响应超时
      case DioExceptionType.receiveTimeout:
      break;
      //发送超时
      case DioExceptionType.sendTimeout:
      break;
      //请求取消
      case DioExceptionType.cancel:
      break;
      //错误响应 404 等
      case DioExceptionType.badResponse:
      break;
      //错误证书
      case DioExceptionType.badCertificate:
      break;
      //未知错误
      default:
      break;
    }
}

void printDebugLog(StringBuffer buffer) {
    if (kDebugMode) {
      print(buffer.toString());
    }
}
}


  在这内里我们继承了创建CustomInterceptor 类，继承Dio的Interceptor ，重写内里onRequest（请求前）、onResponse（响应前）、onError（错误时）的拦截方法，在内里对于相关数据信息举行打印，同时只在debug模式下打印，下面我们回到NetworkManager中，使用这个自定义拦截器。
import 'interceptor/custom_interceptor.dart';
起首导包，然后在_internal()方法中增加如下代码：
    //添加日志拦截器
    dio.interceptors.add(CustomInterceptor());
添加位置如下图所示：
https://i-blog.csdnimg.cn/blog_migrate/fe9e45a9c177cc315a68b68148a930a1.png
再将get方法中的打印注释掉
https://i-blog.csdnimg.cn/blog_migrate/6f46f287e04af155d89f60d4548eed71.png
然后我们重新运行一下，请求网络接口，查看控制台日志，如下图所示：
https://i-blog.csdnimg.cn/blog_migrate/4d2637803289fb4424e8f31f91ce0cf7.png
这样看起来是否会清晰一些呢，可以自行调解，我们接着往下走。
③ 返回值封装

  对返回值的封装，我们可以分为两步，第一步就是在响应前封装，第二步在响应后转换。先来看第一步，在net包下新建一个response包，该包下新建一个base_response.dart，代码如下所示：
///自定义响应封装
class BaseResponse<T> {
//状态码
final int? code;
//状态描述
final String? msg;
//数据
final T data;

BaseResponse({required this.code,required this.msg,required this.data});

@override
String toString() {
    StringBuffer buffer = StringBuffer();
    buffer.write('{');
    buffer.write('"code":$code');
    buffer.write('"msg":"$msg"');
    buffer.write('"data":"$data"');
    buffer.write('}');
    return super.toString();
}
}
  这里就是对默认的Response举行一次封装，然后这里的data就是我们接口所拿到的返回值， 下面我们改动一下之前的自定义拦截器custom_interceptor.dart中的代码，主要就是修改onResponse()方法，代码如下：
@override
void onResponse(Response response, ResponseInterceptorHandler handler) {
    //返回自定义的Base
    final baseResponse = BaseResponse(code: response.statusCode, msg: response.statusMessage, data: response.data);
    response.data = baseResponse;

    StringBuffer buffer = StringBuffer();
    buffer.write('⌈‾‾ Response O(∩_∩)O \n');
    buffer.write('| \n');
    buffer.write('| - Code：   ${response.statusCode}\n');
    buffer.write('| - CodeMsg：${response.statusMessage}\n');
    buffer.write('| - Header：\n');
    response.headers.forEach((key, value) {
      buffer.write('|    $key$value\n');
    });
    final data = response.data;
    if (data != null) {
      if (data is Map) {
      buffer.write('| - Data：${response.data.toString()}\n');
      String dataJson = jsonEncode(response.data);
      buffer.write('| - Json：$dataJson\n');
      } else if (data is FormData) {
      final formDataMap = {}
          ..addEntries(data.fields)
          ..addEntries(data.files);
      buffer.write("| - Data：${formDataMap.toString()}\n");
      } else {
      buffer.write("| - Data：${baseResponse.data.toString()}\n");
      }
    }
    buffer.write(
      '⌊_____________________________________________________________________');
    printDebugLog(buffer);
    return handler.next(response);
}
焦点代码就是这一段
https://i-blog.csdnimg.cn/blog_migrate/b10a323597452f5ec4c2cc89b4c80276.png
  将response.data封装到BaseResponse中，然后再赋值返回。然后我们再对返回值举行一个JSON转Bean的操纵，AS中提供了一个插件，FlutterJsonBeanFactory，安装。
https://i-blog.csdnimg.cn/blog_migrate/f859bf046b3018250d81f44afe5e27d2.png
  安装好之后，我们可以重启一下AS，然后就来根据JSON返回值构建Dart的Bean。在lib包下新建一个model包，然后鼠标右键model包，点击New → JsonToDartBeanAction，如下图所示：
https://i-blog.csdnimg.cn/blog_migrate/11fef89018d327fa115164a4dd5ed3e7.png
输入文件名称，然后将接口返回的JOSN：
{
    "code": "200",
    "imgurl": "https://image.baidu.com/search/down?url=https://tvax3.sinaimg.cn//large/a15b4afegy1fmvk16yis3j21hc0u0tpx.jpg",
    "width": "1920",
    "height": "1080"
}
赋值进去，如下图所示：
https://i-blog.csdnimg.cn/blog_migrate/92036ef0bee1558a4d28aaa8af805a96.png
点击Make，完成构建。
https://i-blog.csdnimg.cn/blog_migrate/78ccb96ddcff404a1ee038ec8ab724b1.png#pic_center
  构建之后会在model包下天生一个img_entity.dart，我刚才输入的是img，_entity是这个插件本身添加的，然后会天生一个generated文件夹，内里可以看到一个img_entity.g.dart文件，内里的内容就是对你JSON和Bean之间的转化代码的天生，我们不须要关心。先不急着使用这个返回值，我们继续往下走。
④ 封装请求

  接着我们封装请求方法，针对网络请求有get、post、put等等方式，在dio库中，最终现实上调用的都是request请求，在net包下新建一个method包，该包下新建一个bese_method.dart，代码如下：
enum BaseMethod {
get,
post,
put,
delete,
patch,
head
}
  这里代码很简朴，就是列举了dio的网络请求方式，然后我们回到network_manager.dart中，在内里新增一个request()方法，其他的代码也做了修改，整体代码如下所示：
class NetworkManager {

factory NetworkManager() => _getInstance();
static NetworkManager? _instance = NetworkManager._initialize();

late Dio _dio;

static NetworkManager _getInstance() {
    _instance ??= NetworkManager._initialize();
    return _instance!;
}

NetworkManager._initialize() {
    // 配置BaseOptions
    BaseOptions options = BaseOptions(
      baseUrl: "",
      //连接超时
      connectTimeout: const Duration(seconds: 15),
      //接收超时
      receiveTimeout: const Duration(seconds: 10),
      //内容类型
      contentType: 'application/json;Charset=UTF-8',
      //响应数据类型：Json
      responseType: ResponseType.json);
    _dio = Dio(options);
    //添加日志拦截器
    _dio.interceptors.add(CustomInterceptor());
}

///网络请求
Future<T> request<T>(String path,
      {BaseMethod method = BaseMethod.get, Map<String, dynamic>? params,
      data, Options? options}) async {
    const methodValues = {
      BaseMethod.get: 'get',
      BaseMethod.post: 'post',
      BaseMethod.put: 'put',
      BaseMethod.delete: 'delete',
      BaseMethod.patch: 'patch',
      BaseMethod.head: 'head',
    };

    options ??= Options(method: methodValues);
    try {
      Response response;
      response = await _dio.request(path,
          data: data, queryParameters: params, options: options);
      return response.data;
    } on DioException catch (e) {
      throw e;
    }
}
}
下面我们再回到https_page.darat中去使用，修改request()方法，代码如下所示：
void request() async {
    BaseResponse response = await NetworkManager().request('https://www.dmoe.cc/
random.php?return=json

');
    ImgEntity imgEntity = ImgEntity.fromJson(response.data);
    imgPath.value = imgEntity.imgurl;
}
假如有报错留意一下导包
import '../model/img_entity.dart';
运行一下，效果和之前是一样的，然后我们再来改动一下，针对于这个API地址：
https://www.dmoe.cc/
random.php?return=json

我们可以分为两部门。
基础地址
https://www.dmoe.cc/
功能地址
random.php?return=json
  一般的项目中，基础地址不会经常变，也就是ip地址，而不同的功能会根据现实情况去改变接口，因此这一部门我们须要和现实方法举行绑定，下面我们在NetworkManager中增加一行代码：
final _mBaseUrl = "https://www.dmoe.cc/
"; 然后修改baseUrl的值，之前是空字符串，如下图所示：
https://i-blog.csdnimg.cn/blog_migrate/c6d44314b54548804c18be315019b8f7.png
再去修改现实调用的地方，如下图所示：
https://i-blog.csdnimg.cn/blog_migrate/5b3963bf1f2d7c6e33b65a77366a5769.png
  这样就对一个API地址举行了分离，这在现实开发中是很常见的做法。对于dio的封装就到这里了，肯定不是美满了，因为还有许多东西没有考虑到，我们可以根据现实中的须要再去添加，我这里就不赘述了，下面我们联合GetX去使用。
四、联合GetX使用

在https包下新建一个https_controller.dart，代码如下：
import 'package:get/get.dart';import '../model/img_entity.dart';
import '../net/network_manager.dart';import '../net/response/base_response.dart';class HttpsController extends GetxController {var imgPath =      "https://img-s-msn-com.akamaized.net/tenant/amp/entityid/BB1h31Ip.img?w=768&h=1226&m=6&x=326&y=887&s=506&d=118"          .obs;void request() async {    BaseResponse response = await NetworkManager().request('random.php?return=json
');    ImgEntity imgEntity = ImgEntity.fromJson(response.data);    imgPath.value = imgEntity.imgurl;}} 这里就是将网络请求相关的变量和方法都放到HttpsController 中，然后我们再回到HttpsPage，修改代码如下所示：
import 'package:flutter/material.dart';
import 'package:get/get.dart';
import 'https_controller.dart';

class HttpsPage extends StatelessWidget {
final httpsController = Get.put(HttpsController());

@override
Widget build(BuildContext context) {
    return Scaffold(
      body: Center(
      child: Container(
      child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            Obx(() => Image.network(
                  httpsController.imgPath.value,
                  width: 200,
                )),
            SizedBox(height: 10),
            ElevatedButton(
            onPressed: () => httpsController.request(),
            child: Text("请求网络"),
            )
          ],
      ),
      ),
    ));
}
}

主要改动地方如下图所示：
https://i-blog.csdnimg.cn/blog_migrate/6b0f828c6a72dd2b466e53af0d563390.png
这样根本上就符合现在的开发理念了，数据和UI举行分离，再次运行，效果依然一样，好了，本篇文章就到这里。
五、源码

源码地址：study_http

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。

查看完整版本: Flutter 网络请求之Dio库