架构设计模式：依赖注入最佳实践

Ya-Jun2025-12-03 9:39

架构设计模式：依赖注入最佳实践

在构建可维护、可测试和可扩展的Flutter应用时，依赖注入（Dependency Injection, DI） 是一个不可或缺的设计模式。它不仅能够降低代码间的耦合度，还能极大地简化单元测试的编写。本文将从基础理论出发，深入探讨Flutter中依赖注入的多种实现方式，重点讲解 get_it 结合 injectable 的工程化实践，并分享在大型项目中的最佳实践。

一、依赖注入基础

1.1 什么是依赖注入？

依赖注入是控制反转（Inversion of Control, IoC） 原则的一种实现方式。简单来说，它意味着一个对象不应该自己创建它所依赖的对象，而应该由外部环境（如构造函数、Setter方法或专门的DI容器）提供这些依赖。

没有DI的代码（高耦合）：

dart 复制代码 
class UserRepository {
  // UserRepository 内部直接创建了 ApiService
  // 导致两者紧密耦合，难以替换 ApiService（例如在测试时）
  final ApiService _apiService = ApiService();
  
  Future<User> getUser() async {
    return _apiService.fetchUser();
  }
}

使用DI的代码（低耦合）：

dart 复制代码 
class UserRepository {
  final ApiService _apiService;
  
  // ApiService 通过构造函数注入
  UserRepository(this._apiService);
  
  Future<User> getUser() async {
    return _apiService.fetchUser();
  }
}

1.2 为什么要使用依赖注入？

  1. 解耦（Decoupling）：类不需要关心依赖是如何创建的，只需要关心如何使用它们。
  2. 可测试性（Testability）：在单元测试中，可以轻松地注入Mock对象来替代真实的依赖（如网络请求、数据库）。
  3. 可维护性（Maintainability）：依赖关系清晰，代码结构更易于理解和修改。
  4. 生命周期管理：DI容器通常可以帮助管理对象的生命周期（单例、懒加载、工厂模式）。

二、Flutter中的DI实现方案

在Flutter生态中，有多种方式可以实现依赖注入，从简单的手动注入到复杂的自动化框架。

2.1 构造函数注入（Constructor Injection）

这是最基本也是最推荐的形式。如上面的例子所示，通过类的构造函数传递依赖。

  • 优点：简单、清晰，不需要第三方库。
  • 缺点：当依赖链很深时（例如 A 依赖 B，B 依赖 C，C 依赖 D...），在顶层组装这些对象会变得非常繁琐（"Prop Drilling" 问题）。

2.2 InheritedWidget / Provider

Provider 本质上是基于 InheritedWidget 的依赖注入封装。

  • 优点：Flutter官方推荐，与Widget树生命周期绑定，天然支持响应式更新。
  • 缺点 ：依赖于 BuildContext，在非UI层（如纯Dart的Service层）获取依赖不太方便。

2.3 GetIt (Service Locator)

GetIt 是一个服务定位器（Service Locator），它不依赖于Widget树，可以在App的任何地方访问注册的对象。

  • 优点 ：速度极快（O(1)查找），不依赖 BuildContext，易于在BLoC、ViewModel或Repository中使用。
  • 缺点 ：如果滥用（在UI中到处调用 GetIt.I），会隐藏类的依赖关系，变成"全局变量"的变体。

2.4 Injectable (Code Generation)

Injectable 是一个代码生成库，它基于 GetIt，通过注解（Annotations）自动生成注册代码。

  • 优点 ：消除了 GetIt 手动注册的样板代码，支持环境区分（Dev/Prod），支持模块化。
  • 最佳组合 ：GetIt + Injectable 是目前Flutter中大型项目非常流行的DI组合。

三、实战：GetIt + Injectable 深度应用

下面我们将演示如何在一个实际项目中使用 get_it 和 injectable 来管理依赖。

3.1 引入依赖

在 pubspec.yaml 中添加：

yaml 复制代码 
dependencies:
  flutter:
    sdk: flutter
  get_it: ^7.6.0
  injectable: ^2.3.0

dev_dependencies:
  build_runner: ^2.4.6
  injectable_generator: ^2.4.1

3.2 配置注入器

创建一个 injection.dart 文件，用于初始化DI容器。

dart 复制代码 
// lib/core/di/injection.dart
import 'package:get_it/get_it.dart';
import 'package:injectable/injectable.dart';
import 'injection.config.dart'; // 生成的文件

final getIt = GetIt.instance;

@InjectableInit(
  initializerName: 'init', // 默认是 init
  preferRelativeImports: true, // 默认是 true
  asExtension: true, // 默认是 true
)
void configureDependencies() => getIt.init();

3.3 定义依赖与注解

假设我们要实现一个用户认证功能。

