Guice3 + MyBatis3

前回のSpring3 + MyBatis3のSpringをGuiceに置き換えてみます。

User.java、UserDao.java、UserDao.xml、UserService.javaは前回と同じ物をそのまま利用します。

Guice-MyBatisプラグインの標準のトランザクションインターセプターではreadOnlyの設定ができない（rollbackOnlyは可能）ため、 readOnlyに対応したトランザクションインターセプターを自作します。
ソースコードはGuice-MyBatisプラグインの標準のトランザクションインターセプターを参考にしています。

※PooledDataSourceProviderではなく、BasicDataSourceProviderを使用すればdefaultReadOnlyの設定が可能でした。
ただし、その場合には標準のトランザクションインターセプターではreadOnlyをfalseに設定しなおす事がないようで、更新系の処理ができません。

TransactionalMethodInterceptor.java

package com.brightgenerous.extension.ibatis;

import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
import java.util.Arrays;

import javax.inject.Inject;

import com.brightgenerous.extension.logging.Log;
import com.brightgenerous.extension.logging.LogFactory;

import org.aopalliance.intercept.MethodInterceptor;
import org.aopalliance.intercept.MethodInvocation;
import org.apache.ibatis.session.ExecutorType;
import org.apache.ibatis.session.SqlSessionManager;
import org.apache.ibatis.session.TransactionIsolationLevel;

public final class TransactionalMethodInterceptor implements MethodInterceptor {

    private static final Class＜?＞[] CAUSE_TYPES = new Class[] { Throwable.class };

    private static final Class＜?＞[] MESSAGE_CAUSE_TYPES = new Class[] {
            String.class, Throwable.class };

    private static final Log log = LogFactory
            .getLog(TransactionalMethodInterceptor.class);

    @Inject
    private SqlSessionManager sqlSessionManager;

    private final boolean readOnly;

    private final ExecutorType executorType;

    private final TransactionIsolationLevel isolationLevel;

    private final boolean rollbackOnly;

    private final boolean force;

    private final Class＜? extends Throwable＞ rethrowExceptionsAs;

    private final String exceptionMessage;

    public TransactionalMethodInterceptor() {
        this(false);
    }

    public TransactionalMethodInterceptor(boolean readOnly) {
        this(readOnly, ExecutorType.SIMPLE, null, false, false,
                Exception.class, "");
    }

    public TransactionalMethodInterceptor(boolean readOnly,
            ExecutorType executorType,
            TransactionIsolationLevel isolationLevel, boolean rollbackOnly,
            boolean force, Class＜? extends Throwable＞ rethrowExceptionsAs,
            String exceptionMessage) {
        this.readOnly = readOnly;
        this.executorType = executorType;
        this.isolationLevel = isolationLevel;
        this.rollbackOnly = rollbackOnly;
        this.force = force;
        this.rethrowExceptionsAs = rethrowExceptionsAs;
        this.exceptionMessage = exceptionMessage;
    }

    public void setSqlSessionManager(SqlSessionManager sqlSessionManager) {
        this.sqlSessionManager = sqlSessionManager;
    }

    @Override
    public Object invoke(MethodInvocation invocation) throws Throwable {
        Method interceptedMethod = invocation.getMethod();

        String debugPrefix = null;
        if (log.isDebugEnabled()) {
            debugPrefix = String.format("[Intercepted method: %s]",
                    interceptedMethod.toGenericString());
        }

        boolean isSessionInherited = sqlSessionManager
                .isManagedSessionStarted();

        if (isSessionInherited) {
            if (log.isDebugEnabled()) {
                log.debug(String.format(
                        "%s - SqlSession already set for thread: %s",
                        debugPrefix, Thread.currentThread().getId()));
            }
        } else {
            if (log.isDebugEnabled()) {
                log.debug(String
                        .format("%s - SqlSession not set for thread: %s, creating a new one",
                                debugPrefix, Thread.currentThread().getId()));
            }

            sqlSessionManager.startManagedSession(executorType, isolationLevel);
            sqlSessionManager.getConnection().setReadOnly(readOnly);
        }

        Object object = null;
        try {
            object = invocation.proceed();

            if (!isSessionInherited && !rollbackOnly) {
                sqlSessionManager.commit(force);
            }
        } catch (Throwable t) {
            sqlSessionManager.rollback(force);

            for (Class＜?＞ exceptionClass : interceptedMethod
                    .getExceptionTypes()) {
                if (exceptionClass.isAssignableFrom(t.getClass())) {
                    throw t;
                }
            }

            if (rethrowExceptionsAs.isAssignableFrom(t.getClass())) {
                throw t;
            }

            String errorMessage;
            Object[] initargs;
            Class＜?＞[] initargsType;

            if (exceptionMessage.length() != 0) {
                errorMessage = String.format(exceptionMessage,
                        invocation.getArguments());
                initargs = new Object[] { errorMessage, t };
                initargsType = MESSAGE_CAUSE_TYPES;
            } else {
                initargs = new Object[] { t };
                initargsType = CAUSE_TYPES;
            }

            Constructor＜? extends Throwable＞ exceptionConstructor = getMatchingConstructor(
                    rethrowExceptionsAs, initargsType);
            Throwable rethrowEx = null;
            if (exceptionConstructor != null) {
                try {
                    rethrowEx = exceptionConstructor.newInstance(initargs);
                } catch (Exception e) {
                    errorMessage = String
                            .format("Impossible to re-throw '%s', it needs the constructor with %s argument(s).",
                                    rethrowExceptionsAs.getName(),
                                    Arrays.toString(initargsType));
                    log.error(errorMessage, e);
                    rethrowEx = new RuntimeException(errorMessage, e);
                }
            } else {
                errorMessage = String
                        .format("Impossible to re-throw '%s', it needs the constructor with %s or %s argument(s).",
                                rethrowExceptionsAs.getName(),
                                Arrays.toString(CAUSE_TYPES),
                                Arrays.toString(MESSAGE_CAUSE_TYPES));
                log.error(errorMessage);
                rethrowEx = new RuntimeException(errorMessage);
            }

            throw rethrowEx;
        } finally {
            if (!isSessionInherited) {
                if (rollbackOnly) {
                    if (log.isDebugEnabled()) {
                        log.debug(debugPrefix + " - SqlSession of thread: "
                                + Thread.currentThread().getId()
                                + " was in rollbackOnly mode, rolling it back");
                    }

                    sqlSessionManager.rollback(true);
                }

                if (log.isDebugEnabled()) {
                    log.debug(String
                            .format("%s - SqlSession of thread: %s terminated its life-cycle, closing it",
                                    debugPrefix, Thread.currentThread().getId()));
                }

                sqlSessionManager.close();
            } else if (log.isDebugEnabled()) {
                log.debug(String
                        .format("%s - SqlSession of thread: %s is inherited, skipped close operation",
                                debugPrefix, Thread.currentThread().getId()));
            }
        }

        return object;
    }

