프레임워크설계및구축 ibatis.net DataMapper Framework 자바개발자들과달리닷넷개발자들에게애플리케이션프레임워크라는단어는그리익숙한단어가아니다. 그만큼애플리케이션프레임워크가가져다주는편리함과각프레임워크들이내재하고있는디자인패턴, 아키텍처등에대한토론과논쟁이활발

프레임워크설계및구축 ibatis.net DataMapper Framework 자바개발자들과달리닷넷개발자들에게애플리케이션프레임워크라는단어는그리익숙한단어가아니다. 그만큼애플리케이션프레임워크가가져다주는편리함과각프레임워크들이내재하고있는디자인패턴, 아키텍처등에대한토론과논쟁이활발하지못했으며이는곧닷넷기반애플리케이션에대한불신과선입견을불러오기도했다. 그러나최근국내? 외를막론하고닷넷환경에서도애플리케이션프레임워크도입과관련, 활발한의견이개진되고있으며, 특히오픈소스애플리케이션프레임워크를실제애플리케이션에적용한사례도하나둘씩늘어나고있다. 이번연재는애플리케이션프레임워크중오픈소스기반의 Spring.NET과데이터베이스접근기술인 ibatis.net에대한이야기중, 두번째이야기다. 스텝 4 바이스텝 연재순서 1 회 2009. 1 애플리케이션과프레임워크동시개발 2 회 2009. 2 프레임워크엔지니어링 1 3 회 2009. 3 프레임워크엔지니어링 2 4 회 2009. 4 Spring.NET 애플리케이션프레임워크 5 회 2009. 5 ibatis.net DataMapper Framework 연재가이드운영체제 윈도우 2K/XP 사용도구 VS2005, Spring.NET 1.2.0 기초지식 C# 응용분야 엔터프라이즈프로그래밍 권효중 fog_rain@naver.com, http:// funnygangstar.tistory.com ( 주 ) 중외정보기술솔루션개발팀. 닷넷환경에서도어플리케이션프레임워크, 오픈소스가널리사용되길바라는평범한개발자이다. ibatis.net은닷넷기반애플리케이션개발시데이터베이스를액세스하기위한기술중의하나이며, ibatis 프레임워크는자바환경에서먼저개발되어현재까지널리사용되고있다. ibatis.net은이의닷넷버전이다. 흔히들 ibatis 프레임워크를 ORM 프레임웍의범주에넣어다른 ORM 프레임워크들과비교를하곤하는데필자의생각은물론, ibatis 개발팀또한 ibatis 프레임워크를 ORM으로보기엔적합하지않다고한다. 그리하여이름붙여진것이 Data Mapper Framework이다. 보통의 ORM 프레임워크들이데이터베이스테이블과대응되는객체를맵핑해서직접쿼리를작성하지않아도되게끔하는데반해서 ibatis 프레임워크는개발자가손수쿼리를작성해야한다. 그렇다면, ibatis 프레임워크가제공해주는역할은무엇일까? 결론부터말하면, ibatis 프레임워크는쿼리결과와객체를맵핑해준다. 그럼이제부터 ibatis.net이제공해주는각종기능들과사용법에대해서알아보도록하자. 은아래와같다. - Visual Studio 2008 ASP.NET MVC 1.0 - MS-SQL 2005 (Northwind Database) - ibatis.net DataMapper 1.6.1 ibatis.net은별도의설치과정없이프로젝트에서관련 DLL 파일을참조하기만하면된다. ibatis.net을사용한간단한예제작성이런저런설명보다간단한예제를보게되면 ibatis.net이무엇인지에대해서쉽게감이올것이다. 예제에서사용할환경 < 화면 1> 프로젝트를생성한후 IBatisNet.Common.dll과 IBatisNet.DataMapper.dll을참조한다. 262 m a s o

