RoboGuiceでAndroidアプリのDI開発

今更ながらRoboGuiceを使ってみたので忘れずメモ。
RoboGuiceについて簡単に触れておくとGoogle GuiceベースのAndroid用のDIコンテナである。
roboguice - Project Hosting on Google Code

細かいViewの制御は抜きにして以下のようなアプリを例としてRoboGuiceを使用して作成してみる。

トップ画面より入力された名前を次の画面で文字列を付け足して表示する。

まず前エントリーを参考にMavenプロジェクトからAndroidプロジェクトを作成。
pom.xmlを追記

view plainprint?

1. <dependency>  
2.   <groupId>org.roboguice</groupId>  
3.   <artifactId>roboguice</artifactId>  
4.   <version>1.1.2</version>  
5. </dependency>  

<dependency>
  <groupId>org.roboguice</groupId>
  <artifactId>roboguice</artifactId>
  <version>1.1.2</version>
</dependency>

TopActivity

view plainprint?

1. public class TopActivity extends RoboActivity {  
2.   
3.     @InjectResource(R.string.message)  
4.     String message;  
5.   
6.     @InjectView(R.id.txt_msg)  
7.     TextView mTextView;  
8.   
9.     @InjectView(R.id.edt_name)  
10.     EditText mEditText;  
11.   
12.     @InjectView(R.id.btn_decision)  
13.     Button mButton;  
14.   
15.     @Override  
16.     protected void onCreate(Bundle savedInstanceState) {  
17.         super.onCreate(savedInstanceState);  
18.   
19. //        mTextView.setText(message); // ここでViewにアクセスするとエラー  
20.         setContentView(R.layout.top); // ここでViewがInjectされる  
21.         mTextView.setText(message);  
22.         mButton.setOnClickListener(new OnClickListener() {  
23.   
24.             public void onClick(View v) {  
25.                 Intent intent = new Intent(TopActivity.this, HelloActivity.class);  
26.                 intent.putExtra("name", mEditText.getText().toString());  
27.                 startActivity(intent);  
28.             }  
29.         });  
30.     }  
31.   
32. }  

public class TopActivity extends RoboActivity {

    @InjectResource(R.string.message)
    String message;

    @InjectView(R.id.txt_msg)
    TextView mTextView;

    @InjectView(R.id.edt_name)
    EditText mEditText;

    @InjectView(R.id.btn_decision)
    Button mButton;

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

//        mTextView.setText(message); // ここでViewにアクセスするとエラー
        setContentView(R.layout.top); // ここでViewがInjectされる
        mTextView.setText(message);
        mButton.setOnClickListener(new OnClickListener() {

            public void onClick(View v) {
                Intent intent = new Intent(TopActivity.this, HelloActivity.class);
                intent.putExtra("name", mEditText.getText().toString());
                startActivity(intent);
            }
        });
    }

}

RoboActivityを継承してアクティビティを作成する。※1.1からGuiceActivityからRoboActivityに変更された
ListActivityの場合はRoboListActivity、TabActivityの場合はRoboTabActivityなどそれぞれ対応したもの
が存在する。
ソースを見るとわかる通り、@InjectView(resouceId)でViewをInjectしてくれる。
リソースを参照したい場合は@InjectResource(resourceId)を使用すればいい。
他にもこんなことが可能である。

Drawable icon = getResources().getDrawable(R.drawable.icon);
↓
@InjectResource(R.drawable.icon)
Drawable icon;

LocationManager loc = (LocationManager) getSystemService(Activity.LOCATION_SERVICE);
↓
@Inject
LocationManager loc;

HelloActivityを実装する前にインターフェースと実装クラスを使用して
少しDIっぽい処理を入れてみる。
RoboSampleService

view plainprint?

1. public interface RoboSampleService {  
2.   
3.     public String hello(String name);  
4. }  

public interface RoboSampleService {

    public String hello(String name);
}

RoboSampleServiceImpl

view plainprint?

1. public class RoboSampleServiceImpl implements RoboSampleService {  
2.   
3.     public String hello(String name) {  
4.         return "Hello " + name;  
5.     }  
6.   
7. }  

public class RoboSampleServiceImpl implements RoboSampleService {

    public String hello(String name) {
        return "Hello " + name;
    }

}

続いて上記サービスをバインド
MyApplication

view plainprint?

1. public class MyApplication extends RoboApplication {  
2.   
3.     @Override  
4.     protected void addApplicationModules(List<Module> modules) {  
5.         modules.add(new MyModule());  
6.     }  
7.   
8.     static class MyModule extends AbstractAndroidModule {  
9.   
10.         @Override  
11.         protected void configure() {  
12.             // RoboSampleServiceのInject要求に対してRoboSampleServiceImplを返すようバインドする  
13.             bind(RoboSampleService.class).to(RoboSampleServiceImpl.class);  
14.         }  
15.   
16.     }  
17. }  

public class MyApplication extends RoboApplication {

    @Override
    protected void addApplicationModules(List<Module> modules) {
        modules.add(new MyModule());
    }

    static class MyModule extends AbstractAndroidModule {

        @Override
        protected void configure() {
            // RoboSampleServiceのInject要求に対してRoboSampleServiceImplを返すようバインドする
            bind(RoboSampleService.class).to(RoboSampleServiceImpl.class);
        }

    }
}

※こちらもGuiceApplicationからRoboApplicationに変更されているので注意

