详解Kotlin 中使用和配置 Dagger2

前言

陆陆续续几篇文章已经讲解了项目中 kotlin 如何配置、简单语法、databinding 配置，接下来就要说到 kotlin 中的 dagger2 了。

配置 dagger2

项目中使用 dagger2 ，首先还是添加依赖。同样的，因为要使用到注解处理，所以和 databinding 一样要添加 kapt 插件：

 apply plugin: 'com.android.application'
 ...
 apply plugin: 'kotlin-kapt' // kapt 插件

 ...
 kapt {
   generatestubs = true
 }

 dependencies {
   ...
   implementation 'com.google.dagger:dagger:2.12' // dagger 2 依赖
   implementation 'com.google.dagger:dagger-android-support:2.12' // dagger 2 android 支持包
   kapt 'com.google.dagger:dagger-compiler:2.12' // dagger 2 注解处理
 }

配置很简单，就这样完成了。

使用 dagger2

简单的配置完 dagger2 ，接下来就是如何在 android 项目中使用了。

首先使 application 继承 daggerapplication，activity 继承 daggerappcompatactivity，fragment 继承 daggerfragment。

新建一个接口使用 @subcomponent 注解继承 androidinjector<youractivity>，内部抽象类使用 @subcomponent.builder 注解继承androidinjector.builder<youractivity>。

 @subcomponent(modules = arrayof(...)) // 没有其他 module 圆括号可省略
 interface youractivitysub : androidinjector<youractivity> {
   @subcomponent.builder
   abstract class builder : androidinjector.builder<youractivity>()
 }

新建一个抽象类使用 @module 注解，用于出入 activity。

 @module(subcomponents = arrayof( youractivitysub::class)) 
// 每新建一个 activity，都要新建相应的 activitysub 接口，并添加到这里
 abstract class activitymodule {
   @binds // 每新建一个 activity，都要添加一个相应方法，方法名不能相同
   @intomap
   @activitykey(youractivity::class)
   abstract fun bindyouractivity(builder: youractivitysub.builder): androidinjector.factory<out activity> 
 } 

新建接口 youapplicationsub 使用 @component 注解，继承 androidinjector<yourapplication>，内部抽象类使用 @component.builder 注解继承 androidinjector.builder<yourapplicaton>。

 @singleton // 如果有 module 使用了该注解实现单例模式，这里也需要添加
 @component(modules = arrayof(
   activitymodule::class, // 注入 activity 的 module
   fragmentmodule::class, // 注入 fragment 的 module
   ...
   androidsupportinjectionmodule::class)) // 确保 daggerapplication、daggeractivity、daggerfragment等所有类型可用
 interface applicationsub : androidinjector<myapplication> {
   @component.builder
   abstract class builder : androidinjector.builder<myapplication>()
 }

使你的 applicatoin 类继承 daggerapplication。

 class myapplication : daggerapplication() { // 如果项目中使用了 v4.fragment 要继承 support 包下的 daggerapplication
   override fun applicationinjector() : androidinjector<out daggerapplication> {
     return daggerapplicationsub.builder().create(this) // 编译后生成
   }
 }

优化

这样使用是不是很麻烦？在 dagger2 2.11 版本之前，项目中每添加一个 activity 或 fragment 等组件，都要新建一个对应 subcomponent 接口，并添加到对应的 module 中，并且添加相应的方法。这样使用起来太复杂了。

好在 google 也同样的意识到了这个问题，所以在 dagger2 2.11 版本及其以后，dagger2 又为我们提供了一个 @contributesandroidinjector 注解，大大的简化了使用。

首先，使用这个注解，你需要添加上 dagger2 注解处理的 android 支持：

 dependencies {
   ...
   implementation 'com.google.dagger:dagger:2.12' // dagger 2 支持 
   implementation 'com.google.dagger:dagger-android-support:2.12' // dagger 2 android 支持
   kapt 'com.google.dagger:dagger-compiler:2.12' // dagger 2 注解处理
   kapt 'com.google.dagger:dagger-android-processor:2.12' // dagger 2 注解处理 android 支持
   ...
 }

然后，在注入 activity 的 module 中改变：

 @module // 不需要再为每个 activity 新建对应的 subcomponent，不必再添加到这里
 abstract class activitymodule {
   @contributesandroidinjector
   abstract fun contributeyouractivity() : youractivity
 }

就这样，是不是简洁了很多？之后每添加一个 activity，只需要在 activity 添加一个对应的方法就可以了。

@contributesandroidinjector 注解自动生成对应的 subcomponent 而不需要我们手动添加。

语法解析

dagger 2 的配置使用说完了，但是相信很多人对上面的一些语法都不了解，这里来简单说明：

 // kotlin 提供的方法，能简单快速的生成一个数组
 val array = arrayof("1", "2") // 与之类似的还有 arraylistof() 、 setof() 等，以后详细说明
 
 // 类对象
 a::class // 相当于 java 中的 a.class，同时还有 a.javaclass 相当于 java 中的 a.getclass()

最后

今天的 kotlin dagger2 使用就讲到这里，接下来我还会为大家带来更多的 kotlin 相关语法知识以及基类封装等。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。