1. 定义抽象类（推荐）
dart 复制代码 
// lib/features/auth/domain/i_auth_service.dart
abstract class IAuthService {
  Future<bool> login(String username, String password);
}
2. 实现类并添加注解

使用 @Injectable 或 @Singleton / @LazySingleton 标记实现类。

dart 复制代码 
// lib/features/auth/data/auth_service_impl.dart
import 'package:injectable/injectable.dart';
import '../domain/i_auth_service.dart';

// 标记为 IAuthService 的实现，并作为 LazySingleton 注册
@LazySingleton(as: IAuthService)
class AuthServiceImpl implements IAuthService {
  @override
  Future<bool> login(String username, String password) async {
    // 模拟网络请求
    await Future.delayed(Duration(seconds: 1));
    return username == 'admin' && password == '123456';
  }
}
3. 注入到其他类

在需要使用 IAuthService 的地方（例如 ViewModel 或 BLoC），直接通过构造函数注入。injectable 会自动识别并生成代码。

dart 复制代码 
// lib/features/auth/presentation/auth_viewmodel.dart
import 'package:flutter/foundation.dart';
import 'package:injectable/injectable.dart';
import '../domain/i_auth_service.dart';

@injectable
class AuthViewModel extends ChangeNotifier {
  final IAuthService _authService;

  // 构造函数注入，injectable 会自动填充 _authService
  AuthViewModel(this._authService);

  bool _isLoading = false;
  bool get isLoading => _isLoading;

  Future<void> login(String username, String password) async {
    _isLoading = true;
    notifyListeners();
    
    final success = await _authService.login(username, password);
    print(success ? 'Login Success' : 'Login Failed');
    
    _isLoading = false;
    notifyListeners();
  }
}

3.4 注册第三方库模块

有时候我们需要注入第三方库的类（如 Dio, SharedPreferences），不能直接在源码上加注解。这时可以使用 @module。

dart 复制代码 
// lib/core/di/register_module.dart
import 'package:dio/dio.dart';
import 'package:injectable/injectable.dart';
import 'package:shared_preferences/shared_preferences.dart';

@module
abstract class RegisterModule {
  // 注册 Dio 实例
  @lazySingleton
  Dio get dio => Dio(BaseOptions(baseUrl: 'https://api.example.com'));

  // 注册异步依赖，如 SharedPreferences
  @preResolve
  Future<SharedPreferences> get prefs => SharedPreferences.getInstance();
}

3.5 生成代码

运行 build_runner 生成 injection.config.dart：

bash 复制代码 
flutter pub run build_runner build --delete-conflicting-outputs

3.6 在 main.dart 中初始化

dart 复制代码 
// lib/main.dart
import 'package:flutter/material.dart';
import 'core/di/injection.dart';
import 'features/auth/presentation/auth_viewmodel.dart';
import 'package:provider/provider.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  // 初始化依赖注入
  await configureDependencies();
  
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: ChangeNotifierProvider(
        // 使用 getIt 获取 AuthViewModel
        create: (_) => getIt<AuthViewModel>(),
        child: LoginScreen(),
      ),
    );
  }
}

四、依赖注入的最佳实践

4.1 面向接口编程

始终依赖于抽象（Interface/Abstract Class），而不是具体实现。

  • Good : AuthViewModel(this._authService)，其中 _authService 是 IAuthService 类型。
  • Bad : AuthViewModel(this._authService)，其中 _authService 是 AuthServiceImpl 类型。

这样做的好处是，在测试时可以轻松传入一个 MockAuthService，或者在未来需要更换实现（例如从 HTTP 换成 Firebase）时，不需要修改 ViewModel 的代码。

4.2 区分环境（Environment）

Injectable 支持环境配置。你可以为开发环境和生产环境提供不同的实现。

dart 复制代码 
@Environment(Environment.dev)
@Injectable(as: IAuthService)
class MockAuthService implements IAuthService { ... }

@Environment(Environment.prod)
@Injectable(as: IAuthService)
class RealAuthService implements IAuthService { ... }

初始化时指定环境：

dart 复制代码 
getIt.init(environment: Environment.prod);

4.3 避免 Service Locator 反模式

虽然 getIt 允许你在任何地方调用 getIt<T>()，但应尽量避免在类的内部直接调用它。

  • Bad:

    dart 复制代码 
    class UserProfile {
  void load() {
    // 隐藏了依赖关系，难以测试
    final api = GetIt.I<ApiService>(); 
    api.fetch();
  }
}

  • Good:

    dart 复制代码 
    class UserProfile {
  final ApiService _api;
  // 明确声明了依赖
  UserProfile(this._api); 
  
  void load() => _api.fetch();
}

    只在"组合根（Composition Root）"（如 main.dart 或 Route 定义处、Provider 的 create 方法中）使用 getIt 来组装对象。

4.4 作用域管理（Scoping）