    private static ＜E extends Throwable＞ Constructor＜E＞ getMatchingConstructor(
            Class＜E＞ type, Class＜?＞[] argumentsType) {
        Class＜? super E＞ currentType = type;
        while (Object.class != currentType) {
            for (Constructor＜?＞ constructor : currentType.getConstructors()) {
                if (Arrays.equals(argumentsType,
                        constructor.getParameterTypes())) {
                    return (Constructor＜E＞) constructor;
                }
            }
            currentType = currentType.getSuperclass();
        }
        return null;
    }
}

Guiceでは、Spring3 + MyBatis3で使用したapplicationContext.xml、sqlMapConfig.xml、database.propertiesが不要になります。
かわりに、Guiceの場合はソースコードに設定を記述します。
以下が実行するテストコードです。beforeメソッド内の処理が設定になります。

UserServiceTestGuice.java

package com.brightgenerous.sample.application.service;

import java.lang.reflect.Method;
import java.util.Properties;
import java.util.Set;

import com.brightgenerous.extension.ibatis.TransactionalMethodInterceptor;
import com.brightgenerous.sample.application.bean.User;
import com.brightgenerous.sample.application.dao.UserDao;

import org.aopalliance.intercept.MethodInterceptor;
import org.apache.ibatis.io.ResolverUtil;
import org.apache.ibatis.session.AutoMappingBehavior;
import org.apache.ibatis.transaction.jdbc.JdbcTransactionFactory;
import org.junit.Before;
import org.junit.Test;
import org.mybatis.guice.MyBatisModule;
import org.mybatis.guice.datasource.builtin.PooledDataSourceProvider;
import org.mybatis.guice.transactional.Transactional;

import com.google.inject.AbstractModule;
import com.google.inject.Guice;
import com.google.inject.Injector;
import com.google.inject.Scopes;
import com.google.inject.matcher.AbstractMatcher;
import com.google.inject.name.Names;

public class UserServiceTestGuice {

    private Injector injector;

