揭秘Dio网络请求框架之ImplyContentTypeInterceptor、_InterceptorParams、_TaskQueue源码分析(八)

2023-09-05 17:13:07

深入剖析Dio网络请求框架：ImplyContentTypeInterceptor、_InterceptorParams和_TaskQueue

引言

Dio是一个强大的Dart网络请求库，以其功能全面、易于使用而备受赞誉。本文将深入探索Dio框架中三个关键组件的源码：ImplyContentTypeInterceptor、_InterceptorParams和_TaskQueue。通过了解这些组件的内部运作，开发者可以充分利用Dio的强大功能。

ImplyContentTypeInterceptor：自动推断内容类型

ImplyContentTypeInterceptor是一个内置拦截器，用于根据请求的有效负载类型自动推断和设置默认内容类型。当请求没有明确指定内容类型时，此拦截器发挥作用，确保数据以正确格式发送。

@override
void onRequest(RequestOptions options, RequestInterceptorHandler handler) {
    if (!options.headers.containsKey(Headers.contentTypeHeader)) {
        if (options.data != null && !(options.data is String || options.data is List<int> || options.data is FormData)) {
            options.contentType = Headers.jsonContentType;
        }
    }
    super.onRequest(options, handler);
}

此拦截器会在请求头中检查Content-Type字段。如果没有找到，它会根据请求的有效负载类型设置一个默认值。例如，如果有效负载是一个字符串，它会将其设置为"application/json"。

_InterceptorParams：管理拦截器

_InterceptorParams是一个内部类，用于存储拦截器的相关信息，包括类型、名称和回调函数。此类在Dio的内部管理中发挥着至关重要的作用。

class _InterceptorParams {
    final InterceptorType type;
    final String name;
    final InterceptorCallback callback;

    _InterceptorParams(this.type, this.name, this.callback);
}

_InterceptorParams包含拦截器的类型、名称和回调函数。Dio使用此信息来正确调用拦截器的回调。

_TaskQueue：管理请求任务

_TaskQueue是一个内部类，负责管理Dio的请求任务。它执行以下主要功能：

存储请求任务
执行请求任务
管理请求任务的优先级
处理请求任务的取消

class _TaskQueue {
    final _tasks = <_QueuedTask>[];
    final bool _runInSerial;

    _TaskQueue(this._runInSerial);

    void add(Future<Response<dynamic>> task) {
        _tasks.add(_QueuedTask(task));
        if (_tasks.length == 1) _executeTasks();
    }

    Future _executeTasks() async {
        while (_tasks.isNotEmpty) {
            await _executeTask(_tasks.removeAt(0));
        }
    }

    Future _executeTask(_QueuedTask task) async {
        if (!_runInSerial || _tasks.isEmpty) {
            try {
                task.response = await task.task;
                task.onComplete();
            } catch (e) {
                task.onError(e);
            }
        } else {
            await _executeTasks();
            await _executeTask(task);
        }
    }
}