본 블로그 글의 출처는
http://network.hanbitbook.co.kr/view.php?bi_id=1118
이며 저자는 한동훈 입니다.
This blog entry is from http://network.hanbitbook.co.kr/view.php?bi_id=1118

또한, DB에 값을 가져오거나 저장하는 일을 단순하게 할 수 있는 방법은 없을까? 라는 물음이다. 물론, Data Access Layer를 담당하는 클래스를 작성해서 DB작업을 단순하게 해주지만 쿼리 작성, 값의 유효성과 같은 것들을 자동화해주지는 못한다.

MS가 Data Access Bulilding Block을 제공한다해도 여전히 반복적인 작업을 해야한다. 이에 대한 대안은 과연 없을까?

컨트롤 처리

ASP.NET에서는 웹 페이지의 각 요소를 컨트롤로 다루기 때문에 각 요소에 접근해서 값을 설정하거나 변경하는 작업을 비교적 쉽게 할 수 있다. 게다가, 앞에서 다룬 것처럼 ASP.NET의 전체 컨트롤 트리를 해석하는 코드를 손쉽게 작성할 수 있기 때문에 페이지 내의 모든 컨트롤 값을 알아내는 작업도 쉽게 할 수 있다.

페이지에 있는 모든 컨트롤의 값을 출력하기 위해 BasePage 클래스에 GetFormVariables() 함수를 추가하였다. 이 함수는 모든 컨트롤값을 해시로 저장한다. 값을 이용하기 위해서는 hash["ControlName"]의 형식으로 이용할 수 있고, 전체 컨트롤 값을 얻기 위해서는 다음과 같이 Iterator 패턴을 사용하면 된다.(닷넷에서는 Enumerator라는 용어를 사용하고 있지만 C++/Java 등에서는 이와 같은 형태에 대해 Iterator라는 용어를 사용하고 있다)

화면에 출력되는 값들을 보면 컨트롤 내의 모든 요소들의 값을 잘 가져오는 것을 알 수 있다. GetFormVariables() 함수는 Hashtable 형태로 값을 가져오는 버전과 필드 구분자를 이용해서 값을 가져오는 형태로 나뉘어져있다. GetFormVariables()에서 값을 가져오지 않는 몇가지가 있다. 그 중에는 DataGrid, DropDownList, RadioButtonList, CheckBoxList 컨트롤들이 있다. 이들은 그 안에 포함된 데이터를 다루기 위한 방법들이 별도로 필요하기 때문에 생략하였다.

다음으로 컨트롤에 값을 설정하는 경우를 살펴보자. 요즘 업무용 웹 응용프로그램의 경향을 보면 다양한 탭을 사용하고, 각 탭마다 적게는 30개에서 많게는 300개 이상의 컨트롤을 올려놓고 작업하고 있다. 이런 상황에서 ControlName.Text = “Value”;와 같은 형태의 코드를 각 컨트롤마다 사용한다는 것은 심각한 시간낭비라 할 수 있다.

첫번째 SetFormVaribles() 함수는 컨트롤 이름 목록과 컨트롤 값 목록을 각각 배열로 받아서 순서대로 값을 찾아서 컨트롤의 값을 매핑해주는 예이며, 두번째 SetFormVariables() 함수는 Hashtable에 설정된 값을 컨트롤에 매핑해주는 형태이다. 예제에서 볼 수 있는 것처럼 다양한 컨트롤에 값을 매핑할 수 있다. DataGrid와 List 컨트롤의 값 설정과 매핑은 별도의 주제로 다룰 것이기 때문에 그 주제는 다음 기회로 미룰 것이다. ^^;

일단, 값을 설정하는 컨트롤의 형태에서 간파할 수 있는 것이 몇가지 있을 것이다. 조회성 화면을 작성하는 경우에 DB로부터의 결과를 Hashtable의 형태로 가져온다면 그 값을 바로 페이지상의 컨트롤에 매핑할 수 있을 것이다. DB Field 명을 컨트롤 명으로 사용하는 방법도 생각할 수 있고, 중간에 XML 파일 형식을 만들어서 DB Field와 컨트롤 이름 사이의 매핑을 작성할 수 있을 것이다. 아마, 필자라면

VS.NET에서 XML 파일을 추가한 경우에 XML 파일을 컴파일된 DLL 파일에 포함시킬 수 있기 때문에 XML 파일을 관리한다거나 누군가가 XML 파일을 변경하는 문제는 발생하지 않는다. 누군가가 DLL에서 XML을 추출해서 변경하고 다시 DLL에 합치는 경우도 강력한 키(Strong Key) 서명을 이용해서 DLL을 배포했다면 예방할 수 있다. DLL에 XML을 포함시키는 방법은 NHibernate을 설명하면서 같이 살펴보도록 하자.

지금은 GetFormVariables와 SetFormVariables의 내부에 대해 좀 더 자세히 살펴보자. 내부구조에 관심없는 분은 살포시 다른 페이지로 이동하면 된다.

Get/SetFormVariables 함수 분석

