yuexunshi / flutter_net Goto Github PK

License: MIT License

Java 0.51% Kotlin 0.11% Ruby 2.45% Swift 1.38% Objective-C 0.59% Dart 52.46% CMake 18.44% C++ 19.58% C 1.85% HTML 1.66% Shell 0.97%

flutter_net's Introduction

可能是 Flutter 上最强的网络框架, 基于dio实现的非侵入式框架(不影响原有功能). 学习成本低、使用简单, 一行代码发起网络请求, 甚至无需初始化。

Features

RESTful API 设计 GET/POST/PUT/HEAH/DELETE/PATCH/DOWNLOAD
可取消请求
异步解析，数据量大不再卡顿
全局错误处理(减少崩溃率)
自定义解析器，支持全局和单个请求
自定义解析方法
配置请求参数
漂亮的日志打印
证书快速配置
代理配置
拦截器配置
强制缓存模式/自定义缓存Key/缓存有效期/LRU缓存算法/缓存任何数据
监听上传/下载进度

Getting started

dependencies:
  flutter_nb_net: ^1.0.3

Usage

全局配置：

 NetOptions.instance
      // header
      .addHeaders({"aaa": '111'})
      // baseUrl
      .setBaseUrl("https://www.wanandroid.com/")
      // 代理/https
      .setHttpClientAdapter(IOHttpClientAdapter()
        ..onHttpClientCreate = (client) {
          client.findProxy = (uri) {
            return 'PROXY 192.168.20.43:8888';
          };
          client.badCertificateCallback =
              (X509Certificate cert, String host, int port) => true;
          return client;
        })
      // cookie
      .addInterceptor(CookieManager(CookieJar()))
      // dio_http_cache
      .addInterceptor(DioCacheManager(CacheConfig(
        baseUrl: "https://www.wanandroid.com/",
      )).interceptor)
      // dio_cache_interceptor
      .addInterceptor(DioCacheInterceptor(
          options: CacheOptions(
        store: MemCacheStore(),
        policy: CachePolicy.forceCache,
        hitCacheOnErrorExcept: [401, 403],
        maxStale: const Duration(days: 7),
        priority: CachePriority.normal,
        cipher: null,
        keyBuilder: CacheOptions.defaultCacheKeyBuilder,
        allowPostMethod: false,
      )))
       //  全局解析器
      .setHttpDecoder(MyHttpDecoder.getInstance())
       //  超时时间
      .setConnectTimeout(const Duration(milliseconds: 3000))
      // 允许打印log，默认未 true
      .enableLogger(true)
      .create();

请求：

    var appResponse = await get<BannerModel, BannerModel>("banner/json",
        responseType: BannerModel());
    appResponse.when(success: (BannerModel model) {
      var size = model.data?.length;
      debugPrint("成功返回$size条");
    }, failure: (String msg, int code) {
      debugPrint("失败了：msg=$msg/code=$code");
    });

泛型一样，也可以不写：

    var appResponse = await get("banner/json",
        responseType: BannerModel());
    appResponse.when(success: (BannerModel model) {
      var size = model.data?.length;
      debugPrint("成功返回$size条");
    }, failure: (String msg, int code) {
      debugPrint("失败了：msg=$msg/code=$code");
    });

需要原始数据的请求：

    var appResponse = await get("banner/json");
    appResponse.when(success: (dynamic) {
      // var size = model.data?.length;
      debugPrint("成功返回$dynamic");
    }, failure: (String msg, int code) {
      debugPrint("失败了：msg=$msg/code=$code");
    });

Additional information

代码仓库

flutter_net's People

Stargazers

Watchers

Forkers

xuzhendada xiaoyao20084321 bobqiu elite-kai fred-gz liangchj guixin567

flutter_net's Issues

能否支持对于范型的限制。目前所有的请求方法范型是必要的。

