android context的使用_【译】使用Kotlin从零开始写一个现代Android 项目-Part4

这是本系列的第四篇文章，还没有看过前面三篇的读者可以先看看：【译】使用Kotlin从零开始写一个现代Android 项目-Part1【译】使用Kotlin从零开始写一个现代Android 项目-Part2【译】使用Kotlin从零开始写一个现代Android 项目-Part3正文开始！什么是依赖注入让我们先看看GitRepoRepository类：class GitRepoRepository(p

weixin_39721924

99人浏览 · 2020-11-27 16:45:16

weixin_39721924 · 2020-11-27 16:45:16 发布

这是本系列的第四篇文章，还没有看过前面三篇的读者可以先看看：

【译】使用Kotlin从零开始写一个现代Android 项目-Part1

【译】使用Kotlin从零开始写一个现代Android 项目-Part2

【译】使用Kotlin从零开始写一个现代Android 项目-Part3

正文开始！

什么是依赖注入

让我们先看看GitRepoRepository类：

class GitRepoRepository(private val netManager: NetManager) {

    private val localDataSource = GitRepoLocalDataSource()
    private val remoteDataSource = GitRepoRemoteDataSource()

    fun getRepositories(): Observable<ArrayList<Repository>> {
      ...
    }
}

我们可以说GitRepoRepository依赖三个对象，分别是netManager、localDataSource 和remoteDataSource。通过构造函数提供netManager时，数据源在GitRepoRepository中被初始化。换句话说，我们将netManager注入到GitRepoRepository。

依赖注入是一个非常简单的概念：你需要什么，其他人就给你提供什么。

让我们看看，我们在哪里构造GitRepoRepository类（Mac上用cmd + B，Windows上用alt + B）：

如你所见，GitRepoRepository类在MainViewModel中被构造，NetManager也是在这儿被构造，是否也应该将它们注入ViewModel？是的。应该将GitRepoRepository实例提供给ViewModel，因为GitRepoRepository可以在其他ViewModel中使用。

另一方面，我们确定整个应用程序仅应创建一个NetManager实例。让我们通过构造函数提供它。我们期望有这样的东西：

class MainViewModel(private var gitRepoRepository: GitRepoRepository) : ViewModel() {
  ...
}

请记住，我们没有在MainActivity中创建MainViewModel。我们从ViewModelProviders来获得它：

class MainActivity : AppCompatActivity(), RepositoryRecyclerViewAdapter.OnItemClickListener {
    ...
    override fun onCreate(savedInstanceState: Bundle?) {
        ...
        val viewModel = ViewModelProviders.of(this).get(MainViewModel::class.java)
        ...
    }
    
  ...
}

如前所述，ViewModelProvider将创建新的ViewModel或返回现有的ViewModel。现在，我们必须将GitRepoRepository作为参数。该怎么做？

我们需要为MainViewModel设置特殊的工厂(Factory)类，因为我们不能使用标准的类：

class MainViewModelFactory(private val repository: GitRepoRepository) 
         : ViewModelProvider.Factory {
    override fun <T : ViewModel?> create(modelClass: Class<T>): T {
        if (modelClass.isAssignableFrom(MainViewModel::class.java)) {
            return MainViewModel(repository) as T
        }

        throw IllegalArgumentException("Unknown ViewModel Class")
    }

}

因此，现在我们可以在构造它时，设置参数，

class MainActivity : AppCompatActivity(), RepositoryRecyclerViewAdapter.OnItemClickListener {
    ....

    override fun onCreate(savedInstanceState: Bundle?) {
        ...

        val repository = GitRepoRepository(NetManager(applicationContext))
        val mainViewModelFactory = MainViewModelFactory(repository)
        val viewModel = ViewModelProviders.of(this, mainViewModelFactory)
                            .get(MainViewModel::class.java)

        ...
    }

    ...
}

等等！我们还是没有解决问题，我们真的应该在MainActivity中创建一个MainViewModelFactory实例吗？不因该的，这里应该使用依赖注入来解决。

让我们创建一个Injection类，它具有将提供所需实例的方法：

object Injection {

    fun provideMainViewModelFactory(context: Context) : MainViewModelFactory{
        val netManager = NetManager(context)
        val repository = GitRepoRepository(netManager)
        return MainViewModelFactory(repository)
    }
}

现在，我们可以将其从此类注入MainActivity.kt：

class MainActivity : AppCompatActivity(), RepositoryRecyclerViewAdapter.OnItemClickListener {

    private lateinit var mainViewModelFactory: MainViewModelFactory

    override fun onCreate(savedInstanceState: Bundle?) {
        ...
      
        mainViewModelFactory = Injection.provideMainViewModelFactory(applicationContext)
        val viewModel = ViewModelProviders.of(this, mainViewModelFactory)
                            .get(MainViewModel::class.java)
        
        ...

    }
    ...
}

因此，现在我们的Activity不知道来自应用程序数据层的repositories。这样的代码组织对我们有很大帮助，尤其是在测试应用程序方面。这样，我们将UI逻辑与业务逻辑分开。

我们可以在Injection.kt中应用更多的依赖注入概念：

object Injection {
    
    private fun provideNetManager(context: Context) : NetManager {
        return NetManager(context)
    }

    private fun gitRepoRepository(netManager: NetManager) :GitRepoRepository {
        return GitRepoRepository(netManager)
    }

    fun provideMainViewModelFactory(context: Context): MainViewModelFactory {
        val netManager = provideNetManager(context)
        val repository = gitRepoRepository(netManager)
        return MainViewModelFactory(repository)
    }
    
}

现在，每个类都有获取它们实例的方法了，如果你仔细看，你会发现，所有的这些方法在我们调用它们时，都会返回一个新的实例，真的应该这样？每当我们某个Repository类中需要时，都要创建NetManager的新实例？当然不是，每个应用程序只需要一个NetManager实例。可以说NetManager应该是单例。

在软件工程中，单例模式是一种将类的实例化限制为一个对象的软件设计模式。

让我们实现它：

object Injection {

    private var NET_MANAGER: NetManager? = null

    private fun provideNetManager(context: Context): NetManager {
        if (NET_MANAGER == null) {
            NET_MANAGER = NetManager(context)
        }
        return NET_MANAGER!!
    }

    private fun gitRepoRepository(netManager: NetManager): GitRepoRepository {
        return GitRepoRepository(netManager)
    }

    fun provideMainViewModelFactory(context: Context): MainViewModelFactory {
        val netManager = provideNetManager(context)
        val repository = gitRepoRepository(netManager)
        return MainViewModelFactory(repository)
    }
}

这样，我们确保每个应用程序只有一个实例。换句话说，我们可以说NetManager实例具有Application同样的生命周期范围。

让我们看看依赖图：

为什么我们需要Dagger？

如果看一下上面的注入，您会发现，如果图中有很多依赖项，那么我们将需要做大量工作。 Dagger帮助我们以简单的方式管理依赖项及其范围。

让我们先引入dagger:

...
dependencies {
    ...
    
    implementation "com.google.dagger:dagger:2.14.1"
    implementation "com.google.dagger:dagger-android:2.14.1"
    implementation "com.google.dagger:dagger-android-support:2.14.1"
    kapt "com.google.dagger:dagger-compiler:2.14.1"
    kapt "com.google.dagger:dagger-android-processor:2.14.1"
    
    ...
}

要使用dragger,我们需要新建一个Application继承自DaggerApplication类，我们创建一个DaggerApplication:

class ModernApplication : DaggerApplication(){

    override fun applicationInjector(): AndroidInjector<out DaggerApplication> {
        TODO("not implemented")
    }

}

在继承DaggerApplication（）时，它需要实现applicationInjector（）方法，该方法应返回AndroidInjector的实现。稍后我将介绍AndroidInjector。

不要忘了在AndroidManifest.xml注册application:

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="me.mladenrakonjac.modernandroidapp">
  
    ...

    <application
        android:name=".ModernApplication"
        ...>
       ...
    </application>

</manifest>

首先，创建AppModule,Modules是具有@Provides注解功能的类。我们说这些方法是提供者，因为它们提供了实例。要将某个类作为模块，我们需要使用@Module注解对该类进行注解。这些注解可帮助Dagger制作和验证图形。我们的AppModule将仅具有提供应用程序上下文的函数：

@Module
class AppModule{

    @Provides
    fun providesContext(application: ModernApplication): Context {
        return application.applicationContext
    }
}

现在，我们创建一个component:

@Singleton
@Component(
        modules = [AndroidSupportInjectionModule::class,
            AppModule::class])
interface AppComponent : AndroidInjector<ModernApplication> {

    @Component.Builder
    abstract class Builder : AndroidInjector.Builder<ModernApplication>()
}

Component是一个接口，我们在其中指定应从哪些模块中将实例注入哪些类中。这个例子中，我们指定AppModule和AndroidSupportInjectionModule。

AndroidSupportInjectionModule是可帮助我们将实例注入Android生态系统类的模块，这些类包括Activity，Fragment，Service，BroadcastReceivers或ContentProviders。

因为我们要使用我们的组件来注入这些类，因此AppComponent必须继承AndroidInjector <T>。对于T，我们使用ModernApplication类。如果打开AndroidInjector接口，则可以看到：

abstract class Builder<T> implements AndroidInjector.Factory<T> {
    @Override
    public final AndroidInjector<T> create(T instance) { ... }
    public abstract void seedInstance(T instance);
    ...
  }
}