    @Before
    public void before() {

        injector = Guice.createInjector(new MyBatisModule() {

            @Override
            protected void initialize() {

                MethodInterceptor updateInterceptor = new TransactionalMethodInterceptor();
                binder().requestInjection(updateInterceptor);
                binder().bindInterceptor(new AbstractMatcher＜Class＜?＞＞() {

                    @Override
                    public boolean matches(Class＜?＞ x_arg0) {
                        return x_arg0.getName().matches("^.*Service$");
                    }
                }, new AbstractMatcher＜Method＞() {

                    @Override
                    public boolean matches(Method x_arg0) {
                        return (x_arg0.getAnnotation(Transactional.class) == null)
                                && x_arg0.getName().matches(
                                        "^(regist|update|delete).*$");
                    }
                }, updateInterceptor);
                MethodInterceptor readInterceptor = new TransactionalMethodInterceptor(
                        true);
                binder().requestInjection(readInterceptor);
                binder().bindInterceptor(new AbstractMatcher＜Class＜?＞＞() {

                    @Override
                    public boolean matches(Class＜?＞ x_arg0) {
                        return x_arg0.getName().matches("^.*Service$");
                    }
                }, new AbstractMatcher＜Method＞() {

                    @Override
                    public boolean matches(Method x_arg0) {
                        return (x_arg0.getAnnotation(Transactional.class) == null)
                                && !x_arg0.getName().matches(
                                        "^(regist|update|delete).*$");
                    }
                }, readInterceptor);

                environmentId("test");

                bindDataSourceProviderType(PooledDataSourceProvider.class);
                bindTransactionFactoryType(JdbcTransactionFactory.class);

                Properties properties = new Properties();
                properties.setProperty("JDBC.url",
                        "jdbc:postgresql://127.0.0.1:5432/scheme");
                properties.setProperty("JDBC.driver", "org.postgresql.Driver");
                properties.setProperty("JDBC.username", "username");
                properties.setProperty("JDBC.password", "password");
                properties.setProperty("JDBC.autoCommit", "false");
                Names.bindProperties(binder(), properties);

                useCacheEnabled(true);
                lazyLoadingEnabled(true);
                aggressiveLazyLoading(true);
                autoMappingBehavior(AutoMappingBehavior.PARTIAL);
                useColumnLabel(true);
                useGeneratedKeys(false);
                failFast(true);
                multipleResultSetsEnabled(true);

                addSimpleAliases("com.brightgenerous.sample.application.bean");

                addMapperClasses(new ResolverUtil＜Object＞().find(
                        new ResolverUtil.Test() {

                            @Override
                            public boolean matches(Class＜?＞ x_arg0) {
                                return x_arg0.getName().matches("^.*Dao$");
                            }
                        }, "com.brightgenerous.sample.application.dao")
                        .getClasses());
            }
        },

        new AbstractModule() {

            @Override
            protected void configure() {
                Set＜Class＜? extends Object＞＞ services = new ResolverUtil＜Object＞()
                        .find(new ResolverUtil.Test() {

                            @Override
                            public boolean matches(Class＜?＞ x_arg0) {
                                return x_arg0.getName().matches("^.*Service$");
                            }
                        }, "com.brightgenerous.sample.application.service")
                        .getClasses();
                for (Class＜? extends Object＞ service : services) {
                    bind(service).in(Scopes.SINGLETON);
                }
            }
        });
    }

    @Test
    public void test01() {
        UserService service = injector.getInstance(UserService.class);
        User user = new User();
        user.setId(Integer.valueOf(1));
        user = service.get(user);
        System.out.println(user.getName());
        user.setName(user.getName() + "-");
        service.update(user);
        System.out.println(service.get(user).getName());
        System.out.println(service.equals(injector
                .getInstance(UserService.class)));
        System.out.println(injector.getInstance(UserDao.class).equals(
                injector.getInstance(UserDao.class)));
    }
}

使ってみると、Guiceもかなり便利でした。
今回は、あえてSpringの場合と同じ設定にするためにトランザクションインターセプターを自作しましたが、 標準のトランザクションインターセプターとTransactionalアノテーションを使う方法が一般的だと思います。

設定をソースコードに記述するフレームワークとして、Wicketと相性が良さそうです。

Spring3 + MyBatis3

MyBatis3がMyBatis2に比べて結構使いやすくなっています。
特に実装クラスを必要としないMapperの機能が便利です。
他には、XMLでognl式が使えたり、使いやすいタグが増えています。

Spring3 + MyBatis3の実装例で試してみます。

まず、データクラスを作成します。

User.java

package com.brightgenerous.sample.application.bean;

import java.io.Serializable;

public class User implements Serializable {

    private static final long serialVersionUID = -1056270813521861315L;

    private Integer m_id;

    private String m_name;

    private String m_email;

    public Integer getId() {
        return m_id;
    }

    public void setId(Integer x_id) {
        m_id = x_id;
    }

    public String getName() {
        return m_name;
    }

    public void setName(String x_name) {
        m_name = x_name;
    }

    public String getEmail() {
        return m_email;
    }

    public void setEmail(String x_email) {
        m_email = x_email;
    }
}

次に、Dao(Mapper)インターフェースを作成します。

UserDao.java

package com.brightgenerous.sample.application.dao;

import com.brightgenerous.sample.application.bean.User;

public interface UserDao {

    User select(User x_user);

    int insert(User x_user);

    int update(User x_user);

    int delete(User x_user);
}

そして、UserDao.javaと同じパッケージにUserDao.xmlを置きます。（拡張子以外のファイル名を同じにする）
それだけでインターフェースとXMLファイルが関連付けられます。

UserDao.xml

 

 
  
  
  
 

 
  select
   *
  from
   t_user
  
   
    and 1 = 0
    and id = #{id}
   
  
 

 
  
   select coalesce((select max(id) from t_user),0) + 1 as id
  
  insert into
   t_user (
    id,
    name,
    email
   ) values (
    #{id},
    #{name},
    #{email}
   )
 

 
  update
   t_user
  set
   name = #{name},
   email = #{email}
  where
   id = #{id}
 

 
  delete from
   t_user
  where
   id = #{id}
 

最後に、トランザクション境界となるServiceクラスを作成します。

UserService.java

package com.brightgenerous.sample.application.service;

import javax.inject.Inject;

import com.brightgenerous.sample.application.bean.User;
import com.brightgenerous.sample.application.dao.UserDao;

public class UserService {

    @Inject
    private UserDao m_userDao;

    public User get(User x_user) {
        return m_userDao.select(x_user);
    }

    public void update(User x_user) {
        m_userDao.update(x_user);
    }
}

あとは設定ファイルを書くだけです。
注入先フィールドのInjectアノテーションはjavax.inject.Injectです。
実は、上記のすべてのクラスでMyBatisやSpringに関するインポートがないのです。

