Flutter网络交互插件packagist_network的使用

网络

示例

• 示例

使用

要使用此插件，在您的 pubspec.yaml 文件中添加 network 作为依赖项。

dependencies:
  network: 
    git:
      url: https://github.com/flutter-packagist/network.git

支持的方法

• ✅ GET
• ✅ POST
• ✅ PUT
• ✅ DELETE
• ✅ PATCH
• ✅ HEAD
• ✅ DOWNLOAD

示例

初始化

HttpRequest().init(HttpRequestSetting(
  baseUrl: EnvConfig.host,
  interceptors: [
    RetryOnConnectionChangeInterceptor(),
    DioLogInterceptor(),
    CancelTokenInterceptor(),
  ],
));

GET

await HttpRequest().get(
  'get',
  onSuccess: (data) {
    showToast("请求成功: ${data.toString()}");
  },
  onFailed: (code, DioException? error) {
    logE('code: $code, msg: $error');
  },
);

POST

await HttpRequest().post(
  'post',
  onSuccess: (data) {
    showToast("请求成功: ${data.toString()}");
  },
  onFailed: (code, DioException? error) {
    logE('code: $code, msg: $error');
  },
);

PUT

await HttpRequest().put(
  'put',
  onSuccess: (data) {
    showToast("请求成功: ${data.toString()}");
  },
  onFailed: (code, DioException? error) {
    logE('code: $code, msg: $error');
  },
);

DELETE

await HttpRequest().delete(
  'delete',
  onSuccess: (data) {
    showToast("请求成功: ${data.toString()}");
  },
  onFailed: (code, DioException? error) {
    logE('code: $code, msg: $error');
  },
);

PATCH

await HttpRequest().patch(
  'patch',
  onSuccess: (data) {
    showToast("请求成功: ${data.toString()}");
  },
  onFailed: (code, DioException? error) {
    logE('code: $code, msg: $error');
  },
);

HEAD

await HttpRequest().head(
  'head',
  onSuccess: (data) {
    showToast("请求成功: ${data.toString()}");
  },
  onFailed: (code, DioException? error) {
    logE('code: $code, msg: $error');
  },
);

下载

await HttpRequest().download(
  url,
  '${(await getTemporaryDirectory()).path}/test.jpg',
  onReceiveProgress: (count, total) {
    logD('进度：$count / $total');
  },
  onSuccess: (data) {
    showToast("下载完成");
  },
  onFailed: (code, error) {
    logE('code: $code, msg: $error');
  },
);

在 Web 上，您可以使用 download(url) 来下载文件。例如：

/// 下载链接内容
static void download(String url) {
  html.AnchorElement anchorElement = html.AnchorElement(href: url);
  anchorElement.download = url;
  anchorElement.click();
}

上传

选择文件

MultipartFile? multipartFile;
if (GetPlatform.isWeb) {
  FilePickerResult? result = await FilePicker.platform.pickFiles();
  Uint8List? fileBytes = result!.files.first.bytes;
  String fileName = result.files.first.name;
  if (fileBytes == null) {
    showToast("文件为空");
    return;
  }
  multipartFile = MultipartFile.fromBytes(
    fileBytes,
    filename: fileName,
  );
} else {
  FilePickerResult? result = await FilePicker.platform.pickFiles();
  if (result?.files.single.path == null) {
    showToast("文件为空");
    return;
  }
  showToast("文件路径: ${result!.files.single.path}");
  multipartFile = await MultipartFile.fromFile(result.files.single.path!);
}

上传文件

await HttpRequest().post(
  'upload',
  formData: {'file': multipartFile},
  onSuccess: (data) {},
  onFailed: (code, msg) {},
  onSendProgress: (count, total) {
    logD('进度：$count / $total');
  },
);

拦截器

• RetryOnConnectionChangeInterceptor: 当网络连接更改时重试。
• DioLogInterceptor: 日志拦截器。
• CancelTokenInterceptor: 在发送请求时会自动创建一个取消令牌，并将其添加到 CancelTokenPool。请求完成后或被取消后，将从 CancelTokenPool 中移除取消令牌。

自定义拦截器

class CustomInterceptor extends Interceptor {
  [@override](/user/override)
  void onRequest(RequestOptions options, RequestInterceptorHandler handler) {
    super.onRequest(options, handler);
    
  }

