如何在Android项目中从头开始设置DAGGER依赖项注入?


100

如何使用匕首?如何配置Dagger在我的Android项目中工作?

我想在我的Android项目中使用Dagger,但我感到困惑。

编辑:Dagger2也自2015年04月15日起退出市场,这更加令人困惑!

[[这个问题是一个“存根”,随着我对Dagger1的了解更多,对Dagger2的了解,我正在添加这个答案。这个问题更多地是一个指南,而不是一个“问题”。]



感谢分享。您是否了解如何注入ViewModel类?我的ViewModel类没有任何@AssistedInject,但是它具有Dagger图可以提供的依赖项?
AndroidDev


还有一个问题,使用Dagger2,是否可以有一个对象,并且它的引用由ViewModel和共享PageKeyedDataSource?就像我使用RxJava2一样,希望CompositeDisposable由两个类共享,并且如果用户按下后退按钮,我想清除Disposable对象。我在这里haved增加情况:stackoverflow.com/questions/62595956/...
AndroidDev

您最好ViewModel不要将CompositeDisposable放到内部,并可能将与您的自定义PageKeyedDataSource的构造函数参数相同的CompositeDisposable传递给我,但是我不会真正在那部分使用Dagger,因为那样的话您就需要子范围的子组件,而Hilt不会真正支持该子组件为您轻松。
EpicPandaForce

Answers:


193

Dagger 2.x 指南(修订版6)

步骤如下:

1.)添加Dagger到您的build.gradle文件中:

  • 顶级build.gradle

// Top-level build file where you can add configuration options common to all sub-projects/modules.

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:2.2.0'
        classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8' //added apt for source code generation
    }
}

allprojects {
    repositories {
        jcenter()
    }
}
  • 应用程序级别build.gradle

apply plugin: 'com.android.application'
apply plugin: 'com.neenbedankt.android-apt' //needed for source code generation

android {
    compileSdkVersion 24
    buildToolsVersion "24.0.2"

    defaultConfig {
        applicationId "your.app.id"
        minSdkVersion 14
        targetSdkVersion 24
        versionCode 1
        versionName "1.0"
    }
    buildTypes {
        debug {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
}

dependencies {
    apt 'com.google.dagger:dagger-compiler:2.7' //needed for source code generation
    compile fileTree(dir: 'libs', include: ['*.jar'])
    compile 'com.android.support:appcompat-v7:24.2.1'
    compile 'com.google.dagger:dagger:2.7' //dagger itself
    provided 'org.glassfish:javax.annotation:10.0-b28' //needed to resolve compilation errors, thanks to tutplus.org for finding the dependency
}

2.)创建AppContextModule提供依赖性的类。

@Module //a module could also include other modules
public class AppContextModule {
    private final CustomApplication application;

    public AppContextModule(CustomApplication application) {
        this.application = application;
    }

    @Provides
    public CustomApplication application() {
        return this.application;
    }

    @Provides 
    public Context applicationContext() {
        return this.application;
    }

    @Provides
    public LocationManager locationService(Context context) {
        return (LocationManager) context.getSystemService(Context.LOCATION_SERVICE);
    }
}

3.)创建AppContextComponent提供接口以获取可注入类的类。

public interface AppContextComponent {
    CustomApplication application(); //provision method
    Context applicationContext(); //provision method
    LocationManager locationManager(); //provision method
}

3.1。)这是使用实现创建模块的方式:

@Module //this is to show that you can include modules to one another
public class AnotherModule {
    @Provides
    @Singleton
    public AnotherClass anotherClass() {
        return new AnotherClassImpl();
    }
}

@Module(includes=AnotherModule.class) //this is to show that you can include modules to one another
public class OtherModule {
    @Provides
    @Singleton
    public OtherClass otherClass(AnotherClass anotherClass) {
        return new OtherClassImpl(anotherClass);
    }
}

public interface AnotherComponent {
    AnotherClass anotherClass();
}

public interface OtherComponent extends AnotherComponent {
    OtherClass otherClass();
}

@Component(modules={OtherModule.class})
@Singleton
public interface ApplicationComponent extends OtherComponent {
    void inject(MainActivity mainActivity);
}

注意::您需要在模块的带注释的方法上提供@Scope注释(如@Singleton@ActivityScope),@Provides以在生成的组件内获取作用域提供者,否则它将不受作用域限制,并且每次注入时都会获得一个新实例。

3.2。)创建一个应用程序范围的组件,该组件指定您可以注入的内容(与injects={MainActivity.class}Dagger 1.x中的相同):

@Singleton
@Component(module={AppContextModule.class}) //this is where you would add additional modules, and a dependency if you want to subscope
public interface ApplicationComponent extends AppContextComponent { //extend to have the provision methods
    void inject(MainActivity mainActivity);
}

3.3。)对于可以通过构造函数自己创建并且不想使用进行重新定义的依赖关系@Module(例如,您使用构建类型来代替更改实现的类型),可以使用带@Inject注释的构造函数。

public class Something {
    OtherThing otherThing;

