Flutter网络通信插件rocket_client的使用

Flutter网络通信插件rocket_client的使用

Rocket Client 是一个 Dart 包，提供了简单易用的 HTTP 客户端。它基于 http 包，并提供了一些额外的功能，如处理 Rocket 模型、检查原始响应数据以及处理异常。

使用

创建一个 RocketClient 类的实例，并使用其 request 方法发送 HTTP 请求：

final rocket = RocketClient(url: 'https://jsonplaceholder.typicode.com');

final response = await rocket.request('posts', method: HttpMethods.get);

print(response);

你也可以通过向 request 方法提供一个 RocketModel 来自动处理响应数据：

final rocket = RocketClient(url: 'https://jsonplaceholder.typicode.com');

final post = Post();

await rocket.request('posts/1', model: post, method: HttpMethods.get);

print(post.toJson());

使用 sendFile 方法可以将文件发送到服务器：

final rocket = RocketClient(url: 'https://example.com');

final response = await rocket.sendFile('upload', files: {'file': '/path/to/my/file.jpg'});

print(response);

API 参考

RocketClient

RocketClient({required String url, Map<String, String> headers = const {}, bool setCookies = false})

创建一个新的 RocketClient 实例。

• url: API 的基础 URL。
• headers: 每个请求附加的额外头信息。
• setCookies: 是否在后续请求中设置从服务器接收到的 Cookie。

Future<dynamic> request<T>(String endpoint, {RocketModel<T>? model, HttpMethods method = HttpMethods.get, RocketDataCallback? inspect, List<String>? targetData, Map<String, dynamic>? data, Map<String, dynamic>? params})

向指定的 endpoint 发送 HTTP 请求。

• endpoint: 要发送请求的目标端点。
• model: 用于处理响应数据的可选 RocketModel。
• method: 要使用的 HTTP 方法。
• inspect: 用于检查原始响应数据的函数。
• targetData: 用于从响应数据中提取嵌套 JSON 对象的关键字列表。
• data: 请求正文，在发送前会被序列化为 JSON。
• params: 要添加到 URL 的查询参数。

返回一个 Future，解析为响应数据（如果提供了 model 则返回处理后的数据，否则返回 JSON 或字符串）。

Future<dynamic> sendFile(String endpoint, {String id = “”, HttpMethods method = HttpMethods.post, Map<String, String>? fields, Map<String, String>? files})

向指定的 endpoint 发送文件或文件，并返回处理后的响应数据。

• endpoint: 要发送文件的目标端点。
• id: URL 中包含的可选 ID。
• method: 要使用的 HTTP 方法。
• fields: 与文件一起发送的其他字段。
• files: 要发送的文件。

返回一个 Future，解析为处理后的响应数据。

HttpMethods

枚举表示 HTTP 方法。

• get: GET 方法。
• post: POST 方法。
• put: PUT 方法。
• delete: DELETE 方法。

示例代码

以下是一个完整的示例代码，展示了如何使用 RocketClient 发送 HTTP 请求并处理响应：

import 'dart:developer';

import 'package:flutter/material.dart';
import 'dart:convert';
import 'package:rocket_client/rocket_client.dart';
import 'package:rocket_model/rocket_model.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Rocket Client Example',
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
      ),
      home: const RocketClientExample(),
    );
  }
}

class RocketClientExample extends StatefulWidget {
  const RocketClientExample({super.key});

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

class RocketClientExampleState extends State<RocketClientExample> {
  final client = RocketClient(
    url: 'https://dummyjson.com',
    globalRetryOptions: RetryOptions(
      retries: 5,
      retryWhen: (r) => r.statusCode != 200,
      onRetry: (p0, p1, p2) {
        log("Retry $p2");
      },
    ),
  );
  bool isLoading = false;
  bool isFailed = false;

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Rocket Client Example'),
      ),
      body: Center(
        child: isLoading
            ? CircularProgressIndicator()
            : Row(
                mainAxisAlignment: MainAxisAlignment.spaceEvenly,
                children: [
                  ElevatedButton(
                    onPressed: () {
                      _makeRequest(context, "products");
                    },
                    child: const Text('Make Request'),
                  ),
                  ElevatedButton(
                    onPressed: () {
                      // 传递错误的端点以产生错误
                      _makeRequest(context, "productsss");
                    },
                    child: const Text('Make Failed Request'),
                  ),
                ],
              ),
      ),
    );
  }

  Future<void> _makeRequest(BuildContext context, String endpoint) async {
    isLoading = true;
    isFailed = false;
    setState(() {});

    // 发送 GET 请求到 /products 端点
    final RocketModel response = await client.request(
      endpoint,
      target: ['products'],
      retryOptions: RetryOptions(
        retries: 2,
        retryWhen: (r) => r.statusCode != 200,
      ),
      onError: (response, statusCode) {
        isFailed = true;
        ScaffoldMessenger.of(context).showSnackBar(SnackBar(
            content: Column(
          children: [
            const Text("Failed"),
            Text("response : $response & status code: $statusCode"),
          ],
        )));
      },
    );

    isLoading = false;
    setState(() {});

    // 在对话框中显示响应
    if (!isFailed) {
      showDialog(
        context: context,
        builder: (context) {
          return AlertDialog(
            title: Text('Response : ${response.statusCode}'),
            content: Text(json.encode(response.apiResponse)),
            actions: [
              TextButton(
                onPressed: () {
                  Navigator.pop(context);
                },
                child: const Text('OK'),
              ),
            ],
          );
        },
      );
    }
  }
}