ASP.NET 페이지의 컨트롤 트리 해석에 대해서는 ASP.NET 가이드 2. 숫자/문자 입력 텍스트 박스 만들기 에서 살펴보았지만 전체 컨트롤 트리를 해석할 필요는 없었다. 여기에 전체 컨트롤 트리를 해석하게 만들기 위해서는 간단하게 재귀를 사용할 수 있다. 하지만, ASP.NET 페이지에 한 탭에 30-100개의 컨트롤이 5-6개의 탭에 올라가는 응용 프로그램을 생각해보면 재귀는 현명한 선택이 아니다. 따라서 재귀버전을 비재귀버전으로 작성할 필요가 있다.

흥미가 있는 분들은 두번째 글을 참고해서 재귀버전을 작성해보고 그에 대한 비재귀버전을 작성해보기 바란다.

비재귀버전으로 작성한 컨트롤 트리 해석

여기서는 비재귀버전으로 작성하기 위해 스택을 사용했다. 스택을 이용해서 작성했기 때문에 컨트롤 트리의 순서는 반대로 출력되지만 사용하기에는 아무 문제가 없다.(순서를 다시 원위치로 복귀해주는 역정렬을 해주는 구현이라든가 이런 예는 인터넷에서 손쉽게 찾아볼 수 있을 것이다)

GetFormVariables() 함수도 Hashtable을 이용한 버전과 구분자로 되어 있는 문자열을 반환하는 형태의 두 가지 버전이 있다.

GetValue() 함수는 실제 컨트롤의 값을 가져오는 역할을 수행하며, GetValue도 Hashtable인 경우와 문자열인 경우의 두 가지 버전을 제공한다.

SetFormVariables() 함수도 GetFormVariables() 함수와 마찬가지로 같은 코드로 작성되어 있으며 GetValue 대신에 SetValue 함수가 사용되었다는 점만 다르다.

이 두 가지 함수면 대부분의 경우에 컨트롤의 값을 편하게 설정하고 제어할 수 있을 것이다. 원한다면 GetValue, SetValue 함수를 사용해서 일부 컨트롤의 값을 변경할 수도 있을 테지만, 그런 경우에도 SetFormVariables에 변경하고 싶은 컨트롤의 목록과 값을 전달하면 충분히 변경할 수 있을 것이다. 30개 중에 3개의 컨트롤 값을 변경하고 싶은 경우에도 SetFormVariables를 유용하게 사용할 수 있으며, 이런 작업에는 Hashtable을 이용하는 버전보다는 배열 형태를 이용하는 SetFormVariables가 더 유용하게 느껴질 것이다. – 실제로, 두 가지 모두 나름대로의 장단점을 갖고 있기 때문에 상호보완하며 혼용하면 손쉽게 문제를 해결할 수 있을 것이다.

컨트롤과 관련해서 개발자를 괴롭히는 또다른 문제는 DB에서 가져온 값을 손쉽게 컨트롤에 매핑할 수 없을까? 라는 문제다. SetFormVariables 함수와 XML 형태의 매핑 함수를 개발하는 방법은 각자가 얼마든지 개발할 수 있을 것이다. 따라서, 여기서는 그런 간단한 문제 대신에 DB의 요소들을 객체로 편하게 다룰 수 있는 방법에 대해 보여줄 것이다.

NHibernate 간편 가이드

이 부분은 전적으로 NHibernate Quick Guide를 토대로 작성할 것이며, 번역판이라 생각해도 될 것이다.

Hibernate은 본래 Java에서 쓰이는 프레임워크로 ERD(Entity-Relationship Diagram) 로 그려진 관계형 데이터가 표현할 수 있는 영역과 객체지향 언어가 표현할 수 있는 영역이 일치하지 않는 부분을 중간에서 매핑 시켜주는 프레임워크다. 이러한 매핑툴을 ORM(Object-Relational Mapping) 도구라 부른다. 자바 버전의 Hibernate을 닷넷 버전으로 포팅한 것을 NHibernate이라 한다. VS 2005에서는 이러한 툴을 자체적으로 내장할 예정이며, ObjectSpaces라는 이름으로 제공될 것이다. ORM은 종종 ORM(Object-Relationship Modeling) 으로 쓰이기도 한다.

NHibernate은 http://nhibernate.org 에서 자세한 정보를 얻을 수 있고, http://nhibernate.sourceforge.net 에서 다운받을 수 있다.

다운로드를 받고, 설치를 했으면 VS.NET에서 새로운 프로젝트를 시작한다.

SQL Server에서는 다음과 같은 테이블을 작성한다.

CREATE TABLE [dbo].[users] (
[LogonID] [nvarchar] (20) COLLATE Korean_Wansung_CI_AS NOT NULL ,
[Name] [nvarchar] (40) COLLATE Korean_Wansung_CI_AS NULL ,
[Password] [nvarchar] (20) COLLATE Korean_Wansung_CI_AS NULL ,
[EmailAddress] [nvarchar] (40) COLLATE Korean_Wansung_CI_AS NULL ,
[LastLogon] [datetime] NULL
) ON [PRIMARY]