ibatis.net DataMapper Framework 먼저 ASP.NET MVC 프로젝트를새로생성한후 IBatis Net.Common.dll과 IBatisNet.DataMapper.dll 파일을참조하도록하자. 이는 < 화면 1> 과같이제시된다. 다음엔 providers.config 파일을참조해야하는데이파일은 ibatis.net을사용해서접속할데이터베이스의드라이버를설정해주는역할을한다. 다운받은 ibatis.net 폴더에보면이미 providers.config 파일이있으므로이를프로젝트에추가하고우리가사용할 MS-SQL 서버에대한사용여부를 enabled= true 로변경해주는것만하면된다. providers.config 파일은웹프로젝트의 root에위치시켜놓도록하자. < 리스트 1> providers.config <provider name="sqlserver2.0" enabled="true" description="microsoft SQL Server, provider V2.0.0.0 in framework.net V2.0" assemblyname="system.data,version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" connectionclass="system.data.sqlclient.sqlconnection" commandclass="system.data.sqlclient.sqlcommand" parameterclass="system.data.sqlclient.sqlparameter" parameterdbtypeclass="system.data.sqldbtype" parameterdbtypeproperty="sqldbtype" dataadapterclass="system.data.sqlclient.sqldataadapter" commandbuilderclass=" System.Data.SqlClient. SqlCommandBuilder" usepositionalparameters = "false" useparameterprefixinsql = "true" useparameterprefixinparameter = "true" parameterprefix="@" allowmars="false" /> 다음은접속할데이터베이스의커넥션정보를설정할 Sql Map.config 파일을추가하도록한다. 이파일역시다운받은폴더에보면샘플파일이있으므로이를활용하도록하고우리는 < 리스트 2> 에서처럼 providers.config의위치와데이터베이스접속정보만본인의환경에맞게변경한다. < 리스트 2> SqlMap.config <?xml version="1.0" encoding="utf-8"?> <sqlmapconfig xmlns="http://ibatis.apache.org/datamapper" xmlns:xsi="http://www.w3.org/2001/xmlschema-instance"> <settings> <setting usestatementnamespaces="false"/> </settings> <!-- DB 접속정보기재 --> <!-- provider 엘리먼트의 name 요소에는 providers.config 에서사용하기로한 DB provider 의이름을기재한다. --> <database> <provider name="sqlserver2.0"/> <datasource name="northwind" connectionstring="data Source=(local);Initial Catalog=Northwind;Integrated Security=True"/> </database> <!-- SQL 쿼리를기재할파일을지정한다 --> <sqlmaps> <sqlmap resource="./models/customers.xml"/> </sqlmaps> </sqlmapconfig> 이제간단한쿼리를작성하고쿼리결과와맵핑될클래스파일을작성하도록하자. ibatis.net은데이터베이스쿼리를 XML 파일에작성해야한다. 이방법은코드에쿼리를작성할때보다몇가지장점이있는데, 시스템운영중에도중단없이쿼리를변경할수있다는것과클래스파일에서문자열변수에쿼리를저장할때보다가독력이좋아진다는것, 쿼리문의재사용성이좋아진다는점, 검색조건의다이내믹한추가제거가가능하다는점등이그것이다. 이에대한자세한내용은후반부에자세히알아보도록하겠다. < 리스트 2> 의 SqlMap.config파일하단에지정한것처럼 Models 폴더하위에 Customers.xml 파일을프로젝트에추가하고 < 리스트 3> 과같이구성한다. < 리스트 3> Customers.xml <?xml version="1.0" encoding="utf-8"?> <sqlmap namespace="ibatissample" xmlns= "http://ibatis.apache.org/mapping" xmlns:xsi= "http://www.w3.org/2001/xmlschema-instance" > <!-- 쿼리결과를리턴할객체의이름을지정 --> <alias> <typealias alias="customers" type= "ibatissample.models.customers" /> </alias> <!-- 쿼리를작성한다 --> <!-- 쿼리결과를 Customers 객체에바인딩한다 --> <statements> <select id="selectcustomers" resultclass="customers" > select top 5 * from customers </select> </statements> </sqlmap> m a s o 263

