Flutter网络请求插件morpheme_http的使用

morpheme_http 是一个基于 http 库的Flutter网络请求插件，提供了更高级的功能如自动处理Token、刷新Token等。本文将介绍如何使用该插件进行网络请求。

依赖安装

首先，在你的 pubspec.yaml 文件中添加以下依赖：

dependencies:
  morpheme_http: ^latest_version
  get_it: ^7.0.0
  flutter_secure_storage: ^6.0.0
  morpheme_inspector: ^latest_version

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

初始化MorphemeHttp

我们需要先初始化 MorphemeHttp 并将其注册到服务定位器（Service Locator）中。这里我们使用 get_it 插件来管理服务定位器。

import 'package:get_it/get_it.dart';
import 'package:morpheme_http/morpheme_http.dart';
import 'package:flutter_secure_storage/flutter_secure_storage.dart';

final locator = GetIt.instance;

void setupLocator() {
  locator.registerLazySingleton(
    () => MorphemeHttp(
      timeout: 30000,
      showLog: true,
      morphemeInspector: locator(),
      authTokenOption: AuthTokenOption(
        typeHeader: 'Authorization',
        prefixHeader: 'Bearer',
        getToken: () => locator<FlutterSecureStorage>().read(key: 'token'),
        authCondition: (request, response) =>
            request.url == MorphemeEndpoints.login,
        onAuthTokenResponse: (response) async {
          final map = jsonDecode(response.body);
          await locator<FlutterSecureStorage>().write(
            key: 'token',
            value: map['token'],
          );
          await locator<FlutterSecureStorage>().write(
            key: 'refresh_token',
            value: map['refresh_token'],
          );
        },
        clearCondition: (request, response) =>
            request.url == MorphemeEndpoints.logout,
        onClearToken: () =>
            locator<FlutterSecureStorage>().delete(key: 'token'),
        excludeEndpointUsageToken: [
          MorphemeEndpoints.login,
          MorphemeEndpoints.register,
        ],
      ),
      refreshTokenOption: RefreshTokenOption(
        method: RefreshTokenMethod.post,
        url: MorphemeEndpoints.refreshToken,
        condition: (request, response) =>
            request.url != MorphemeEndpoints.login && response.statusCode == 401,
        getBody: () async {
          final refreshToken =
              await locator<FlutterSecureStorage>().read(key: 'refresh_token');

          return {
            'refresh_token': refreshToken ?? '',
          };
        },
        onResponse: (response) async {
          // handle response refresh token
          final map = jsonDecode(response.body);
          locator<FlutterSecureStorage>().write(
            key: 'token',
            value: map['token'],
          );
        },
      ),
    ),
  );

  locator.registerLazySingleton(
    () => MorphemeInspector(
      showNotification: true, // default true
      showInspectorOnShake: true, // default true
      saveInspectorToLocal: true, // default true
      notificationIcon: '@mipmap/ic_launcher', // default '@mipmap/ic_launcher' just for android
    ),
  );
}

在应用启动时调用 setupLocator() 方法完成初始化。

基本请求方法

GET 请求

final http = locator<MorphemeHttp>();

try {
  final response = await http.get(Uri.parse('https://api.morpheme.id'));
  print(response.body);
} catch (e) {
  print(e.toString());
}

POST 请求

final http = locator<MorphemeHttp>();

try {
  final response = await http.post(
    Uri.parse('https://reqres.in/api/login'),
    body: {"email": "eve.holt@reqres.in", "password": "cityslicka"},
  );
  print(response.body);
} on MorphemeException catch (e) {
  final failure = e.toMorphemeFailure();
  print(failure.toString());
} catch (e) {
  print(e.toString());
}

PUT 请求

final http = locator<MorphemeHttp>();

try {
  final response = await http.put(
    Uri.parse('https://api.morpheme.id/update'),
    body: {"key": "value"},
  );
  print(response.body);
} catch (e) {
  print(e.toString());
}

DELETE 请求

final http = locator<MorphemeHttp>();

try {
  final response = await http.delete(
    Uri.parse('https://api.morpheme.id/delete'),
    body: {"key": "value"},
  );
  print(response.body);
} catch (e) {
  print(e.toString());
}

Multipart POST 请求

final http = locator<MorphemeHttp>();
final File file = getImage();

try {
  final response = await http.postMultipart(
    Uri.parse('https://api.morpheme.id/upload'),
    files: {'image': file},
    body: {"key": "value"},
  );
  print(response.body);
} catch (e) {
  print(e.toString());
}