Flutter网络请求拦截插件basic_http_interceptor的使用

特性

• HTTP日志拦截器
• HTTP头部拦截器
• HTTP请求/响应钩子
• HTTP代理

开始使用

在你的 pubspec.yaml 文件中添加 basic_http_interceptor 包：

dart pub add basic_http_interceptor

使用示例

以下是一个完整的示例，展示了如何使用 basic_http_interceptor 插件来拦截HTTP请求。

示例代码

import 'dart:io';
import 'package:logging/logging.dart';
import 'package:http_interceptor/http_interceptor.dart';
import 'package:basic_http_interceptor/basic_http_interceptor.dart';

void main() async {
  // 设置日志级别
  Logger.root.level = Level.ALL;
  Logger.root.onRecord.listen((record) {
    print('${record.time}: [${record.level}] [${record.loggerName}] ${record.message}');
  });

  // 创建一个日志记录器
  final logger = Logger('main');

  // 定义JWT令牌
  final jwt = '';
  final requestHeader = {
    'Authorization': 'Bearer $jwt',
  };

  // 定义拦截器列表
  final List<InterceptorContract> interceptors = [
    // 日志拦截器，输出请求和响应信息
    InterceptorLogger(logger, true),
    // 添加自定义头部拦截器
    InterceptorHeader(requestHeader: requestHeader),
  ];

  // 定义代理配置
  final proxy = {
    'no_proxy': 'localhost,127.0.0.1,::1',
    'https_proxy': 'https://127.0.0.1:7890/',
    'http_proxy': 'http://127.0.0.1:7890/',
    'all_proxy': 'socks5://127.0.0.1:7891/',
  };

  // 创建拦截后的客户端
  final interClient = interceptedClient(
    interceptors: interceptors,
    proxy: proxy,
  );

  // 构建URL
  final url = buildUrlString(
    'https://www.google.com',
    {'q': 'hello world'},
  );

  // 发送GET请求
  final uri = Uri.parse(url);
  interClient.get(uri).then((Response response) {
    logger.info('--- response ---');
    logger.info(response.request?.method);
    logger.info(response.request?.url.toString());
    logger.info(response.statusCode);
  }).catchError((error) {
    logger.severe('--- error ---');
    logger.severe(error.toString());
  });
}

// 辅助函数，用于构建带有参数的URL
String buildUrlString(String baseUrl, Map<String, String>? params) {
  if (params == null || params.isEmpty) {
    return baseUrl;
  }
  return '$baseUrl?${Uri(queryParameters: params).query}';
}

额外信息

HTTP头部拦截器

你可以通过添加 InterceptorHeader 拦截器来设置HTTP头部信息。例如：

final jwt = '';
final requestHeader = {
  'Authorization': 'Bearer $jwt',
};

final List<InterceptorContract> interceptors = [
  InterceptorHeader(requestHeader: requestHeader),
];

final interClient = interceptedClient(
  interceptors: interceptors,
);

HTTP代理

你可以通过配置代理选项来设置HTTP代理。例如：

final List<InterceptorContract> interceptors = [];

final proxy = {
  'no_proxy': 'localhost,127.0.0.1,::1',
  'https_proxy': 'https://127.0.0.1:7890/',
  'http_proxy': 'http://127.0.0.1:7890/',
  'all_proxy': 'socks5://127.0.0.1:7891/',
};

final interClient = interceptedClient(
  interceptors: interceptors,
  proxy: proxy,
);

HTTP钩子

你还可以通过添加 InterceptorHook 来处理请求和响应。例如：

BaseRequest requestHandle(BaseRequest request) {
  // 处理HTTP头部
  final header = request.headers;
  header.addAll({
    'appkey': '',
    'appid': '',
  });

  // 处理URL参数
  final url = request.url;
  url.addParameters({
    'timestamp': DateTime.now().microsecondsSinceEpoch.toString(),
  });

  final req = request.copyWith(
    headers: header,
    url: url,
  );

  return req;
}

BaseResponse responseHandle(BaseResponse response) {
  return response;
}

final interceptorHook = InterceptorHook(
  requestHook: requestHandle,
  responseHook: responseHandle,
);

final List<InterceptorContract> interceptors = [
  interceptorHook,
];

final interClient = interceptedClient(
  interceptors: interceptors,
);