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に下記を追加するだけ。

view plainprint?

1. <dependency>  
2.   <groupId>org.zdevra</groupId>  
3.   <artifactId>lime-velocity</artifactId>  
4.   <version>0.2.0.rc2</version>  
5. </dependency>  
6. <dependency>  
7.   <groupId>javax.servlet</groupId>  
8.   <artifactId>javax.servlet-api</artifactId>  
9.   <version>3.0.1</version>  
10.   <scope>provided</scope>  
11. </dependency>  
12. <!-- ViewとしてJSPを使う場合は必要 -->  
13. <!-- Velocity等を使用する場合は不要 -->  
14. <dependency>  
15.   <groupId>javax.servlet</groupId>  
16.   <artifactId>jstl</artifactId>  
17.   <version>1.2</version>  
18.   <scope>provided</scope>  
19. </dependency>  

<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)にリスナーとして登録する必要がある。

view plainprint?

1. public class WebAppContextListener extends GuiceServletContextListener {  
2.   
3.     @Override  
4.     protected Injector getInjector() {  
5.         return Guice.createInjector(new MvcModule() {  
6.             @Override  
7.             protected void configureControllers() {  
8.                 // URLパターンとコントローラーのマッピングを行う  
9.                 control("/samples/*").withController(WebAppController.class);  
10.             }  
11.         });  
12.     }  
13. }  

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に記述する。

view plainprint?

1. <filter>  
2.   <filter-name>guiceFilter</filter-name>  
3.   <filter-class>com.google.inject.servlet.GuiceFilter</filter-class>  
4. </filter>  
5.   
6. <filter-mapping>  
7.   <filter-name>guiceFilter</filter-name>  
8.   <url-pattern>/*</url-pattern>  
9. </filter-mapping>  
10.   
11. <listener>  
12.   <listener-class>jp.u1aryz.products.samples.lime.listener.WebAppContextListener  
13.   </listener-class>  
14. </listener>  

<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に転送する場合のコントローラーは下記の通りとなる。
メソッドの戻り値をデータとしてビューに渡すことが出来る。

view plainprint?

1. @Controller  
2. public class WebAppController {  
3.   
4.     @Path("/helloworld/(.*)")  
5.     @ModelName("msg")  
6.     @ToView("main.jsp")  
7.     public String doAction(@UriParameter(1) String name) {  
8.         return "Hello World " + name + "!";  
9.     }  
10. }  

@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で表示することが出来る。

view plainprint?

1. <%@ taglib uri="http://java.sun.com/jstl/core" prefix="c" %>  
2. <html>  
3. <head>  
4. </head>  
5. <body>  
6. <c:out value="${msg}" />  
7. </body>  
8. </html>  

<%@ 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使いとしてはありがたや〜。