105

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

我想在我的 Android 项目中使用 Dagger，但我觉得它很混乱。

编辑： Dagger2 自 2015 年 4 月 15 日以来也已发布，而且更加令人困惑！

[这个问题是一个“存根”，当我了解更多关于 Dagger1 和更多关于 Dagger2 的信息时，我将在这个问题上添加到我的答案中。这个问题更像是一个指南，而不是一个“问题”。]

4

2 回答 2

198

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.)对于您可以通过构造函数自己创建并且不想使用 a 重新定义的依赖@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）

（注意：使用 APTRebuild 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为您的组件指定您可以创建活动级别范围的组件。子范围允许您提供只需要给定子范围的依赖项，而不是整个应用程序。通常，每个 Activity 都会通过此设置获得自己的模块。请注意，每个组件都存在一个范围提供程序，这意味着为了保留该活动的实例，组件本身必须在配置更改后继续存在。例如，它可以通过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 结构在此 answer中指定。

谢谢

感谢Github、TutsPlus、Joe Steele、Froger MCS和Google的指导。

在写完这篇文章后，我还发现了这个分步迁移指南。

对于Kirill 的范围解释。

更多信息在官方文档中。

于 2015-04-29T12:11:28.130 回答
11

Dagger 1.x指南：

步骤如下：

1.) 将依赖项添加Dagger到build.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.) 如果您的模块中有其他子模块在您的 Root 中指定，请为这些子模块创建：

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

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

@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的方法中调用 Injector onCreate()。

@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注释。

于 2014-11-20T10:13:29.333 回答