2011年11月28日月曜日

lime-mvcを使ってみた

久々にWebアプリを作る機会があったのでlime-mvcを使ってみた。
今のところ(2011/11/28現在)あまり知名度がなく、日本語の記事など一切存在していないので
今後の参考にメモ。
lime-mvc - http://code.google.com/p/lime-mvc/

lime-mvcとは

Google Guiceを拡張して作られたMVCパターンのフレームワーク。

セットアップ

lime-mvcはMavenリポジトリから利用可能になっているのでpom.xmlに下記を追加するだけ。
<dependency>
  <groupId>org.zdevra</groupId>
  <artifactId>lime-velocity</artifactId>
  <version>0.2.0.rc2</version>
</dependency>
<dependency>
  <groupId>javax.servlet</groupId>
  <artifactId>javax.servlet-api</artifactId>
  <version>3.0.1</version>
  <scope>provided</scope>
</dependency>
<!-- ViewとしてJSPを使う場合は必要 -->
<!-- Velocity等を使用する場合は不要 -->
<dependency>
  <groupId>javax.servlet</groupId>
  <artifactId>jstl</artifactId>
  <version>1.2</version>
  <scope>provided</scope>
</dependency>

lime-mvcを使用する場合、MvcModuleのconfigureControllersをオーバーライドして
URLパターンとコントローラーのマッピングを行う。
これはアプリケーション起動時に呼ぶ必要があるため、GuiceServletContextListenerを継承して
デプロイメントディスクリプタ(web.xml)にリスナーとして登録する必要がある。
public class WebAppContextListener extends GuiceServletContextListener {

    @Override
    protected Injector getInjector() {
        return Guice.createInjector(new MvcModule() {
            @Override
            protected void configureControllers() {
                // URLパターンとコントローラーのマッピングを行う
                control("/samples/*").withController(WebAppController.class);
            }
        });
    }
}

Guiceは上記リスナーでマッピングしたデータをGuiceFilterでキャッチしてDispatchするので
ここではすべてのリクエストに対してGuiceFilterを通す設定をweb.xmlに記述する。
<filter>
  <filter-name>guiceFilter</filter-name>
  <filter-class>com.google.inject.servlet.GuiceFilter</filter-class>
</filter>

