Flutter支付请求插件paylike_dart_request的使用

Flutter支付请求插件paylike_dart_request的使用

Paylike低级请求助手

本库用于通过HTTP(s)请求与Paylike API进行交互。它遵循了Paylike API参考文档中的约定。

该库适用于任何Dart环境（包括Flutter），因为它接受一个io.HttpClient实现作为输入。这个库利用io.HttpClient是因为它可以适当地中止请求。

这个函数通常会放在重试机制后面。Paylike API期望客户端能够优雅地处理速率限制响应，并在必要时进行重试。

由于重试机制高度依赖于项目，并且在没有进一步上下文的情况下难以实现流式请求，因此这个包不包含重试机制。

示例

var requester = PaylikeRequester().setLog((dynamic o) => print(o));
var opts = RequestOptions.fromClientId('dart-1')
    .setQuery({
      'foo': 'bar',
    })
    .setVersion(1)
    .setData({
      'foo': 'bar',
    });
requester.request('http://foo', opts).then((response) {
  return response.getBody();
}).then((body) {
  print(body);
}).catchError((error) {
  print(error);
});

PaylikeRequester 类

这是用来初始化请求者实例的默认类：

var requester = PaylikeRequester();

默认情况下，请求者使用默认的io.HttpClient作为其客户端，并且有一个简单的日志功能：

class PaylikeRequester {
  Function log = (dynamic o) => print(o);
  io.HttpClient client = io.HttpClient();
  ...
}

你可以通过命名构造函数来改变这一点：

var requester = PaylikeRequester.withClientAndLog(io.HttpClient(), (dynamic o) => print(o));

request 函数

用于执行请求，其签名如下：

Future<PaylikeResponse> request(String endpoint, RequestOptions? opts)

消耗一个端点和RequestOptions，然后返回PaylikeResponse。

RequestOptions

描述了构建请求的不同选项。

构造器：

var opts = RequestOptions.v1() // 创建版本1的请求选项

var opts = RequestOptions.fromClientId('your-client-id'); // 使用你的client id创建

RequestOptions 使用构建器模式：

var opts = RequestOptions.fromClientId('dart-1')
    .setQuery({
      'foo': 'bar',
    })
    .setVersion(1)
    .setData({
      'foo': 'bar',
    })
    .setTimeout(Duration(seconds: 20));

PaylikeResponse

描述了请求的响应。

var response = await requester.request('http://foo', opts);

var body = await response.getBody(); // String | 返回纯文本响应体

var reader = await response.getBodyReader(); // Stream<dynamic> | 返回带有解码json体的对象流

错误处理

request 可能抛出以下错误类之一以及io.HttpClient 实现可能抛出的任何错误。

所有错误类都可以通过包访问。

示例

try {
  await requester.request('http://foo', opts);
} catch (e) {
  if (e is RateLimitException) {
    // 启动重试
  }
  if (e is ServerErrorException) {
    // 意外的服务器错误
  }
}

try {
  var opts = RequestOptions().setVersion(0);
} catch (e) {
  if (e is VersionException) {
    // 版本应该是正整数
  }
}

错误类

• RateLimitException

  如果由服务器发送，可能会有retryAfter（Duration）属性，指定最小延迟。

• TimeoutException

  来自dart:async库。

• ServerErrorException

  具有从io.HttpClientResponse复制的status和headers属性。

• PaylikeException

  这些错误对应API参考中的状态码。它们至少具有code和message属性，但可能还具有其他有用的属性，例如金额的最小值和最大值。

完整示例代码

import 'package:paylike_dart_request/paylike_dart_request.dart';

Future<void> fetchBodyAsStream(PaylikeRequester requester, RequestOptions opts) async {
  var response = await requester.request('http://foo', opts);
  var reader = await response.getBodyReader();
  await reader.forEach((element) {
    print(element);
  });
}

void main() {
  var requester = PaylikeRequester().setLog((dynamic o) => print(o));
  var opts = RequestOptions.fromClientId('dart-1')
      .setQuery({
        'foo': 'bar',
      })
      .setVersion(1)
      .setData({
        'foo': 'bar',
      });
  requester.request('http://foo', opts).then((response) {
    return response.getBody();
  }).then((body) {
    print(body);
  }).catchError((error) {
    print(error);
  });

  fetchBodyAsStream(requester, opts).catchError((error) {
    print(error);
  });
}