applicationContext.xml

 
 
  
 

 
 
  
  
  
  
  
  
 

 
 
  
 
 
  
   
    PROPAGATION_REQUIRED
    PROPAGATION_REQUIRED
    PROPAGATION_REQUIRED
    PROPAGATION_REQUIRED,readOnly
   
  
 
 
  
  
 
 
  
  
 

 
 
  
  
 

 
 
  
 
 
  
 

applicationContext.xmlには com.brightgenerous.extension.spring3.FqcnBeanNameGeneratorというクラスがありますが、
これは、ただFQCNを返すだけのSpringのBeanNameGenerator実装です。
database.propertiesファイルは特にここで書くほどでもないので省略します。

sqlMapConfig.xml

実行方法は以下のようになります。

UserServiceTestSpring

package com.brightgenerous.sample.application.service;

import com.brightgenerous.sample.application.bean.User;
import com.brightgenerous.sample.application.dao.UserDao;

import org.junit.Before;
import org.junit.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

public class UserServiceTestSpring {

    private ApplicationContext context;

    @Before
    public void before() {
        context = new ClassPathXmlApplicationContext("applicationContext.xml");
    }

    @Test
    public void test01() {
        UserService service = context.getBean(UserService.class);
        User user = new User();
        user.setId(Integer.valueOf(1));
        user = service.get(user);
        user.setName(user.getName() + "-");
        service.update(user);
    }
}

これ以上ソースコードの記述量を減らせないんじゃないのかと思えるほど、簡単になりました。
設定ファイルは一度書いてしまえば、以降は編集しないので、 実際に作成するファイルはデータクラス、Mapperインターフェース、MapperのXMLファイル、サービスクラスの４つです。

次回は、SpringをGuiceに置き換えて同じ機能を実現してみようと思います。
具体的には、Springでの設定ファイルにあたる部分をソースで書くだけで、Mapperやサービスクラスには手を加えません。

Servlet3.0 と Guice

最近、Servlet3.0のアノテーションによるゼロコンフィグを試していましたところ、 ふと、これってGuiceと相性いいんんじゃね？と思い至りました。
サクっと書いてみたServlet3.0 + Guice + JDBCってのを紹介します。

Servlet3.0からは、アノテーションでServletを登録できる他に、ServletContext#addServlet()を呼び出しての登録も可能になっています。
つまり、Guiceを利用して生成したServletインスタンスをマッピングさせることが可能だということです。
これをやってみようかと思います。

まず、トランザクション担当のクラスの親となるクラスを作成します。

AbstractService.java

package com.brightgenerous.sample;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.sql.Connection;

public abstract class AbstractService {

    @Target({ ElementType.METHOD })
    @Retention(RetentionPolicy.RUNTIME)
    public static @interface Transactional {
    }

    private final ThreadLocal＜Holder＜Connection＞＞ thlocal = new ThreadLocal＜Holder＜Connection＞＞() {

        @Override
        protected Holder＜Connection＞ initialValue() {
            return new Holder＜Connection＞();
        }
    };

    protected Connection getConnection() {
        return thlocal.get().m_object;
    }

    private void setConnection(Connection x_connection) {
        thlocal.get().m_object = x_connection;
    }

    static class Holder＜T＞ {

        T m_object;
    }
}

次に、そのトランザクションの実装クラスを作成します。
インターフェースと実装クラスは１つずつなので、まとめて書いてしまいます。
便利なのでapache-commons-dbutilsを使用しています。

UserService.java

package com.brightgenerous.sample.service;

import java.sql.SQLException;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;


import org.apache.commons.dbutils.QueryRunner;
import org.apache.commons.dbutils.handlers.MapListHandler;
import org.apache.commons.dbutils.handlers.ScalarHandler;

import com.brightgenerous.sample.AbstractService;

public interface UserService {

    List＜Map＜String, Object＞＞ findAll();

    void add(Map＜String, Object＞ x_data);

    class UserServiceImpl extends AbstractService implements UserService {

        @Transactional
        @Override
        public List＜Map＜String, Object＞＞ findAll() {
            StringBuilder sql = new StringBuilder();
            sql.append("SELECT id, name, email FROM t_user ORDER BY id");
            try {
                return new QueryRunner().query(getConnection(), sql.toString(),
                        new MapListHandler());
            } catch (SQLException e) {
                throw new RuntimeException(e);
            }
        }

        @Transactional
        @Override
        public void add(Map＜String, Object＞ x_data) {
            x_data.put("id", nextId());
            StringBuilder sql = new StringBuilder();
            sql.append("INSERT INTO t_user(id, name, email) VALUES (?, ?, ?)");
            List＜Object＞ params = new ArrayList＜Object＞();
            params.add(x_data.get("id"));
            params.add(x_data.get("name"));
            params.add(x_data.get("email"));
            try {
                new QueryRunner().update(getConnection(), sql.toString(),
                        params.toArray());
            } catch (SQLException e) {
                throw new RuntimeException(e);
            }
        }

        private Number nextId() {
            StringBuilder sql = new StringBuilder();
            sql.append("SELECT COALESCE((SELECT MAX(id) FROM t_user), 0) + 1");
            try {
                return (Number) new QueryRunner().query(getConnection(),
                        sql.toString(), new ScalarHandler());
            } catch (SQLException e) {
                throw new RuntimeException(e);
            }
        }
    }
}

