Merge pull request #533 from DSM-PICK/473-fcm-리펙토링

473 fcm 리펙토링

Author: ByunDohwi

build.gradle.kts

@@ -79,6 +79,8 @@ dependencies {
     implementation(Dependencies.SMTP)
 
     implementation(Dependencies.GOOGLE_OAUTH)
+
+    implementation(Dependencies.KAFKA)
 }
 
 tasks.withType<KotlinCompile> {

buildSrc/src/main/kotlin/Dependencies.kt

@@ -1,47 +1,35 @@
 object Dependencies {
-    // kotlin
     const val KOTLIN_REFLECT = "org.jetbrains.kotlin:kotlin-reflect"
     const val JACKSON = "com.fasterxml.jackson.module:jackson-module-kotlin:${DependencyVersions.JACKSON_VERSION}"
     const val JACKSON_TYPE = "com.fasterxml.jackson.datatype:jackson-datatype-jsr310:${DependencyVersions.JACKSON_VERSION}"
 
-    // web
     const val SPRING_WEB = "org.springframework.boot:spring-boot-starter-web"
 
     const val REDIS = "org.springframework.boot:spring-boot-starter-data-redis:${DependencyVersions.REDIS_VERSION}"
 
-    // database
     const val SPRING_DATA_JPA = "org.springframework.boot:spring-boot-starter-data-jpa:${PluginVersions.SPRING_BOOT_VERSION}"
     const val MYSQL_CONNECTOR = "mysql:mysql-connector-java:${DependencyVersions.MYSQL}"
     const val SPRING_REDIS = "org.springframework.boot:spring-boot-starter-data-redis:${PluginVersions.SPRING_BOOT_VERSION}"
 
-    // security
     const val SPRING_SECURITY = "org.springframework.boot:spring-boot-starter-security"
 
-    // test
     const val SPRING_TEST = "org.springframework.boot:spring-boot-starter-test:${PluginVersions.SPRING_BOOT_VERSION}"
 
-    // open feign
     const val OPEN_FEIGN = "org.springframework.cloud:spring-cloud-starter-openfeign:${DependencyVersions.OPEN_FEIGN_VERSION}"
 
-    // validation
     const val SPRING_VALIDATION = "org.springframework.boot:spring-boot-starter-validation"
 
-    // json
     const val JSON = "org.json:json:${DependencyVersions.JSON_VERSION}"
 
-    // Jwt
     const val JWT = "io.jsonwebtoken:jjwt:${DependencyVersions.JWT_VERSION}"
 
-    // cloud
     const val SPRING_CLOUD = "org.springframework.cloud:spring-cloud-dependencies:${DependencyVersions.SPRING_CLOUD_VERSION}"
 
     const val SWAGGER = "org.springdoc:springdoc-openapi-ui:${DependencyVersions.SWAGGER_VERSION}"
 
-    // QueryDSL
     const val QUERYDSL = "com.querydsl:querydsl-jpa:${DependencyVersions.QUERYDSL}"
     const val QUERYDSL_PROCESSOR = "com.querydsl:querydsl-apt:${DependencyVersions.QUERYDSL}:jpa"
 
-    // apachePOI
     const val APACHE_POI = "org.apache.poi:poi:${DependencyVersions.APACHE_POI}"
     const val APACHE_POI_OOXML = "org.apache.poi:poi-ooxml:${DependencyVersions.APACHE_POI}"
 
@@ -59,7 +47,7 @@ object Dependencies {
 
     const val GOOGLE_OAUTH = "com.google.auth:google-auth-library-oauth2-http:${DependencyVersions.GOOGLE_OAUTH2}"
 
-
-    //smtp
     const val SMTP = "org.springframework.boot:spring-boot-starter-mail"
+
+    const val KAFKA = "org.springframework.kafka:spring-kafka:${DependencyVersions.KAFKA}"
 }

buildSrc/src/main/kotlin/DependencyVersions.kt

@@ -13,4 +13,5 @@ object DependencyVersions {
     const val AWS = "1.12.281"
     const val FCM = "8.1.0"
     const val GOOGLE_OAUTH2 = "1.17.0"
+    const val KAFKA = "2.9.13"
 }

src/main/kotlin/dsm/pick2024/domain/application/service/ApplicationService.kt

@@ -11,7 +11,11 @@ import dsm.pick2024.domain.application.port.out.SaveApplicationPort
 import dsm.pick2024.domain.application.presentation.dto.request.ApplicationRequest
 import dsm.pick2024.domain.event.dto.UserInfoRequest
 import dsm.pick2024.domain.event.enums.EventTopic
+import dsm.pick2024.domain.fcm.dto.request.FcmRequest
 import dsm.pick2024.domain.fcm.port.out.FcmSendPort
+import dsm.pick2024.domain.outbox.domain.Outbox
+import dsm.pick2024.domain.outbox.enum.EventType
+import dsm.pick2024.domain.outbox.port.out.SaveOutboxPort
 import dsm.pick2024.domain.user.port.`in`.UserFacadeUseCase
 import org.springframework.context.ApplicationEventPublisher
 import org.springframework.stereotype.Service
@@ -26,7 +30,8 @@ class ApplicationService(
     private val userFacadeUseCase: UserFacadeUseCase,
     private val eventPublisher: ApplicationEventPublisher,
     private val fcmSendPort: FcmSendPort,
-    private val adminFinderUseCase: AdminFinderUseCase
+    private val adminFinderUseCase: AdminFinderUseCase,
+    private val saveOutboxPort: SaveOutboxPort
 ) : ApplicationUseCase {
 
     @Transactional
@@ -52,18 +57,22 @@ class ApplicationService(
                 applicationKind = ApplicationKind.APPLICATION
             )
         )
+
         val deviceToken = adminFinderUseCase.findByGradeAndClassNumOrThrow(
             grade = user.grade,
             classNum = user.classNum
         ).deviceToken
 
-        deviceToken?.let {
-            fcmSendPort.send(
-                deviceToken = it,
-                title = "[PiCK] ${user.grade}학년 ${user.classNum}반 ${user.num}번 ${user.name} 학생이 외출을 신청했습니다.",
-                body = "사유: ${request.reason}"
+        saveOutboxPort.saveOutbox(
+            Outbox(
+                payload = FcmRequest(
+                    tokens = listOf(deviceToken),
+                    title = "[PiCK] ${user.grade}학년 ${user.classNum}반 ${user.num}번 ${user.name} 학생이 외출을 신청했습니다.",
+                    body = "사유: ${request.reason}"
+                ),
+                eventType = EventType.NOTIFICATION
             )
-        }
+        )
 
         eventPublisher.publishEvent(UserInfoRequest(EventTopic.HANDLE_EVENT, user.id))
     }

src/main/kotlin/dsm/pick2024/domain/application/service/ChangeApplicationStatusService.kt

@@ -31,7 +31,7 @@ class ChangeApplicationStatusService(
             userFacadeUseCase.getUserById(
                 it.userId
             ).deviceToken
-        }.filter { it.isNotBlank() }
+        }
 
         if (request.status == Status.OK) {
             approvalProcessor.process(applications, admin.name, deviceTokens)

src/main/kotlin/dsm/pick2024/domain/application/service/processor/ApplicationApprovalProcessor.kt

@@ -11,9 +11,10 @@ import dsm.pick2024.domain.attendance.port.`in`.AttendanceFinderUseCase
 import dsm.pick2024.domain.attendance.port.out.SaveAttendancePort
 import dsm.pick2024.domain.event.dto.ChangeStatusRequest
 import dsm.pick2024.domain.event.enums.EventTopic
-import dsm.pick2024.domain.fcm.port.out.FcmSendPort
+import dsm.pick2024.domain.outbox.port.`in`.OutboxFacadeUseCase
 import org.springframework.context.ApplicationEventPublisher
 import org.springframework.stereotype.Service
+import org.springframework.transaction.annotation.Transactional
 
 @Service
 class ApplicationApprovalProcessor(
@@ -23,9 +24,10 @@ class ApplicationApprovalProcessor(
     private val saveAttendancePort: SaveAttendancePort,
     private val attendanceService: AttendanceService,
     private val eventPublisher: ApplicationEventPublisher,
-    sendMessageUseCase: FcmSendPort
-) : ApplicationStatusProcessor(sendMessageUseCase) {
+    outboxFacadeUseCase: OutboxFacadeUseCase
+) : ApplicationStatusProcessor(outboxFacadeUseCase) {
 
+    @Transactional
     override fun process(applications: List<Application>, adminName: String, deviceTokens: List<String>) {
         val updateApplications = applications.map { it.copy(teacherName = adminName, status = Status.OK) }
 

src/main/kotlin/dsm/pick2024/domain/application/service/processor/ApplicationRejectionProcessor.kt

@@ -4,17 +4,19 @@ import dsm.pick2024.domain.application.domain.Application
 import dsm.pick2024.domain.application.enums.ApplicationKind
 import dsm.pick2024.domain.application.port.out.DeleteApplicationPort
 import dsm.pick2024.domain.event.dto.ChangeStatusRequest
-import dsm.pick2024.domain.fcm.port.out.FcmSendPort
+import dsm.pick2024.domain.outbox.port.`in`.OutboxFacadeUseCase
 import org.springframework.context.ApplicationEventPublisher
 import org.springframework.stereotype.Service
+import org.springframework.transaction.annotation.Transactional
 
 @Service
 class ApplicationRejectionProcessor(
     private val deleteApplicationPort: DeleteApplicationPort,
     private val eventPublisher: ApplicationEventPublisher,
-    sendMessageUseCase: FcmSendPort
-) : ApplicationStatusProcessor(sendMessageUseCase) {
+    private val outboxFacadeUseCase: OutboxFacadeUseCase
+) : ApplicationStatusProcessor(outboxFacadeUseCase) {
 
+    @Transactional
     override fun process(applications: List<Application>, adminName: String, deviceTokens: List<String>) {
         applications.forEach {
             deleteApplicationPort.deleteByIdAndApplicationKind(it.id!!, ApplicationKind.APPLICATION)

src/main/kotlin/dsm/pick2024/domain/application/service/processor/ApplicationStatusProcessor.kt

@@ -1,14 +1,18 @@
 package dsm.pick2024.domain.application.service.processor
 
 import dsm.pick2024.domain.application.domain.Application
-import dsm.pick2024.domain.fcm.port.out.FcmSendPort
+import dsm.pick2024.domain.outbox.port.`in`.OutboxFacadeUseCase
 
 abstract class ApplicationStatusProcessor(
-    private val sendMessageUseCase: FcmSendPort
+    private val outboxFacadeUseCase: OutboxFacadeUseCase
 ) {
     abstract fun process(applications: List<Application>, adminName: String, deviceTokens: List<String>)
 
-    protected fun sendNotification(title: String, message: String, deviceTokens: List<String>) {
-        sendMessageUseCase.sendAll(deviceTokens, title, message)
+    protected fun sendNotification(title: String, message: String, deviceTokens: List<String?>) {
+        outboxFacadeUseCase.sendNotificationAll(
+            title = title,
+            deviceToken = deviceTokens,
+            body = message
+        )
     }
 }

src/main/kotlin/dsm/pick2024/domain/earlyreturn/service/CreateEarlyReturnService.kt

@@ -12,6 +12,7 @@ import dsm.pick2024.domain.earlyreturn.port.`in`.CreateEarlyReturnUseCase
 import dsm.pick2024.domain.earlyreturn.presentation.dto.request.CreateEarlyReturnRequest
 import dsm.pick2024.domain.event.dto.UserInfoRequest
 import dsm.pick2024.domain.fcm.port.out.FcmSendPort
+import dsm.pick2024.domain.outbox.port.`in`.OutboxFacadeUseCase
 import dsm.pick2024.domain.user.port.`in`.UserFacadeUseCase
 import org.springframework.context.ApplicationEventPublisher
 import org.springframework.stereotype.Service
@@ -26,7 +27,8 @@ class CreateEarlyReturnService(
     private val userFacadeUseCase: UserFacadeUseCase,
     private val eventPublisher: ApplicationEventPublisher,
     private val adminFinderUseCase: AdminFinderUseCase,
-    private val fcmSendPort: FcmSendPort
+    private val fcmSendPort: FcmSendPort,
+    private val outboxFacadeUseCase: OutboxFacadeUseCase
 ) : CreateEarlyReturnUseCase {
     @Transactional
     override fun createEarlyReturn(request: CreateEarlyReturnRequest) {
@@ -57,7 +59,7 @@ class CreateEarlyReturnService(
         ).deviceToken
 
         deviceToken?.let {
-            fcmSendPort.send(
+            outboxFacadeUseCase.sendNotification(
                 deviceToken = it,
                 title = "[PiCK] ${user.grade}학년 ${user.classNum}반 ${user.num}번 ${user.name} 학생이 조기귀가를 신청했습니다.",
                 body = "사유: ${request.reason}"

src/main/kotlin/dsm/pick2024/domain/earlyreturn/service/QueryAllOKEarlyReturnService.kt

@@ -18,7 +18,7 @@ class QueryAllOKEarlyReturnService(
 
         queryAllApplicationPort.findAllByApplicationKind(ApplicationKind.EARLY_RETURN)
             .filter { it.status == Status.OK }
-            .map { it ->
+            .map {
                 QueryAllOKEarlyReturnResponse(it)
             }.distinctBy { it.id }.sortedWith(compareBy({ it.grade }, { it.classNum }, { it.num }))
 }