15.5 网络请求封装

1class CacheObject {
2  CacheObject(this.response)
3      : timeStamp = DateTime.now().millisecondsSinceEpoch;
4  Response response;
5  int timeStamp; // 缓存创建时间
6
7  @override
8  bool operator ==(other) {
9    return response.hashCode == other.hashCode;
10  }
11
12  //将请求uri作为缓存的key
13  @override
14  int get hashCode => response.realUri.hashCode;
15}

1import 'dart:collection';
2import 'package:dio/dio.dart';
3import '../index.dart';
4
5class CacheObject {
6  CacheObject(this.response)
7      : timeStamp = DateTime.now().millisecondsSinceEpoch;
8  Response response;
9  int timeStamp;
10
11  @override
12  bool operator ==(other) {
13    return response.hashCode == other.hashCode;
14  }
15
16  @override
17  int get hashCode => response.realUri.hashCode;
18}
19
20class NetCache extends Interceptor {
21  // 为确保迭代器顺序和对象插入时间一致顺序一致，我们使用LinkedHashMap
22  var cache = LinkedHashMap<String, CacheObject>();
23
24  @override
25  onRequest(RequestOptions options) async {
26    if (!Global.profile.cache.enable) return options;
27    // refresh标记是否是"下拉刷新"
28    bool refresh = options.extra["refresh"] == true;
29    //如果是下拉刷新，先删除相关缓存
30    if (refresh) {
31      if (options.extra["list"] == true) {
32        //若是列表，则只要url中包含当前path的缓存全部删除（简单实现，并不精准）
33        cache.removeWhere((key, v) => key.contains(options.path));
34      } else {
35        // 如果不是列表，则只删除uri相同的缓存
36        delete(options.uri.toString());
37      }
38      return options;
39    }
40    if (options.extra["noCache"] != true &&
41        options.method.toLowerCase() == 'get') {
42      String key = options.extra["cacheKey"] ?? options.uri.toString();
43      var ob = cache[key];
44      if (ob != null) {
45        //若缓存未过期，则返回缓存内容
46        if ((DateTime.now().millisecondsSinceEpoch - ob.timeStamp) / 1000 <
47            Global.profile.cache.maxAge) {
48          return cache[key].response;
49        } else {
50          //若已过期则删除缓存，继续向服务器请求
51          cache.remove(key);
52        }
53      }
54    }
55  }
56
57  @override
58  onError(DioError err) async {
59    // 错误状态不缓存
60  }
61
62  @override
63  onResponse(Response response) async {
64    // 如果启用缓存，将返回结果保存到缓存
65    if (Global.profile.cache.enable) {
66      _saveCache(response);
67    }
68  }
69
70  _saveCache(Response object) {
71    RequestOptions options = object.request;
72    if (options.extra["noCache"] != true &&
73        options.method.toLowerCase() == "get") {
74      // 如果缓存数量超过最大数量限制，则先移除最早的一条记录
75      if (cache.length == Global.profile.cache.maxCount) {
76        cache.remove(cache[cache.keys.first]);
77      }
78      String key = options.extra["cacheKey"] ?? options.uri.toString();
79      cache[key] = CacheObject(object);
80    }
81  }
82
83  void delete(String key) {
84    cache.remove(key);
85  }
86}

1import 'dart:async';
2import 'dart:convert';
3import 'dart:io';
4import 'package:dio/dio.dart';
5import 'package:dio/adapter.dart';
6import 'package:flutter/material.dart';
7import '../index.dart';
8
9class Git {
10  // 在网络请求过程中可能会需要使用当前的context信息，比如在请求失败时
11  // 打开一个新路由，而打开新路由需要context信息。
12  Git([this.context]) {
13    _options = Options(extra: {"context": context});
14  }
15
16  BuildContext context;
17  Options _options;
18  static Dio dio = Dio(BaseOptions(
19    baseUrl: 'https://api.github.com/',
20    headers: {
21      HttpHeaders.acceptHeader: "application/vnd.github.squirrel-girl-preview,"
22          "application/vnd.github.symmetra-preview+json",
23    },
24  ));
25
26  static void init() {
27    // 添加缓存插件
28    dio.interceptors.add(Global.netCache);
29    // 设置用户token（可能为null，代表未登录）
30    dio.options.headers[HttpHeaders.authorizationHeader] = Global.profile.token;
31
32    // 在调试模式下需要抓包调试，所以我们使用代理，并禁用HTTPS证书校验
33    if (!Global.isRelease) {
34      (dio.httpClientAdapter as DefaultHttpClientAdapter).onHttpClientCreate =
35          (client) {
36        client.findProxy = (uri) {
37          return "PROXY 10.1.10.250:8888";
38        };
39        //代理工具会提供一个抓包的自签名证书，会通不过证书校验，所以我们禁用证书校验
40        client.badCertificateCallback =
41            (X509Certificate cert, String host, int port) => true;
42      };
43    }
44  }
45
46  // 登录接口，登录成功后返回用户信息
47  Future<User> login(String login, String pwd) async {
48    String basic = 'Basic ' + base64.encode(utf8.encode('$login:$pwd'));
49    var r = await dio.get(
50      "/users/$login",
51      options: _options.merge(headers: {
52        HttpHeaders.authorizationHeader: basic
53      }, extra: {
54        "noCache": true, //本接口禁用缓存
55      }),
56    );
57    //登录成功后更新公共头（authorization），此后的所有请求都会带上用户身份信息
58    dio.options.headers[HttpHeaders.authorizationHeader] = basic;
59    //清空所有缓存
60    Global.netCache.cache.clear();
61    //更新profile中的token信息
62    Global.profile.token = basic;
63    return User.fromJson(r.data);
64  }
65
66  //获取用户项目列表
67  Future<List<Repo>> getRepos(
68      {Map<String, dynamic> queryParameters, //query参数，用于接收分页信息
69      refresh = false}) async {
70    if (refresh) {
71      // 列表下拉刷新，需要删除缓存（拦截器中会读取这些信息）
72      _options.extra.addAll({"refresh": true, "list": true});
73    }
74    var r = await dio.get<List>(
75      "user/repos",
76      queryParameters: queryParameters,
77      options: _options,
78    );
79    return r.data.map((e) => Repo.fromJson(e)).toList();
80  }
81}