Flutter客户端通信插件duckma_client的使用

duckma_client

一个带有适配层的接口，旨在高效且智能地使用Dio。

安装

1. 在项目的pubspec.yaml文件中添加依赖项：

dependencies:
  duckma_client: ^last

2. 从命令行安装插件：

$ flutter pub get

3. 导入插件：

在Dart代码中可以这样导入：

import 'package:duckma_client/duckma_client.dart';

使用

步骤：

1. 创建一个HttpClient实例。
2. 创建一个Dio实例并将其传递给HttpClient。
3. 开始享受便利吧！

以下是一个完整的示例，展示如何使用duckma_client进行GET请求。

示例代码

main.dart

// Copyright (c) 2022 DuckMa Srl. All rights reserved.
// Use of this source code is governed by a MIT-style license that can be
// found in the LICENSE file.

import 'package:connectivity_plus/connectivity_plus.dart'; // 网络连接工具
import 'package:dio/dio.dart'; // HTTP 请求库
import 'package:duckma_client/duckma_client.dart'; // 主插件
import 'package:example/user/model/user/user_model.dart'; // 用户模型
import 'package:example/user_detail.dart'; // 用户详情页面
import 'package:flutter/material.dart'; // Flutter UI框架

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

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return const MaterialApp(
      home: UsersScreen(), // 启动页面
    );
  }
}

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

  [@override](/user/override)
  State<UsersScreen> createState() => _UsersScreenState();
}

class _UsersScreenState extends State<UsersScreen> {
  late HttpClient _client; // 客户端实例
  final List<UserModel?> _users = []; // 用户列表

  /// 获取所有用户数据
  Future<void> getAllUsers() async {
    final Response<List> response = await _client.get(
      Uri(path: '/users'), // 设置API路径
    );

    // 将响应数据解析为用户模型列表
    final List<UserModel> model =
        response.body.map((e) => UserModel.fromJson(e)).toList();
    _users.addAll(model); // 添加到本地列表

    setState(() {}); // 更新UI
  }

  /// 跳转到用户详情页面
  void onNavToDetail(int index) {
    if (_users[index] != null) {
      Navigator.push(
        context,
        MaterialPageRoute(
          builder: (context) {
            return UserDetailScreen(userModel: _users[index]!);
          },
        ),
      );
    }
  }

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

    // 初始化Dio实例
    Dio dio = Dio();
    dio.options.baseUrl = 'https://jsonplaceholder.typicode.com';

    // 配置网络连接检查器
    final connectivity = Connectivity();
    final requestRetrier = RequestRetrier(dio);
    final connectivityRequestRetrier = ConnectivityRequestRetrier(
      requestRetrier,
      connectivity,
    );

    // 创建HttpClient实例
    _client = HttpClient(
      dio,
      connectivityRequestRetrier: connectivityRequestRetrier,
    );

    // 获取所有用户数据
    getAllUsers();
  }

  [@override](/user/override)
  void dispose() {
    super.dispose();
    _client.close(); // 关闭客户端
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Users'), // 页面标题
      ),
      body: ListView.builder( // 列表视图
        itemCount: _users.length,
        itemBuilder: (BuildContext context, int index) {
          final UserModel? user = _users[index];

          // 如果用户数据存在，则显示用户信息
          if (user != null) {
            return ListTile(
              leading: Text(user.id.toString()), // 用户ID
              title: Text(user.name), // 用户名
              subtitle: Text(user.email), // 用户邮箱
              onTap: () => onNavToDetail(index), // 点击跳转详情
            );
          }

          // 如果数据不存在，显示错误提示
          return const Center(
            child: Text('Error to the user'),
          );
        },
      ),
    );
  }
}