Flutter增强型网络请求插件enhanced_http的使用

Flutter增强型网络请求插件enhanced_http的使用

enhanced-http

这是一个围绕Google提供的dart http包（https://pub.dev/packages/http）的包装器，灵感来自axios。

Getting started

创建一个enhanced http实例如下：

// 创建EnhancedHttp实例
EnhancedHttp http = EnhancedHttp(baseURL: "https://dog.ceo/api");

可以通过’name’参数提供自定义头（默认的内容类型指定为application/json）：

// 带有自定义头的EnhancedHttp实例
EnhancedHttp http = EnhancedHttp(
  baseURL: "https://dog.ceo/api",
  headers: {'Authorization': "Bearer $token"}
);

可以按如下方式提供可选的拦截器：

// 使用拦截器的EnhancedHttp实例
EnhancedHttp http = EnhancedHttp(
    baseURL: "https://dog.ceo/api",
    interceptors: InterceptorOptions(
      response: (dynamic res) {
        print("Status ${res["status"]}");
        print("Headers ${res["headers"]}");
        print("Data ${res["data"]}");
        return res["data"];
      },
      error: (dynamic e) {
        print(e);
        return "An error has occurred please try again later";
      }
    )
);

Usage

从API端点获取数据 - GET

// GET 请求示例
final res = await http.get("/path");

向API端点发送数据 - POST

// POST 请求示例
final res = await http.post("/path", payload: {
    "data": "This is some sample data to send to a server"
});

在API端点更新数据 - PUT

// PUT 请求示例
final res = await http.put("/path", payload: {
    "data": "This is some sample data to update at a server"
});

部分更新API端点的数据 - PATCH

// PATCH 请求示例
final res = await http.patch("/path", payload: {
    "data": "This is some sample data to update at a server"
});

删除API端点的数据 - DELETE

// DELETE 请求示例
final res = await http.delete("/path");

请求API端点的头部信息 - HEAD

// HEAD 请求示例
final res = await http.head("/path");

Additional Parameters

http post、http put和http patch方法上的files属性可用于将文件发送到服务器：

// 发送文件示例
final res = await http.post("/path",
    payload: {
        "data": "This is some sample data to update at a server"
    },
    headers: {
      "Content-Type": "multipart/form-data"
    },
    files: [
        {
            "array_key": "file",
            "file": File("path_to_file")
        }
    ],
);

Access to the underlying http package

通过以下方式访问底层的http包，绕过传递依赖导入警告：

import 'package:enhanced_http/enhanced_http.dart' as http;

final res = await http.get("/path");

完整示例Demo

import 'package:flutter/material.dart';
import 'package:enhanced_http/enhanced_http.dart';

void main() {
  // 创建EnhancedHttp实例
  EnhancedHttp http = EnhancedHttp(baseURL: "https://dog.ceo/api");

  runApp(MyApp(http: http));
}

class MyApp extends StatelessWidget {
  final EnhancedHttp http;

  const MyApp({Key? key, required this.http}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Enhanced HTTP Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: HomeScreen(http: http),
    );
  }
}

class HomeScreen extends StatefulWidget {
  final EnhancedHttp http;

  const HomeScreen({Key? key, required this.http}) : super(key: key);

  [@override](/user/override)
  _HomeScreenState createState() => _HomeScreenState();
}

class _HomeScreenState extends State<HomeScreen> {
  String _response = '';

  [@override](/user/override)
  void initState() {
    super.initState();
    _fetchData();
  }

  Future<void> _fetchData() async {
    try {
      // 执行GET请求
      final res = await widget.http.get("/breeds/list/all");
      setState(() {
        _response = res.toString();
      });
    } catch (e) {
      setState(() {
        _response = "Error: $e";
      });
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Enhanced HTTP Demo'),
      ),
      body: Center(
        child: Padding(
          padding: const EdgeInsets.all(16.0),
          child: Text(_response),
        ),
      ),
    );
  }
}