并非所有对象都应该是单例。

  • Singleton / LazySingleton : 适用于全局共享的服务，如 ApiService, AuthService, Database.
  • Factory (@injectable) : 每次请求都会创建一个新实例。适用于 Bloc, ViewModel，或者是包含状态且不应共享的对象。

五、常见面试题解析

5.1 依赖注入和依赖查找（Service Locator）有什么区别？

答：

  • 依赖注入（DI）：是被动的。类通过构造函数声明它需要什么，由外部容器将依赖"推"进去。类不知道容器的存在。
  • 依赖查找（Service Locator） ：是主动的。类显式地向容器（Locator）请求它需要的依赖（如 GetIt.I<Service>()）。类依赖于容器的接口。

DI通常优于Service Locator，因为它使依赖关系更显式，且类更容易测试（不需要Mock整个容器）。

5.2 GetIt中的Factory和Singleton有什么区别？

答：

  • Factory : 每次调用 getIt<T>() 时，都会执行注册的工厂函数，返回一个新的实例。适用于有状态且不共享的对象（如页面级的 Bloc/ViewModel）。
  • Singleton: 第一次调用时创建实例，之后每次调用都返回同一个实例。
  • LazySingleton: 类似 Singleton，但只有在第一次被请求时才会被创建（延迟初始化），这对于启动优化很有帮助。

5.3 如何处理具有循环依赖的类？

答 ：

循环依赖（A依赖B，B依赖A）通常是设计不良的标志。

  • 解决方案1（重构）：提取公共部分到第三个类 C，让 A 和 B 都依赖 C。
  • 解决方案2（延迟获取） ：在构造函数中不直接使用依赖，而是在方法调用时使用。或者在 GetIt 中使用 getIt.registerLazySingleton 配合在内部使用 getIt() 获取，但这增加了风险。
  • 最佳策略：重新设计架构，消除循环依赖。

5.4 InheritedWidget 和 Provider 算是依赖注入吗？

答 ：

是的，它们实现了依赖注入的一种形式（通常称为基于树的依赖注入）。它们允许数据在 Widget 树中自上而下传递，子 Widget 可以获取父级提供的依赖，而不需要通过构造函数一层层传递。Provider 是目前 Flutter 中最常用的轻量级 DI 解决方案之一，特别适合 UI 相关的状态注入。

六、总结

依赖注入是构建高质量 Flutter 应用的基石。

  1. 核心价值：解耦、可测试、可维护。
  2. 工具选择 ：
    • 小型项目：使用 Provider 或简单的构造函数注入即可。
    • 中大型项目：强烈推荐 GetIt + Injectable 组合，它提供了类型安全、编译时检查和强大的代码生成能力，能有效管理复杂的依赖关系。
  3. 设计原则：坚持面向接口编程，合理管理对象生命周期，避免滥用 Service Locator 模式。

通过合理应用依赖注入，你的 Flutter 项目结构将变得更加清晰，代码质量也将得到显著提升。

相关推荐
松☆1 小时前
Flutter + OpenHarmony 构建工业巡检 App：离线采集、多端协同与安全上报
安全·flutter
●VON1 小时前
Flutter for OpenHarmony前置知识《Flutter 路由与导航完整教程》
学习·flutter·华为·openharmony·开源鸿蒙
天意__1 小时前
Flutter开发，scroll_to_index适配flutter_list_view
前端·flutter
Ya-Jun1 小时前
架构设计模式：模块化设计方案
flutter
克喵的水银蛇1 小时前
Flutter 状态管理：Provider 入门到实战（替代 setState）
前端·javascript·flutter
鹏多多1 小时前
flutter-使用url_launcher打开链接/应用/短信/邮件和评分跳转等
android·前端·flutter
晚霞的不甘2 小时前
Flutter 与开源鸿蒙（OpenHarmony）测试体系构建：从单元测试到真机自动化的一站式质量保障方案
flutter·开源·harmonyos
克喵的水银蛇2 小时前
Flutter 入门实战：从零搭建跨平台 HelloWorld 应用（适配鸿蒙 / 安卓 /iOS）
android·flutter·harmonyos
热门推荐
01GitHub 镜像站点02UV安装并设置国内源03安娜的档案(Anna’s Archive) 镜像网站/国内最新可访问入口（持续更新）04BongoCat - 跨平台键盘猫动画工具05本地部署阿里最新开源的Z-Image06Linux下V2Ray安装配置指南07Meta第三代“分割一切”模型——SAM 3本地部署教程：首支持文本提示分割，400万概念、30毫秒响应，检测分割追踪一网打尽08【保姆级教程】免费使用Gemini3的5种方法！免翻墙/国内直连09Labelme从安装到标注：零基础完整指南10在VSCode配置Java开发环境的保姆级教程（适配各类AI编程IDE）