  [@override](/user/override)
  void onResponse(Response response, ResponseInterceptorHandler handler) {
    super.onResponse(response, handler);
    
  }

  [@override](/user/override)
  void onError(DioException err, ErrorInterceptorHandler handler) {
    super.onError(err, handler);
    
  }
}

添加拦截器

HttpRequest().init(HttpRequestSetting(
  baseUrl: EnvConfig.host,
  interceptors: [
    ...
    CustomInterceptor(),
  ],
));

取消请求

取消令牌

final cancelToken = CancelToken();
await HttpRequest().get(
  'get',
  cancelToken: cancelToken,
);

cancelToken.cancel();

绑定控制器

如果您希望在控制器被释放时取消网络请求，可以使用 CancelTokenPool().cancel(this) 来取消它。并将请求绑定到控制器。

class NetworkController extends BaseController<NetworkModel> {
  [@override](/user/override)
  NetworkModel model = NetworkModel();
  
  [@override](/user/override)
  onReady() {
    super.onReady();
    get();
  }

  [@override](/user/override)
  void onClose() {
    // 取消当前控制器绑定的网络请求
    CancelTokenPool().cancel(this);
    super.onClose();
  }
  
  void get() {
    HttpRequest().get(
      'get',
      bind: this,
    );
  }
}

记得在初始化 HttpRequest 时添加 CancelTokenInterceptor()。

HttpRequest().init(HttpRequestSetting(
  baseUrl: EnvConfig.host,
  interceptors: [
    ...
    CancelTokenInterceptor(),
  ],
));

安全转换

• toInt(value, {int defaultValue = 0})
• toDouble(value, {double defaultValue = 0.0})
• toBool(value, {bool defaultValue = false})
• toString(value, {String defaultValue = ""})
• toMap(value, {Map<String, dynamic>? defaultValue})
• toList(value, {List? defaultValue})
• asInt(Map<String, dynamic>? json, String key, {int defaultValue = 0})
• asDouble(Map<String, dynamic>? json, String key, {double defaultValue = 0.0})
• asBool(Map<String, dynamic>? json, String key, {bool defaultValue = false})
• asString(Map<String, dynamic>? json, String key, {String defaultValue = ""})
• asMap(Map<String, dynamic>? json, String key, {Map<String, dynamic>? defaultValue})
• asList(Map<String, dynamic>? json, String key, {List? defaultValue})

示例

test("convert dynamic to safe type", () {
  Object? a;
  print(a.runtimeType); // print: Null
  print(toInt(a).runtimeType); // print: int
  print(toInt(a)); // print: 0
});

test("convert from json key to safe type", () {
  final json = {
    'int': 1,
    'double': 1.0,
    'bool': true,
    'string': 'string',
    'map': {'key': 'value'},
    'list': ["1", "2", "3"],
  };

  print(asInt(json, 'int')); // print: 1
  print(asDouble(json, 'double')); // print: 1.0
  print(asBool(json, 'bool')); // print: true
  print(asString(json, 'string')); // print: string
  print(asMap(json, 'map')); // print: {key: value}
  print(asList(json, 'list').map((e) => toString(e)).toList()); // print [1, 2, 3]

  print("\n");
  print(asMap(json, 'int')); // print: {}
  print(asMap(json, 'double')); // print: {}
  print(asMap(json, 'bool')); // print: {}
  print(asMap(json, 'string')); // print: {}
  print(asMap(json, 'map')); // print: {}
  print(asMap(json, 'list')); // print: {}

  print("\n");
  print(asList(json, 'map').map((e) => toString(e)).toList()); // print []
});

完整示例Demo

示例代码

example/lib/main.dart

import 'dart:async';

import 'package:example/network/network_page.dart';
import 'package:flutter/material.dart';
import 'package:log_wrapper/log/log.dart';
import 'package:oktoast/oktoast.dart';

import 'app_service.dart';

void main() {
  runZonedGuarded(() async {
    WidgetsFlutterBinding.ensureInitialized();
    await AppService.init();
    runApp(const MyApp());
  }, (Object error, StackTrace stack) {
    logStackE("$error", error, stack);
  });
}

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      home: const NetworkPage(),
      builder: (context, widget) {
        return OKToast(child: widget!);
      },
    );
  }
}