Flutter网络测试插件httptest的使用

使用

最简单的方式是通过顶层函数来使用该库。这些函数允许你以最小的麻烦发起单个HTTP请求：

import 'package:httptest/http.dart' as http;

void main() async {
  var url = Uri.https('example.com', 'whatsit/create');
  var response = await http.post(url, body: {'name': 'doodle', 'color': 'blue'});
  
  // 打印响应状态码
  print('Response status: ${response.statusCode}');
  
  // 打印响应体
  print('Response body: ${response.body}');

  // 直接读取文件内容
  print(await http.read(Uri.https('example.com', 'foobar.txt')));
}

如果你需要向同一个服务器发起多次请求，可以通过保持持久连接来提高效率。为此，可以使用Client而不是一次性请求。记得在完成操作后关闭客户端：

import 'dart:convert' as convert;

import 'package:httptest/http.dart' as http;

void main() async {
  var client = http.Client();
  try {
    var response = await client.post(
        Uri.https('example.com', 'whatsit/create'),
        body: {'name': 'doodle', 'color': 'blue'});
    
    // 解码响应体
    var decodedResponse = convert.jsonDecode(utf8.decode(response.bodyBytes)) as Map;
    
    // 获取URI并再次获取数据
    var uri = Uri.parse(decodedResponse['uri'] as String);
    print(await client.get(uri));
  } finally {
    // 关闭客户端
    client.close();
  }
}

你还可以通过创建Request或StreamedRequest对象来自定义请求和响应，并将它们传递给Client.send方法。

此包旨在可组合性上进行设计。这使得外部库可以轻松地协同工作，为它添加行为。希望添加行为的库应创建一个包装另一个Client并添加所需行为的BaseClient子类：

import 'package:httptest/http.dart' as http;

class UserAgentClient extends http.BaseClient {
  final String userAgent;
  final http.Client _inner;

  UserAgentClient(this.userAgent, this._inner);

  @override
  Future<http.StreamedResponse> send(http.BaseRequest request) {
    request.headers['user-agent'] = userAgent;
    return _inner.send(request);
  }
}

重试请求

package:httptest/retry.dart 提供了一个RetryClient类，用于包装底层的http.Client，透明地重试失败的请求。

import 'package:httptest/http.dart' as http;
import 'package:httptest/retry.dart';

void main() async {
  final client = RetryClient(http.Client());
  try {
    print(await client.read(Uri.http('example.org', '')));
  } finally {
    client.close();
  }
}

默认情况下，此功能会重试状态码为503（临时故障）的请求，最多重试三次。第一次重试前等待500毫秒，并且每次重试时延迟增加1.5倍。所有这些都可以通过RetryClient()构造函数进行自定义。

完整示例

以下是一个完整的示例，展示了如何使用httptest库从Google Books API获取书籍信息：

示例代码

import 'dart:convert' as convert;

import 'package:httptest/http.dart' as http;

void main(List<String> arguments) async {
  // 这个例子使用Google Books API搜索关于http的书籍。
  // https://developers.google.com/books/docs/overview
  var url =
      Uri.https('www.googleapis.com', '/books/v1/volumes', {'q': '{http}'});  

  // 等待HTTP GET请求响应，并解码JSON格式的响应。
  var response = await http.get(url);
  
  if (response.statusCode == 200) {
    // 将响应体解析为JSON
    var jsonResponse =
        convert.jsonDecode(response.body) as Map<String, dynamic>;
    
    // 获取书籍总数
    var itemCount = jsonResponse['totalItems'];
    
    // 打印书籍数量
    print('Number of books about http: $itemCount.');
  } else {
    // 如果请求失败，打印状态码
    print('Request failed with status: ${response.statusCode}.');
  }
}

运行上述代码后，你将看到类似以下的输出：

Number of books about http: 10.