DataAccess 계층

소개

이 문서는 백엔드 개발 중 DataAccess 계층 개발에 대한 설명을 담고 있습니다.

DataAccess 계층 설명

DataAccess 계층은 백엔드 개발 중 Database를 핸들링을 하기 위한 계층입니다. 이 계층은 Database에 접근할 수 있는 최상위 계층이자 마지막 계층입니다. 이 계층에서는 여러 DAO 객체를 생성하여 Database에 접근하며 테이블 뿐만 아니라 뷰, 프로시져 또는 특정목적의 접근방식의 필요로 모듈화 하여 구현할 수 있습니다.

DataAccess 계층 구성

DataAccess 계층은 DAO(Data Access Object)객체와 DTO(Data Transfer Object)객체로 이루어져 있습니다. DataAccess 계층 개발은 데이터 처리적 측면의 핵심관심사항이 파편화 되지 않고 모듈화 되도록 주의하며 관리 해야 합니다. 관리 방법은 모두 디렉토리 및 네임스페이스의 패턴화된 구조로 관리하고 있습니다.

네임스페이스 구조

서비스의 객체들은 아래의 네임스페이스 구조 아래 생성됩니다.

namespace app.info.MyDaoName.Dao {}
namespace app.info.MyDaoName.Dao.Model {}

네임스페이스 설명

디렉토리 구조

DataAccess 계층에서 필요한 DAO객체와, DTO객체가 위치해야 하는 규칙입니다. 보통 아래의 모습처럼 디렉토리를 생성합니다.

.
└──📁info
    └──📁DaoName /* ex, Orders */
        └──📁Dao /* Dao 객체가 위치 */
        └──📁Model /* Dao 객체가 사용하는 엔티티객체 또는 모델객체가 위치 */

DataAccess 계층 생성

DAO(Data Access Object)객체와 DTO(Data Transfer Object)객체로 구성됩니다. 이 중 DAO객체는 ADO.NET 기술을 사용하며 이를 지원하는 Spring.NET의 템플릿 기반의 DAO작성 패턴을 따릅니다. 티쿤은 자체개발한 Spring.NET의 AdoDaoSupport로 부터 파생된 ObjectDao 지원객체를 이용하여 일반화된 기능이 추가된 DAO객체를 만듭니다. ObjectDao를 사용함으로써 티쿤의 DAO객체는 대부분 Generic 기술(Spring.Data.Generic)을 사용하며, 때문에 DTO객체가 항상 함께 구성될 필요가 있습니다.

DTO (엔티티, 모델) 객체 생성

티쿤의 DAO는 Spring.NET의 Spring.Data.Generic 네임스페이스에 포함된 기술을 사용합니다. 때문에 이 기술의 Generic 객체로 사용할 DTO 객체는 항상 필요합니다. DTO 객체는 조회 전용의 리터럴한 모델 객체로 사용하거나, Database의 테이블과 매칭되는 엔티티 객체를 통해 제공되는 일반화된 CRUD 기능을 시도할 수 있습니다.

엔티티 객체 생성 (~DbItem)

엔티티 객체는 Database의 테이블과 매칭됩니다. 이 객체는 테이블이름을 유추할 수 있는 이름과 함께 접미어 DbItem를 사용하여 명명되거나, 또는 기능적 측면의 이름을 사용한다면 TableInfo특성을 사용하여 Database의 Table을 유추할 수 있도록 해야합니다. 제공되는 특별한 특성과 함께 DAO객체에서 사용하면 Table의 입력, 수정, 삭제, 조회를 쉽게 작성할 수 있습니다.

/// <summary>
/// SimpleUserInfo Table의 컬럼과 매핑되는 엔티티 객체
/// </summary>
[TableInfo]
public class SimpleUserInfoDbItem
{
  [IdColumn]
  public int Id { get; set; } // id int identity(1,1)
  public string FullName { get; set; } // fullName nvarchar(20)
  public int Age { get; set; } // age int
  public string BirthDay { get; set; } // birthDay varchar(8)
}

예제에 포함된 특성의 설명

Model 객체 생성

모델 객체는 View나 Join된 데이터를 가져올 때, 리터럴하게 사용되는 객체 입니다. 또는 특별하게 입력, 수정, 삭제가 필요할 경우에도 목적에 맞는 객체로써 생성될 수 있습니다. 또한, 조회조건이 되는 파라메터 객체가 될 수도 있습니다.

// SimpleUserInfo에 고객의 주소가 추가 포함하는 객체
public class SimpleUserInfoItem : SimpleUserInfoDbItem
{
  public string Address { get; set; }
}

