Flutter网络请求插件flutter_rest_client的使用

Flutter网络请求插件flutter_rest_client的使用

flutter_rest_client 是一个使用强大的 dio 库进行网络调用的模块。您可以直接从已经设置好的项目开始，或者按以下方式在您的项目中配置它。

简介

flutter_rest_client 是一个为方便维护 dio 代码而单独创建的网络模块。使用此模块非常简单。

GetIt.I<AppConfig>().initialize(
  appName: 'appName',
  flavorName: env,
  baseUrl: 'https://domain.com/v1/',
);

AppConfig 是项目依赖的一部分，我们从中使用 baseUrl 来初始化 flutter_rest_client。

基本使用

response = await httpHelper.request(RequestEndpoint(), BaseRequestModel(), headers: {});

headers 参数是可选的，基本的映射集已经在请求拦截器中设置好了。

除了上述用法外，还有其他一些基本功能使用了 dio 的特性。

需要在应用中注入的配置

@Named('httpConfig')
@Singleton(as: IHttpConfig)
class HttpConfig implements IHttpConfig {
  final AppConfig _appConfig;
  final ISessionManager _iSessionManager;

  HttpConfig(this._appConfig, this._iSessionManager);

  [@override](/user/override)
  int connectTimeout = 8000;

  [@override](/user/override)
  String contentType = AppKeys.applicationJson;

  [@override](/user/override)
  int receiveTimeout = 8000;

  [@override](/user/override)
  String get baseUrl => _appConfig.baseUrl;

  [@override](/user/override)
  int connectionTimeout = 8000;

  [@override](/user/override)
  Future<String?> get token => _sessionManager.getToken();
}

设置完成后，运行命令 flutter pub run build_runner build --delete-conflicting-outputs。

完整示例代码

以下是完整的示例代码：

import 'package:flutter/material.dart';
import 'package:get_it/get_it.dart';
import 'package:injectable/injectable.dart';
import 'config/app_config.dart';
import 'package:flutter_rest_client/flutter_rest_client.dart';

void main() {
  WidgetsFlutterBinding.ensureInitialized();

  // 初始化 AppConfig
  GetIt.I<AppConfig>().initialize(
      appName: 'Flutter Rest Client',
      baseUrl: 'https://beta.worldstory.life/api/v1/',
      flavorName: Environment.dev);
  
  runApp(const MyApp());
}

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    // 初始化 IHttpHelper
    IHttpHelper httpHelper;

    return Center(
      child: MaterialButton(
        onPressed: () async {
          // 这里可以添加请求代码
        },
        child: Text('Load Data'),
      ),
    );
  }
}

更多关于Flutter网络请求插件flutter_rest_client的使用的实战教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter网络请求插件flutter_rest_client的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


当然，关于Flutter网络请求插件flutter_rest_client的使用，下面是一个基本的代码示例，展示了如何配置和使用该插件进行网络请求。

首先，确保你已经在pubspec.yaml文件中添加了flutter_rest_client依赖：

dependencies:
  flutter:
    sdk: flutter
  flutter_rest_client: ^x.y.z  # 请替换为最新版本号

然后运行flutter pub get来安装依赖。

接下来，配置和使用flutter_rest_client进行网络请求的示例代码如下：

import 'package:flutter/material.dart';
import 'package:flutter_rest_client/flutter_rest_client.dart';

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('Flutter Rest Client Example'),
        ),
        body: Center(
          child: MyHomePage(),
        ),
      ),
    );
  }
}

class MyHomePage extends StatefulWidget {
  @override
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  RestClient _client;
  String _responseData = '';

  @override
  void initState() {
    super.initState();
    // 配置RestClient
    _client = RestClient(baseUrl: 'https://api.example.com'); // 替换为你的API基础URL
  }

  Future<void> fetchData() async {
    try {
      // 发起GET请求
      Response response = await _client.get('/endpoint'); // 替换为你的API端点
      if (response.statusCode == 200) {
        setState(() {
          _responseData = response.data.toString();
        });
      } else {
        setState(() {
          _responseData = 'Error: ${response.statusCode}';
        });
      }
    } catch (e) {
      setState(() {
        _responseData = 'Error: $e';
      });
    }
  }

  @override
  Widget build(BuildContext context) {
    return Column(
      mainAxisAlignment: MainAxisAlignment.center,
      children: <Widget>[
        ElevatedButton(
          onPressed: fetchData,
          child: Text('Fetch Data'),
        ),
        SizedBox(height: 20),
        Text(_responseData),
      ],
    );
  }
}

代码解释：

  1. 依赖配置：在pubspec.yaml文件中添加flutter_rest_client依赖。

  2. RestClient初始化：在_MyHomePageState的initState方法中初始化RestClient实例，并设置基础URL。

  3. 网络请求：fetchData方法使用_client.get方法发起GET请求，请求成功后更新UI显示响应数据。如果请求失败或发生异常，则显示错误信息。

  4. UI构建：UI包含一个按钮和一个文本显示区。点击按钮时调用fetchData方法发起网络请求，并将响应数据显示在文本区域。

这个示例展示了如何使用flutter_rest_client进行基本的GET请求。当然，flutter_rest_client还支持POST、PUT、DELETE等HTTP方法，你可以根据需求进行相应配置和调用。详细使用方法可以参考flutter_rest_client的官方文档。

回到顶部