SqlSessionFactoryBuilder

SqlSessionFactoryBuilder 는 5 개의 build() 메서드를 가진다. 각각은 서로 다른 소스에서 SqlSession 을 빌드한다.

SqlSessionFactory build(InputStream inputStream)
SqlSessionFactory build(InputStream inputStream, String environment)
SqlSessionFactory build(InputStream inputStream, Properties properties)
SqlSessionFactory build(InputStream inputStream, String env, Properties props)
SqlSessionFactory build(Configuration config)

처음 4 개의 메서드가 가장 공통적이다. XML 문서를 나타내는 Reader 인스턴스를 가진다. SqlMapConfig.xml 파일은 위에서 다루었다. 선택적으로 사용가능한 프로퍼티는 environment 와 properties 이다. environment 는 데이터소스와 트랜잭션 관리자를 포함하여 로드할 환경을 판단한다. 예를 들면:

<environments default="development">
  <environment id="development">
    <transactionManager type="JDBC">
        ...
    <dataSource type="POOLED">
        ...
  </environment>
  <environment id="production">
    <transactionManager type="MANAGED">
        ...
    <dataSource type="JNDI">
        ...
  </environment>
</environments>

environment 파라미터를 가진 메서드를 호출한다면, MyBatis 는 사용할 환경을 위한 설정을 사용할 것이다. 물론 잘못된 환경설정을 사용하면, 에러를 보게 될 것이다. environment 파라미터를 가지지 않는 메서드 중 하나를 호출한다면, 디폴트 환경(위 예제에서 default=“development”)이 사용될 것이다.

properties 인스턴스를 가진 메서드를 호출하면, MyBatis 는 프로퍼티들을 로드해서 설정에서 사용가능한 부분을 사용할 것이다. 프로퍼티들은 ${propName} 와 같은 문법을 사용해서 설정의 값으로 대체될 수 있다.

프로퍼티들은 SqlMapConfig.xml 파일에서 사용되거나 직접 명시할 수 있다. 그러므로 프로퍼티들의 우선순위를 이해하는 것이 중요하다. 우리는 앞서 언급하긴 했지만, 쉽게 이해할 수 있도록 다시 보여주도록 하겠다.

프로퍼티가 한개 이상 존재한다면, MyBatis 는 일정한 순서로 로드한다.:

• properties 요소에 명시된 속성을 가장 먼저 읽는다.
• properties 요소의 클래스패스 자원이나 url 속성으로 부터 로드된 속성을 두번재로 읽는다. 그래서 이미 읽은 값이 있다면 덮어쓴다.,
• 마지막으로 메서드 파라미터로 전달된 속성을 읽는다. 앞서 로드된 값을 덮어쓴다

그래서 가장 우선순위가 높은 속성은 메서드의 파라미터로 전달된 값이고 그 다음은 자원및 url 속성이고 마지막은 properties 요소에 명시된 값이다.

요약해보면, 처음 4 개의 메서드는 사실 같지만, environment 그리고/또는 properties 에 명시한 값을 오버라이드한다. mybatis-config.xml 파일에서 SqlSessionFactory 를 빌드하는 예제이다.

String resource = "org/mybatis/builder/mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
SqlSessionFactory factory = builder.build(inputStream);

Resources 유틸리티 클래스를 사용하고 있는 것을 주의깊게 보면 된다. 이 클래스는 org.apache.ibatis.io 패키지에 있다. Resources 클래스는 그 이름이 나타내는 것처럼, 클래스패스나 파일 시스템 또는 웹 URL 에서 자원으로 로드하도록 해준다. IDE 를 통해 클래스의 소스 코드를 보는 것으로 유용한 메서드를 보게 될 것이다. 그 유용한 메서드 목록들이다.

URL getResourceURL(String resource)
URL getResourceURL(ClassLoader loader, String resource)
InputStream getResourceAsStream(String resource)
InputStream getResourceAsStream(ClassLoader loader, String resource)
Properties getResourceAsProperties(String resource)
Properties getResourceAsProperties(ClassLoader loader, String resource)
Reader getResourceAsReader(String resource)
Reader getResourceAsReader(ClassLoader loader, String resource)
File getResourceAsFile(String resource)
File getResourceAsFile(ClassLoader loader, String resource)
InputStream getUrlAsStream(String urlString)
Reader getUrlAsReader(String urlString)
Properties getUrlAsProperties(String urlString)
Class classForName(String className)

