본문으로 건너뛰기

Domain & Infra model separation

· 약 7분
Ryukato
Ryukato
BackEnd Software Developer

이 문서는 TestDomainItem을 예시로 하여, 도메인 모델과 MongoDB용 인프라 모델을 분리하는 과정을 단계별로 정리한 것입니다.
각 단계에서는 선택된 구조의 장단점 및 고려할 트레이드오프도 함께 포함되어 있습니다.

✅ Step 1: 도메인 모델에 MongoDB 어노테이션 직접 사용​

import org.springframework.data.annotation.Id
import org.bson.types.ObjectId

data class TestDomainItem(
    @Id val id: ObjectId? = null,
    val itemSequence: String,
    val itemName: String
)

장점​

  • 가장 간단하고 빠르게 개발 가능
  • Spring Data MongoDB의 자동 매핑 지원

단점 및 고려사항​

  • 도메인 모델이 spring-data-mongodb, bson 등에 직접 의존
  • 테스트, 비즈니스 로직에서 순수 모델로 보기 어려움
  • 향후 DB 마이그레이션(R2DBC, JPA 등) 시 강하게 coupling 됨

✅ Step 2: @Id 제거 후 _id 필드만 선언​

data class TestDomainItem(
    val _id: ObjectId? = null,
    val itemSequence: String,
    val itemName: String
)

장점​

  • 어노테이션 제거로 약간의 순수성 향상
  • MongoDB _id 필드에 자동 매핑됨

단점 및 고려사항​

  • _id는 여전히 DB 특화된 필드명
  • 도메인 모델이 Mongo 구조에 간접적으로 종속
  • 다른 DB 타입으로 전환 시 더러운 필드로 작용

✅ Step 3: 도메인 모델과 Mongo 모델 분리​

도메인 모델​

data class TestDomainItem(
    val itemSequence: String,
    val itemName: String
)

인프라 모델​

@Document(collection = "test_items")
data class TestDomainItemDocument(
    @Id val id: ObjectId? = null,
    val itemSequence: String,
    val itemName: String
) {
     companion object {
        const val COLLECTION = "test_items"
    }
}

장점​

  • 도메인 모델 완전한 순수성 확보
  • Mongo 의존성은 인프라 계층에만 존재
  • 변환 계층 (toDomain, fromDomain)으로 책임 명확화

단점 및 고려사항​

  • 필드가 많을 경우 변환 코드 반복 발생
  • 도메인 , Infra 간 매핑 테스트 필요

✅ Step 4: Infra 모델을 nested 구조로 단순화​

@Document(collection = "test_items")
data class TestDomainItemDocument(
    @Id val id: ObjectId? = null,
    val item: TestDomainItem
)

💡 NOTE:
MongoDB와 같은 NoSQL 데이터베이스는 nested 구조를 자연스럽게 저장하고 쿼리할 수 있지만,
RDB(Relational Database)에서는 nested 객체를 컬럼으로 표현할 수 없기 때문에
모든 속성을 평탄화(flatten)하여 별도 컬럼으로 나열해야 합니다.
따라서 nested 구조는 NoSQL 전용 구조이며, RDB 마이그레이션 시 반드시 변환이 필요합니다.

장점​

  • Infra ↔ 도메인 간 변환 코드가 단순해짐
  • 도메인 객체 자체를 포함시켜 중복 제거

단점 및 고려사항​

  • 저장 구조가 nested document 형태 (e.g., { item: {...}, _id: ... })
  • Mongo 쿼리 작성 시 "item.itemSequence" 처럼 경로가 깊어짐
  • index 작성 등에서 추가 경로 고려 필요

✅ 최종 권장 전략​

  • 도메인 모델은 순수하게 유지
  • Mongo 저장용 모델은 별도로 두고, @Document, @Id는 infra 쪽에만
  • 간단한 변환은 extension function 또는 mapper로 구현
  • Infra → 도메인 매핑은 읽기/쓰기 테스트로 보장

✅ Sample for bulk upsert​

Convert extensions​

domain-to-document​

fun TestDomainItem.toDocument(): Document =
    Document()
        .append("itemSequence", itemSequence)
        .append("itemName", itemName)

infra-model-to-document​

fun TestDomainItemDocument.toDocument(): Document {
    val doc = Document("item", this.item.toDocument())

    if (this.id != null) {
        doc["_id"] = this.id
    }

    return doc
}

domain repository​

interface TestDomainItemWriteRepository {
    suspend fun upsertAll(items: Collection<TestDomainItem>): Boolean
}

interface TestDomainItemReadOnlyRepository {
    suspend fun findAll(paginationRequest: PaginationRequest): PaginatedElements<TestDomainItem>
}

infra repository​


