Dagger 2，在模块中提供应用程序上下文答案

【问题标题】：Dagger 2, Providing Application Context in ModuleDagger 2，在模块中提供应用程序上下文
【发布时间】：2018-11-12 07:43:10
【问题描述】：

我在 Android 开发方面相当新，在 DI 方面比较新。我在一个我正在试验 Dagger 2 的个人项目中使用 Kotlin。我设法为一个 util 类设置了它，但是我需要一个上下文来使用它来注入一个需要上下文的类（一个 sharedpref 管理器课），我失败了。这是我的代码，这是我得到的错误（ NPE ）。提前谢谢你。

我的模块类

package com.android.pine

import android.content.Context
import com.android.pine.utils.SharedPreferencesManager
import dagger.Module
import dagger.Provides
import javax.inject.Singleton

@Module
class AppModule {

    @Provides
    @Singleton
    fun context(pineApplication: PineApplication): Context = pineApplication.applicationContext

    @Provides
    @Singleton
    fun provideSharedPrefManager(context: Context): SharedPreferencesManager = SharedPreferencesManager(context)
}

我的组件类：

package com.android.pine

import com.android.pine.home.HomePresenter
import com.android.pine.home.categories.CategoryAdapter
import dagger.Component
import javax.inject.Singleton

@Singleton
@Component(modules = arrayOf(AppModule::class))
interface AppComponent {
    fun inject(categoryAdapter: CategoryAdapter)
    fun inject(homePresenter: HomePresenter)
}

编辑：添加了以下信息，我如何调用 sharedPreferencesManager 的注入：

class HomePresenter : BasePresenter<HomeView>() {

    @Inject
    lateinit var sharedPreferencesManager: SharedPreferencesManager
.
.
.

也在我的 HomePresenter 类中，在 onAttached 方法覆盖中：

 DaggerAppComponent.create().inject(this)

我的 pineApplication 类和 SharedPrefManager 类如下所示：

class PineApplication @Inject constructor(): Application()

共享首选项：

class SharedPreferencesManager @Inject constructor(context: Context) {
.
.
.

崩溃，无法获取 pineApplication.getContext()（已编辑，添加了完整的堆栈跟踪）

     06-02 11:57:01.028 14840-14840/com.android.pine.debug E/AndroidRuntime: FATAL EXCEPTION: main
Process: com.android.pine.debug, PID: 14840
java.lang.RuntimeException: Unable to resume activity {com.android.pine.debug/com.android.pine.home.HomeActivity}: java.lang.NullPointerException: Attempt to invoke virtual method 'android.content.Context android.content.Context.getApplicationContext()' on a null object reference
    at android.app.ActivityThread.performResumeActivity(ActivityThread.java:3429)
    at android.app.ActivityThread.handleResumeActivity(ActivityThread.java:3469)
    at android.app.ActivityThread.handleLaunchActivity(ActivityThread.java:2732)
    at android.app.ActivityThread.-wrap12(ActivityThread.java)
    at android.app.ActivityThread$H.handleMessage(ActivityThread.java:1477)
    at android.os.Handler.dispatchMessage(Handler.java:102)
    at android.os.Looper.loop(Looper.java:154)
    at android.app.ActivityThread.main(ActivityThread.java:6119)
    at java.lang.reflect.Method.invoke(Native Method)
    at com.android.internal.os.ZygoteInit$MethodAndArgsCaller.run(ZygoteInit.java:886)
    at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:776)
 Caused by: java.lang.NullPointerException: Attempt to invoke virtual method 'android.content.Context android.content.Context.getApplicationContext()' on a null object reference
    at android.content.ContextWrapper.getApplicationContext(ContextWrapper.java:106)
    at com.android.pine.AppModule.context(AppModule.kt:12)
    at com.android.pine.AppModule_ContextFactory.proxyContext(AppModule_ContextFactory.java:34)
    at com.android.pine.DaggerAppComponent.getContext(DaggerAppComponent.java:29)
    at com.android.pine.DaggerAppComponent.getSharedPreferencesManager(DaggerAppComponent.java:34)
    at com.android.pine.DaggerAppComponent.injectHomePresenter(DaggerAppComponent.java:59)
    at com.android.pine.DaggerAppComponent.inject(DaggerAppComponent.java:49)
    at com.android.pine.home.HomePresenter.onAttached(HomePresenter.kt:31)
    at com.android.pine.home.HomePresenter.onAttached(HomePresenter.kt:10)
    at com.android.pine.core.BaseActivity.onResume(BaseActivity.kt:34)
    at android.app.Instrumentation.callActivityOnResume(Instrumentation.java:1269)
    at android.app.Activity.performResume(Activity.java:6783)
    at android.app.ActivityThread.performResumeActivity(ActivityThread.java:3406)
    at android.app.ActivityThread.handleResumeActivity(ActivityThread.java:3469) 
    at android.app.ActivityThread.handleLaunchActivity(ActivityThread.java:2732) 
    at android.app.ActivityThread.-wrap12(ActivityThread.java) 
    at android.app.ActivityThread$H.handleMessage(ActivityThread.java:1477) 
    at android.os.Handler.dispatchMessage(Handler.java:102) 
    at android.os.Looper.loop(Looper.java:154) 
    at android.app.ActivityThread.main(ActivityThread.java:6119) 
    at java.lang.reflect.Method.invoke(Native Method) 
    at com.android.internal.os.ZygoteInit$MethodAndArgsCaller.run(ZygoteInit.java:886) 
    at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:776)

