105

ダガーの使い方は？Android プロジェクトで動作するように Dagger を構成するにはどうすればよいですか?

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.)コンストラクターを使用して自分で作成でき、 を使用して再定義したくない依存関係@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()

サブスコープの詳細については、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();
    }
}

依存関係として指定できるスコープ付きコンポーネントは1 つだけであることに注意してください。Java で多重継承がサポートされていないのとまったく同じように考えてください。

+2.) About @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 に関する他のスタック オーバーフローの質問も確認してください。多くの情報が提供されています。たとえば、現在の Dagger2 構造はこの回答で指定されています。

ありがとう

Github、TutsPlus、Joe Steele、 Froger MCS、Googleのガイドに感謝します。

この段階的な移行ガイドについても、この投稿を書いた後に見つけました。

そしてキリルによるスコープ説明。

公式ドキュメントのさらに詳しい情報。

于 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.) ルートで指定されたモジュール内に他のサブモジュールがある場合は、それらのモジュールを作成します。

@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でインジェクターを呼び出します。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 に答える