Android @Singleton上的Dagger 2注释类没有被注入

Question

我目前正在尝试将Dagger 2集成到Android应用程序中.我的项目设置如下:

• 图书馆
• 应用程序(取决于库)

在我的库项目中,我定义了一个类,我稍后将其注入到库中的其他需要它的类(活动和常规类)以及应用程序项目中.

@Singleton
public class MyManager{
  @Inject
  public MyManager(){
    //Do some initializing
  }
}

现在 - 例如在我的片段或活动或常规类中,我将按如下方式注入上述Singleton:

public class SomeClass{

  @Inject
  MyManager myManager;
}

或者我想,因为在实践中,myManager总是为空.显然它的构造函数从未被调用过,所以我想我必须错过配置方面的东西？或者我可能误解了文档,但这并不意味着以这种方式工作？MyManager类的目的是成为应用程序范围内可访问的组件累积实体 - 这就是我选择@Singleton的原因.

UPDATE

为了避免混淆:我在评论中提到了我的组件,我认为 - 这是指"基于组件的设计"意义上的组件,与匕首无关.我上面列出了基于匕首的代码 - 我的代码中没有任何与dagger相关的代码.

当我开始添加@Component时,我遇到了一些编译器问题,因为我的dagger2设置不正确 - 请查看这个关于如何正确设置dagger2的真正有用的线程:https://stackoverflow.com/a/29943394/1041533

更新2

这是我更新的代码,基于G. Lombard的建议 - 我更改了代码如下 - 原始的Singleton在库项目中:

@Singleton
public class MyManager{
  @Inject
  public MyManager(){
    //Do some initializing
  }
}

库项目中还有bootstrap类:

@Singleton
@Component
public interface Bootstrap {
    void initialize(Activity activity);
}

然后我在我的活动中使用上面的Bootstrap类(在我的具体应用程序中,而不是在库项目中!但是我在库中也有访问Bootstrap以注入MyManager的类/活动):

public class MyActivity extends Activity{

    @Inject
    MyManager manager;


    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        //DONT DO THIS !!! AS EXPLAINED BY EpicPandaForce
        DaggerBootstrap.create().initialize(this);
    }
}

但即便在这一行之后:

        DaggerBootstrap.create().initialize(this);

管理器实例仍为空,即未注入.

我刚刚发现了这个:https://stackoverflow.com/a/29326023/1041533

如果我没有误读,暗示我需要在Bootstrap类中指定将使用@Inject注入内容的每个类.可悲的是 - 这不是一个选择,因为我有超过40个课程和活动,我必须这样做.

这意味着我的Bootstrap界面显然必须看起来像这样:

@Singleton
@Component
public interface Bootstrap {
    void initialize(ActivityA activity);
    void initialize(ActivityB activity);
    void initialize(ActivityC activity);
    void initialize(ActivityD activity);
    void initialize(ActivityE activity);
    void initialize(ActivityF activity);
    //and so on and so forth...
}

如果上述情况属实,那对我的用例来说就不值得了.另外:如果我忘了在这里指定我的40多个课程之一,似乎没有编译时检查？它不会工作 - 即在运行时崩溃应用程序.

Answer 1

你犯了一个错误,你正在使用它

DaggerBootstrap.create().initialize(this);

在您的Activity中,因为范围不在多个组件实例之间共享.我建议使用自定义应用程序类

public class CustomApplication extends Application {
    @Override
    public void onCreate() {
         super.onCreate();
         Bootstrap.INSTANCE.setup();
    }
}

@Component
@Singleton
public interface _Bootstrap {
    void initialize(ActivityA activityA);
    //void initiali...
}

public enum Bootstrap {
    INSTANCE;

    private _Bootstrap bootstrap;

    void setup() {
        bootstrap = Dagger_Bootstrap.create();
    }

    public _Bootstrap getBootstrap() {
        return bootstrap;
    }
}

然后你可以称之为

Bootstrap.INSTANCE.getBootstrap().initialize(this);

这样,您可以在各个类中共享组件.我亲自命名Bootstrap为injector,_Bootstrap因为ApplicationComponent它看起来像这样:

Injector.INSTANCE.getApplicationComponent().inject(this);

但这只是我的典型设置.名字并不重要.

编辑:对于您的上一个问题,您可以通过subscoping和组件依赖性来解决这个问题.

你的库项目应该只能看到库类,对吗？在这种情况下,你所做的就是

@Scope
@Retention(RetentionPolicy.RUNTIME)
public @interface LibraryScope {
}

@Component(modules={LibraryModule.class})
@LibraryScope
public interface LibraryComponent {
    LibraryClass libraryClass(); //provision method for `MyManager`
}

@Module
public class LibraryModule {
    @LibraryScope
    @Provides
    public LibraryClass libraryClass() { //in your example, LibraryClass is `MyManager`
        return new LibraryClass(); //this is instantiation of `MyManager`
    }
}

public enum LibraryBootstrap {
    INSTANCE;

    private LibraryComponent libraryComponent;

    static {
        INSTANCE.libraryComponent = DaggerLibraryComponent.create();
    }

    public LibraryComponent getLibraryComponent() {
        return libraryComponent;
    }
}