마지막 build 메서드는 Configuration 의 인스턴스를 가진다. Configuration 클래스는 SqlSessionFactory 인스턴스에 대해 알 필요가 있는 모든 것으로 가지고 있다. Configuration 클래스는 SQL Map 을 찾거나 관리하는 것을 포함하여 설정을 살펴보기 위해 유용하다. Configuration 클래스는 앞서 봤던 모든 설정을 처리할 수 있으며, 자바 API 로 나타낼 수 있다. SqlSessionFactory 를 생성하기 위해 Configuration 인스턴스를 build() 메서드에 전달하는 예제이다.

DataSource dataSource = BaseDataTest.createBlogDataSource();
TransactionFactory transactionFactory = new JdbcTransactionFactory();

Environment environment = new Environment("development", transactionFactory, dataSource);

Configuration configuration = new Configuration(environment);
configuration.setLazyLoadingEnabled(true);
configuration.setEnhancementEnabled(true);
configuration.getTypeAliasRegistry().registerAlias(Blog.class);
configuration.getTypeAliasRegistry().registerAlias(Post.class);
configuration.getTypeAliasRegistry().registerAlias(Author.class);
configuration.addMapper(BoundBlogMapper.class);
configuration.addMapper(BoundAuthorMapper.class);

SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
SqlSessionFactory factory = builder.build(configuration);

이제 SqlSessionFactory 를 만들었다. SqlSession 인스턴스를 만들기 위해 사용해보자.

SqlSessionFactory

SqlSessionFactory 는 SqlSession 인스턴스를 생성하기 위해 사용할 수 있는 6 개의 메서드를 가지고 있다. 6 개의 메서드가 선택해서 사용하는 것들을 보자.

• Transaction: 세션에서 트랜잭션 스코프 또는 자동 커밋을 사용하고 싶은가?
• Connection: 설정된 DataSource 에서 Connection 을 회득하고 싶은가?
• Execution: PreparedStatements 그리고/또는 배치(insert, delete 를 포함해서) 업데이트를 재사용하고 싶은가?

오버로드된 메서드인 penSession() 이 3 가지를 적절히 혼합해서 사용할 수 있다.

SqlSession openSession()
SqlSession openSession(boolean autoCommit)
SqlSession openSession(Connection connection)
SqlSession openSession(TransactionIsolationLevel level)
SqlSession openSession(ExecutorType execType,TransactionIsolationLevel level)
SqlSession openSession(ExecutorType execType)
SqlSession openSession(ExecutorType execType, boolean autoCommit)
SqlSession openSession(ExecutorType execType, Connection connection)
Configuration getConfiguration();

파라미터를 가지지 않는 디폴트 openSession() 메서드는 다음과 같은 성격을 가진 SqlSession 을 만들것이다.

• 트랜잭션 스코프는 시작될 것이다.
• Connection 객체는 활성화된 환경에 의해 설정된 DataSource 인스턴스를 획득할 것이다.
• 트랜잭션 격리 레벨은 드라이버나 데이터소스가 디폴트로 제공하는 옵션을 사용할 것이다.
• PreparedStatements 는 재사용되지 않을 것이다. 그리고 update 또한 배치처리되지 않을 것이다.

메서드 대부분은 그 이름과 파라미터가 그 역할을 충분히 설명한다. 자동커밋을 활성화하기 위해서, autoCommit 파라미터에 “true” 값을 셋팅하라. 자체적인 커넥션을 제공하기 위해서는, connection 파라미터에 Connection 인스턴스를 셋팅하라.

Connection 과 autoCommit 둘다 셋팅하는 것을 오버라이드하지 않는다. 왜냐하면 MyBatis 는 제공된 connection 객체를 셋팅할때마다 현재 사용중인 것을 사용한다. MyBatis 는 TransactionIsolationLevel 라고 불리는 트랜잭션 격리 레벨을 위한 자바 enum 래퍼를 사용한다. JDBC 를 5 가지를 지원한다(NONE, READ_UNCOMMITTED, READ_COMMITTED, REPEATABLE_READ, SERIALIZABLE).

새롭게 보일수 있는 하나의 파라미터는 ExecutorType 이다. enum 으로는 3 개의 값을 정의한다.