    @Inject
    public Something(OtherThing otherThing) {
        this.otherThing = otherThing;
    }
}

另外,如果使用@Inject构造函数,则可以使用字段注入而不必显式调用component.inject(this)

public class Something {
    @Inject
    OtherThing otherThing;

    @Inject
    public Something() {
    }
}

这些@Inject构造函数类将自动添加到相同作用域的组件中,而无需在模块中显式指定它们。

一个@Singleton范围的@Inject构造函数的类会在可见@Singleton范围的部件。

@Singleton // scoping
public class Something {
    OtherThing otherThing;

    @Inject
    public Something(OtherThing otherThing) {
        this.otherThing = otherThing;
    }
}

3.4。)在为给定的接口定义了特定的实现之后,如下所示:

public interface Something {
    void doSomething();
}

@Singleton
public class SomethingImpl {
    @Inject
    AnotherThing anotherThing;

    @Inject
    public SomethingImpl() {
    }
}

您需要使用来将特定的实现“绑定”到接口@Module

@Module
public class SomethingModule {
    @Provides
    Something something(SomethingImpl something) {
        return something;
    }
}

自Dagger 2.4以来的简化形式如下:

@Module
public abstract class SomethingModule {
    @Binds
    abstract Something something(SomethingImpl something);
}

4.)创建一个Injector类来处理您的应用程序级组件(它代替了单体ObjectGraph

(注意:使用APT Rebuild Project创建DaggerApplicationComponent构建器类)

public enum Injector {
    INSTANCE;

    ApplicationComponent applicationComponent;

    private Injector(){
    }

    static void initialize(CustomApplication customApplication) {
        ApplicationComponent applicationComponent = DaggerApplicationComponent.builder()
           .appContextModule(new AppContextModule(customApplication))
           .build();
        INSTANCE.applicationComponent = applicationComponent;
    }

    public static ApplicationComponent get() {
        return INSTANCE.applicationComponent;
    }
}

5.)创建您的CustomApplication课程

public class CustomApplication
        extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        Injector.initialize(this);
    }
}

6.)添加CustomApplication到您的中AndroidManifest.xml

<application
    android:name=".CustomApplication"
    ...

7.)将您的课程注入MainActivity

public class MainActivity
        extends AppCompatActivity {
    @Inject
    CustomApplication customApplication;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        Injector.get().inject(this);
        //customApplication is injected from component
    }
}

8)享受!

+1。)您可以Scope为自己的组件指定创建活动级别范围的组件。子范围允许您提供仅对给定子范围而不是整个应用程序都需要的依赖项。通常,每个活动都通过此设置获得其自己的模块。请注意,每个组件都存在一个作用域提供者,这意味着为了保留该活动的实例,组件本身必须在配置更改后仍然有效。例如,它可以通过onRetainCustomNonConfigurationInstance()或Mortar示波器生存。

有关订阅的更多信息,请参阅Google的指南。另外,请访问此站点以了解供应方法以及组件依赖项部分)和此处

要创建自定义范围,必须指定范围限定符批注:

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

要创建子范围,您需要在组件上指定作用域,并指定ApplicationComponent其依赖项。显然,您还需要在模块提供者方法上指定子范围。

@YourCustomScope
@Component(dependencies = {ApplicationComponent.class}, modules = {CustomScopeModule.class})
public interface YourCustomScopedComponent
        extends ApplicationComponent {
    CustomScopeClass customScopeClass();

    void inject(YourScopedClass scopedClass);
}

@Module
public class CustomScopeModule {
    @Provides
    @YourCustomScope
    public CustomScopeClass customScopeClass() {
        return new CustomScopeClassImpl();
    }
}

请注意,只能将一个作用域组件指定为依赖项。完全像Java中不支持多重继承那样思考它。

+2。)关于@Subcomponent:本质上,作用域@Subcomponent可以替换组件依赖关系;但是您需要使用组件工厂方法,而不是使用注释处理器提供的构建器。

所以这:

@Singleton
@Component
public interface ApplicationComponent {
}

@YourCustomScope
@Component(dependencies = {ApplicationComponent.class}, modules = {CustomScopeModule.class})
public interface YourCustomScopedComponent
        extends ApplicationComponent {
    CustomScopeClass customScopeClass();

    void inject(YourScopedClass scopedClass);
}

变成这个:

@Singleton
@Component
public interface ApplicationComponent {
    YourCustomScopedComponent newYourCustomScopedComponent(CustomScopeModule customScopeModule);
}

@Subcomponent(modules={CustomScopeModule.class})
@YourCustomScope
public interface YourCustomScopedComponent {
    CustomScopeClass customScopeClass();
}

还有这个:

DaggerYourCustomScopedComponent.builder()
      .applicationComponent(Injector.get())
      .customScopeModule(new CustomScopeModule())
      .build();

变成这个:

Injector.INSTANCE.newYourCustomScopedComponent(new CustomScopeModule());

+3):请同时检查有关Dagger2的其他Stack Overflow问题,它们提供了大量信息。例如,在此答案中指定了我当前的Dagger2结构。

谢谢