스텝바이스텝 4 < 리스트 3> 과같은파일을 ibatis.net에서는맵핑파일이라고부르며, 이파일들에필요한각종쿼리를기재하게된다. ibatis.net 기반으로개발할경우사실상가장자주사용할파일이되겠다. 다음으로는 < 리스트 4> 와같이쿼리결과를반환할엔티티클래스를작성한다. < 리스트 4> Customers.cs // Models 폴더하위에생성한다. namespace ibatissample.models public class Customers public string CustomerID get; set; public string CompanyName get; set; public string ContactName get; set; public string ContactTitle get; set; 이제 ibatis.net과관련된부분은모두작성했다. 이제는 XML 파일에작성한쿼리를호출하고 View페이지에바인딩하는기능만삽입하면된다. 이후 < 리스트 5> 와같이 HomeCon troller 컨트롤러클래스의액션메소드에서쿼리를호출한다. < 리스트 5> HomeController.cs namespace ibatissample.controllers [HandleError] public class HomeController : Controller public ActionResult Index() // XML 파일상의쿼리를호출하기위해 ibatis.net은 Mapper 클래스를제공한다. // 쿼리결과는 Customers 타입의 IList 형태로반환된다. ViewData.Model = Mapper.Instance().QueryForList<Customers>("SelectCustomers", null); return View(); public ActionResult About() return View(); 컨트롤러클래스의 Index() 액션메소드에서반환한 View Data를 Index.aspx에바인딩한다. Type화된 View를쉽게만드는방법은 Index() 액션메소드에서마우스오른쪽버튼을클릭 하면제공하는자동View 추가기능을통해손쉽게 View화면을구현할수있다. < 리스트 6> Index.aspx <%@ Page Title="" Language="C#" MasterPageFile= "~/Views/Shared/Site.Master" Inherits= "System.Web.Mvc.ViewPage<IEnumerable<iBatisSample.Models.Cu stomers>>" %> <asp:content ID="Content1" ContentPlaceHolderID= "TitleContent" runat="server"> Index </asp:content> <asp:content ID="Content2" ContentPlaceHolderID= "MainContent" runat="server"> <h2>index</h2> <table> <tr> <th></th> <th>customerid</th> <th>companyname</th> <th>contactname</th> <th>contacttitle</th> </tr> <% foreach (var item in Model) %> <tr> <%= Html.ActionLink("Edit", "Edit", new /* id=item.primarykey */ ) %> <%= Html.ActionLink("Details", "Details", new /* id=item.primarykey */ )%> <%= Html.Encode(item.CustomerID) %> <%= Html.Encode(item.CompanyName) %> <%= Html.Encode(item.ContactName) %> <%= Html.Encode(item.ContactTitle) %> </tr> <% %> </table> <p> <%= Html.ActionLink("Create New", "Create") %> </p> </asp:content> 264 m a s o

ibatis.net DataMapper Framework xmlns:xsi="http://www.w3.org/2001/xmlschema-instance" > 여기까지문제없이작성하고프로젝트를실행하게되면 < 화면 2> 와같이 Customers 테이블의데이터가바인딩되었을것이다. 간단한예제를통해서 ibatis.net을어떻게사용하는지대략이해가되었으리라고본다. 예제를통해본 ibatis.net의기능을간략히요약해보면다음과같다. - 데이터베이스쿼리는클래스파일이아닌 XML 파일에작성하게되며, - 데이터베이스가변경되더라도쿼리를호출하는메소드는변경할필요가없으며, - 쿼리결과를객체에자동맵핑시켜준다. 살펴본바와같이 ibatis.net은기존에우리가사용하던데이터액세스프레임워크들, Enterprise Library, Helper (SqlHelper, OracleHelper 등 ) 이나 ORM (NHibernate, Linq, Entity Framework 등 ) 프레임워크의중간정도에있는프레임워크라고할수있다. 맵핑파일작성하기 ibatis.net을사용하면서가장많이사용되는파일은아무래도쿼리를작성하는 XML 파일일것이다. 그러면이파일을작성하는방법및몇가지편리한기능들에대해서보도록하자. 먼저맵핑파일의구성은크게아래와같이구성된다. - Entity 클래스들에대한별칭선언 - result map 클래스선언 ( 필요할경우 ) - parameter map 클래스선언 ( 필요할경우 ) - 쿼리문작성 < 화면 2> 실행결과화면 < 리스트 7> 은전형적인맵핑파일의모습을보여주고있다. < 리스트 7> SQL 맵핑파일 <?xml version="1.0" encoding="utf-8"?> <sqlmap namespace="ibatissample" xmlns="http://ibatis.apache.org/mapping" // 쿼리결과를반환할엔티티객체의별칭을선언한다. <alias> <typealias alias="customers" type= "ibatissample.models.customers" /> </alias> // 필요할경우엔티티객체의각프로퍼티와테이블의컬럼을맵핑한다. <resultmaps> <resultmap id="customersresultmap" class="customers"> <result column="customerid" property="customerid"/> <result column="companyname" property="companyname /> <result column="contactname" property="contactname"/> <result column="contacttitle" property= "ContactTitle"/> </resultmap> </resultmaps> // 필요할경우쿼리의파라미터로사용될객체와테이블의컬럼명을맵핑한다. <parametermaps> <parametermap id="customersparametermap" class= "customers"> <parameter column="customerid" property= "CustomerID"/> <parameter column="companyname" property= "CompanyName"/> <parameter column="contactname" property= "ContactName"/> <parameter column="contacttitle" property= "ContactTitle"/> </parametermap> </parametermaps> // <statements> 엘리먼트내부에쿼리문을기재한다. <statements> <select id="selectcustomers" resultmap= "customersresultmap" > select top 5 * from customers </select> <insert id="insertcustomers" parametermap= "customersparametermap" > insert into customers(customerid, CompanyName, ContactName, ContactTitle) values (#CustomerID#, #CompanyName#, #ContactName#, #ContactTitle#) </insert> <update id="updatecustomers" parametermap= "customersparametermap"> update customers set CompanyName=#CompanyName#, ContactName=#ContactName#, ContactTitle=#ContactTitle# where CustomerID = #CustomerID# </update> <delete id="deletecustomers" parametermap= "customersparametermap"> delete from customers where CustomerID = #CustomerID# m a s o 265