いったん、Servletの抽象クラスを作成しておきます。

AbstractHttpServlet.java

package com.brightgenerous.sample.servlet;

import java.io.IOException;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

abstract class AbstractHttpServlet extends HttpServlet {

    private static final long serialVersionUID = 2788992165026478005L;

    @Override
    protected void doGet(HttpServletRequest x_request,
            HttpServletResponse x_response) throws ServletException,
            IOException {

        doService(x_request, x_response);
    }

    @Override
    protected void doPost(HttpServletRequest x_request,
            HttpServletResponse x_response) throws ServletException,
            IOException {

        doService(x_request, x_response);
    }

    abstract protected void doService(HttpServletRequest x_request,
            HttpServletResponse x_response) throws ServletException,
            IOException;
}

そして、Servletの実装クラスを作成します。
ここでも、インターフェースと実装クラスは１つずつなので、まとめて書いてしまいます。

UserAddServlet.java

package com.brightgenerous.sample.servlet;

import java.io.IOException;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import javax.servlet.Servlet;
import javax.servlet.ServletException;
import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;


import com.brightgenerous.sample.service.UserService;
import com.google.inject.Inject;

public interface UserAddServlet extends Servlet {

    class UserAddServletImpl extends AbstractHttpServlet implements
            UserAddServlet {

        private static final long serialVersionUID = -4751580520972958252L;

        @Inject
        private UserService service;

        @Override
        protected void doService(HttpServletRequest x_request,
                HttpServletResponse x_response) throws ServletException,
                IOException {

            List＜Map＜String, Object＞＞ datas = service.findAll();
            Map＜String, Object＞ data = new HashMap＜String, Object＞();
            data.put("name", x_request.getParameter("name"));
            data.put("email", x_request.getParameter("email"));

            service.add(data);

            StringBuilder sb = new StringBuilder();
            sb.append("＜html＞＜head＞＜title＞servlet3 + guice＜/title＞＜/head＞＜body＞");
            sb.append("＜a href=\"" + UserFormServlet.class.getSimpleName()
                    + "\"＞back＜/a＞");
            sb.append("＜table border=\"1\"＞");
            sb.append("＜tr＞＜th＞name＜/th＞＜th＞e-mail＜/th＞＜/tr＞");
            // ignore SQL injection...
            for (Map＜String, Object＞ d : datas) {
                sb.append("＜tr＞＜td＞" + d.get("name") + "＜/td＞");
                sb.append("＜td＞" + d.get("email") + "＜/td＞＜/tr＞");
            }
            sb.append("＜tr＞＜th＞name＜/th＞＜th＞e-mail＜/th＞＜/tr＞");
            sb.append("＜tr＞＜td＞" + data.get("name") + "＜/td＞");
            sb.append("＜td＞" + data.get("email") + "＜/td＞＜/tr＞");

            sb.append("＜/table＞");
            sb.append("＜/body＞＜/html＞");

            ServletOutputStream out = x_response.getOutputStream();
            out.print(sb.toString());
            out.flush();
        }
    }
}

最後に、ServletContextListener実装クラスを作成します。
このクラスにweb.xmlに対応する処理を記述します。

InitialContextListener.java

package com.brightgenerous.sample;

import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.SQLException;

import javax.servlet.ServletContext;
import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.servlet.annotation.WebListener;


import org.aopalliance.intercept.MethodInterceptor;
import org.aopalliance.intercept.MethodInvocation;

import com.brightgenerous.sample.AbstractService.Transactional;
import com.brightgenerous.sample.service.UserService;
import com.brightgenerous.sample.service.UserService.UserServiceImpl;
import com.brightgenerous.sample.servlet.UserAddServlet;
import com.brightgenerous.sample.servlet.UserFormServlet;
import com.brightgenerous.sample.servlet.UserAddServlet.UserAddServletImpl;
import com.brightgenerous.sample.servlet.UserFormServlet.UserFormServletImpl;
import com.google.inject.AbstractModule;
import com.google.inject.Guice;
import com.google.inject.Injector;
import com.google.inject.matcher.Matchers;

@WebListener
public class InitialContextListener implements ServletContextListener {

    @Override
    public void contextDestroyed(ServletContextEvent x_sce) {
    }

    @Override
    public void contextInitialized(ServletContextEvent x_sce) {

        Injector injector = Guice.createInjector(new AbstractModule() {

            @Override
            protected void configure() {
                bind(UserAddServlet.class).to(UserAddServletImpl.class);
                bind(UserService.class).to(UserServiceImpl.class);
                bindInterceptor(Matchers.subclassesOf(AbstractService.class),
                        Matchers.annotatedWith(Transactional.class),
                        new MethodInterceptorImpl());
            }
        });

        ServletContext context = x_sce.getServletContext();
        context.addServlet(UserAddServlet.class.getSimpleName(),
                injector.getInstance(UserAddServlet.class)).addMapping(
                "/" + UserAddServlet.class.getSimpleName());
    }

    static class MethodInterceptorImpl implements MethodInterceptor {

        private static final String URL = "jdbc:postgresql://127.0.0.1:5432/db";

        private static final String USERNAME = "username";

        private static final String PASSWORD = "password";

        private static final Method getter;

