[#22] application event 발행 시 spring-integration 활용 (#26)

Author: chanhyeong

.github/workflows/gradle-build-pr.yml

@@ -1,24 +1,24 @@
 name: Gradle Build
-on: 
+on:
   pull_request:
-    branches :
+    branches:
       - main
 jobs:
   gradle:
     strategy:
       matrix:
-        os: [ubuntu-latest]
+        os: [ ubuntu-latest ]
     runs-on: ${{ matrix.os }}
     steps:
-    - name: Check out
-      uses: actions/checkout@v2
-    - name: Setup java
-      uses: actions/setup-java@v1
-      with:
-        java-version: 11
-    - name: Build USER module
-      uses: gradle/gradle-build-action@v2
-      with:
-        build-root-directory: user/
-        arguments: build 
-        gradle-version : 7.2
+      - name: Check out
+        uses: actions/checkout@v2
+      - name: Setup java
+        uses: actions/setup-java@v1
+        with:
+          java-version: 11
+      - name: Build USER module
+        uses: gradle/gradle-build-action@v2
+        with:
+          build-root-directory: /
+          arguments: build
+          gradle-version: 7.2

README.md

@@ -11,6 +11,9 @@
 
 ----
 
+- 기본 환경 구성 - [ENVIRONMENT](./docs/ENVIRONMENT.md)
+- 코딩 컨벤션 - [CONVENTION](./docs/CONVENTION.md)
+
 # 프로젝트 세팅
 
 - spring boot 2.5.5

build.gradle.kts

@@ -8,8 +8,6 @@ plugins {
     id("org.jlleitschuh.gradle.ktlint") version "10.2.0"
 }
 
-
-
 allprojects {
     group = "com.sns"
     version = "1.0.0"
@@ -37,9 +35,9 @@ subprojects {
 
         // test
         testImplementation("org.springframework.boot:spring-boot-starter-test")
-        testImplementation("io.mockk:mockk:1.12.0")
-        testImplementation("com.ninja-squad:springmockk:3.0.1")
-        testImplementation("org.junit.jupiter:junit-jupiter:5.8.1")
+        testImplementation("io.mockk:mockk:${property("mockkVersion")}")
+        testImplementation("com.ninja-squad:springmockk:${property("springMockkVersion")}")
+        testImplementation("org.junit.jupiter:junit-jupiter:${property("jupiterVersion")}")
     }
 
     tasks.withType<KotlinCompile> {
@@ -56,6 +54,8 @@ subprojects {
 
 project(":user-api") {
     dependencies {
+        implementation(project(":submodules:commons"))
+
         implementation("org.springframework.boot:spring-boot-starter-data-jdbc")
         implementation("com.fasterxml.jackson.module:jackson-module-kotlin")
         implementation("io.springfox:springfox-boot-starter:3.0.0")
@@ -71,3 +71,11 @@ project(":front") {
         implementation("org.springframework.boot:spring-boot-starter-thymeleaf")
     }
 }
+
+project(":submodules:commons") {
+    dependencies {
+        implementation(project(":submodules:commons"))
+
+        api("org.springframework.boot:spring-boot-starter-integration")
+    }
+}

docs/CONVENTION.md

@@ -30,6 +30,11 @@
 
 kotlin 공식 룰을 따름 - https://kotlinlang.org/docs/coding-conventions.html
 
+- commmit 전 ktlint 체크하도록 설정
+  ```shell
+  ./gradlew addKtlintFormatGitPreCommitHook
+  ```
+
 ## 구성
 
 - Event 는 Spring 에서 제공하는 것으로 사용한다 (`ApplicationEventPublisher`)

front/src/main/kotlin/com/sns/front/utils/Logger.kt

@@ -0,0 +1,6 @@
+package com.sns.front.utils
+
+import org.slf4j.Logger
+import org.slf4j.LoggerFactory
+
+inline fun <reified T : Any> T.log(): Logger = LoggerFactory.getLogger(T::class.java)

gradle.properties

@@ -0,0 +1,3 @@
+mockkVersion=1.12.0
+springMockkVersion=3.0.1
+jupiterVersion=5.8.1

settings.gradle.kts

@@ -1,3 +1,3 @@
 rootProject.name = "juniors-ddd"
 include("user-api", "front")
-
+include(":submodules:commons")

submodules/commons/src/main/kotlin/com/sns/commons/DomainEvent.kt

@@ -0,0 +1,7 @@
+package com.sns.commons
+
+interface DomainEvent {
+    val eventId: String
+
+    val channel: String
+}

submodules/commons/src/main/kotlin/com/sns/commons/annotation/CustomEventListener.kt

@@ -0,0 +1,9 @@
+package com.sns.commons.annotation
+
+import org.springframework.stereotype.Component
+
+@Target(AnnotationTarget.CLASS)
+@Retention(AnnotationRetention.RUNTIME)
+@MustBeDocumented
+@Component
+annotation class CustomEventListener

submodules/commons/src/main/kotlin/com/sns/commons/config/IntegrationEventBaseConfig.kt

@@ -0,0 +1,11 @@
+package com.sns.commons.config
+
+import com.sns.commons.service.EventPublisher
+import org.springframework.context.ApplicationContext
+import org.springframework.context.annotation.Bean
+
+class IntegrationEventBaseConfig {
+
+    @Bean
+    fun eventPublisher(applicationContext: ApplicationContext) = EventPublisher(applicationContext)
+}

submodules/commons/src/main/kotlin/com/sns/commons/service/EventPublisher.kt

@@ -0,0 +1,19 @@
+package com.sns.commons.service
+
+import com.sns.commons.DomainEvent
+import com.sns.commons.utils.log
+import org.springframework.context.ApplicationContext
+import org.springframework.messaging.MessageChannel
+import org.springframework.messaging.support.GenericMessage
+
+class EventPublisher(private val applicationContext: ApplicationContext) {
+    private val log = log()
+
+    fun <T : DomainEvent> publish(domainEvent: T) {
+        val channel = applicationContext.getBean(domainEvent.channel) as MessageChannel
+
+        log.info("publish ${domainEvent.eventId}")
+
+        channel.send(GenericMessage(domainEvent))
+    }
+}

submodules/commons/src/main/kotlin/com/sns/commons/utils/Logger.kt

@@ -0,0 +1,6 @@
+package com.sns.commons.utils
+
+import org.slf4j.Logger
+import org.slf4j.LoggerFactory
+
+inline fun <reified T : Any> T.log(): Logger = LoggerFactory.getLogger(T::class.java)

user-api/src/main/kotlin/com/sns/user/component/test/domains/TestUser.kt

@@ -1,19 +1,19 @@
 package com.sns.user.component.test.domains
 
+import com.sns.commons.DomainEvent
 import com.sns.user.component.test.dtos.LaughingEvent
 import org.springframework.data.annotation.Id
-import org.springframework.data.domain.AbstractAggregateRoot
 import org.springframework.jdbc.core.BeanPropertyRowMapper
 import org.springframework.jdbc.core.RowMapper
 
 data class TestUser(
     val nickName: String = "anonymous"
-) : AbstractAggregateRoot<TestUser>() {
+) {
     @Id
     private var id: Int? = null
 
-    fun happy() {
-        registerEvent(LaughingEvent(nickName))
+    fun happy(publish: (DomainEvent) -> Unit = { _ -> }) {
+        publish(LaughingEvent(nickName))
     }
 
     companion object {

user-api/src/main/kotlin/com/sns/user/component/test/dtos/LaughingEvent.kt

@@ -1,5 +1,12 @@
 package com.sns.user.component.test.dtos
 
-import com.sns.user.core.supports.DomainEvent
+import com.sns.commons.DomainEvent
+import com.sns.user.core.config.IntegrationConfig
 
-class LaughingEvent(val who: String) : DomainEvent
+class LaughingEvent(val who: String) : DomainEvent {
+    // FIMXE 예제용 임시 포맷
+    override val eventId: String
+        get() = "$channel-$who-${System.currentTimeMillis()}"
+
+    override val channel = IntegrationConfig.Channels.EMOTION
+}

user-api/src/main/kotlin/com/sns/user/component/test/listeners/EmotionListener.kt

@@ -1,24 +1,14 @@
 package com.sns.user.component.test.listeners
 
+import com.sns.commons.annotation.CustomEventListener
+import com.sns.commons.utils.log
 import com.sns.user.component.test.dtos.LaughingEvent
-import org.slf4j.LoggerFactory
-import org.springframework.context.event.EventListener
-import org.springframework.core.annotation.Order
-import org.springframework.stereotype.Component
 
-@Component
+@CustomEventListener
 class EmotionListener {
-    val log = LoggerFactory.getLogger(javaClass)
+    private val log = log()
 
-    @EventListener(LaughingEvent::class)
-    @Order(1)
     fun onLaughing(event: LaughingEvent) {
         log.error("${event.who} is laughing")
     }
-
-    @EventListener
-    @Order(2)
-    fun actionLaughing(event: LaughingEvent) {
-        log.error("하 하 하")
-    }
 }

user-api/src/main/kotlin/com/sns/user/component/test/repositories/DefaultTestUserRepository.kt

@@ -1,22 +1,23 @@
 package com.sns.user.component.test.repositories
 
+import com.sns.commons.utils.log
 import com.sns.user.component.test.domains.TestUser
-import org.slf4j.LoggerFactory
+import org.springframework.data.repository.CrudRepository
 import org.springframework.jdbc.core.JdbcTemplate
 import org.springframework.stereotype.Repository
 
 @Repository
-class DefaultTestUserRepository(val jdbcTemplate: JdbcTemplate) : TestUserRepository {
-    private val log = LoggerFactory.getLogger(javaClass)
+class DefaultTestUserRepository(
+    private val jdbcTemplate: JdbcTemplate,
+    private val testUserCRUDRepository: TestUserCRUDRepository
+) : TestUserRepository,
+    CrudRepository<TestUser, Int> by testUserCRUDRepository {
+    private val log = log()
 
     override fun save(nickName: String): Int {
         return jdbcTemplate.update("INSERT INTO test_user (`nick_name`) VALUES(?)", nickName)
     }
 
-    override fun save(user: TestUser): Int {
-        return jdbcTemplate.update("INSERT INTO test_user (`nick_name`) VALUES(?)", user.nickName)
-    }
-
     override fun findByNickName(nickName: String): TestUser {
         return jdbcTemplate.queryForObject(
             """
@@ -25,7 +26,7 @@ class DefaultTestUserRepository(val jdbcTemplate: JdbcTemplate) : TestUserReposi
                 WHERE nick_name = ?
                 LIMIT 1
             """,
-            TestUser.MAPPER, nickName
+            TestUser.MAPPER, nickName,
         ) ?: TestUser()
     }
 }

user-api/src/main/kotlin/com/sns/user/component/test/repositories/TestUserRepository.kt

@@ -1,9 +1,11 @@
 package com.sns.user.component.test.repositories
 
 import com.sns.user.component.test.domains.TestUser
+import org.springframework.data.repository.CrudRepository
+import org.springframework.data.repository.NoRepositoryBean
 
-interface TestUserRepository {
+@NoRepositoryBean
+interface TestUserRepository : CrudRepository<TestUser, Int> {
     fun save(nickName: String): Int
-    fun save(user: TestUser): Int
     fun findByNickName(nickName: String): TestUser
 }

user-api/src/main/kotlin/com/sns/user/core/config/IntegrationConfig.kt

@@ -0,0 +1,26 @@
+package com.sns.user.core.config
+
+import com.sns.commons.config.IntegrationEventBaseConfig
+import com.sns.user.component.test.dtos.LaughingEvent
+import com.sns.user.component.test.listeners.EmotionListener
+import org.springframework.context.annotation.Bean
+import org.springframework.context.annotation.Configuration
+import org.springframework.context.annotation.Import
+import org.springframework.integration.dsl.integrationFlow
+
+@Import(IntegrationEventBaseConfig::class)
+@Configuration
+class IntegrationConfig {
+
+    @Bean
+    fun emotionFlow(emotionListener: EmotionListener) = integrationFlow {
+        channel { publishSubscribe(Channels.EMOTION) }
+        handle<LaughingEvent> { event, _ ->
+            emotionListener.onLaughing(event)
+        }
+    }
+
+    object Channels {
+        const val EMOTION = "EMOTION_CHANNEL"
+    }
+}

user-api/src/main/kotlin/com/sns/user/core/supports/DomainEvent.kt

@@ -1,31 +1,28 @@
 package com.sns.user.components.test
 
 import com.ninjasquad.springmockk.SpykBean
+import com.sns.commons.service.EventPublisher
 import com.sns.user.component.test.domains.TestUser
 import com.sns.user.component.test.listeners.EmotionListener
-import com.sns.user.component.test.repositories.TestUserCRUDRepository
 import com.sns.user.component.test.repositories.TestUserRepository
 import io.mockk.verify
 import org.assertj.core.api.Assertions.assertThat
 import org.assertj.core.api.Assumptions
 import org.junit.jupiter.api.DisplayName
 import org.junit.jupiter.api.Tag
 import org.junit.jupiter.api.Test
-import org.junit.jupiter.api.extension.ExtendWith
 import org.junit.jupiter.params.ParameterizedTest
 import org.junit.jupiter.params.provider.ValueSource
 import org.springframework.beans.factory.annotation.Autowired
 import org.springframework.boot.test.context.SpringBootTest
 import org.springframework.test.annotation.Rollback
-import org.springframework.test.context.junit.jupiter.SpringExtension
 
 @Tag("init-test")
-@ExtendWith(SpringExtension::class)
 @Rollback
 @SpringBootTest
 class TestUserRepositoryTest @Autowired constructor(
     val repository: TestUserRepository,
-    val crudRepository: TestUserCRUDRepository,
+    val eventPublisher: EventPublisher
 ) {
 
     @SpykBean
@@ -40,24 +37,14 @@ class TestUserRepositoryTest @Autowired constructor(
     }
 
     @Test
-    @DisplayName("CRUDRepository.save 호출시 이벤트 리스너 동작.")
+    @DisplayName("repository.save 호출시 이벤트 리스너 동작.")
     fun laughing_on_crud_repo() {
         val user = TestUser(nickName = "NEW_USER")
-        user.happy()
-        crudRepository.save(user)
-
-        verify(exactly = 1) { emotionListener.actionLaughing(any()) }
-        verify(exactly = 1) { emotionListener.onLaughing(any()) }
-    }
-
-    @Test
-    @DisplayName("일반 @Repository.save 호출시 이벤트 리스너 미동작.")
-    fun laughing_on_normal_repo() {
-        val user = TestUser(nickName = "NEW_USER")
-        user.happy()
+        user.happy() {
+            eventPublisher.publish(it)
+        }
         repository.save(user)
 
-        verify(exactly = 0) { emotionListener.actionLaughing(any()) }
-        verify(exactly = 0) { emotionListener.onLaughing(any()) }
+        verify(exactly = 1) { emotionListener.onLaughing(any()) }
     }
 }