@Repository
class MongoTestDomainItemReadOnlyRepository(
    private val mongoTemplate: ReactiveMongoTemplate
) : TestDomainItemReadOnlyRepository {
    override suspend fun findAll(paginationRequest: PaginationRequest): PaginatedElements<TestDomainItem> {
        val pageable = paginationRequest.toPageable()
        val page = pageable.pageNumber
        val size = pageable.pageSize
        val skip = (page - 1).coerceAtLeast(0) * size
        val sort = pageable.sort

        val query = Query()
        val pageQuery = query.skip(skip.toLong())
            .limit(size)
            .with(sort)

        val listedResult = mongoTemplate.find(
            pageQuery,
            MongoWrappedTestDomainItem::class.java,
        ).map { it.toDomain() }.collectList()
        val total = mongoTemplate.count(query, MongoWrappedTestDomainItem::class.java)

        return listedResult
            .zipWith(total)
            .map { entityTuples -> Tuples.of(entityTuples.t1.toList(), entityTuples.t2) }
            .map { entityTuples -> convertToPaginatedElements(entityTuples, pageable) }
            .awaitSingle()
    }
}


@Repository
class MongoTestDomainItemWriteRepository(
    private val reactiveMongoTemplate: ReactiveMongoTemplate
) : TestDomainItemWriteRepository {
    
    override suspend fun upsertAll(items: Collection<TestDomainItem>): Boolean {
        if (items.isEmpty()) return false

        val collection = reactiveMongoTemplate.getCollection(MongoWrappedTestDomainItem.COLLECTION).awaitSingle()
        val models = items.map { item ->
            val mongoItem = item.toMongo()
            val doc = mongoItem.toDocument()
            val filter = Filters.eq("item.itemSequence", item.itemSequence)

            ReplaceOneModel(filter, doc, ReplaceOptions().upsert(true))
        }

        val result = collection.bulkWrite(models).awaitSingle()
        // logger.info("Upsert result - inserted: ${result.insertedCount}, modified: ${result.modifiedCount}, upserts: ${result.upserts.size}")
        return result.modifiedCount > 0 || result.insertedCount > 0 || result.upserts.isNotEmpty()
    }
}

bulk-upsert function​

suspend fun upsertAll(items: Collection<TestDomainItem>): Boolean {
    if (items.isEmpty()) return false

    val collection = reactiveMongoTemplate.getCollection(TestDomainItemDocument.COLLECTION).awaitSingle()
    val models = items.map { item ->
        val mongoItem = item.toMongo()
        val doc = mongoItem.toDocument()
        val filter = Filters.eq("item.itemSequence", item.itemSequence)

        ReplaceOneModel(filter, doc, ReplaceOptions().upsert(true))
    }

    val result = collection.bulkWrite(models).awaitSingle()
    // logger.info("Upsert result - inserted: ${result.insertedCount}, modified: ${result.modifiedCount}, upserts: ${result.upserts.size}")
    return result.modifiedCount > 0 || result.insertedCount > 0 || result.upserts.isNotEmpty()
}

Note

만약 doc 전체를 교체하려는 목적이기 때문에, UpdateOneModel이 아닌 ReplaceOneModel을 사용했습니다. 하지만 일부 속성만 수정하는 목적이라면 아래와 같이 UpdateOneModel을 사용해야 해요.

val updateDoc = Document("\$set", doc)
UpdateOneModel<Document>(filter, updateDoc, UpdateOptions().upsert(true))

Test Codes​



MongoRawDrugItemSummaryRepositoryTest {

    @Autowired
    private lateinit var rawDrugItemSummaryWriteRepository: MongoRawDrugItemSummaryWriteRepository

    @Autowired
    private lateinit var rawDrugItemSummaryReadOnlyRepository: MongoRawDrugItemSummaryReadOnlyRepository

    @Test
    fun testUpsertAll() = runBlocking {
        val rawDrugItemSummaries = (1..10).map {
            TestDomainItem(
                itemSequence = "$it",
                itemName = "item-$it",
            )
        }
        var updated = testDomainItemWriteRepository.upsertAll(rawDrugItemSummaries)
        assertTrue(updated)

        var paginatedElements = testDomainItemReadOnlyRepository.findAll(
            paginationRequest = PaginationRequest.Companion.build(1, 100)
        )
        assertTrue(paginatedElements.elements.isNotEmpty())
        assertEquals(rawDrugItemSummaries.size, paginatedElements.totalCount.toInt())


        val updatedName = "this is updated name"
        val updates = rawDrugItemSummaries.map {
            it.copy(itemName = updatedName)
        }
        updated = testDomainItemWriteRepository.upsertAll(updates)
        assertTrue(updated)
        paginatedElements = testDomainItemReadOnlyRepository.findAll(
            paginationRequest = PaginationRequest.build(1, 100)
        )

        paginatedElements.elements.forEach {
            assertEquals(updatedName, it.itemName)
        }
    }
}