        private static final Method setter;

        static {
            try {
                Class.forName("org.postgresql.Driver");
            } catch (ClassNotFoundException e) {
                throw new RuntimeException(e);
            }
            try {
                getter = AbstractService.class
                        .getDeclaredMethod("getConnection");
                if (!getter.isAccessible()) {
                    getter.setAccessible(true);
                }
                setter = AbstractService.class.getDeclaredMethod(
                        "setConnection", Connection.class);
                if (!setter.isAccessible()) {
                    setter.setAccessible(true);
                }
            } catch (NoSuchMethodException e) {
                throw new RuntimeException(e);
            }
        }

        @Override
        public Object invoke(MethodInvocation x_arg0) throws Throwable {
            Object object = x_arg0.getThis();
            if (getter.invoke(object) != null) {
                return x_arg0.proceed();
            }

            Connection connection = DriverManager.getConnection(URL, USERNAME,
                    PASSWORD);
            if (connection.getAutoCommit()) {
                connection.setAutoCommit(false);
            }

            setter.invoke(object, connection);

            Object result = null;
            try {

                result = x_arg0.proceed();
                connection.commit();

            } catch (Throwable e) {
                try {
                    connection.rollback();
                } catch (SQLException ex) {
                    ex.printStackTrace();
                }
                throw e;
            } finally {
                try {
                    connection.close();
                } catch (SQLException e) {
                    e.printStackTrace();
                }
                try {

                    setter.invoke(object, (Connection) null);

                } catch (IllegalAccessException e) {
                    e.printStackTrace();
                } catch (IllegalArgumentException e) {
                    e.printStackTrace();
                } catch (InvocationTargetException e) {
                    e.printStackTrace();
                }
            }
            return result;
        }
    }
}

起動すると、以下の順に実行されます
１．WebListenerアノテーションによってInitialContextListenerをServletContextListenerとして登録
２．contextInitializedが実行される
２-１．GuiceでAbstractServiceのサブクラスのTransactionalアノテーションが付いているメソッドに対してMethodInterceptorImplを設定しておく
２-２．GuiceがUserAddServletのインスタンスを生成する際にUserServiceを実装したクラスのインスタンスを注入
２-３．UserAddServletのインスタンスをServletとして登録

http://[SERVER_NAME]:[PORT_NUMBER]/[CONTEXT_ROOT]/UserAddServlet?name=brigen_name&email=brigen_mail
にRequestを送ると、サーブレットが実行されます。

かなり簡単にServletが書けました。
実際に活用することを考えたらトランザクションの実装はもっと細かくすべきでしょうが。

もちろん、GlassFishなどのJavaEE環境ではServlet3.0 + EJB Lite + JPAの選択が最適でしょう。

Androidアプリを登録しました

昨日、個人で使うために作ったアプリを公開しました。

どんなアプリかというと、最近使用したアプリのショートカットを表示するウィジェットです。

Android端末のユーザの大半は、その機能はHomeボタン長押しで使えるとご認識しているでしょう。
しかしながら、実は、私の使用しているAndroid端末(IS05)では、Home長押しは「起動中のアプリ」を表示します。
さらには、「最近起動したアプリ」を表示する機能が見当たりません(案外、調べればありそうですが・・・)。

と、いうような経緯があり、それならばウィジェットでその機能を提供し、ワンタッチで起動できるアプリとして作成してみました。

つまるところ、ただの俺得アプリに過ぎませんが、興味がありましたら、使ってみてください。
Android Market - 最近アプリ

JavaSE7のtryは便利

7月28日に正式リリースされるJavaSE7では、いくつか便利な構文が増えます。
今回は、その中でも特に有用であろうtryの新しい構文について調べてみました。

ファイルのコピーを例にして、tryの構文の拡張を調べてみます
JavaSE6以前のソースコードをJavaSE7のコードに置き換えます。

これまで(JavaSE6以前)のコード

FileInputStream fis = null;
FileOutputStream fos = null;
try {
 fis = new FileInputStream("D:\\test.txt");
 fos = new FileOutputStream("D:\\test2.txt");
 byte[] bytes = new byte[1024];
 int size = -1;
 while ((size = fis.read(bytes)) != -1) {
  fos.write(bytes, 0, size);
 }
} catch (FileNotFoundException e) {
 e.printStackTrace();
} catch (IOException e) { 
 e.printStackTrace();
} finally {
 if (fos != null) {
  try {
   fos.close();
  } catch (IOException ex) {
  }
 }
 if (fis != null) {
  try {
   fis.close();
  } catch (IOException ex) {
  }
 }
}

これから、上記のソースコードをJavaSE7風に書き換えていきます。

例外のマルチキャッチ

catchの部分をひとつにまとめることができます

FileInputStream fis = null;
FileOutputStream fos = null;
try {
 fis = new FileInputStream("D:\\test.txt");
 fos = new FileOutputStream("D:\\test2.txt");
 byte[] bytes = new byte[1024];
 int size = -1;
 while ((size = fis.read(bytes)) != -1) {
  fos.write(bytes, 0, size);
 }
} catch (FileNotFoundException | IOException e) {
 e.printStackTrace();
} finally {
 if (fos != null) {
  try {
   fos.close();
  } catch (IOException ex) {
  }
 }
 if (fis != null) {
  try {
   fis.close();
  } catch (IOException ex) {
  }
 }
}