感谢您在GithubTutsPlusJoe SteeleFroger MCSGoogle的指南

在撰写本文后,我也找到了有关此逐步迁移指南的信息。

对于基里尔的范围解释

官方文档中还有更多信息。


我相信我们缺少DaggerApplicationComponent的实现
Thanasis Kapelonis

1
@ThanasisKapelonis DaggerApplicationComponent由APT在生成时自动生成,但我将其添加。
EpicPandaForce'5

1
我只需要公开Injector.initializeApplicationComponent方法,因为我的CustomApplication不在包范围内,因此一切正常!谢谢!
胡安·萨拉维亚

2
有点晚了,但以下示例可能对任何人都有 帮助:github.com/dawidgdanski/android-compass-api github.com/dawidgdanski/Bakery
dawid gdanski

1
如果您收到“警告:使用不兼容的插件进行注释处理:android-apt。这可能会导致意外行为。” 在第1步中,将apt'com.google.dagger:dagger-compiler:2.7'更改为注释处理器'com.google.dagger:dagger-compiler:2.7'并删除所有apt配置。可以在此处找到详细信息bitbucket.org/hvisser/android-apt/wiki/Migration
thanhbinh84 '17

11

Dagger 1.x指南:

步骤如下:

1.)添加Daggerbuild.gradle文件中的依赖项

dependencies {
    compile fileTree(dir: 'libs', include: ['*.jar'])
    ...
    compile 'com.squareup.dagger:dagger:1.2.2'
    provided 'com.squareup.dagger:dagger-compiler:1.2.2'

另外,添加packaging-option以防止出现错误duplicate APKs

android {
    ...
    packagingOptions {
        // Exclude file to avoid
        // Error: Duplicate files during packaging of APK
        exclude 'META-INF/services/javax.annotation.processing.Processor'
    }
}

2.)创建一个Injector类来处理ObjectGraph

public enum Injector
{
    INSTANCE;

    private ObjectGraph objectGraph = null;

    public void init(final Object rootModule)
    {

        if(objectGraph == null)
        {
            objectGraph = ObjectGraph.create(rootModule);
        }
        else
        {
            objectGraph = objectGraph.plus(rootModule);
        }

        // Inject statics
        objectGraph.injectStatics();

    }

    public void init(final Object rootModule, final Object target)
    {
        init(rootModule);
        inject(target);
    }

    public void inject(final Object target)
    {
        objectGraph.inject(target);
    }

    public <T> T resolve(Class<T> type)
    {
        return objectGraph.get(type);
    }
}

3.)创建一个RootModule将将来的模块链接在一起。请注意,您必须包括injects指定在其中使用@Inject注释的每个类,否则Dagger会抛出RuntimeException

@Module(
    includes = {
        UtilsModule.class,
        NetworkingModule.class
    },
    injects = {
        MainActivity.class
    }
)
public class RootModule
{
}

4.)如果在根目录中指定的模块中还有其他子模块,请为这些模块创建模块:

@Module(
    includes = {
        SerializerModule.class,
        CertUtilModule.class
    }
)
public class UtilsModule
{
}

5.)创建将依赖项作为构造函数参数接收的叶子模块。就我而言,没有循环依赖关系,所以我不知道Dagger是否可以解决这个问题,但是我发现这不太可能。构造函数参数还必须由Dagger在Module中提供,如果您指定,complete = false则它也可以在其他Module中提供。

@Module(complete = false, library = true)
public class NetworkingModule
{
    @Provides
    public ClientAuthAuthenticator providesClientAuthAuthenticator()
    {
        return new ClientAuthAuthenticator();
    }

    @Provides
    public ClientCertWebRequestor providesClientCertWebRequestor(ClientAuthAuthenticator clientAuthAuthenticator)
    {
        return new ClientCertWebRequestor(clientAuthAuthenticator);
    }

    @Provides
    public ServerCommunicator providesServerCommunicator(ClientCertWebRequestor clientCertWebRequestor)
    {
        return new ServerCommunicator(clientCertWebRequestor);
    }
}

6.)扩展Application并初始化Injector

@Override
public void onCreate()
{
    super.onCreate();
    Injector.INSTANCE.init(new RootModule());
}

7.)在中MainActivity,在onCreate()方法中调用Injector 。

@Override
protected void onCreate(Bundle savedInstanceState)
{
    Injector.INSTANCE.inject(this);
    super.onCreate(savedInstanceState);
    ...

8.)@Inject在您的MainActivity

public class MainActivity extends ActionBarActivity
{  
    @Inject
    public ServerCommunicator serverCommunicator;

...

如果出现错误no injectable constructor found,请确保您没有忘记@Provides注释。


此答案部分基于生成的代码Android Bootstrap。因此,归功于他们弄清楚了这一点。解决方案用途Dagger v1.2.2
EpicPandaForce 2014年

3
的范围dagger-compiler应为provided其他情况,否则将包含在应用程序中,并且已获得GPL许可。
Denis Kniazhev

@deniskniazhev哦,我不知道!感谢您的注意!
EpicPandaForce 2015年
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.