如题，针对如下场景的json，传递范型进行decoder是很有必要的。
{ "data": [{ "desc": "我们支持订阅啦~", "id": 30, "imagePath": "https://www.wanandroid.com/blogimgs/42da12d8-de56-4439-b40c-eab66c227a4b.png", "isVisible": 1, "order": 2, "title": "我们支持订阅啦~", "type": 0, "url": "https://www.wanandroid.com/blog/show/3352" }, { "desc": "", "id": 6, "imagePath": "https://www.wanandroid.com/blogimgs/62c1bd68-b5f3-4a3c-a649-7ca8c7dfabe6.png", "isVisible": 1, "order": 1, "title": "我们新增了一个常用导航Tab~", "type": 1, "url": "https://www.wanandroid.com/navi" }, { "desc": "一起来做个App吧", "id": 10, "imagePath": "https://www.wanandroid.com/blogimgs/50c115c2-cf6c-4802-aa7b-a4334de444cd.png", "isVisible": 1, "order": 1, "title": "一起来做个App吧", "type": 1, "url": "https://www.wanandroid.com/blog/show/2" }], "errorCode": 0, "errorMsg": "" }

但对于如下json，范型就是多余的，没必要的。勉强可以定一个只有 status字段但model，但很没必要。
{ "data": { "status": true }, "errorCode": 0, "errorMsg": "" }
甚至，对于不太规范的json，通过 NetConverter 自行解析，就会问题。
{ "data": true, "errorCode": 0, "errorMsg": "" }

我该如何取出 extra: {'"tag"': tag}, extra值

如同标题使用 dio库直接使用response.requestOptions.extra.toString()) 可以获取
使用您的库我该如何操作
在线等谢谢

还是没看懂为什么需要泛型，只在decodeType传一个泛型的实例不行吗，为什么还要在前面加两个泛型的实例？

看您文章里说了，泛型可以不写。。那这两个有啥用啊？麻烦解答一下，感激不尽。

是否考虑支持多语言？

NetException 类里引入了一个中文字符串。

如何实现类似于ChatGPT的那种流式数据返回效果啊。

为什么依赖freezed_annotation这个库？

能不能解释下，为什么依赖freezed_annotation？能不能出个去掉这个依赖的版本？

能否支持对于范型的限制。目前所有的请求方法范型是必要的。

首先感谢大佬开源，受益匪浅。

如题，针对如下场景的json，传递范型进行decoder是很有必要的。

{ "data": [{ "desc": "我们支持订阅啦~", "id": 30, "imagePath": "https://www.wanandroid.com/blogimgs/42da12d8-de56-4439-b40c-eab66c227a4b.png", "isVisible": 1, "order": 2, "title": "我们支持订阅啦~", "type": 0, "url": "https://www.wanandroid.com/blog/show/3352" }, { "desc": "", "id": 6, "imagePath": "https://www.wanandroid.com/blogimgs/62c1bd68-b5f3-4a3c-a649-7ca8c7dfabe6.png", "isVisible": 1, "order": 1, "title": "我们新增了一个常用导航Tab~", "type": 1, "url": "https://www.wanandroid.com/navi" }, { "desc": "一起来做个App吧", "id": 10, "imagePath": "https://www.wanandroid.com/blogimgs/50c115c2-cf6c-4802-aa7b-a4334de444cd.png", "isVisible": 1, "order": 1, "title": "一起来做个App吧", "type": 1, "url": "https://www.wanandroid.com/blog/show/2" }], "errorCode": 0, "errorMsg": "" }

但对于如下json，范型就是多余的，没必要的。勉强可以定一个只有 status字段但model，但很没必要。

{ "data": { "status": true },  "errorCode": 0,  "errorMsg": "" }

甚至，对于不太规范的json，通过 NetConverter 自行解析，就会问题。

 { "data": true,  "errorCode": 0,  "errorMsg": "" }

如 put/delete 方法。范型完全没必要。虽然可以通过类似download() 方式进行解析，但感觉有些奇怪。

强大

强大是强大，怎么赶紧没人用呢，赶紧多发文章，多宣传，多写源码分析给别人看，推广起来，不然我也不敢用 😂

感谢作者开源,freezed 怎么能跟这个库一起是用