// SimpleUserInfo에 고객별 주문번호가 추가 포함되는 객체
public class SimpleUserOrderItem : SimpleUserInfoDbItem
{
  public int OrderId { get; set; }
}

// 간단한유저정보 조회 파라메터
public class SimpleUserSearchParam
{
  public string NameLike { get; set; }
  public int? Age { get; set; }
}

DTO 접미어 규칙

Model과 엔티티 객체는 사용방법에 따라 접미어 규칙을 가지고 있습니다. 이 규칙들은 프로그램에 의해 특별하게 제어되지는 않지만, 객체의 사용용도에 따라 약속된 명명 규칙입니다.

접미어 규칙 설명

DTO 객체에서 사용하는 특성들

아래는 DTO객체 생성시 사용되는 특성에 관한 설명입니다. 이들 특성으로 ObjectDao지원객체에서 테이블명과 컬럼명 매핑방식 등의 힌트를 얻고 동작하게 됩니다.

[TableInfo("tblMyTable")]
public class MyTableDbItem
{
  [IdColumn]
  public int Id { get; set; }
  
  [JsonParsing]
  public MyClass MyClass { get; set; }

  [XmlParsing]
  public MyClass MyClass2 { get; set; }

  /* ... */
}

DAO (Data Access Object) 객체 생성

DAO객체는 기본적으로 ADO.NET 기술을 사용하며 Spring.NET의 AdoDaoSupport 지원객체로 부터 파생된 ObjectDao 객체를 상속받음으로 써 생성합니다. 보통 DTO 객체를 통하여 단일 인스턴스 템플릿기반의 DAO를 생성합니다만, 필요한 경우 Generic 형태가 아닌 비템플릿 기반의 DAO또한 생성할 수 있습니다. 단일 인스턴스 템플릿과의 차이를 두기위해 ObjectDao는 ObjectDao<ModelClass>와 ObjectDao로 존재 합니다. 이 객체들은 Spring.NET의 각각 Spring.Data.Object, Spring.Data.Generic의 AdoDaoSupport 지원객체를 상속받으며 그 기능과 함께 티쿤에서 제작한 추가적인 기본기능을 제공받습니다.

// 단일인스턴스 기반 Generic형 DAO
public class SimpleUserInfoDao : ObjectDao<SimpleUserInfoItem>, ISimpleUserInfoDao
{
  public int void DeleteAll()
  {
    return Query("DELETE SimpleUserInfo");
  }

  public int void UpdateUserName(int id, string fullName)
  {
    return Query("UPDATE SimpleUserInfo SET fullName = @fullName WHERE id = @id", new { id, fullName });
  }

  public IList<SimpleUserInfoItem> FindListByAge(int age)
  {
    return Query(new ListQuery<SimpleUserInfoItem>
    {
        Query = "SELECT * FROM SimpleUserInfo WHERE age = @age",
        DbParam = new { age }
    });
  }
}

// DataTable, DataSet 등의 기술지원을 하는 Object형 DAO
public class SimpleUserInfoDao2 : ObjectDao, ISimpleUserInfoDao2
{
  /* ... */
}

ObjectDao의 기본제공 기능

티쿤의 ObjectDao 지원객체는 Spring.NET의 AdoDaoSupport로 부터 파생되었습니다. 때문에 ObjectDao를 상속받는 모든 DAO들은 AdoTemplate속성에 접근하여 Spring에서 제공하는 기능을 그대로 사용할 수 있습니다. 또한 티쿤에서 자체 제공하는 일반화된 편의 기능을 사용할 수 있습니다.

아래는 여기에 추가로 ObjectDao에서 제공하는 일반화된 편의기능에 대해 설명합니다.

Insert(T item)

전달된 객체에서 테이블명을 유추하여 새로운 행을 입력합니다. Identity 컬럼이 존재하면 증가된 Identity 값을 반환합니다.

MyDao.Insert(myTableItem);
// SQL> INSERT INTO (col1, col2) VALUES ('', '')

Insert(T item, bool triggerOff)

전달된 객체에서 테이블명을 유추하여 새로운 행을 입력합니다. Identity 컬럼이 존재하면 증가된 Identity 값을 반환합니다. 트리거 OFF 옵션을 켜면, INSERT 트리거가 동작하지 않습니다.

MyDao.Insert(myTableItem, true);
// TRIGGER OFF 됨
// SQL> INSERT INTO (col1, col2) VALUES ('', '')

Update(T item)

전달된 객체에서 테이블명과 Identity 속성을 유추합니다. 유추된 정보와 객체의 내용으로 행을 갱신합니다.

MyDao.Update(myTableItem);
// SQL> UPDATE MyTable SET col1 = '', col2 = '' WHERE id = 1234

