http_client_helper 0.2.1

  • Readme
  • Changelog
  • Example
  • Installing
  • 96

http_client_helper #

pub package

A Flutter plugin for http request with cancel and retry fuctions.

Usage #

To use this plugin, add http_client_helper as a dependency in your pubspec.yaml file.

Example #

  cancellationToken = new CancellationToken();
      try {
        await HttpClientHelper.get(url,
                cancelToken: cancellationToken,
                timeRetry: Duration(milliseconds: 100),
                retries: 3,
                timeLimit: Duration(seconds: 5))
            .then((response) {
          setState(() {
            msg = response.body;
          });
        });
      } on TimeoutException catch (_) {
        setState(() {
          msg = "TimeoutException";
        });
      } on OperationCanceledError catch (_) {
        setState(() {
          msg = "cancel";
        });
      } catch (e) {
        setState(() {
          msg = "$e";
        });
      }

Please see the example app of this plugin for a full example.

[0.2.1] #

  • public HttpClientHelper.httpClient, so that you can new client base on your case. dart:io =>IOClient dart:html=>BrowserClient

[0.2.0] #

  • add OnTimeout onTimeout parameter for all method

[0.1.8] #

  • add other method of http

[0.1.7] #

  • add timeLimit for timeout

[0.1.5] #

  • format code

[0.1.4] #

  • remove map to string for post

[0.1.3] #

  • make all http_client_helper darts as library http_client_helper

[0.1.2] #

  • Fix retries for retry helper.

[0.1.1] #

  • Handle map body.

[0.1.0] #

  • Upgrade Some Commments.

[0.0.1] #

  • Initial Open Source release.

example/lib/main.dart

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

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

class MyApp extends StatelessWidget {
  // This widget is the root of your application.
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        // This is the theme of your application.
        //
        // Try running your application with "flutter run". You'll see the
        // application has a blue toolbar. Then, without quitting the app, try
        // changing the primarySwatch below to Colors.green and then invoke
        // "hot reload" (press "r" in the console where you ran "flutter run",
        // or press Run > Flutter Hot Reload in IntelliJ). Notice that the
        // counter didn't reset back to zero; the application is not restarted.
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(title: 'http client helper'),
    );
  }
}

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

  // This widget is the home page of your application. It is stateful, meaning
  // that it has a State object (defined below) that contains fields that affect
  // how it looks.

  // This class is the configuration for the state. It holds the values (in this
  // case the title) provided by the parent (in this case the App widget) and
  // used by the build method of the State. Fields in a Widget subclass are
  // always marked "final".

  final String title;

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

class _MyHomePageState extends State<MyHomePage> {
  CancellationToken cancellationToken;
  String msg = "";
  @override
  void initState() {
    // TODO: implement initState
    super.initState();
  }

  void request() async {
    var url = "https://api.tuchong.com/feed-app";
    //url = "https://google.com";
    setState(() {
      msg = "begin request";
    });
    cancellationToken = new CancellationToken();
    try {
      await HttpClientHelper.get(url,
              cancelToken: cancellationToken,
              timeRetry: Duration(milliseconds: 100),
              retries: 3,
              timeLimit: Duration(seconds: 5))
          .then((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(
          // Here we take the value from the MyHomePage object that was created by
          // the App.build method, and use it to set our appbar title.
          title: Text(widget.title),
        ),
        body: Column(
          children: <Widget>[
            Row(
              mainAxisAlignment: MainAxisAlignment.spaceBetween,
              children: <Widget>[
                FlatButton(
                    onPressed: () {
                      request();
                    },
                    child: Text("Requset")),
                FlatButton(
                    onPressed: () {
                      cancel();
                    },
                    child: Text("Cancel"))
              ],
            ),
            Expanded(
              child: Text(msg),
            )
          ],
        ));
  }
}

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  http_client_helper: ^0.2.1

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter pub get

Alternatively, your editor might support pub get or flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:http_client_helper/http_client_helper.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
93
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
96
Learn more about scoring.

We analyzed this package on Apr 8, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.7.1
  • pana: 0.13.6

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0-dev.68.0 <3.0.0
http ^0.12.0 0.12.0+4
Transitive dependencies
async 2.4.1
charcode 1.1.3
collection 1.14.12
http_parser 3.1.4
meta 1.1.8
path 1.6.4
pedantic 1.9.0
source_span 1.7.0
string_scanner 1.0.5
term_glyph 1.1.0
typed_data 1.1.6