https://github.com/ajinasokan/flutter_curl

Flutter plugin to use libcurl for HTTP calls
https://github.com/ajinasokan/flutter_curl

curl flutter http libcurl quic

Last synced: 6 days ago
JSON representation

Flutter plugin to use libcurl for HTTP calls

• Host: GitHub
• URL: https://github.com/ajinasokan/flutter_curl
• Owner: ajinasokan
• License: mit
• Created: 2020-12-21T10:18:06.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-12-06T05:30:33.000Z (about 2 months ago)
• Last Synced: 2025-01-09T06:09:51.323Z (14 days ago)
• Topics: curl, flutter, http, libcurl, quic
• Language: Dart
• Homepage:
• Size: 563 KB
• Stars: 53
• Watchers: 3
• Forks: 9
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# libcurl for Flutter

Flutter plugin to use [libcurl](https://curl.se/libcurl/) for HTTP calls in Flutter Android & iOS apps. HTTP stack built in to Dart as part of `dart:io` supports only HTTP 1.1. This plugin aims to bring upto date features in connectivity available in libcurl such as:

* HTTP2 with [Nghttp2](https://nghttp2.org)

* Automatic upgrade to HTTP2 from 1.1 with [ALPN](https://www.keycdn.com/support/alpn) TLS extension

* [Brotli](https://github.com/google/brotli) compression

* **Experimental** HTTP3 and alt-svc support

## Getting started

Add to project:

```yaml

flutter pub add flutter_curl

```

Example usage:

```dart

import 'package:flutter_curl/flutter_curl.dart';

import 'package:path/path.dart' as path;

import 'package:path_provider/path_provider.dart' as paths;

// Initialize client

Client client = Client(

      verbose: true,

      interceptors: [

        // HTTPCaching(),

      ],

    );

await client.init();

// Send request

final res = await c.send(Request(

      method: "GET",

      url: "https://ajinasokan.com/",

      headers: {

          "user-agent": "myapp-v1.0/android9"

      },

      // body

      // body: RequestBody.raw(utf8.encode("hello world")),

      // body: RequestBody.string("hello world"),

      // body: RequestBody.form({"age": "10", "hello": "world"}),

      // body: RequestBody.multipart([

      //    Multipart(name: "age", data: "24"),

      //    Multipart(name: "hello", data: "world"),

      //    Multipart.file(

      //      name: "fieldname",

      //      path: "/sdcard/todo.txt",

      //      filename: "filename.txt",

      //    ),

      //  ]),

    },

));

// Read response

print("Status: ${res.statusCode}");

print("HTTP: ${res.httpVersion}");

res.headers.forEach((key, value) {

    print("$key: $value");

});

print(res.text());

```

## How it works

This plugin uses custom built libcurl libraries distributed via [releases](https://github.com/ajinasokan/flutter_curl/releases). If you would like to build these by yourself follow [instructions](https://github.com/curl/curl/blob/master/docs/HTTP3.md) in cURL project. The configuration used for above mentioned builds is:

* [Ngtcp2](https://github.com/ngtcp2/ngtcp2) for HTTP2

* [libbrotli](https://github.com/bagder/libbrotli)

* NDK min SDK: 21 (armv7a, arm64, x86_64), iOS min SDK: 8.0 (arm64, x86_64)

* Android binaries are packaged as **aar** and iOS binary as **framework**

This will be downloaded once the project builds for Android or when pod install happens for iOS. In Android these binaries are dynamically linked and in iOS it is statically linked.

The cURL APIs are accessed directly in a different isolate in Flutter using the [dart:ffi](https://dart.dev/guides/libraries/c-interop) APIs(beta). Isolate is used to avoid unresponsiveness in the app as the cURL APIs are blocking.

## Reducing APK size

Flutter's `--target-platform` argument only removes its own native binaries for unspecified architectures. This is not adding `abiFilters` to the project gradle. So this doesn't remove the binaries for unspecified architectures from the plugins like flutter_curl. 

A workaround suggested in [flutter_vpn](https://pub.dev/packages/flutter_vpn) project is to add this logic to the project gradle config manually like below:

```groovy

android {

    ...

    buildTypes {

        ...

        release {

            ...

            ndk {

                if (!project.hasProperty('target-platform')) {

                    abiFilters 'arm64-v8a', 'armeabi-v7a', 'x86_64'

                } else {

                    def platforms = project.property('target-platform').split(',')

                    def platformMap = [

                            'android-arm'  : 'armeabi-v7a',

                            'android-arm64': 'arm64-v8a',

                            'android-x86'  : 'x86',

                            'android-x64'  : 'x86_64',

                    ]

                    abiFilters = platforms.stream().map({ e ->

                        platformMap.containsKey(e) ? platformMap[e] : e

                    }).toArray()

                }

            }

    }

}

```