iBATIS

출처: http://beans.tistory.com/37

 

가장 간단히 설명하면, JAVA에서 DB관련 작업을 편하게 해주는 프레임웍정도라고 할까?

iBATIS in action에서 iBATIS는 "SQL 실행 결과를 자바빈즈 혹은 Map 객체에 매핑해주는 퍼시스턴스 솔루션으로 SQL을 소스 코드가 아닌 XML로 따로 분리해 관리하여 지겨운 SQL 문자열 더하기에서 해방시켜 줍니다. 또한 XML에서 동적 SQL 요소를 사용하여 쿼리 문장을 프로그래밍 코딩 없이 자유롭게 변환할 수 있게 해줍니다. 이러한 접근방식으로 인해 iBATIS를 사용하면 JDBC를 사용할 때보다 약 60% 정도의 코드만으로 프로그램 작성이 가능하다" 라고 한다.

말로만 하면 뭔소리인지 모르겠으니 간단한 예제 정도를 들어보자.

 

- 일반적인 JDBC 예제

import! javax.naming.*;
import! javax.sql.*;
import! java.sql.*;

public class Employee {
  public Account getAccount(int id) throws SQLException, NamingException{
    Account account = null;
    
    String sql = "select * from employee where id= ?";
    
    Connection conn      = null;
    PreparedStatement ps = null;
    ResultSet rs       = null;
    
    try {      
      Context ctx = new InitialContext();
      DataSource ds =
              (DataSource)ctx.lookup(
                 "java:comp/env/jdbc/TestDB"); 
      conn = ds.getConnection();
      ps = conn.prepareStatement(sql);
      ps.setInt(1, id);
      rs = ps.executeQuery();
      
      while( rs.next()){
        account = new Account();
        account.setId(rs.getInt("ID"));        
      }
    } finally {
      try {
        if ( rs != null ) rs.close();
      } finally {
        try {
          if (ps != null) ps.close();
        } finally {
          if (conn != null) ps.close();
        }
      } 
    } 
    return account;  
  }
}   

뭐다들 아시겠지만 간단히 쿼리를 날려서 Acount 객체에 담아가지고 오는 소스이다. 대충봐도 무척이나 길다,

이걸 iBATIS를 이용해서 처리하는 예를 보자, 

- iBATIS 를 이용한 예

acount.xml
<select id="getAcount" resultClass="Acount" parameterClass="java.lang.Integer">
    select * from employee where id= #id#
</select>

java
Acount act = (Acount) sqlMap.queryForObject("getAcount",new Integer(5));

 

보면 알겠지만 상단에 쿼리를 닮고있는 xml과 아래 간단히 크 쿼리를 실행시키는 java 한줄정도?이다.

사실 iBATIS를 설정하는 config파일과 sqlMap객체를 불러오는 부분이 있긴하지만, 무척이나 좋아보이도록,
이것만 쓰겠다. -_-;;

iBATIS 의 목표와 특징은 몇마디로 짧게정의하다면,

쉽고, 간단하고, 의존성이 적은 프레임웍이라는 것이다. 
sql문과 java코드와의 분리만으로도 java개발자는 쿼리문을 신경쓰지 않아도 된다. sql문이 변경되더라도,

파라미터 값만 변경되지 않는다면, java소스에서는 수정할 부분이 없다.

 

 

[ ibatis 설치 & 이클립스를 이용한 DB연동 ]

 

1. 우선 iBATIS 를 다운받습니다.

http://ibatis.apache.org/javadownloads.html  현재링크입니다.

2. 다운을 풀고, /lib 폴더에 ibatis-2.3.4.726 를 톰캣의 lib폴더나

   프로젝트의 web-inf/lib 폴더에 넣습니다.

- /현제프로젝트/WebContent/WEB-INF/lib/
- /톰캣/lib/   (톰캣6버전)

두 폴더중 편한곳에다가 jar파일을 저장합니다.

3. example 폴더를 타고 들어가보면 sqlMapConfi.xml 파일이 있습니다. 이파일을 복사해서

   붙여넣기 하셔도 되고, src폴더에서 새로 xml 파일을 만드셔도 됩니다.

sqlMapClient.xml

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE sqlMapConfig      

    PUBLIC "-//ibatis.apache.org//DTD SQL Map Config 2.0//EN"      

    "http://ibatis.apache.org/dtd/sql-map-config-2.dtd">

<sqlMapConfig>

  <!-- Configure a built-in transaction manager.  If you're using an 

       app server, you probably want to use its transaction manager 

       and a managed datasource -->

  <transactionManager type="JDBC" commitRequired="false">

    <dataSource type="SIMPLE">

      <property name="JDBC.Driver" value="org.hsqldb.jdbcDriver"/>

      <property name="JDBC.ConnectionURL" value="jdbc:oracle:thin:@192.168.10.103:1521:db"/>

      <property name="JDBC.Username" value="ahm"/>

      <property name="JDBC.Password" value="ahm"/>

    </dataSource>

  </transactionManager>

  <!-- List the SQL Map XML files. They can be loaded from the 

       classpath, as they are here (com.domain.data...) -->

  <sqlMap resource="db/Account.xml"/>

  <!-- List more here...

  <sqlMap resource="com/mydomain/data/Order.xml"/>

  <sqlMap resource="com/mydomain/data/Documents.xml"/>

  -->

