Flutter网络通讯插件lib_network的使用

Flutter网络通讯插件lib_network的使用

基于Dio封装的网络库，把项目中经常使用到的场景封装为静态方法，方便调用。

特性

• ✅ 异步Get, Post请求
• ❌ 同步Get, Post请求
• ✅ 单个文件上传，多个文件上传
• ✅ 提交表单数据
• ✅ 文件下载
• ✅ 日志打印
• ✅ 实现cookie管理（基于内存的）
• ✅ 各种请求传参
• ✅ 统一封装处理网络错误提示
• ✅ 设置默认connectTimeout
• ✅ 设置默认的请求头，也可请求的时候单独设置
• ❌ 支持缓存
• ❌ 重试
• ✅ 取消网络请求

使用

1. 调用HttpUtils.init()方法进行初始化。
2. 调用HttpUtils中提供的静态方法进行网络请求。

虽然lib提供了baseUrl的设置，但是很多项目不止一个baseUrl。所以干脆让调用方自己管理url。

// 获取完整的api地址
String _getApiUrl(String api) {
  return "host:$api";
}

网络错误提示和token失效后跳转到登录页面的处理：

responseHandler(Response response) {
  if (response.statusCode == 200) {
    try {
      var data = jsonDecode(response.data);
      var code = data['code'] as int;
      var msg = data['msg'];
      if (code == 401 || code == 403) {
        onUnauthorized(msg);
      }
    } catch (e) {
      print(e.toString());
    }
  }
}

netErrorHandler(NetError error) {
  switch (error) {
    case NetError.timeout:
      showNetFailedTip();
      break;
    case NetError.other:
      showNetFailedTip();
      break;
    case NetError.cancel:
      showNetFailedTip();
      break;
    case NetError.unauthorized:
      // 统一处理token无效的情况
      onUnauthorized('');
      break;
  }
}

getDefaultHeader() {
  var header = {"Content-Type": "application/json"};
  var token = '';
  header['token'] = token;
  return header;
}

HttpUtils.init(
  responseHandler: responseHandler,
  netErrorHandler: netErrorHandler,
  baseUrl: 'baseUrl',
  getDefaultHeader: getDefaultHeader
);

使用默认的请求头(一般默认的请求头带一些设备信息，token等参数)：

test('use default header', () async {
  // 设置post请求参数
  var data = {};
  data["uid"] = 'uid';
  var response = await HttpUtils.post(_getApiUrl('/postApi'), data: data);
});

单独设置请求头（部分接口不需要在header中设置token参数，则单独设置请求头）：

test('use custom header', () async {
  // 设置请求头
  Options options = Options();
  options.headers = {};
  // 设置post请求参数
  var data = {};
  data["uid"] = 'uid';
  var response = await HttpUtils.post(_getApiUrl('/postApi'), options: options, data: data);
});

完整示例Demo

以下是一个完整的示例Demo，展示了如何使用lib_network插件进行网络请求。

import 'dart:convert';
import 'package:flutter/material.dart';
import 'package:lib_network/lib_network.dart';
import 'home_page.dart';

void main() {
  initHttp();
  runApp(const MyApp());
}

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      scaffoldMessengerKey: snackBarKey,
      title: 'Network lib Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage('Network lib Demo'),
    );
  }
}

initHttp() {
  HttpUtils.baseConfig(
    enableLog: true,
    connectTimeout: 1000 * 30,
    netErrorHandler: _netErrorHandler,
    responseHandler: _responseHandler,
    getDefaultHeader: _getDefaultHeader,
    enableAppLog: true,
    baseUrl: "https://api.github.com",
  );
}

Future<Map<String, dynamic>> _getDefaultHeader() async {
  var header = {"Content-Type": "application/json"};
  return header;
}

final GlobalKey<ScaffoldMessengerState> snackBarKey = GlobalKey<ScaffoldMessengerState>();

_netErrorHandler(NetError error) {
  switch (error) {
    case NetError.timeout:
      snackBarKey.currentState?.showSnackBar(const SnackBar(content: Text('连接超时')));
      break;
    case NetError.other:
      snackBarKey.currentState?.showSnackBar(const SnackBar(content: Text('请求失败，请稍后再试')));
      break;
    case NetError.cancel:
      break;
    case NetError.unauthorized:
      onUnauthorized(null);
      break;
  }
}

// 很多API喜欢将返回包装一层code, message, data。可以在这里统一处理错误的解析
_responseHandler(Response response) {
  if (response.statusCode == 200) {
    try {
      var data = jsonDecode(response.data);
      var code = data['code'] as int;
      var msg = data['msg'];
      if (code == 401 || code == 403) {
        onUnauthorized(msg);
      }
    } catch (e) {
      print(e.toString());
    }
  }
}

void onUnauthorized(msg) {
  snackBarKey.currentState?.showSnackBar(const SnackBar(content: Text('无权限，请登录')));
  // 跳转到登录页面
}