android - 如何在考虑测试的情况下使用 Dagger 设计 Android 应用程序

Question

我是 dagger 的新手，我最近开始在我自己的一个项目中使用 dagger，因为能够以不同方式处理测试和生产的依赖注入(inject)的概念，从而能够注入(inject)我可以注入(inject)的模拟对象用于测试很棒。

我修改了我的应用程序以遵循 dagger simple-android example 中列出的样式.

全部设置好后，我发现注入(inject)有问题，我无法用测试逻辑完全重载生产应用程序中的注入(inject)。

我正在寻找有关如何设置它的建议，以便我的测试实际上可以根据需要与模拟或其他对象进行差异化注入(inject)以进行测试，并且不会太笨拙。目前，MainActivityTest 被正确注入(inject)，但是当我们到达 MainActivity 时，它会转到 PhoneApplication 并使用它的对象图注入(inject) p>

我已经包含了下面的内容。任何帮助将不胜感激!

---

这是我的PhoneApplication，基于DemoApplication。

public class PhoneApplication extends Application {
    private ObjectGraph graph;

    @Override
    public void onCreate() {
        super.onCreate();

        graph = ObjectGraph.create(getModules().toArray());
    }

    protected List<Object> getModules() {
        return Arrays.asList(new AndroidModule(this), new PhoneModule());
    }

    public void inject(Object object) {
        graph.inject(object);
    }
}

这是我的 AndroidModule

@Module(library = true, injects = MainActivity.class)
public class AndroidModule {
    private final Context context;

    public AndroidModule(Context context) {
        this.context = context;
    }

    /**
     * Allow the application context to be injected but require that it be
     * annotated with {@link ForApplication @Annotation} to explicitly
     * differentiate it from an activity context.
     */
    @Provides
    @Singleton
    @ForApplication
    Context provideApplicationContext() {
        return context;
    }

    @Provides
    @Singleton
    NotificationManager provideNotificationManager() {
        return (NotificationManager) context
                .getSystemService(Application.NOTIFICATION_SERVICE);
    }

    @Provides
    @Singleton
    LocalBroadcastManager provideLocalBroadcastManager() {
        return LocalBroadcastManager.getInstance(context);
    }

    @Provides
    @Singleton
    ContentResolver provideContentResolver() {
        return context.getContentResolver();
    }

}

根据示例，我还设置了我的 Activity 以使用基本 Activity。

public abstract class ActionBarBaseActivity extends ActionBarActivity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        ((PhoneApplication) getApplication()).inject(this);
    }
}

然后在我的 MainActivity 中我有以下内容

public class MainActivity extends ActionBarBaseActivity {

...

    @Inject
    LocalBroadcastManager localBroadcastManager;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
...
        try {
            messageReceivedIntentFilter = new IntentFilter(
                    Constants.EVENT_MESSAGE_RECEIVED,
                    "vnd.android.cursor.dir/vnd."
                            + DataProviderContract.AUTHORITY + "."
                            + DataProviderContract.MESSAGES_TABLE_NAME);

            localBroadcastManager.registerReceiver(messageReceiver,
                    messageReceivedIntentFilter);
        } catch (MalformedMimeTypeException e) {
            Log.e(LOG_TAG,
                    "An error occurred registering an Intent for EVENT_MESSAGE_RECEIVED",
                    e);
        }
...
    }
...
}

效果很好，注入(inject)很快就到位了，我欣喜若狂。直到我真的想做一些测试。我想要执行的第一个测试是在我的 MainActivity 上。

在上面的 onCreate 方法中，我们注入(inject)了来自 AndroidModule 的 LocalBroadcastManager，而不是来自 MainActivityTest 的 LocalBroadcastManager，因为我们不目前有一种方法可以告诉 PhoneApplication 或 Activity 他们应该使用不同的对象图。

public class MainActivityTest extends
        ActivityInstrumentationTestCase2<MainActivity> {

    @Inject
    NotificationManager notificationManager;

    @Inject
    ContentResolver contentResolver;

    @Inject
    MockContentResolver mockContentResolver;

    @Inject
    LocalBroadcastManager localBroadcastManager;

    private Context context;

    public MainActivityTest() {
        super(MainActivity.class);
    }

    @Module(injects = { MainActivityTest.class, MainActivity.class }, library = true, overrides = true)
    static class MockModule {
        Context context;

        public MockModule(Context context) {
            this.context = context;
        }

        @Provides
        @Singleton
        ContentResolver provideContentResolver() {
            return provideMockContentResolver();
        }

        @Provides
        @Singleton
        MockContentResolver provideMockContentResolver() {
            return new MockContentResolver();
        }

        @Provides
        @Singleton
        LocalBroadcastManager provideLocalBroadcastManager() {
            return Mockito.mock(LocalBroadcastManager.class);
        }
    }

    @Override
    protected void setUp() throws Exception {
        System.setProperty("dexmaker.dexcache", getInstrumentation()
                .getTargetContext().getCacheDir().getPath());

        context = getInstrumentation().getTargetContext();
        ObjectGraph graph = ObjectGraph.create(new AndroidModule(context),
                new MockModule(context));
        graph.inject(this);

        super.setUp();
    };

    @MediumTest
    @UiThreadTest
    public void testIncomingMessageReceiver_onReceive()
            throws MalformedMimeTypeException {

        ArgumentCaptor<BroadcastReceiver> receiverCaptor = ArgumentCaptor
                .forClass(BroadcastReceiver.class);
        Mockito.verify(localBroadcastManager, Mockito.atLeastOnce())
                .registerReceiver(receiverCaptor.capture(),
                        Mockito.any(IntentFilter.class));
    }
}

这是一个非常简单的入门测试。我知道在 onCreate 中，我们将要注册一个 BroadcastReceiver，所以让我们确保它已注册。因为测试有 mockLocalBroadcastManager，但是 Activity 使用生产 LocalBroadcastManager，验证失败。

Answer 1

我不确定。刚刚在网上搜索以了解如何正确使用 dagger 进行测试。

然而，据我所知，MainActivity 从应用程序中获取其对象图。所以，这是您必须插入 MockModule 的地方。

为此，您应该创建 PhoneApplication 的子类并覆盖 getModules() 方法以返回您的 MockModule。之后，您应该使用 ActivityUnitTestCase.setApplication() 模拟应用程序(您的测试应该首先子类化 ActivityUnitTestCase)。这应该可以解决问题。