关于lru缓存的需求

场景：如果应用程序需要频繁访问某些数据，并且这些数据在一段时间内保持不变或者变化较慢，那么将这些数据缓存到本地磁盘可以显著提高访问速度，减轻服务器负担。
能否提供一个配置项，包含最大缓存数、缓存时间、缓存行为开关

可以追加header吗

如何在 failure 中拿到错误的响应信息

如图，在code为400，failure 中的msg并没有返回的错误信息

头部参数问题

如果是每次都要动态传入header，你这个库要怎么写

感谢大大，有一些改进建议~

每个实现类都要继承 BaseNetworkModel 可能对项目浸入会比较大，写起来也麻烦。是否考虑将 decodeType 改为直接传实体类的fromJson函数？
示例：

/// 默认解码器
class MyHttpDecoder extends NetDecoder {
  /// 单例对象
  static final MyHttpDecoder _instance = MyHttpDecoder._internal();

  /// 内部构造方法，可避免外部暴露构造函数，进行实例化
  MyHttpDecoder._internal();

  /// 工厂构造方法，这里使用命名构造函数方式进行声明
  factory MyHttpDecoder.getInstance() => _instance;

  @override
  K decode<T, K>({required Response<dynamic> response, T? Function(dynamic)? fromJsonFunc }) {
    var errorCode = response.data['code'];

    /// 请求成功
    if (errorCode == 2000) {
      var data = response.data['data'];
      if (fromJsonFunc != null && data is List) {
        var dataList = List<T>.from(data.map((item) => fromJsonFunc(item)).toList()) as K;
        return dataList;
      }
      if (fromJsonFunc != null) {
        var model = fromJsonFunc(data) as K;
        return model;
      }
      return data as K;
    } else {
      var errorMsg = response.data['message'];
      throw NetException(errorMsg, errorCode);
    }
  }
}

修改后的效果：

class MineUserInfoBean {

  MineUserInfoBean({...}) {...}

  MineUserInfoBean.fromJson(dynamic json) {...}

}

class MineHttpManager {


  ///获取MINE/用户信息
  static Future<Result<MineUserInfoBean>> getMineInfo() {
    return get(
      '/user',
      fromJsonFunc: MineUserInfoBean.fromJson,
    );
  }

  ///获取通用的资源
  static Future<Result<List<CommonResBean>>> getCommonRes({
    required String? resId,
  }) {
    return get(
      "/getGenericResource/$resId",
      fromJsonFunc: CommonResBean.fromJson,
    );
  }

}

全局异常处理应该怎么配置？

比如网络异常toast自定义的文字描述，捕获token失效跳转登录之类的操作

多个问题： baseUrl 如果在多个具体怎么请求呢；另外如果有多个请求之间有依赖关系，或者异步关系怎么请求；

问题1.baseUrl 如果存在多个不同地址，具体怎么请求呢，通过传递option参数吗？
问题2.另外如果有多个请求之间有依赖关系，或者异步同时请求怎么实现呢？

NetOptions.instance 怎么修改 contentType multipart/form-data create中写死了

/// 配置网络请求并初始化
void create() {
var httpConfig = _httpConfigBuilder.create();
if (httpConfig.interceptors?.isNotEmpty ?? false) {
_dio.interceptors.addAll(httpConfig.interceptors!);
}
if (_isLogger) {
dio.interceptors.add(PrettyDioLogger(
requestHeader: true,
requestBody: true,
responseBody: true,
responseHeader: false,
error: true,
compact: true,
maxWidth: 90
));
}
_dio.options = BaseOptions(
baseUrl: httpConfig.baseUrl ?? '',
contentType: 'application/json',
connectTimeout: httpConfig.connectTimeout,
sendTimeout: httpConfig.sendTimeout,
receiveTimeout: httpConfig.receiveTimeout,
headers: httpConfig.headers);
if (httpConfig.httpClientAdapter != null) {
_dio.httpClientAdapter = httpConfig.httpClientAdapter!;
}
}