これで、例外処理時に同じコードを書かずに済みます。
また、「|」で複数の例外を指定した場合は、左の例外から評価されるようです。
これまでの構文のcatchで上に書いていた例外は、その順で左から書けばよいでしょう。つまり、Throwableを書く場合は、一番右です。

AutoCloseableインターフェース

JavaSE7から、AutoCloseableというインターフェースが追加されます。
このインターフェースには、closeというメソッドがあります（ご存知のとおり、JavaSE6以前にもcloseメソッドはありますが、それをオーバーライドしている感じです）。このメソッドが「try-finallyの処理で勝手に呼ばれる」ようです。 AutoCloseableを利用するためのコードは下記の通りです。

try (FileInputStream fis = new FileInputStream("D:\\test.txt"); FileOutputStream fos = new FileOutputStream("D:\\test2.txt")) {
 byte[] bytes = new byte[1024];
 int size = -1;
 while ((size = fis.read(bytes)) != -1) {
  fos.write(bytes, 0, size);
 }
} catch (FileNotFoundException | IOException e) {
 e.printStackTrace();
}

tryの()の中ではセミコロンで区切ると、複数のAutoCloseableを並べて記述できるようです。
Stream関係のインターフェースはAutoCloseableのサブインターフェースになっているようです。
インターフェースを実装する際に、AutoCloseableを意識する必要はあまりないと思われます。ъ(ﾟДﾟ)ｸﾞｯｼﾞｮﾌﾞ!!（JavaSE6以前のソースを書き換える場合は別）
※public void close() throws IOException => public void close() throws Exception というふうに変わります。

なにはともあれ、コード量がかなり減りました。ﾜｰｲヽ(ﾟ∀ﾟ)ﾒ(ﾟ∀ﾟ)ﾒ(ﾟ∀ﾟ)ﾉﾜｰｲ

AutoCloseableを検証

実際に自分の眼で見て確認しました。
closeの順番と、実際に例外が起こった場合について。

public class Test {
 public static void main(String[] args) {
  new Test().start();
 }

 void start() {
  try (AutoCloseableImpl1 ac1 = new AutoCloseableImpl1(); AutoCloseableImpl2 ac2 = new AutoCloseableImpl2()) {
   
  }
 }
}

class AutoCloseableImpl1 implements AutoCloseable {

 AutoCloseableImpl1() {
  System.out.println(getClass().getSimpleName());
 }

 @Override
 public void close() {
  System.out.println(getClass().getSimpleName() + "#close()");
 }
}

class AutoCloseableImpl2 implements AutoCloseable {

 AutoCloseableImpl2() {
  System.out.println(getClass().getSimpleName());
 }

 @Override
 public void close() {
  System.out.println(getClass().getSimpleName() + "#close()");
 }
}

上記のプログラムを実行します。
実行結果は

AutoCloseableImpl1
AutoCloseableImpl2
AutoCloseableImpl2#close()
AutoCloseableImpl1#close()

closeが呼ばれており、closeする順番もオッケー。
ちなみに、AutoCloseableImpl2()コンストラクタで例外を投げた場合は、以下

AutoCloseableImpl1
AutoCloseableImpl1#close()
Exception in thread "main" java.lang.NullPointerException
・・・

期待通りです。

余談ですが、catchもfinallyもないtry構文が書けるようになりました。（内部的にはfinallyが存在しますが）

実は、JavaSE7にはjava.nio.file.Filesというクラスが追加されており、ファイルをコピーするだけなら、このクラスを使ったほうが良いです。
まぁ、今回はあくまで勉強のためですから・・・

今回の検証でもちいたIDEはNetBeansです。
Eclipse3.7でも検証は可能でしたが、不都合な点がありましたので、NetBeansを使用しました。
現在のEclipse3.7とJDK1.7の詳細については こちら

Eclipse3.7 で JavaSE7

Eclipse3.7 で JavaSE7

JavaSE7の正式リリースは2011年7月28日で、NetBeansは既にJavaSE7に対応しています。
EclipseはまだJavaSE7に対応していないのですが、pluginをインストールすれば使えるようになります。

各ツールのサイト

Java™ Platform, Standard Edition 7 Developer Preview Release
Eclipse Classic 3.7
JDT/Eclipse Java 7 Support(BETA)

JDK準備

JDK7 Preview Releaseをダウンロードして、インストールします。
開発ツールだけインストールすればOKです。

Eclipse準備

Eclipseは3.7の「Classic」を使います。
「IDE for Java Developers」や、「IDE for Java EE Developers」では、pluginのインストールができませんでした。
Install New SoftWare -> Work with:
「http://build.eclipse.org/eclipse/java7patch/」を入力して、pluginをインストールします。

Eclipse設定

Preferences -> Java -> Installed JREs
インストールしたJDK1.7を追加し、使用するようにします。
あとは、Java Compilerの設定で、Compiler compliance level を 1.7 にすれば準備完了です。

実は、上記で設定した開発環境には問題があり、メソッドや変数の候補を出せなくなります。
普段から、何も考えずにとりあえず Ctrl + Space 押して幸せになっている私にとっては致命的です。
Eclipseで正式にサポートされるまではJavaSE7は我慢するか、NetBeansを使いましょう。