Builder有两个方法：create(T instance)用于创建AndroidInjector，而seedInsance(T instance)方法则用于提供实例。

在我们的例子中，我们将创建具有ModernApplication实例的AndroidInjector，并将在需要的地方提供该实例。

@Component.Builder
abstract class Builder : AndroidInjector.Builder<ModernApplication>()

关于我们的AppComponent，总结一下：

我们拥有AppComponent，它是继承与AndroidInjector的应用程序的主要组件
当我们要构建Component时，我们将需要使用ModernApplication类的实例作为参数。
将以AppComponent中使用的模块形式，向所有其他@Provides方法提供ModernApplication的实例。例如，将向AppModule中的providerContext（application：ModernApplication）方法提供ModernApplication的实例。

现在，我们编译一下项目

当构建结束，Dragger将自动生成一些新的类，对于AppComponent,Dragger将会生成一个DaggerAppComponent类。

让我们回到ModernApplication并创建应用程序的主要组件。创建的组件应在applicationInjector（）方法中返回。

class ModernApplication : DaggerApplication(){

    override fun applicationInjector(): AndroidInjector<out DaggerApplication> {
        return DaggerAppComponent.builder().create(this)
    }

现在，我们完成了Dagger所需的标准配置。

当我们想将实例注入MainActivity类时，我们需要创建MainActivityModule。

@Module
internal abstract class MainActivityModule {