<filter-mapping>
  <filter-name>guiceFilter</filter-name>
  <url-pattern>/*</url-pattern>
</filter-mapping>

<listener>
  <listener-class>jp.u1aryz.products.samples.lime.listener.WebAppContextListener
  </listener-class>
</listener>

/helloworld/(.*)というパスに対してリクエストがあった場合にdoActionメソッドを呼び出し
main.jspに転送する場合のコントローラーは下記の通りとなる。
メソッドの戻り値をデータとしてビューに渡すことが出来る。
@Controller
public class WebAppController {

    @Path("/helloworld/(.*)")
    @ModelName("msg")
    @ToView("main.jsp")
    public String doAction(@UriParameter(1) String name) {
        return "Hello World " + name + "!";
    }
}

coreタグライブラリでModelNameアノテーションより指定された変数名で出力することにより、
JSPで表示することが出来る。
<%@ taglib uri="http://java.sun.com/jstl/core" prefix="c" %>
<html>
<head>
</head>
<body>
<c:out value="${msg}" />
</body>
</html>

コンテキストパスが"/"の場合はhttp://localhost:8080/samples/helloworld/hogeでアクセスすれば
下記のように出力されるはず。
Hello World hoge!

ほかにもlime-mvcはビューとしてJSilverやVelocity、Freemarkerを使えるので
Velocity使いとしてはありがたや〜。

2011年11月20日日曜日

いつからかEclipse上でAndroidプロジェクトのMavenビルドが出来なくなったので…

久々にMavenを使用してAndroidアプリを作成しようと思ったらなぜかビルドが出来ない。。
ADTやらSDKを更新したタイミングで使えなくなったのだろうと思い、いろいろ思考錯誤してみた。
そしてようやくビルドが出来る環境を作成する手順が確立出来たので忘れずメモ。

ちなみに私の環境は以下の通り。
Mac OS X 10.6.8
ADT 15 & SDK15
Maven 3.0.3
Eclipse Indigo

m2eのインストール

[Help] -> [Install New Software...]
プルダウンからIndigoのアップデートサイトを選択しCollaborationを展開する。
「Maven Integration for Eclipse」と「slf4j over logback loggind」にチェックし、-> [Next]
あとは指示通り進んでインストール完了後Eclipseを再起動。

m2e-androidのインストール

[Help] -> [Eclipse Marketplace...]
「m2e-android」と検索すると「Android Configuration for M2E」がヒットするので
Installボタンをクリックし指示通り進んでインストール完了後Eclipseを再起動。

Archetypeの追加

[New] -> [Project...] -> [Maven Project]
Workspace locationに任意の場所を指定 -> [Next] -> [Add Archetype...]
下記のような画面になるので各項目を入力 -> [OK]
Archetype Group Id: de.akquinet.android.archetypes
Archetype Artifact Id : android-quickstart
Archetype Version: 1.0.6
Repository URL: 空白
上記で追加したandroid-quickstartを選択しAndroidプロジェクトを作成する。

m2e connectorのインストール

Androidプロジェクトを作成すると、下記画面のようにpom.xmlにエラーマークがつくので
POMエディターで開く。
pom.xmlを開くと上記に赤くメッセージが表示されるのでその箇所をクリック。
下記のような黄色いウィンドウが表示されるので「Discover new m2e connectors」をクリック。
m2e Marketplaceなるものが開くので「Application」と「Maven」にチェックをし、
「Lifecycle Mappings」と「embedded maven runtimes」をインストールしEclipseを再起動。

pom.xmlの修正

<artifactId>maven-android-plugin</artifactId>
<version>2.8.4</version>
↓
<artifactId>android-maven-plugin</artifactId>
<version>3.0.0-alpha-14</version>
以上でEclipse上でAndroidプロジェクトのMavenビルドが出来るようになるはず。

ちなみにpom.xmlの全体はこんな感じ。
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>jp.u1aryz.products.hoge</groupId>
  <artifactId>HogeSample</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <packaging>apk</packaging>
  <name>HogeSample</name>

  <dependencies>
    <dependency>
      <groupId>com.google.android</groupId>
      <artifactId>android</artifactId>
      <version>2.1.2</version>
      <scope>provided</scope>
    </dependency>
  </dependencies>

  <build>
    <finalName>${project.artifactId}</finalName>
    <sourceDirectory>src/main/java</sourceDirectory>
    <plugins>
      <plugin>
        <groupId>com.jayway.maven.plugins.android.generation2</groupId>
        <artifactId>android-maven-plugin</artifactId>
        <version>3.0.0-alpha-14</version>
        <configuration>
          <sdk>
            <!-- SDKのパスはsettings.xmlで定義していれば不要 -->
            <path>"your ANDROID_HOME"</path>
            <platform>7</platform>
          </sdk>
          <manifest>
            <debuggable>true</debuggable>
          </manifest>
        </configuration>
        <extensions>true</extensions>
      </plugin>
      <plugin>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>2.3.2</version>
        <configuration>
          <source>1.6</source>
          <target>1.6</target>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

2011年11月18日金曜日

RoboGuiceでAndroidアプリのDI開発

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

細かいViewの制御は抜きにして以下のようなアプリを例としてRoboGuiceを使用して作成してみる。
  • トップ画面より入力された名前を次の画面で文字列を付け足して表示する。




  • まず前エントリーを参考にMavenプロジェクトからAndroidプロジェクトを作成。
    pom.xmlを追記
    <dependency>
      <groupId>org.roboguice</groupId>
      <artifactId>roboguice</artifactId>
      <version>1.1.2</version>
    </dependency>
    

    TopActivity
    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
    public interface RoboSampleService {
    
        public String hello(String name);
    }
    
    

    RoboSampleServiceImpl
    public class RoboSampleServiceImpl implements RoboSampleService {
    
        public String hello(String name) {
            return "Hello " + name;
        }
    
    }
    
    

    続いて上記サービスをバインド
    MyApplication
    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
    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
    public class MockServiceImpl implements RoboSampleService {
    
        @Override
        public String hello(String name) {
            return "test";
        }
    
    }
    

    続いてテストコードの実装
    HelloActivityTest
    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で...
    これで一通り完了。案外使いやすいかも?