アルゴリズムを考える

アルゴリズムというものについて考えてみる

Twitterでこんなツイートを見つけました。

自然数nに対して操作F「nが偶数ならばnを2で割る。nが奇数ならばnを3倍して1を加える。」を10回行う。10回目で初めて1となる自然数を全て求めよ。（０７京都高校生数学コンテスト）

プログラマとしては、さっとプログラムを書いて結果を出してみたくなるのではないでしょうか。

この解を出すアルゴリズムは大きく分けて２通りあります。
その１．1から1024(2^10)までの全ての数についてチェックして探す
その２．結果の「1」から逆に遡って探す

上記その１のアルゴリズムは２重ループによる処理で、その２は再帰による処理になります。
おそらく、この問題で求められている解き方は２の方法でしょう。

書いてみた

import java.util.ArrayList;
import java.util.Collection;


public class Main {

 /*
  * こいつを呼ぶ
  */
 public static void main(String[] x_args) {
  new Main().start();
 }

 public void start() {
  exec(new F10To1ImplVer1());
  System.out.println();
  exec(new F10To1ImplVer2());
 }

 void exec(F10To1 x_f) {
  {
   System.out.println(x_f.getClass().getSimpleName() + ":start.");
   long time_s = System.currentTimeMillis();
   int count = 10;
   int end = (int) Math.pow(2, count);
   Collection＜Integer＞ values = x_f.getF10To1(end, count);
   for (Integer value : values) {
    System.out.print(value + "\t");
   }
   long time_e = System.currentTimeMillis();
   System.out.println();
   System.out.println(":end.");
   System.out.println("time => " + (time_e - time_s) + "ms");
  }
 }
 
}

interface F10To1 {

 /*
  * 戻り値Collection内の要素の順番は保証しない
  */
 Collection＜Integer＞ getF10To1(int x_end, int x_count);
}

/**
 * 全ての自然数についてチェックするパターン
 */
class F10To1ImplVer1 implements F10To1 {

 public Collection＜Integer＞ getF10To1(int x_end, int x_count) {
  Collection＜Integer＞ result = new ArrayList＜Integer＞();
  // 1...最後までのループ
  for (int i = 1 ; i <= x_end ; i++) {
   if (isF10To1(i, x_count)) {
    result.add(Integer.valueOf(i));
   }
  }
  return result;
 }

 private boolean isF10To1(int x_value, int x_count) {
  int tmp = x_value;
  // 9回処理する
  for (int i = 0 ; i < x_count - 1 ; i++) {
   tmp = f(tmp);
   if (tmp == 1) {
    // 1になったら対象外
    return false;
   }
  }
  // 10回目
  tmp = f(tmp);
  return tmp == 1;
 }

 /*
  * 1回分の処理
  */
 private int f(int x_value) {
  if (x_value % 2 == 0) {
   return x_value / 2;
  }
  return x_value * 3 + 1;
 }
}

/**
 * 逆から辿るパターン
 */
class F10To1ImplVer2 implements F10To1 {

 public Collection＜Integer＞ getF10To1(int x_end, int x_count) {
  int tmp = 1;
  // 再帰処理でチェックします
  Collection＜Integer＞ result = new ArrayList＜Integer＞();
  revF(result, tmp, x_count);
  return result;
 }

 private void revF(Collection＜Integer＞ x_values, int x_value, int count) {
  boolean can3 = canRevF_3(x_value);
  int v2 = revF_2(x_value);
  int v3 = revF_3(x_value);
  count--;
  if (count < 1) {
   if (can3) {
    x_values.add(Integer.valueOf(v3));
   }
   x_values.add(Integer.valueOf(v2));
   return;
  }
  if (can3 && (1 < v3)) {
   revF(x_values, v3, count);
  }
  if (v2 != 1) {
   revF(x_values, v2, count);
  }
 }

 /*
  * 引数が2で割った結果だとした場合の元の数を返す
  */
 private int revF_2(int x_value) {
  return x_value * 2;
 }

 /*
  * 引数が3倍して1を足した結果だとした場合に元の数が存在するか判断する
  */
 private boolean canRevF_3(int x_value) {
  if (x_value < 4) {
   return false;
  }
  if ((x_value - 1) % 3 != 0) {
   return false;
  }
  return (x_value - 1) / 3 % 2 == 1;
 }

 /*
  * 引数が3倍して1を足した結果だとした場合の元の数を返す
  */
 private int revF_3(int x_value) {
  return (x_value - 1) / 3;
 }
}

もしかしたら上記の実装に間違いがあるかもしれません。その場合は、ご指摘いただけるとありがたいです。
F10To1ImplVer1が総当り(その１)で、F10To1ImplVer2が再帰処理を行う(その２)クラスです。
10回程度のループではそれほど差が出ません(マシンにもよります)が、20回程に回数を増やすと極端に処理時間に差が出ます。

上記の２通りのアルゴリズムで、私が先に書いたのは総当り(その１)の方です。
その後、少し考えてその２の方法を書きました。

普段から簡単にプログラムを書こうとしているせいか、「本来はどういうアルゴリズムであるべきか」をあまり考えなくなってしまったようです。

私は細かい実装はあまり気にしないのですが、気にせずともより良いアルゴリズムで書けるのが理想的ですね。