프로젝트 참조에 NHibernate.dll을 추가하고, 클래스에는 using NHibernate.Cfg;와 using NHibernate;을 추가한다.

DB의 테이블을 클래스와 매핑시킬 것이기 때문에 먼저 User 클래스에 대한 정의가 있어야한다.

User 클래스 정의

NHibernate은 클래스와 DB 사이의 매핑을 XML 파일로 구성한다. 이 XML 파일은 “클래스명.hbm.xml”을 사용한다. 여기서 작성한 user.hbm.xml의 정의는 다음과 같다.

user.hbm.xml 정의

여기서 알 수 있는 것처럼 DB의 컬럼명, 데이터 타입, 데이터의 길이까지 지정할 수 있다는 것을 알 수 있다. CLASS 태그는 중요하다. 필자는 Mona.Web.Samples라는 프로젝트를 생성했고, 컴파일된 DLL은 Mona.Web.Samples.DLL이 된다. 네임 스페이스 또한 Mona.Web.Samples이며 User 클래스의 전체 이름은 Mona.Web.Samples.User가 된다. class의 이름은 “클래스명, DLL명”이 되어야 한다. table 속성은 DB에서 사용할 테이블의 이름을 지정한다. 이 XML 파일은 DLL안에 포함되어야만 NHibernate에서 오류없이 XML 파일의 내용을 읽어들일 수 있다.

XML 파일을 DLL에 포함시키기

XML 파일 위에서 마우스 오른쪽 버튼을 클릭하고 [속성]을 선택한다.

빌드 작업을 보면 “포함 리소스”를 선택할 수 있다. [포함 리소스]를 선택하면 컴파일시에 XML 파일에 DLL에 자동으로 포함된다. 이제, NHibernate을 이용할 준비가 되었으니 사용법을 살펴보자.

NHibernate 사용하기

NHibernate에서는 먼저 XML 설정 파일을 읽어들인다. 설정 파일을 읽어들이고, 각 세션을 유지하기 위해 factory를 생성한다. factory는 각 세션을 유지하고, 세션에서는 트랙잰션을 처리할 수 있다. 다음은 새로운 사용자를 추가하는 예제이다.

cfg.AddXmlFile()은 XML 파일을 DLL에 포함시키지 않은 경우에 사용할 수 있는 코드인데 개발중일 때를 제외하면 잘 사용하지 않는다. SQL 쿼리를 사용하지 않고 새로운 사용자를 DB에 성공적으로 집어넣었다. 작업이 끝나면 반드시 해당 세션을 저장해야하고, 변경사항을 DB에 반영하기 위해 Commit을 수행하면 된다.

이 코드는 factory에서 새로운 세션을 열고, “joe_cool”로 검색되는 사용자를 가져와서 로긴 시간만 변경하는 예이다. Flush()를 호출해서 해당 데이터의 변경사항을 반영할 수 있다.

이 예제는 범주를 만들어서 사용자를 검색하는 예제이며, 각 사용자 목록을 어떻게 처리할 수 있는지를 보여주기 위한 예제이다. SQL 쿼리문에서는 WHERE 절에 해당하는 부분을 NHibernate에서는 CreateCriteria()를 사용해서 대신 처리할 수 있는 것이다. Expression.Gt()는 WHERE 절에서 >를 대신하는 것이다. Gt는 “Greater than”을 뜻하며 Ge는 “Greater than or equal”을 뜻한다. 이런 의미로 Lt, Eq와 같은 다양한 메서드들이 존재한다.

NHibernate은 테이블과 클래스의 1:1 매핑 뿐만 아니라 1:N, M:N과 같은 다양한 관계의 매핑도 처리할 수 있으므로 사용법을 참고하면 좋을 것이다.

마치며

이제, 독자에게 남겨진 작업은 Get/SetFormVariables() 같은 메서드를 이용해서 컨트롤 값을 가져오고, NHibernate과 같은 프레임워크를 이용한 객체 사이를 자동으로 처리할 수 있게 해주는 부분이다. Hashtable로 가져온 컨트롤의 이름과 NHibernate 객체의 속성을 매핑해주는 부분을 작성한다면 ASP.NET 페이지에서 DB 까지의 처리를 보다 빠르고 편하게 할 수 있을 것이다. Hibernate 프레임워크를 이용한다고 위의 예제처럼 Hibernate 코드를 직접 조작하는 것은 결국 웹 프로그래밍에서의 무의미한 반복과 별차이가 없지않은가? 그러니, 반복작업을 줄여줄 함수나 도구를 독자 스스로 만들어서 사용해보기 바란다.

☞ 본문 소스코드 다운로드

참고자료

NHibernate 공식사이트(http://nhibernate.org) : 소스 다운로드에서 관련 설명서, 기사 모음까지 제공하고 있어 NHibernate 출발점으로 굉장히 유용하다.

NHibernate( http://www.theserverside.net/articles/showarticle.tss?id=NHibernate ): 1:N, M:N에서의 Hibernate 사용법등에 대한 설명이 자세히 되어 있다.