    @ContributesAndroidInjector()
    internal abstract fun mainActivity(): MainActivity

}

@ContributesAndroidInjector注解可帮助Dagger连接所需的内容，以便我们可以将实例注入指定的Activity中。

如果返回到我们的Activity，可以看到我们使用Injection类注入了MainViewModelProvider。因此，我们需要在MainActivityModule中提供provider方法，该方法将提供MainViewModelProvider：

@Module
internal abstract class MainActivityModule {
    
    @Module
    companion object {

       @JvmStatic
       @Provides
       internal fun providesMainViewModelFactory(gitRepoRepository: GitRepoRepository)
        : MainViewModelFactory {
          return MainViewModelFactory(gitRepoRepository)
       }
     }

    @ContributesAndroidInjector()
    internal abstract fun mainActivity(): MainActivity

}

但是，谁将提供GitRepoRepository给providesMainViewModelFactoty方法呢？

有两个选择：我们可以为其创建provider方法并返回新实例，或者可以使用@Inject注解它的构造函数。

让我们回到我们的GitRepoRepository并使用@Inject注解来标注其构造函数：

class GitRepoRepository @Inject constructor(var netManager: NetManager) {
  ...
}

因为GitRepoRepository需要NetManager,因此，同样标注NetManager的构造函数

@Singleton
class NetManager @Inject constructor(var applicationContext: Context) {
   ...
}

我们使用@Singleton注解设置NetManager为单例。另外，NetManager需要applicationContext。 AppModule中有一个方法来提供它。

不要忘记将MainActivityModule添加到AppComponent.kt中的模块列表中：

@Component(
        modules = [AndroidSupportInjectionModule::class,
            AppModule::class,
            MainActivityModule::class])
interface AppComponent : AndroidInjector<ModernApplication> {

    @Component.Builder
    abstract class Builder : AndroidInjector.Builder<ModernApplication>()
}

最后，我们需要将其注入到我们的MainActivity中。为了使Dagger在那里工作，我们的MainActivity需要继承DaggerAppCompatActivity。

class MainActivity : DaggerAppCompatActivity(), RepositoryRecyclerViewAdapter.OnItemClickListener {
    ...
    @Inject lateinit var mainViewModelFactory: MainViewModelFactory

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        val viewModel = ViewModelProviders.of(this, mainViewModelFactory)
                .get(MainViewModel::class.java)
        ...
       }

    ...
}

要注入MainViewModelFactory实例，我们需要使用@Inject注解。

