Flutter网络请求插件tang_network的使用

Flutter网络请求插件tang_network的使用

tang_network 是一个用于HTTP网络请求的工具，具备以下功能：

• GET 请求
• POST 请求
• 文件上传
• 文件下载
• 抽象配置支持

安装

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

dependencies:
  tang_network: ^0.0.1

然后运行 flutter pub get 来安装该库。

使用

配置

首先需要实现一些配置类，这些类用于自定义网络请求的行为。例如：

/// Configuration.
class MainConfigNetworkHttp implements NetworkHttpConfig { /* 实现配置逻辑 */ }

/// Base.
class MainConfigNetworkHttpBase implements NetworkHttpBase { /* 实现基础配置逻辑 */ }

/// Keys.
class MainConfigNetworkHttpKeys implements NetworkHttpKeys { /* 实现键值逻辑 */ }

/// Codes.
class MainConfigNetworkHttpCodes implements NetworkHttpCodes { /* 实现状态码逻辑 */ }

/// Getters.
class MainConfigNetworkHttpGetters implements NetworkHttpGetters { /* 实现获取器逻辑 */ }

/// Callbacks.
class MainConfigNetworkHttpCallbacks implements NetworkHttpCallbacks { /* 实现回调逻辑 */ }

初始化

在应用启动时调用 setup() 方法进行初始化：

await NetworkHttp.shared.setup(config: MainConfigNetworkHttp());

可选步骤：如果需要收集设备信息，则在用户同意后调用 setupDeviceInfo() 方法：

onPrivacyPolicyConfirmed: () async {
  await NetworkHttp.shared.setupDeviceInfo();
}

发送请求

创建一个API类，并调用 NetworkHttp 的API发送请求：

final response = await NetworkHttp.shared.request('/api-service/module/method',
  {
    'param1': 1,
    'param2': '2',
  },
  method: NetworkMethodType.post,
).then((resp) => NetworkRespModel.fromJson(resp));
return response;

完整示例

下面是一个完整的示例代码，展示了如何使用 tang_network 插件发送网络请求。

import 'package:example/tang_network_example_api.dart';
import 'package:example/tang_network_example_config.dart';
import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'package:tang_network/http/tang_network_http.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await NetworkHttp.shared.setup(config: ExampleConfigNetworkHttp());
  await NetworkHttp.shared.setupDeviceInfo();
  runApp(const MyApp());
}

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

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

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key, required this.title});

  final String title;

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  final _exampleApi = NetworkExampleApi();
  String? _response;

  void _doRequest() async {
    final response = await _exampleApi.getJson('param1', 'param2');
    setState(() {
      _response = response;
    });
    if (kDebugMode) {
      print('The response of HTTP request is: $response');
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        backgroundColor: Theme.of(context).colorScheme.inversePrimary,
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            Text(
              _response == null
                  ? 'Please click the add button to send a request.'
                  : 'You have sent a HTTP request,',
            ),
            Text(
              'the response is: ${_response ?? '...'}',
              style: Theme.of(context).textTheme.headlineMedium,
              maxLines: 888,
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _doRequest,
        tooltip: 'Send',
        child: const Icon(Icons.add),
      ),
    );
  }
}