Flutter网络请求辅助插件http_client_helper的使用

简介

http_client_helper 是一个用于Flutter应用进行HTTP请求的插件，它提供了取消和重试的功能。该插件可以方便地集成到你的项目中，并且可以通过简单的配置来处理复杂的网络请求逻辑。

使用方法

添加依赖

为了使用此插件，你需要在项目的pubspec.yaml文件中添加http_client_helper作为依赖项：

dependencies:
  http_client_helper: ^最新版本号

然后运行flutter pub get来安装依赖。

示例代码

下面是一个完整的示例，展示了如何使用http_client_helper发起GET请求以及如何取消请求。

完整示例

import 'dart:async';
import 'package:flutter/material.dart';
import 'package:http_client_helper/http_client_helper.dart';

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(title: 'http client helper'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key, this.title}) : super(key: key);

  final String? title;

  @override
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  CancellationToken? cancellationToken;
  String msg = '';

  Future<void> request() async {
    final Uri url = Uri.parse('https://api.tuchong.com/feed-app');
    setState(() {
      msg = 'begin request';
    });
    cancellationToken = CancellationToken();
    try {
      await HttpClientHelper.get(
        url,
        cancelToken: cancellationToken,
        timeRetry: const Duration(milliseconds: 100),
        retries: 3,
        timeLimit: const Duration(seconds: 5),
      ).then((Response? response) {
        setState(() {
          msg = response!.body;
        });
      });
    } on TimeoutException catch (_) {
      setState(() {
        msg = 'TimeoutException';
      });
    } on OperationCanceledError catch (_) {
      setState(() {
        msg = 'cancel';
      });
    } catch (e) {
      setState(() {
        msg = '$e';
      });
    }
  }

  void cancel() {
    cancellationToken?.cancel();
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title!),
      ),
      body: Column(
        children: <Widget>[
          Row(
            mainAxisAlignment: MainAxisAlignment.spaceBetween,
            children: <Widget>[
              TextButton(
                onPressed: () {
                  request();
                },
                child: const Text('Request'),
              ),
              TextButton(
                onPressed: () {
                  cancel();
                },
                child: const Text('Cancel'),
              )
            ],
          ),
          Expanded(
            child: Text(msg),
          )
        ],
      ),
    );
  }
}

关键点说明

• CancellationToken：用于取消正在进行的网络请求。
• HttpClientHelper.get：发起GET请求的方法，支持设置重试次数、超时时间和取消令牌。
• 异常处理：通过捕获TimeoutException和OperationCanceledError来处理超时和取消的情况。

以上就是http_client_helper的基本用法，你可以根据实际需求调整参数或扩展功能。如果你有更多问题或者需要进一步的帮助，请参考官方文档或示例项目。