@Scope
@Retention(RetentionPolicy.RUNTIME)
public @interface ApplicationScope {
}

@Component(dependencies={LibraryComponent.class}, modules={AdditionalAppModule.class})
@ApplicationScope
public interface ApplicationComponent extends LibraryComponent {
    AdditionalAppClass additionalAppClass();

    void inject(InjectableAppClass1 injectableAppClass1);
    void inject(InjectableAppClass2 injectableAppClass2);
    void inject(InjectableAppClass3 injectableAppClass3);
}

@Module
public class AdditionalAppModule {
    @ApplicationScope
    @Provides
    public AdditionalAppClass additionalAppClass() { //something your app shares as a dependency, and not the library
        return new AdditionalAppClass();
    }
}

public enum ApplicationBootstrap {
    INSTANCE;

    private ApplicationComponent applicationComponent;

    void setup() {
        this.applicationComponent = DaggerApplicationComponent.builder()
                                        .libraryComponent(LibraryBootstrap.INSTANCE.getLibraryComponent())
                                        .build();
    }

    public ApplicationComponent getApplicationComponent() {
        return applicationComponent;
    }
}

然后

@Inject
LibraryClass libraryClass; //MyManager myManager;

...
    ApplicationBootstrap.INSTANCE.getApplicationComponent().inject(this);

Answer 2

很难说你的问题是什么,因为你没有展示你的Component样子以及你是否有多个组件等.

假设这个逻辑结构:

/app
   MainComponent
   SomeClass    // where MyManager is to be injected
   MainActivity // where SomeClass is to be injected
/library
   LibraryComponent
   MyManager    // Singleton

然后列出的类将正确注入以下配置:

@Singleton
@Component
public interface LibraryComponent {
    MyManager getMyManager();
}

以及将依赖项注入活动的应用程序级组件:

@ActivityScope
@Component(dependencies = LibraryComponent.class)
public interface MainComponent {
    void inject(MainActivity mainActivity);
}

请注意,这MainComponent取决于LibraryComponent,但由于后者具有单例范围,您还需要为另一个范围定义范围,我在这里使用了"活动范围".(或者您也可以将MainComponent设置为单例,并在符合您需要的情况下完全删除LibraryComponent.)

最后,所有注入活动都是这样的:

@Inject
SomeClass someClass;

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);

    DaggerMainComponent.builder()
            .libraryComponent(DaggerLibraryComponent.create())
            .build()
            .inject(this);

    someClass.doSomething();
}

我在GitHub上放了一个工作样本

更新1:

如果我没有理解你的设置,你至今只使用了@Singleton和@Inject注解上列出的两个类(MyManager和SomeClass),并且在你的项目中没有其他匕首相关的代码.

在这种情况下,你MyManager没有注入的原因是因为Dagger不知道如何提供/实例化依赖项.这就是我上面提到的"组件"的来源.如果没有任何Dagger 2组件(接口或抽象类注释@Component),您的依赖项将不会自动注入.

我不知道您是否有使用依赖注入概念的经验,但假设您没有,我将逐步介绍您需要了解的最低基础知识,以便MyManager注入SomeClass:

第一:当你使用DI时,你需要了解"newables"和"injectables"之间的区别.这篇由Misko Hevery撰写的博文解释了细节.

这意味着,你无法new提升你的SomeClass.这不起作用:

mSomeClass = new SomeClass();

因为如果你这样做(比如在一个活动或片段中),Dagger将不知道你期望一个依赖注入SomeClass,它没有机会注入任何东西.

为了使其依赖项被注入,您还必须SomeClass通过Dagger 实例化(或注入)自身.

换句话说,在您的Activity中SomeClass使用,您需要:

@Inject
SomeClass mSomeClass;

接下来,您需要一个Dagger组件来执行实际注入.要创建组件,可以使用将根对象(例如MainActivity)作为参数的方法创建一个接口,例如:

@Singleton
@Component
public interface Bootstrap {
    void initialize(MainActivity activity);
}

现在,当您构建项目时,Dagger 2会生成一个名为" DaggerBootstrap实现此接口"的类.您可以使用此生成的类来执行注入,例如在您的活动的onCreate中:

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);

    DaggerBootstrap.create().initialize(this);

    mSomeClass.doSomething();
}

我相信这个生成的组件是你缺少的关键部分.上面的完整代码在这里.

一些有用的Dagger 2资源:

• 官方Dagger 2指南
• reddit页面有很多链接

更新2:

似乎最后缺失的部分是你的组件为Activity基类提供了一个注入方法,但不是为你的实际具体活动提供了注入方法.

不幸的是,Dagger 2需要为每个活动或要注入的其他类注入方法.

正如您所提到的,当您的应用中有许多不同的活动时,这会很烦人.有一些可行的解决方法,搜索"dagger 2注入基类",例如@EpicPandaForce的建议:Dagger 2基类注入

还要注意,正如@EpicPandaForce在评论中指出的那样,在我的简单示例中,我DaggerLibraryComponent.create()每次都调用可能不是你想要的,因为该组件应该提供你的单身,所以你可能最好还是获得现有的来自其他地方的实例,例如来自Application实例的实例.