【问题讨论】：

请包含完整的堆栈跟踪以及您调用/注入它的位置/方式的代码，这似乎很奇怪
编辑了帖子，添加了更多信息，对问题中的不完整表示歉意
由于对 Android 和 Dagger 的误解，您的代码中有几个错误。这没关系，我们都经历过。我看到的一个问题是你正在注入一个演示者，但由于你完全控制了那个类，你应该只使用构造函数注入。看看这个博客，它详细解释了如何使用 Dagger dev.to/autonomousapps/… 建立一个 Android 项目

标签： android kotlin dagger-2

【解决方案1】：

这就是它的完成方式。在您的组件中使用 @BindsInstance 会将应用程序注入您的所有模块。在您的情况下，只是 AppModule

@Singleton
@Component(modules = arrayOf(AppModule::class))
interface AppComponent {
    @Component.Builder
    interface Builder() {
        fun build(): AppComponent

        @BindsInstance
        fun application(application: Application): Builder
    }
}

** 删除 APP 模块中“提供应用程序”功能的代码，并确保传递应用程序上下文以创建 sharedPreferences。

@Module
class AppModule {


@Provides
@Singleton
fun provideSharedPrefManager(context: Application): SharedPreferencesManager = 
    SharedPreferencesManager(context)
}

现在在您的应用程序类的 onCreate 中

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

可选：如果你想在你的 applicationClass 中注入一些东西，那么请执行以下操作

 DaggerAppComponent.builder().application(this).build().inject(this)

【讨论】：

为什么我在任何帖子上都找不到任何答案，这个简单而有效的例子。我向上帝发誓，如果我没有找到这个，我会跳出窗外
如果我理解正确，我会在 MainActivity 中获取上下文并在那里构建 AppComponent。但是我需要注入一些东西，例如一个片段。我没有那个上下文，那我该怎么做呢？

【解决方案2】：

您不能使用class PineApplication @Inject constructor(): Application() 创建PineApplication。它是一个框架类，必须由 Android 框架创建。

这样做 Dagger 将创建 PineApplication，但 applicationContext 将返回 null，因为它从未被初始化（由系统）。

不要对框架类使用构造函数注入，也不要自己创建。使用@Bindsintance 将对象添加到带有其构建器的组件中，或者使用模块来提供它。

【讨论】：

能否请您举例说明在这种情况下如何使用@BindInstance ？
@tipi 您可以check the javadoc 或查看users guide 示例

【解决方案3】：

为了提供应用上下文，你可以创建类，比如ComponentsManager 与：

public class ComponentsManager {

    private Context context;
    private AppComponent appComponent;

    public ComponentsManager(Context context) {
        this.context = context.getApplicationContext();
    }

    public AppComponent getAppComponent(){
        if (appComponent == null){
            appComponent = DaggerAppComponent.builder()
                    .appModule(new AppModule(context))
                    .build();
        }
        return appComponent;
    }
}

在你的应用程序类中初始化这个ComponentsManager，像这样：

public class YourApp extends Application {

    private static ComponentsManager componentsManager;

    @Override
    public void onCreate() {
        super.onCreate();
        initComponentsManager();
        initAppComponent();
    }

    public static ComponentsManager getComponentsManager(){
        return componentsManager;
    }

    private void initComponentsManager(){
        componentsManager = new ComponentsManager(this);
    }

    private void initAppComponent(){
        componentsManager.getAppComponent();
    }
}

【讨论】：

【解决方案4】：

您可以尝试像这样修改您的 App 模块。

@Module
class ApplicationModule(private val application: Application) {

    @Provides
    @Singleton
    fun provideContext(): Context {
        return application.applicationContext
    }

    @Provides
    @Singleton
    fun provideSharedPreferences(context: Context): SharedPreferences {
        return context.getSharedPreferences(PREF_FILE_NAME, Context.MODE_PRIVATE)
    }
}

然后你可以从你的应用程序类中构建这样的匕首组件。

val appComponent = DaggerAppComponent.builder()
                .applicationModule(ApplicationModule(this))
                .build()

像这样在presenter中注入值。

application.appComponent.inject(this)

【讨论】：