</sqlMapConfig>

빨간부분으로 표시된부분이 제가 수정한 부분입니다. db정보는 propertie로 빼서 관리하는방법도 있으나, 

우선은 이렇게 하도록 하겠습니다. 

 

4. 자바빈즈를 생성합니다. 

db라는 패키지를 만들고 그 밑에 Acount.java 파일을 생성합니다. 결과를 담아올 빈즈입니다. 

Account.java

package db;

public class Account {
  private int id;

  public int getId() {
    return id;
  }

  public void setId(int id) {
    this.id = id;
  }
}

 

5. XML을 생성합니다.

우리가 사용할 쿼리를 작성하는 XML입니다.

Account.xml

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE sqlMap      

    PUBLIC "-//ibatis.apache.org//DTD SQL Map 2.0//EN"      

    "http://ibatis.apache.org/dtd/sql-map-2.dtd">

<sqlMap namespace="Account">

  <!-- Select with no parameters using the result map for Account class. -->

  <select id="getAcount" resultClass="db.Acount"> 

 다음값을 이용하여 쿼리와 맵핑합니다.

    select id from ACCOUNT where name=#value#

  </select>

</sqlMap>

 

6. 이제 쿼리를 실행할 JAVA를 작성한다.

SimpleExample.java

package db;

import! com.ibatis.sqlmap.client.SqlMapClient;
import! com.ibatis.sqlmap.client.SqlMapClientBuilder;
import! com.ibatis.common.resources.Resources;

import! java.io.Reader;
import! java.io.IOException;
import! java.sql.SQLException;

public class SimpleExample {

  private static SqlMapClient sqlMapper;

  static {
    try {
      Reader reader = Resources.getResourceAsReader("SqlMapConfig.xml");
      sqlMapper = SqlMapClientBuilder.buildSqlMapClient(reader);
      reader.close(); 
    } catch (IOException e) {
      // Fail fast.
      throw new RuntimeException("Something bad happened while building the SqlMapClient instance." + e, e);
    }
  }

  public static Account getAcount() throws SQLException {
    return (Account)sqlMapper.queryForObject("getAcount","ahm");
    // 이부분에서 쿼리를 실행한다. queryForObject는 한개의 데이터를 가져올? 사용하는 메소드이다.
  }
  
  public static void main(String[] args){
    
    try {
    Account temp = getAcount();    
    System.out.println(temp.getId());
  } catch (SQLException e) {
    // TODO Auto-generated catch block
    e.printStackTrace();
  }
  }
}

물론 이 java파일을 실행하기 전에는 DB에 TABLE과 데이터가 준비되어있어야겠다.

 

 

[ JNDI 설정 ] 

sqlMapClient.xml 설정파일에서

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE sqlMapConfig     
    PUBLIC "-//ibatis.apache.org//DTD SQL Map Config 2.0//EN"     
    "http://ibatis.apache.org/dtd/sql-map-config-2.dtd">

<sqlMapConfig>
 
 <settings
  cacheModelsEnabled="true"
  enhancementEnabled="true"
  lazyLoadingEnabled="true"
  maxRequests="50"
  maxSessions="25"
  maxTransactions="10"
  useStatementNamespaces="false"
 />

 <!--Type aliases allow you to use a shorter name for long fully qualified class names. -->

 <typeAlias alias="order" type="testdomain.Order"/>

  <!-- Configure a built-in transaction manager.  If you're using an
       app server, you probably want to use its transaction manager
       and a managed datasource -->
  <transactionManager type="JDBC" commitRequired="false">
     <dataSource type="JNDI">
         <property name="DataSource" value="java:/comp/env/jdbc/DB"/>
     </dataSource>
  </transactionManager>
 
  <!--sqlMap resource="C:\LuckyData\Project\Java1.5\data\ibatis\Member.xml"/-->
  <sqlMap resource="board/board.xml"/>
  <sqlMap resource="login/login.xml"/> 
  <sqlMap resource="db/dbChange.xml"/>
  <sqlMap resource="statics/static.xml"/>
 
  <!-- List more here...
  <sqlMap resource="com/mydomain/data/Order.xml"/>
  <sqlMap resource="com/mydomain/data/Documents.xml"/>
  -->

</sqlMapConfig>

빨간색 부분처럼 바꿔준다. JNDI 물론 톰캣 SERVER.XML에 설정이 되있어야 겠다.

SERVER.XML

<Context docBase="" path="" reloadable="true">
        <Resource name="jdbc/IMARC" auth="Container" type="javax.sql.DataSource"                
        driverClassName="oracle.jdbc.driver.OracleDriver" 
                             url="jdbc:oracle:thin:@XXX.XXX.XXX.X:XXX:XXXX" 
                  username="XXXX" password="XXXX maxActive="20" maxIdle="10" maxWait="10000" />
</Context>

각자 설정에 알맞게 바꿔야겠죠? ^^