重要说明： mainViewModelFactory变量必须是公共的。

到这儿就完成了！

不再需要从“注入”类进行注入：

mainViewModelFactory = Injection.provideMainViewModelFactory(applicationContext)

实际上，我们可以删除Injection类了，因为我们现在正在使用Dagger了。

一步步回头看看

我们想把MainViewModelFactory注入MainActiivty
为了使Dragger能在MainActivity中正常工作，MainActivity需要继承自DaggerAppCompatActivity
我们需要使用@Inject注解对mainViewModelFactory进行标注
Dagger搜索带有@ContributesAndroidInjector注解的方法的模块，该方法返回MainActivity。
Dagger搜索返回MainViewModelFactory实例的provider，或带@Inject注解的构造函数。
provideMainViewModelFactory() 返回实例，但是为了创建它，需要GitRepoRepository实例
Dagger搜索provider或@Inject带注解的构造函数，该构造函数返回GitRepoRepository实例。
GitRepoRepository类具有带@Inject注解的构造函数。但是该构造函数需要NetManager实例
Dagger搜索返回NetManager实例的provider或带@Inject注释的构造函数。
Dagger搜索返回Application Context实例的provider。
AppModule具有返回application context 的provider方法。但是该构造函数需要ModernApplication实例。
AndroidInjector具有provider。

就是这样！

有一种更好的自动化方法来提供ViewModelFactory

问题：对于每个具有参数的ViewModel，我们都需要创建ViewModelFactory类。在Chris Banes的Tivi应用程序源代码中，我发现了一种非常好的自动方法。

创建ViewModelKey.kt :

@Target(AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER)
@Retention(AnnotationRetention.RUNTIME)
@MapKey
annotation class ViewModelKey(val value: KClass<out ViewModel>)

然后添加一个DaggerAwareViewModelFactory类：

class DaggerAwareViewModelFactory @Inject constructor(
        private val creators: @JvmSuppressWildcards Map<Class<out ViewModel>, Provider<ViewModel>>
) : ViewModelProvider.Factory {

    override fun <T : ViewModel> create(modelClass: Class<T>): T {
        var creator: Provider<out ViewModel>? = creators[modelClass]
        if (creator == null) {
            for ((key, value) in creators) {
                if (modelClass.isAssignableFrom(key)) {
                    creator = value
                    break
                }
            }
        }
        if (creator == null) {
            throw IllegalArgumentException("unknown model class " + modelClass)
        }
        try {
            @Suppress("UNCHECKED_CAST")
            return creator.get() as T
        } catch (e: Exception) {
            throw RuntimeException(e)
        }
    }
}

创建ViewModelBuilder module:

@Module
internal abstract class ViewModelBuilder {

    @Binds
    internal abstract fun bindViewModelFactory(factory: DaggerAwareViewModelFactory):
            ViewModelProvider.Factory
}

添加ViewModelBuilder到AppComponent:

@Singleton
@Component(
        modules = [AndroidSupportInjectionModule::class,
            AppModule::class,
            ViewModelBuilder::class,
            MainActivityModule::class])
interface AppComponent : AndroidInjector<ModernApplication> {

    @Component.Builder
    abstract class Builder : AndroidInjector.Builder<ModernApplication>()
}

MainViewModel类添加@Injec:

class MainViewModel @Inject constructor(var gitRepoRepository: GitRepoRepository) : ViewModel() {
  ...
}

从现在开始，我们只需要将其绑定到Activity模块即可：

@Module
internal abstract class MainActivityModule {

    @ContributesAndroidInjector
    internal abstract fun mainActivity(): MainActivity

    @Binds
    @IntoMap
    @ViewModelKey(MainViewModel::class)
    abstract fun bindMainViewModel(viewModel: MainViewModel): ViewModel
}

不需要MainViewModelFactory provider 。实际上，根本不需要MainViewModelFactory.kt，因此可以将其删除。

最后，在MainActivity.kt中对其进行更改，以便我们使用ViewModel.Factory类型而不是MainViewModelFactory：

class MainActivity : DaggerAppCompatActivity(), RepositoryRecyclerViewAdapter.OnItemClickListener {
  
    @Inject lateinit var viewModelFactory: ViewModelProvider.Factory

    override fun onCreate(savedInstanceState: Bundle?) {
      ...

        val viewModel = ViewModelProviders.of(this, viewModelFactory)
                .get(MainViewModel::class.java)
       ...
    }
    ...
}

感谢Chris Banes 这个神奇的解决方案！