如何用Dagger 2在Kotlin Android应用中实现依赖注入：基于PhotoAffix的完整教程

如何用Dagger 2在Kotlin Android应用中实现依赖注入：基于PhotoAffix的完整教程

【免费下载链接】photo-affix📷 Stitch your photos together vertically or horizontally easily!项目地址: https://gitcode.com/gh_mirrors/ph/photo-affix

PhotoAffix 是一款用 Kotlin 编写的 Android 照片拼接应用，它将 Dagger 2 依赖注入框架运用得恰到好处：通过 1 个 AppComponent 和 5 个 Module，把图片引擎、用户偏好、协程调度器等依赖自动装配到界面层。这篇完整教程带你从核心概念到实战源码，快速掌握 Dagger 2 依赖注入的全部用法。

PhotoAffix 是什么：轻量级照片拼接 Android 应用 📷

PhotoAffix 的玩法很简单：导入手机里的照片，选择横向或纵向排列，调整尺寸与间距，一键拼接成一张大图导出。它采用多模块（multi-module）架构，将界面、引擎、偏好、工具拆分为独立子项目，而这正是引入Dagger 2 依赖注入的典型场景——依赖关系复杂、需要清晰解耦。

项目使用 Dagger 2.21，版本集中声明在 dependencies.gradle 中。

3 分钟理解 Dagger 2 依赖注入核心概念 🧩

在动手之前，先搞懂 Dagger 2 依赖注入的 4 个核心角色：

再加上@Inject（声明"我要什么"）、@Singleton（单例）和Qualifier 限定符（区分同类型依赖），就构成了完整的 Dagger 2 依赖注入体系。

PhotoAffix 依赖注入架构全解析

PhotoAffix 的依赖注入涉及 7 个关键文件，分布在app、prefs、engine、utilities四个模块中，每个文件各司其职。下面按"搭建依赖注入的 4 个关键步骤"逐步拆解。

第 1 步：创建 AppComponent 依赖容器

一切依赖注入的起点是 AppComponent.kt。它声明了 5 个 Module 作为依赖来源，并列出 3 个需要注入的"消费端"：

@Singleton @Component( modules = [ PrefsModule::class, AppBindModule::class, UtilityModule::class, EnginesModule::class, AppProvideModule::class ] ) interface AppComponent { fun inject(mainActivity: MainActivity) fun inject(settingsLayout: SettingsLayout) fun inject(imageSpacingDialog: ImageSpacingDialog) @Component.Builder interface Builder { @BindsInstance fun application(application: Application): Builder fun build(): AppComponent } }

💡要点：@Component.Builder中的@BindsInstance application(...)是"入口参数"——Application 实例由外部传入，成为整个依赖图的根基。

第 2 步：在 Application 启动时构建组件

App.kt 在应用启动的一瞬间构建 Dagger 组件：

appComponent = DaggerAppComponent.builder() .application(this) .build()

注意类名DaggerAppComponent是Dagger 编译器自动生成的，无需手写。App 还实现了 Injector.kt 中的injectInto(target)接口，通过when (target)把不同对象分发到对应的inject()方法，让注入入口统一收口。

第 3 步：用 Module 划分职责边界

PhotoAffix 的 5 个 Module 恰好展示了两种提供依赖的方式：

①@Binds：接口绑定实现类

AppBindModule.kt、EnginesModule.kt、UtilityModule.kt 都遵循同一模式——把Real*实现绑定到接口：

@Binds @Singleton abstract fun providePhotoLoader(realPhotoLoader: RealPhotoLoader): PhotoLoader

抽象方法（abstract fun）+@Binds意味着：实例由 Dagger 自动构造，你只需要告诉它"谁实现谁"。

②@Provides：手动创建复杂实例

PrefsModule.kt 和 AppProvideModule.kt 则适合需要参数或特殊逻辑的场景：

@Provides @Singleton fun provideRxkPrefs(app: Application): RxkPrefs { return rxkPrefs(app, KEY_PREFERENCES) }

AppProvideModule 还提供了一个巧妙用法——把协程调度器也交给 Dagger 管理：

@Provides @Singleton @MainDispatcher fun provideMainDispatcher(): CoroutineContext = Dispatchers.Main @Provides @Singleton @IoDispatcher fun provideIoDispatcher(): CoroutineContext = Dispatchers.IO

第 4 步：消费端接收注入

看 MainActivity.kt 如何"伸手要依赖"：

@Inject lateinit var presenter: MainPresenter @Inject lateinit var affixEngine: AffixEngine override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) (application as App).appComponent.inject(this) // 触发注入 ... }

而MainPresenter的实现类 MainPresenter.kt 通过@Inject构造函数自动装配依赖，无需任何new操作：

class RealMainPresenter @Inject constructor( private val ioManager: IoManager, private val photoLoader: PhotoLoader ) : MainPresenter

🎯 这就是依赖注入的魅力：MainActivity 只依赖接口，具体实现由 Dagger 2 在运行时决定——想替换实现或写单元测试，改 Module 即可，业务代码零改动。

Qualifier 限定符：如何区分同类型依赖 🔍

当同一类型有多个实例时，Dagger 需要"名牌"来区分。PrefQualifiers.kt 定义了 5 个自定义限定符：

@Qualifier @Retention(RUNTIME) annotation class ImageSpacingVertical

每个Pref<Int>类型都长一样，但加上@ImageSpacingVertical、@ImageSpacingHorizontal、@StackHorizontally等限定符后，Dagger 就能精确区分"纵向间距"和"横向间距"这两个完全不同的偏好。同样的手法也用于 IoDispatcher.kt 区分 Main 与 IO 调度器。

⚠️新手注意：自定义限定符必须同时加@Qualifier和@Retention(RUNTIME)，少写一个都会导致编译或运行异常。

新手常见 3 个疑问 ❓

Q1：DaggerAppComponent 是谁生成的？Dagger 的 Gradle 插件（com.google.dagger）在编译期扫描@Component接口，自动生成带Dagger前缀的类。你只需编写声明，绝不该手写生成代码。

Q2：@Binds和@Provides怎么选？简单规则：实现类可以直接new出来 → 用@Binds（更简洁高效）；需要参数、条件逻辑或包装第三方类 → 用@Provides。PhotoAffix 两种都用到了。

Q3：为什么用lateinit var接收注入？@Inject lateinit是字段注入的标准写法，Dagger 会在inject(this)调用后填充值。缺点是绕过编译器检查，更严格的团队会改用构造函数注入（如RealMainPresenter的写法）。

总结：PhotoAffix 的 Dagger 2 依赖注入架构亮点 ✅

从 PhotoAffix 的这套 Dagger 2 依赖注入实践中可以看出：依赖注入不是炫技，而是当你的 Android 应用模块越来越多、依赖关系越来越复杂时，让代码"可组装、可测试、可替换"的基础设施。建议直接对照上述 7 个源码文件跟读一遍，Dagger 2 依赖注入从此不再陌生。

【免费下载链接】photo-affix📷 Stitch your photos together vertically or horizontally easily!项目地址: https://gitcode.com/gh_mirrors/ph/photo-affix