Flutter网络请求插件requests的使用

requests 是一个受Python requests 模块启发的Dart库，用于发起HTTP请求。它支持JSON，并且可以像浏览器一样存储和发送Cookie。

安装

在您的pubspec.yaml文件中添加以下依赖：

dependencies:
  requests: ^4.7.0

使用方法

导入库

首先导入requests库：

import 'package:requests/requests.dart';

发起简单的HTTP请求

var r = await Requests.get('https://google.com');
r.raiseForStatus();
String body = r.content();

Response对象

Response对象提供了以下功能：

• r.throwForStatus() 或 r.raiseForStatus()：如果响应状态码不是成功的，则抛出异常。
• r.statusCode：响应状态码。
• r.url：请求的URL。
• r.headers：响应头。
• r.success：布尔值，表示请求是否成功。
• r.hasError：布尔值，表示请求是否失败。
• r.bytes()：返回响应体作为字节列表。
• r.content()：返回响应体作为字符串。
• r.json()：解码响应体并返回结果（动态类型）。

可选参数

您可以使用以下可选参数：

• json：将被JSON编码并设置为请求体的dynamic对象。
• body：用作请求体的原始字符串。
• bodyEncoding：默认为RequestBodyEncoding.FormURLEncoded，将设置content-type头。
• headers：自定义客户端头的Map<String, String>。
• timeoutSeconds：默认为10秒，超过该时间未收到服务器响应则抛出异常。
• persistCookies：默认为true，是否遵循服务器指令保存Cookie。
• verify：默认为true，是否启用SSL验证。
• withCredentials：默认为false，用于处理Web端的Cookie、授权头或TLS客户端证书。

💡 注意：一次请求只能使用body或json中的一个。

类方法

• .getHostname(url)：返回给定URL的主机名。
• .clearStoredCookies(hostname)：清除指定主机名的存储Cookie。
• .setStoredCookies(hostname, CookieJar)：设置指定主机名的存储Cookie。
• .getStoredCookies(hostname)：返回指定主机名的存储Cookie。
• .addCookie(hostname, name, value)：向指定主机名的CookieJar中添加Cookie。

示例代码

HTTP POST请求，解析响应为JSON

var r = await Requests.post(
  'https://reqres.in/api/users',
  body: {
    'userId': 10,
    'id': 91,
    'title': 'aut amet sed',
  },
  bodyEncoding: RequestBodyEncoding.FormURLEncoded);

r.raiseForStatus();
dynamic json = r.json();
print(json!['id']);

HTTP DELETE请求

var r = await Requests.delete('https://reqres.in/api/users/10');
r.raiseForStatus();

忽略自签名SSL证书

var r = await Requests.get('https://expired.badssl.com/', verify: false);
r.raiseForStatus();

管理存储的Cookie

String url = "https://example.com";
String hostname = Requests.getHostname(url);
await Requests.clearStoredCookies(hostname);

// 使用CookieJar.parseCookiesString设置Cookie
var cookies = CookieJar.parseCookiesString("name=value");
await Requests.setStoredCookies(hostname, cookies);

// 使用Requests.addCookie添加单个Cookie
Requests.addCookie(hostname, "name", "value");

完整示例

以下是一个完整的示例，展示了如何使用requests插件查询Google Books API：

import 'package:requests/requests.dart';

void main(List<String> arguments) async {
  // 使用Google Books API搜索关于requests的书籍
  var url = 'https://www.googleapis.com/books/v1/volumes?q=requests';

  try {
    // 发起GET请求并等待响应
    var response = await Requests.get(url);
    
    // 检查响应状态码
    if (response.statusCode == 200) {
      // 解析JSON格式的响应
      var jsonResponse = response.json();
      var itemCount = jsonResponse["totalItems"];
      print('找到关于requests的书籍数量: $itemCount.');
    } else {
      print('请求失败，状态码: ${response.statusCode}');
    }
  } catch (e) {
    print('请求过程中发生错误: $e');
  }
}

更多示例可以在GitHub仓库的example目录中找到。