アプリケーションのエントリポイントとして上記クラスを呼び出す必要があるので
AndroidManifest.xmlに以下を追加

<application...
    android:name=".MyApplication"
    ...>

最後にHelloActivityの実装
HelloActivity

view plainprint?

1. public class HelloActivity extends RoboActivity {  
2.   
3.     @InjectExtra("name")  
4.     String name;  
5.   
6.     @InjectView(R.id.hello_msg)  
7.     TextView textView;  
8.   
9.     @Inject  
10.     RoboSampleService service;  
11.   
12.     @Override  
13.     protected void onCreate(Bundle savedInstanceState) {  
14.         super.onCreate(savedInstanceState);  
15.         setContentView(R.layout.hello);  
16.         textView.setText(service.hello(name));  
17.     }  
18.   
19. }  

public class HelloActivity extends RoboActivity {

    @InjectExtra("name")
    String name;

    @InjectView(R.id.hello_msg)
    TextView textView;

    @Inject
    RoboSampleService service;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.hello);
        textView.setText(service.hello(name));
    }

}

@InjectExtra("name")でTopActivityでputExtraした値が入る。
また、RoboSampleServiceに@Injectアノテーションをつけることで上記でバインドした
RoboSampleServiceImplをInjectしてくれるのでインスタンスを生成せず使用することが出来る。

続いてDIの長所を活かしてHelloActivityのテストを書いてみる。
テストプロジェクトを作成する前にテスト対象のプロジェクトのクラスパスをエクスポート。

通常通りAndroidテストプロジェクトを作成する。
今回作成したサンプルプログラムのhelloメソッドは静的な文字列を付加するだけの
シンプルな作りであるが、実際は動的であったり、バグが混入していたり、
決まっていなかったりするので依存するクラスの振る舞いを固定化するモックを作成する。

MockServiceImpl

view plainprint?

1. public class MockServiceImpl implements RoboSampleService {  
2.   
3.     @Override  
4.     public String hello(String name) {  
5.         return "test";  
6.     }  
7.   
8. }  

public class MockServiceImpl implements RoboSampleService {

    @Override
    public String hello(String name) {
        return "test";
    }

}

続いてテストコードの実装
HelloActivityTest

view plainprint?

1. public class HelloActivityTest extends RoboActivityUnitTestCase<HelloActivity> {  
2.   
3.     private Context mContext;  
4.   
5.     public HelloActivityTest() {  
6.         super(HelloActivity.class);  
7.     }  
8.   
9.     class MockApplication extends RoboApplication {  
10.   
11.         public MockApplication(Context context) {  
12.             super();  
13.             attachBaseContext(context);  
14.         }  
15.   
16.         @Override  
17.         protected void addApplicationModules(List<Module> modules) {  
18.             modules.add(new MockModule());  
19.         }  
20.   
21.     }  
22.   
23.     class MockModule extends AbstractAndroidModule {  
24.   
25.         @Override  
26.         protected void configure() {  
27.             // RoboSampleServiceのInject要求に対してMockServiceImplを返すようバインドする  
28.             bind(RoboSampleService.class).to(MockServiceImpl.class);  
29.         }  
30.   
31.     }  
32.   
33.     @Override  
34.     protected void setUp() throws Exception {  
35.         super.setUp();  
36.         mContext = getInstrumentation().getContext();  
37.         setApplication(new MockApplication(mContext));  
38.     }  
39.   
40.     @MediumTest  
41.     public void testShouldBeHelloMsg() {  
42.         Intent intent = new Intent(mContext, HelloActivity.class);  
43.         intent.putExtra("name", "name");  
44.         HelloActivity a = startActivity(intent, null, null);  
45.         assertNotNull(a);  
46.   
47.         // Mockで返す文字列を"test"にしているため  
48.         assertEquals(((TextView)a.findViewById(R.id.hello_msg)).getText(), "test");  
49.     }  
50. }  

public class HelloActivityTest extends RoboActivityUnitTestCase<HelloActivity> {

    private Context mContext;

    public HelloActivityTest() {
        super(HelloActivity.class);
    }

    class MockApplication extends RoboApplication {

        public MockApplication(Context context) {
            super();
            attachBaseContext(context);
        }

        @Override
        protected void addApplicationModules(List<Module> modules) {
            modules.add(new MockModule());
        }

    }

    class MockModule extends AbstractAndroidModule {

        @Override
        protected void configure() {
            // RoboSampleServiceのInject要求に対してMockServiceImplを返すようバインドする
            bind(RoboSampleService.class).to(MockServiceImpl.class);
        }

    }

    @Override
    protected void setUp() throws Exception {
        super.setUp();
        mContext = getInstrumentation().getContext();
        setApplication(new MockApplication(mContext));
    }

    @MediumTest
    public void testShouldBeHelloMsg() {
        Intent intent = new Intent(mContext, HelloActivity.class);
        intent.putExtra("name", "name");
        HelloActivity a = startActivity(intent, null, null);
        assertNotNull(a);

        // Mockで返す文字列を"test"にしているため
        assertEquals(((TextView)a.findViewById(R.id.hello_msg)).getText(), "test");
    }
}

RoboActivityUnitTestCase<対象アクティビティ>を継承してテストコードを作成する。
RoboSampleServiceのInject要求に対してモックを返すようにバインドさせ、
setApplicationでセットすることで依存したオブジェクトの振る舞いを固定化させることが出来る。

Run As -> Android JUnit Testで...

これで一通り完了。案外使いやすいかも？