• ExecutorType.SIMPLE: 이 타입의 실행자는 아무것도 하지 않는다. 구문 실행마다 새로운 PreparedStatement 를 생성한다.
• ExecutorType.REUSE: 이 타입의 실행자는 PreparedStatements 를 재사용할 것이다.
• ExecutorType.BATCH: 이 실행자는 모든 update 구문을 배치처리하고 중간에 select 가 실행될 경우 필요하다면 경계를 표시한다. 이러한 과정은 행위를 좀더 이해하기 쉽게 하기 위함이다.

참고 SqlSessionFactory 에서 언급하지 않는 한개 이상의 메서드가 있다. getConfiguration() 메서드인데, 이 메서드는런타임시 MyBatis 설정을 조사하는 Configuration 인스턴스를 리턴할것이다.

참고 MyBatis 이전저번을 사용했다면, 세션, 트랜잭션 그리고 배치들을 여기저기서 찾게 될 것이다. 이것들은 더이상 사용되지 않는다. 세가지 모두 세션의 범위에 모두 포함되었다. 이것들이 제공하던 모든 기능을 사용하기 위해 각각이 필요한 것 아니다.

SqlSession

앞서 언급한 것처럼, SqlSession 인스턴스는 MyBatis 에서 굉장히 강력한 클래스이다. 구문을 실행하고, 트랜잭션을 커밋하거나 롤백하는 그리고 mapper 인스턴스를 습득하기 위해 필요한 모든 메서드를 찾을 수 있을 것이다.

SqlSession 에는 20 개 이상의 메서드가 있다. 좀더 적절히 모아서 보도록 하자.

<T> T selectOne(String statement, Object parameter)
<E> List<E> selectList(String statement, Object parameter)
<K,V> Map<K,V> selectMap(String statement, Object parameter, String mapKey)
int insert(String statement, Object parameter)
int update(String statement, Object parameter)
int delete(String statement, Object parameter)

<T> T selectOne(String statement)
<E> List<E> selectList(String statement)
<K,V> Map<K,V> selectMap(String statement, String mapKey)
int insert(String statement)
int update(String statement)
int delete(String statement)

<E> List<E> selectList (String statement, Object parameter, RowBounds rowBounds)
<K,V> Map<K,V> selectMap(String statement, Object parameter, String mapKey, RowBounds rowbounds)
void select (String statement, Object parameter, ResultHandler<T> handler)
void select (String statement, Object parameter, RowBounds rowBounds, ResultHandler<T> handler)

int offset = 100;
int limit = 25;
RowBounds rowBounds = new RowBounds(offset, limit);

package org.apache.ibatis.session;
public interface ResultHandler<T> {
  void handleResult(ResultContext<? extends T> context);
}

void commit()
void commit(boolean force)
void rollback()
void rollback(boolean force)

void clearCache()

void close()

SqlSession session = sqlSessionFactory.openSession();
try {
    // following 3 lines pseudocod for "doing some work"
    session.insert(...);
    session.update(...);
    session.delete(...);
    session.commit();
} finally {
    session.close();
}

try (SqlSession session = sqlSessionFactory.openSession()) {
    // following 3 lines pseudocode for "doing some work"
    session.insert(...);
    session.update(...);
    session.delete(...);
    session.commit();
}

Configuration getConfiguration()

<T> T getMapper(Class<T> type)

public interface AuthorMapper {
  // (Author) selectOne("selectAuthor",5);
  Author selectAuthor(int id); 
  // (List<Author>) selectList(“selectAuthors”)
  List<Author> selectAuthors();
  
  // (Map<Integer,Author>) selectMap("selectAuthors", "id")
  @MapKey("id")
  List<Author> selectAuthorsAsMap();
  // insert("insertAuthor", author)
  int insertAuthor(Author author);
  // updateAuthor("updateAuthor", author)
  int updateAuthor(Author author);
  // delete("deleteAuthor",5)
  int deleteAuthor(int id);
}

@Insert("insert into table3 (id, name) values(#{nameId}, #{name})")
@SelectKey(statement="call next value for TestSequence", keyProperty="nameId", before=true, resultType=int.class)
int insertTable3(Name name);

@Insert("insert into table2 (name) values(#{name})")
@SelectKey(statement="call identity()", keyProperty="nameId", before=false, resultType=int.class)
int insertTable2(Name name);