Update(T item, bool triggerOff)

전달된 객체에서 테이블명과 Identity 속성을 유추합니다. 유추된 정보와 객체의 내용으로 행을 갱신합니다. 트리거 OFF 옵션을 켜면, UPDATE 트리거가 동작하지 않습니다.

MyDao.Update(myTableItem, true);
// TRIGGER OFF 됨
// SQL> UPDATE MyTable SET col1 = '', col2 = '' WHERE id = 1234

Delete(T item)

전달된 객체에서 Identity인 속성을 찾아 단건 1건을 삭제 합니다. 또는, Identity인 속성을 찾을 수 없는 경우 모든 속성을 Where절 조건으로 하여 삭제합니다.

MyDao.Delete(myTableItem);

Delete(int id)

전달된 타입에서 테이블명을 유추하고 해당 id컬럼을 조건으로 ROW를 삭제 합니다.

MyDao.Delete<MyTableDbItem>(10);
// SQL>  DELETE MyTable WHERE id = 10;

T Query(ItemQuery query)

단건 조회를 지원합니다. 이 메소드는 DAO 객체 내에서 구현합니다. (protected)

return Query(new ItemQuery<MyClassDbItem>
  {
    Query = "SELECT * FROM MyClass WHERE id = @id",
    DbParam = new { id = 1234 }
  });

// Generic Type에 Primitive한 Value 타입이나 string, DateTime 형식이 할당되면, 쿼리는 Scalar로 동작합니다.
return Query(new ItemQuery<string>
  {
    Query = "SELECT TOP 1 col FROM MyClass"
  });

IList Query(ListQuery query)

다건 조회를 지원합니다. 이 메소드는 DAO 객체 내에서 구현합니다. (protected)

return Query(new ListQuery<MyClassDbItem>
  {
    Query = "SELECT * FROM MyClass WHERE id > @id",
    DbParam = new { id = 1 }
  });

return Query(new ListQuery<int>
  {
    Query = "SELECT TOP 100 id FROM MyClass"
  });

int Query(ExecuteQuery query)

단순 실행 후 영향받은 ROW를 반환하는 기능입니다. 보통 프로시져를 호출하거나 삭제 및 갱신 할 때 사용합니다. 이 메소드는 DAO 객체 내에서 구현합니다. (protected)

return Query(new ExecuteQuery
  {
    Query = "UPDATE MyClass SET col1 = '123'"
  });

return Query(new ExecuteQuery
{
  Query = "EXEC dbo.RunProgram @key, @val",
  DbParam = new { key = "a", val = "b" }
});

return Query(new ExecuteQuery
{
  Query = "DELETE MyClass WHERE id = @id",
  DbParam = new { id = 123 }
});

in 쿼리

DbParam 을 이용해 in 쿼리 구현이 불가능하기 때문에 특별한 함수를 제공한다.

IEnumerable<int> ids = new int[] { 1, 2, 3 };
var query = new ListQuery<TestItem>
{
    Query = $"SELECT * FROM Table WHERE id in ({ids.ToInQueryParam()}) " //name가 null 이거나 Count == 0 일경우 쿼리 구문 오류
};
var result = COD.Query(query);

IEnumerable<string> names = new string[] { "a", "b", "c" };
var query = new ListQuery<TestItem>
{
    Query = $"SELECT * FROM Table WHERE name in ({names.ToInQueryParam()}) " //name가 null 이거나 Count == 0 일경우 쿼리 구문 오류
};
var result = COD.Query(query);

bit flag 쿼리

enum 타입을 bit flag 형식으로 사용하는 경우 사용 편의를 위해 특별한 함수를 제공한다.

[Flags]public enum FlagEnum
{
    FEV0 = 0, FEV1 = 1, FEV2 = 2, FEV4 = 4, FEV8 = 8, FEV16 = 16
}

var query = new ListQuery<EnumTestItem>
{
    Query = $"SELECT * FROM EnumTest WHERE flagEnum {Q.BitAny("@flagEnum")} ", // flagEnum 에 FEV1 이나 FEV4 둘 중 하나가 있을 경우 true
    DbParam = new { flagEnum = FlagEnumValue.FEV1 | FlagEnumValue.FEV4 }
};
var result = COD.Query(query);

var query = new ListQuery<EnumTestItem>
{
    Query = $"SELECT * FROM EnumTest WHERE flagEnum {Q.BitAll("@flagEnum")} ", // flagEnum 에 FEV1 와 FEV4 모두 있을 경우 true
    DbParam = new { flagEnum = FlagEnumValue.FEV1 | FlagEnumValue.FEV4 }
};
var result = COD.Query(query);