스텝바이스텝 4 </delete> </statements> </sqlmap> <resultmaps> 이나 <parametermaps> 같은경우는데이터베이스테이블의컬럼이름이 C# 의명명관례와다를경우에유용하다. 예를들면, 컬럼이름을 CUSTOMER_ID 라고정한경우에이이름을 C# 의클래스에서도프로퍼티이름으로그대로쓰는것은바람직하지않다. 이런경우에 <result column= CUS TOMER_ID property= CustomerID /> 와같이맵핑시켜주면각각의시스템에충실한명명규칙을사용할수있을것이다. SQL 맵핑파일은주로테이블당 1개씩작성하거나, 비즈니스로직별로구분지어사용할수있다. 어떤것이더바람직한지는애플리케이션마다다를수있겠지만, 쿼리의재활용관점에서는테이블별로작성하는것을권장하고싶다. 쿼리를호출하기위해서인자값을넘겨야할경우에는 # 표시를사용해서프로퍼티이름의앞뒤를감싸주면되며, 인자값의형태는객체형참조형태나기본형모두가능하다. 또한 < 리스트 8> 처럼 HashTable 과같은키-값형태의컬렉션형태도가능하다. < 리스트 8> HashTable 형태로인자값을넘기는경우 <insert id="insertcustomers" parameterclass= "System.Collections.Hashtable" > insert into customers(customerid, CompanyName, ContactName, ContactTitle) values (#CustomerID#, #CompanyName#, #ContactName#, #ContactTitle#) </insert> 다이나믹 SQL 작성하기 SQL 맵핑파일에서는 XML을사용해다양한형태의조건을추가할수있다. 예를들어, Where 조건식에서특정조건을추가또는삭제해야하는경우다. < 리스트 9> 에작성된쿼리를보면쉽 < 리스트 9> 다이나믹 SQL 을사용하는쿼리 <select id="selectcustomers" resultmap="customersresultmap" > SELECT TOP 5 * FROM CUSTOMERS <dynamic prepend="where"> <isnotnull prepend="and" property="customerid"> CustomerID = #CustomerID# </isnotnull> </dynamic> </select> 게이해할수있다. 쉽게눈치챌수있겠지만, 파라미터로넘어온값중에 Cus tomerid 변수가 Null이아니라면검색조건이추가되는것이다. 필자의경우에는클래스파일에서 if~ else~ 를남발할때보다이러한방식이더욱가독력이있어보였다. ibatis.net이제공하는다이나믹 SQL 기능은 isnotnull 이외에도다음과같은조건을사용할수있다. - <isequal> : 특정 property의값이지정한값과동일할경우 - <isnotequal> : 특정 property의값이지정한값과상이한경우 - <isgreaterthan> : 특정 property의값이지정한값보다큰경우 - <islessequal> : 특정 property의값이지정한값보다작은경우 - <isempty> : 특정 property의값이 null이거나빈값인경우 프로그래밍지원 SQL을기재한 XML 파일에서원하는 SQL을호출하기위해서는 Mapper 클래스를사용한다. 이클래스를사용하여 Mapp er.instance() 메소드를호출하면 SqlMap.config에지정한데이터베이스를디폴트로연결하게된다. 만일파일이름이 SqlMap. config가아니고개발자가임의로지정한파일이름이라면 < 리스트 10> 과같이파일명을지정해야한다. < 리스트 10> 임의로지정한 config 파일을지정하는코드 DomSqlMapBuilder dom = new DomSqlMapBuilder(); ISqlMapper sqlmapper = dom.configure(@".\oraclemap.config"); Mapper.Instance() 메소드를사용하면쿼리결과를리턴받을수있는몇가지메소드를제공해준다. - QueryForList() : 결과를 IList 형태로반환 - QueryForList<>() : 결과를타입화된 IList<> 형태로반환 - QueryForObject() : 결과를 Object 형태로반환 - QueryForObject<>() : 결과를타입화된 Object 형태로반환 또한데이타조작성쿼리는 Insert(), Delete(), Update() 메소드를통해지원해준다. < 리스트 11> ibatis.net 에서제공하는트랜잭션 try Mapper.Instance().BeginTransaction(); 266 m a s o

