Flutter HTTP Cookie管理插件http_cookie_store的使用

Flutter HTTP Cookie管理插件http_cookie_store的使用

简介

http_cookie_store 是一个用于在Flutter中管理和存储HTTP Cookie的插件。它遵循RFC 6265标准，提供了对Cookie的解析、存储和管理功能。你可以使用它来处理和存储Cookie，或者直接将其作为HTTP客户端使用。

功能

• ✅ Cookie：表示单个Cookie对象。
• ✅ CookieStore：用于存储和检索Cookie。
• ✅ CookieClient：基于http包的HTTP客户端，内置了CookieStore来自动管理Cookie。

使用方法

1. CookieKey

CookieKey 用于唯一标识一个Cookie，它由Cookie的名称、域名和路径组成。

// 示例：创建一个CookieKey
CookieKey key = CookieKey('session_id', Uri(host: 'example.com', path: '/user'));

2. Cookie

Cookie 可以从Set-Cookie响应头中解析出来。以下是一个示例：

// 从Set-Cookie头中解析Cookie
Cookie cookie = Cookie.fromSetCookieHeader(
    "foo=bar; Domain=example.com; Path=/; Secure; HttpOnly",
    // 可选参数，默认为当前时间
    time: DateTime.now(),
    // 可选参数，用于验证和当Domain属性缺失时
    domain: Uri(host: "example.com"),
);

print(cookie.domain); // => example.com
print(cookie.path);   // => /
print(cookie.secure); // => true
print(cookie.httpOnly); // => true

注意：DateTime对象总是转换为UTC，因为这是标准要求的。

3. RawCookie

RawCookie 是Cookie的简化形式，只包含名称、值和属性映射。它可以像Cookie一样从Set-Cookie头中解析。

4. CookieStore

CookieStore 用于存储和检索Cookie。它实现了Map<CookieKey, Cookie>接口。

// 创建一个CookieStore实例
CookieStore store = CookieStore();

// 添加多个Cookie
DateTime time = DateTime.utc(2015, 10, 21, 7, 0);

store.executeHeaders([
    "foo=bar; Domain=example.com; Path=/; Secure; HttpOnly",
    "foo=baz; Path=/bar; HttpOnly; Expires=Wed, 21 Oct 2015 07:28:00 GMT",
    "bar=foo; Domain=bar.example.com; Secure; Max-Age=3600",
], domain: Uri(host: "bar.example.com"), time: time);

// 获取指定域和路径的Cookie
print(store.cookiesFor(uri: Uri(host: "bar.example.com"), time: time));
// => [foo=bar; Domain=example.com; Secure; HttpOnly,
//     bar=foo; Expires=Wed, 21 Oct 2015 08:00:00 GMT; Domain=bar.example.com; Secure]

// 更新时间并清理过期Cookie
time = time.add(Duration(hours: 2));

store.pump(time: time);

print(store.cookiesFor(uri: Uri(host: "bar.example.com"), time: time));
// => [foo=bar; Domain=example.com; Secure; HttpOnly]

5. CookieClient

CookieClient 是http包中的Client的封装，内置了CookieStore来自动管理Cookie。

import 'package:http_cookie_store/http_cookie_store.dart';
import 'package:collection/collection.dart';

void main() async {
  // 创建一个CookieClient实例
  final client = CookieClient();

  // 发送GET请求到纽约时报
  await client.get(Uri.parse('https://www.nytimes.com/'));

  // 发送GET请求到CNN
  await client.get(Uri.parse('https://edition.cnn.com/'));

  // 打印所有存储的Cookie，按域名分组
  groupBy(client.store.cookies, (c) => c.domain).forEach((key, value) {
    print("$key:");
    for (var cookie in value) {
      print('\t$cookie');
    }
  });

  // 获取特定Cookie
  print(client.store[CookieKey('geoData', Uri(host: 'cnn.com'))]);

  // 关闭客户端
  client.close();
}

完整示例Demo

以下是一个完整的示例，展示了如何使用http_cookie_store插件来管理HTTP请求中的Cookie。

import 'package:http_cookie_store/http_cookie_store.dart';
import 'package:collection/collection.dart';

void main() async {
  // 创建一个CookieClient实例
  final client = CookieClient();

  try {
    // 发送GET请求到纽约时报
    final response1 = await client.get(Uri.parse('https://www.nytimes.com/'));
    print('Response from NYTimes: ${response1.statusCode}');

    // 发送GET请求到CNN
    final response2 = await client.get(Uri.parse('https://edition.cnn.com/'));
    print('Response from CNN: ${response2.statusCode}');

    // 打印所有存储的Cookie，按域名分组
    groupBy(client.store.cookies, (c) => c.domain).forEach((key, value) {
      print("Cookies for domain $key:");
      for (var cookie in value) {
        print('\t$cookie');
      }
    });

    // 获取特定Cookie
    final specificCookie = client.store[CookieKey('geoData', Uri(host: 'cnn.com'))];
    if (specificCookie != null) {
      print('Specific Cookie: $specificCookie');
    } else {
      print('No specific cookie found for cnn.com');
    }
  } finally {
    // 关闭客户端
    client.close();
  }
}