跨平台开发 / 系统课时

用 Provider 注入 API 客户端

用 Provider 注入 API 客户端

业务代码如果到处直接执行 Dio(),会把地址、超时、拦截器和测试替身分散到多个类中。把 API 客户端交给 Provider 创建,可以让依赖入口集中起来,并让 Repository 只关心业务请求,而不负责基础客户端的构造。

学习目标

  • 使用 Provider 集中创建和配置 Dio 客户端
  • 通过 Provider 依赖关系把客户端注入 Repository
  • 理解这种组织方式如何降低替换环境和测试依赖的成本

把客户端创建集中到 Provider

Dio 属于基础设施依赖,通常应在应用的一处完成基础地址、超时等公共配置。Provider 本身不保存业务数据也没问题,它同样适合提供长期复用的服务对象。

dart
import 'package:dio/dio.dart';
import 'package:flutter/material.dart';
import 'package:flutter_riverpod/flutter_riverpod.dart';

final dioProvider = Provider<Dio>((ref) {
  final dio = Dio(
    BaseOptions(
      baseUrl: 'https://jsonplaceholder.typicode.com',
      connectTimeout: const Duration(seconds: 5),
      receiveTimeout: const Duration(seconds: 5),
    ),
  );

  // Provider 容器销毁时同步释放客户端资源。
  ref.onDispose(dio.close);
  return dio;
});

class PostRepository {
  PostRepository(this.dio);

  final Dio dio;

  Future<String> fetchTitle(int postId) async {
    final response = await dio.get<Map<String, dynamic>>('/posts/$postId');
    return response.data!['title'] as String;
  }
}

final postRepositoryProvider = Provider<PostRepository>((ref) {
  final dio = ref.watch(dioProvider);
  return PostRepository(dio);
});

final postTitleProvider = FutureProvider.family<String, int>((ref, postId) {
  final repository = ref.watch(postRepositoryProvider);
  return repository.fetchTitle(postId);
});

void main() {
  runApp(const ProviderScope(child: App()));
}

class App extends ConsumerWidget {
  const App({super.key});

  @override
  Widget build(BuildContext context, WidgetRef ref) {
    final title = ref.watch(postTitleProvider(1));

    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: const Text('Provider 依赖注入')),
        body: Center(
          child: title.when(
            loading: () => const CircularProgressIndicator(),
            error: (error, stackTrace) => Text('加载失败:$error'),
            data: Text.new,
          ),
        ),
      ),
    );
  }
}

预期结果

text
应用启动后先显示加载指示器,随后显示 JSONPlaceholder 中编号 1 文章的标题。
页面没有直接创建 Dio,也没有直接拼接请求地址;请求通过 postTitleProvider → PostRepository → dioProvider 完成。

这样组织后,PostRepository 只声明“我需要一个 Dio”,至于 Dio 如何创建、使用哪个基础地址,由更外层的 Provider 决定。

看清 Provider 的依赖链

这个结构的重点不是为了多写几层 Provider,而是建立单向依赖:界面依赖业务状态,业务状态依赖 Repository,Repository 再依赖 API 客户端。上层不负责构造下层对象。

Riverpod API 客户端依赖结构图

当 postTitleProvider 读取 postRepositoryProvider,而 Repository Provider 又读取 dioProvider 时,Riverpod 会建立依赖关系。如果底层 Provider 被替换,上层可以沿依赖链重新获得新的对象,而页面不需要知道构造细节。

在不同环境替换客户端

集中注入的另一个价值是替换依赖。生产环境可以使用真实客户端,测试或局部 ProviderScope 可以 override dioProvider,而 Repository 和页面代码保持不变。

下面是片段示例,依赖前面的 dioProvider 与 App。它展示如何把基础地址替换为另一个环境,而不是在各个 Repository 中分别增加环境判断。

dart
void runWithStagingApi() {
  final stagingDio = Dio(
    BaseOptions(baseUrl: 'https://staging.example.com'),
  );

  runApp(
    ProviderScope(
      overrides: [
        dioProvider.overrideWithValue(stagingDio),
      ],
      child: const App(),
    ),
  );
}

预期结果

text
ProviderScope 内所有通过 dioProvider 间接获取客户端的 Repository 都会使用替换后的 Dio 实例。
页面和 PostRepository 不需要修改依赖创建代码。

实际项目还可以把鉴权拦截器、统一请求头等集中配置在客户端 Provider 中,但不要把所有业务逻辑都塞进这里。客户端 Provider 负责“怎样连接 API”,Repository 负责“怎样完成某项业务数据访问”,这种边界能让依赖关系保持清晰。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

用 Provider 注入 API 客户端

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通