ibatis.net DataMapper Framework Mapper.Instance().Insert("insert", paramobject); Mapper.Instance().Update("update", paramobject); Mapper.Instance().CommitTransaction(); catch Mapper.Instance().RollBackTransaction(); ibatis.net을사용할경우트랜잭션은 Mapper.Instance() 에서제공하는트랜잭션지원기능을사용한다. 사용법은 < 리스트 11> 과같다. 팁 & 테크 ibatis.net을통해서개발하다보면 XML 파일을자주사용하게된다. 이때비쥬얼스튜디오에서인텔리전스기능을사용하려면, 다운받은 ibatis.net 폴더에서 SqlMap.xsd, SqlMap Config.xsd, providers.xsd 세가지파일을여러분들의비쥬얼스튜디오설치폴더에복사해놓으면된다. 설치시특별히경로를변경하지않았다면 C:\Program Files\Microsoft Visual Studio 8\Xml\Schemas 폴더에위의세가지파일을옮겨놓으면된다. 이외에도쿼리로깅시쿼리를원래모양대로편하게보는방법, MyGeneration을사용한 Entity 클래스자동생성법, ibatis.net 관련설정시의몇가지주의사항등에관해서는필자의블로그 (http://funnygangstar.tistory.com) 를참조하자. 어쨌든, 이번컬럼을통해서도 ibatis.net의주요기능을대부분살펴볼수있고, 쉽게사용할수있을정도로 ibatis. NET은사용하기에쉽다. 즉, ibatis.net 프레임워크를사용하기위한학습곡선이높지않다는것인데, 이는다수의개발자로팀을이루고있을경우복잡하고어려운프레임워크를사용할때드는시간적비용을줄일수있는장점이기도하다. ORM을제외한데이터액세스기술중에는마이크로소프트에서오픈소스로제공해주는 Enterprise Library의 DAAB (Data Access Application Block) 가자주사용된다. DAAB는닷넷 1.0의 SqlHelper 클래스에서부터계속해서발전해왔으며, 현재까지마이크로소프트에서도적극적으로지원을하고있으며, 닷넷기반여러프로젝트에서도잘사용되고있다. 그러나 DAAB는 ibatis.net처럼쿼리결과를객체에자동맵핑해주지않으므로개발자가직접바인딩하는코드들을일일이구현해야한다. 또한프로시져를사용하지않고인라인코드에쿼리를직접작성할때에는스트링변수에쿼리를담아넣는지저분한코드가양산이되기도한다. 결론적으로여타 Data Access 기술들이나 ORM 프레임워크들에비교해서 ibatis.net의장점을다음과같이정리했다. - 여타 ORM 프레임워크들보다배우기쉽다. - 쿼리결과와객체간맵핑작업이필요없다. - 데이터베이스쿼리의장점을그대로사용할수있다. - 쿼리문만따로관리하므로유지보수가용이하다. - WHERE 조건의다이나믹한추가제거, 일부쿼리문의재사용성이증가한다. - ibatis.net이제공하는몇가지쿼리캐쉬메커니즘을사용할수있다. < 화면 3> 맵핑파일에인텔리전스가적용된화면 Data Access 기술비교 ibatis.net은그사용목적에따라서단순한쿼리호출및객체바인딩용으로사용해도좋으며, ORM의대용으로사용하더라도충분한기능을발휘할수있다. 다만이경우엔 N+1문제를비롯한몇가지해결해야할문제들이존재한다. 개인적으로필자는 ibatis.net을주로단순쿼리호출및객체바인딩용으로사용한다. ibatis.net이어차피 ORM 영역이아닌이상 ORM 툴과같은효과를보려면차라리여타 ORM 전문툴을사용하는것이더낫다는관점에서인데, 이는개인마다생각이다를수있다고본다. 프로젝트에서 ORM 프레임워크가아닌직접수작업으로데이터베이스쿼리를작성해야하는경우라면, 여타 Data Access 프레임워크들보다 ibatis.net을사용할경우훨씬깔끔한코드를유지시켜주며개발자가코딩해야할양도대폭줄어들수있다는것이필자의의견이다. 지난 4월호에소개했던 Spring.NET 프레임워크와더불어 ibatis.net 프레임워크는현재닷넷기반에서사용할수있는오픈소스기술중단연추천할만한기술들로이미그안정성과효과를자바환경에서입증했고닷넷환경에서도충분히실전에사용될만한기술들이라고할수있다. 참고자료 1. ibatis.net 공식매뉴얼 - http://ibatis.apache.org/dotnetdownloads.cgi m a s o 267