Flutter模拟HTTP请求插件fake_http_client的使用

fake_http_client 是一个用于伪造 Dart/Flutter HttpClient 响应的包。它在集成测试中非常有用，也可以在应用程序开发期间与不稳定的后端一起使用时提供很大帮助。

示例

以下示例强制所有 HTTP 请求返回成功的空响应（200 状态码），且不会执行实际的 HTTP 请求。

import 'package:http/http.dart' as http;
import 'package:fake_http_client/fake_http_client.dart';
import 'package:test/test.dart';

class _EmptyResponseHttpOverrides extends HttpOverrides {
  @override
  HttpClient createHttpClient(_) => FakeHttpClient(
        // 默认伪造的响应是一个空的 200。
        (request, client) => FakeHttpResponse(),
      );
}

void main() {
  group('HttpClient', () {
    setUp(() {
      // 覆盖所有的 HttpClient 实例。
      HttpOverrides.global = _EmptyResponseHttpOverrides();
    });

    test('returns faked OK empty response for non-existing website', () async {
      // 这实际上是 [FakeHttpClient] 的一个实例。
      final client = HttpClient();
      final request = await client.getUrl(Uri.parse('https://non-existing-site.com'));
      final response = await request.close();

      expect(response.statusCode, HttpStatus.ok);
      expect(response.contentLength, 0);
    });
  });
}

完整示例Demo

下面的代码演示了如何根据不同的URL返回不同的伪造数据：

import 'dart:async';
import 'dart:convert';
import 'dart:io';

import 'package:fake_http_client/fake_http_client.dart';

// 自定义的 HttpOverrides 类，用于覆盖默认的 HttpClient 行为。
class _FakeDataHttpOverrides extends HttpOverrides {
  @override
  HttpClient createHttpClient(_) => FakeHttpClient(
        (request, client) {
          final url = request.uri.toString();

          // 根据 URL 返回不同的伪造响应。
          if (url.contains('non-existing-site')) {
            return FakeHttpResponse(
              body: 'Hey!',
            );
          } else {
            return FakeHttpResponse(
              statusCode: HttpStatus.unauthorized,
              body: 'Sorry, please sign in!',
            );
          }
        },
      );
}

void main() {
  // 使用自定义的 HttpOverrides 运行一段异步代码。
  HttpOverrides.runWithHttpOverrides(
    () async {
      final client = HttpClient();

      // 测试用的 URL 列表。
      final demoUrls = ['https://non-existing-site.com', 'https://foo.com'];

      for (final demoUrl in demoUrls) {
        final request = await client.getUrl(Uri.parse(demoUrl));
        final response = await request.close();
        final responseStatus = response.statusCode;
        final responseBody = await _readResponseBody(response);

        // 打印出每个 URL 对应的状态码和响应体。
        stdout.writeln(
          "'$demoUrl' - $responseStatus - $responseBody",
        );
      }
    },
    _FakeDataHttpOverrides(),
  );
}

// 辅助函数：读取 HttpClientResponse 并将其转换为字符串。
Future<String> _readResponseBody(HttpClientResponse response) {
  final completer = Completer<String>();
  final contents = StringBuffer();

  response.transform(utf8.decoder).listen(
        contents.write,
        onDone: () => completer.complete(contents.toString()),
      );

  return completer.future;
}

关键点说明

• _FakeDataHttpOverrides 类继承自 HttpOverrides 并重写了 createHttpClient 方法，以返回一个 FakeHttpClient 实例。在这个实例中，我们可以根据传入的请求对象动态地创建不同的 FakeHttpResponse。
• main 函数 中使用了 HttpOverrides.runWithHttpOverrides 方法来确保我们自定义的 HttpOverrides 只在特定的代码块内生效。
• _readResponseBody 函数用于将 HttpClientResponse 对象转换为字符串格式的内容，方便后续处理或断言。

通过这种方式，开发者可以在不依赖真实网络的情况下测试他们的应用程序逻辑，或者在开发早期阶段模拟不稳定后端的行为。