美文网首页
Flutter中网络请求的封装

Flutter中网络请求的封装

作者: iOS_Programmer | 来源:发表于2023-03-08 13:37 被阅读0次

    Flutter的网络请求可以使用Dart自带的库http或者dio。本文介绍了一种基于dio的网络请求封装方案,方便快捷地进行网络请求操作。

    1. 添加依赖

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

    dependencies:
      dio: <latest_version>
    

    其中<latest_version>表示最新版的dio库版本号。

    1. 创建API类

    在项目中创建一个api.dart文件,用于定义请求接口。比如,我们定义一个获取用户信息的接口:

    import 'package:dio/dio.dart';
    
    class Api {
      static const String baseUrl = 'https://api.example.com';
    
      Dio _dio = Dio(BaseOptions(baseUrl: baseUrl));
    
      Future<Map<String, dynamic>> getUserInfo(String userId) async {
        final response = await _dio.get('/user/$userId');
        return response.data;
      }
    }
    

    上述代码中,我们创建了一个Api类,定义了一个baseUrl常量,该常量存储了我们的API的基础URL地址,同时在getUserInfo方法中,我们使用dio库发送了一个GET请求,获取了用户信息。方法返回一个Future对象,该对象返回一个Map类型的数据,表示我们获取到的用户信息。

    1. 网络请求封装

    为了方便使用,在上述的api.dart文件中,我们直接使用了dio库发送了网络请求。但是在实际的项目中,我们往往需要对请求进行更加详细的参数设置、响应处理和错误处理。

    因此,我们可以结合每个接口的具体业务场景,将网络请求的通用部分封装在一起,使用时直接调用API类中的相应方法即可。

    具体而言,我们在api.dart文件中定义一个BaseApi类作为网络请求的基类,然后我们每个接口所对应的Api类都继承BaseApi类,覆盖其中的一些方法,以实现自己特定的逻辑。

    import 'package:dio/dio.dart';
    
    class BaseApi {
      static const String baseUrl = 'https://api.example.com';
    
      Dio _dio = Dio(
        BaseOptions(
          baseUrl: baseUrl,
          connectTimeout: 5000,
          receiveTimeout: 5000,
        ),
      );
    
      Future<Map<String, dynamic>> get(
        String path, {
        Map<String, dynamic>? params,
      }) async {
        final response = await _dio.get(
          path,
          queryParameters: params,
        );
        return _handleResponse(response);
      }
    
      Future<Map<String, dynamic>> post(
        String path, {
        Map<String, dynamic>? data,
      }) async {
        final response = await _dio.post(
          path,
          data: data,
        );
        return _handleResponse(response);
      }
    
      Future<Map<String, dynamic>> _handleResponse(Response response) async {
        if (response.statusCode == 200) {
          return response.data;
        } else if (response.statusCode == 400) {
          throw BadRequestException(response.data.toString());
        } else if (response.statusCode == 401) {
          throw UnauthorizedException();
        } else if (response.statusCode == 403) {
          throw ForbiddenException();
        } else if (response.statusCode == 500) {
          throw ServerException();
        } else {
          throw UnknownException();
        }
      }
    }
    

    上述代码中,我们定义了一个BaseApi类,该类包含了get和post方法,分别用于发送GET和POST请求,同时也定义了一些常见的HTTP状态码对应的异常类型。

    其中,_handleResponse方法用于处理响应数据,如果响应正常返回数据,否则根据HTTP状态码抛出相应的异常。

    接着,我们定义一个UserApi类,该类继承BaseApi类,实现了获取用户信息的接口:

    class UserApi extends BaseApi {
      Future<Map<String, dynamic>> getUserInfo(String userId) async {
        return await get('/user/$userId');
      }
    }
    

    在该类中,我们通过继承BaseApi类,直接调用了BaseApi类中的get方法,实现了获取用户信息的接口。

    1. 使用网络请求封装

    在我们的页面或代码中,可以直接通过调用UserApi类中的方法,实现网络请求:

    // 获取用户信息
    try {
      final userInfo = await UserApi().getUserInfo(userId);
      // 处理用户信息
    } catch (e) {
      // 处理错误
    }
    

    我们通过调用UserApi类中的getUserInfo方法,实现了对用户信息的获取操作。在请求过程中,由于网络请求有可能失败,我们使用try-catch语句进行了异常处理,以确保程序的稳健性。

    到此为止,我们就完成了对Flutter网络请求的封装,使用起来非常方便并且具有通用性,可以加速我们的开发效率。

    相关文章

      网友评论

          本文标题:Flutter中网络请求的封装

          本文链接:https://www.haomeiwen.com/subject/kxqpldtx.html