Flutter网络请求插件cherry_request的使用

cherry_request 是一个用于 Flutter 的网络请求插件，它基于 Dio 实现，提供了更简洁的 API 和更多的功能。本文将详细介绍如何使用 cherry_request 插件进行网络请求，并附带完整的示例代码。

Getting Started（开始使用）

1. 添加依赖

在你的 pubspec.yaml 文件中添加 cherry_request 依赖：

dependencies:
  cherry_request: ^1.0.0  # 请根据最新版本替换

然后运行以下命令安装依赖：

flutter pub get

2. 初始化 HttpClient

首先，我们需要初始化一个 HttpClient 对象，配置基础 URL 和超时时间等参数。

以下是完整的初始化代码：

import 'package:cherry_request/request/index.dart';
import 'package:dio/dio.dart';
import 'package:flutter/material.dart';

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

class MyApp extends StatefulWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  late HttpClient httpClient;

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

    // 配置 HTTP 客户端
    HttpConfig httpConfig = HttpConfig(
      baseUrl: 'https://jsonplaceholder.typicode.com', // 示例 API 基础 URL
      interceptors: [], // 可选的拦截器列表
      connectTimeout: 100000, // 连接超时时间（毫秒）
      sendTimeout: 100000, // 请求发送超时时间（毫秒）
      receiveTimeout: 100000, // 响应接收超时时间（毫秒）
    );

    // 创建 HttpClient 实例
    httpClient = HttpClient(dioConfig: httpConfig, checkSuccessFn: (Response<dynamic> response) {
      // 自定义成功判断逻辑
      return response.data!["code"] == 200;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('cherry_request 示例'),
        ),
        body: const Center(
          child: Text('网络请求插件已初始化！'),
        ),
      ),
    );
  }
}

3. 发起网络请求

接下来，我们可以通过 httpClient 发起 GET 或 POST 请求。以下是完整的示例代码：

示例 1：GET 请求

Future<void> fetchPosts() async {
  try {
    // 发起 GET 请求
    Response response = await httpClient.get('/posts');

    // 检查请求是否成功
    if (response.isSuccess) {
      print('GET 请求成功，数据为: ${response.data}');
    } else {
      print('GET 请求失败，错误信息: ${response.message}');
    }
  } catch (e) {
    print('网络请求异常: $e');
  }
}

示例 2：POST 请求

Future<void> createPost() async {
  try {
    // 构造请求参数
    Map<String, dynamic> params = {
      "title": "New Post",
      "body": "This is a new post created by cherry_request.",
      "userId": 1,
    };

    // 发起 POST 请求
    Response response = await httpClient.post('/posts', data: params);

    // 检查请求是否成功
    if (response.isSuccess) {
      print('POST 请求成功，返回数据为: ${response.data}');
    } else {
      print('POST 请求失败，错误信息: ${response.message}');
    }
  } catch (e) {
    print('网络请求异常: $e');
  }
}

4. 调用示例方法

在 build 方法中，我们可以添加按钮来触发上述网络请求方法：

[@override](/user/override)
Widget build(BuildContext context) {
  return MaterialApp(
    home: Scaffold(
      appBar: AppBar(
        title: const Text('cherry_request 示例'),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            ElevatedButton(
              onPressed: fetchPosts,
              child: const Text('发起 GET 请求'),
            ),
            ElevatedButton(
              onPressed: createPost,
              child: const Text('发起 POST 请求'),
            ),
          ],
        ),
      ),
    ),
  );
}