Merge pull request #30 from EntryDSM/feature/28-school-info

feature/28-school-info

Author: qkrwndnjs1075

buildSrc/src/main/kotlin/Dependencies.kt

@@ -8,6 +8,7 @@ object Dependencies {
     const val SPRING_BOOT_STARTER_WEB = "org.springframework.boot:spring-boot-starter-web"
     const val SPRING_BOOT_STARTER_TEST = "org.springframework.boot:spring-boot-starter-test"
     const val SPRING_BOOT_STARTER_ACTUATOR  = "org.springframework.boot:spring-boot-starter-actuator"
+    const val SPRING_CONTEXT = "org.springframework:spring-context"
 
     //jexl
     const val APACHE_COMMONS_JEXL = "org.apache.commons:commons-jexl3:${DependencyVersions.APACHE_COMMONS_JEXL_VERSION}"
@@ -35,6 +36,12 @@ object Dependencies {
     //commons io
     const val COMMONS_IO = "commons-io:commons-io:${DependencyVersions.COMMONS_IO}"
 
+    // Feign Client
+    const val OPEN_FEIGN = "org.springframework.cloud:spring-cloud-starter-openfeign:${DependencyVersions.OPEN_FEIGN_VERSION}"
+
+    // Spring Cloud BOM
+    const val SPRING_CLOUD = "org.springframework.cloud:spring-cloud-dependencies:${DependencyVersions.SPRING_CLOUD_VERSION}"
+
     // WebFlux
     const val WEB_FLUX = "org.springframework.boot:spring-boot-starter-webflux"
 
@@ -82,5 +89,13 @@ object Dependencies {
     const val SPRING_BOOT_STARTER_DATA_JPA = "org.springframework.boot:spring-boot-starter-data-jpa"
 
     // transaction
-    const val SPRING_TRANSACTION = "org.springframework:spring-tx:${DependencyVersions.SPRING_TRANSACTION}"
-}
+    const val SPRING_TRANSACTION = "org.springframework:spring-tx"
+
+    //spring cache
+    // Redis (캐시)
+    const val REDIS = "org.springframework.boot:spring-boot-starter-data-redis"
+
+    // Cache (스프링 캐시)
+    const val SPRING_CACHE = "org.springframework.boot:spring-boot-starter-cache"
+
+}

buildSrc/src/main/kotlin/DependencyVersions.kt

@@ -1,31 +1,47 @@
 object DependencyVersions {
     // JEXL
     const val APACHE_COMMONS_JEXL_VERSION = "3.5.0"
-    
+
     // Kotlinx Serialization
     const val KOTLINX_SERIALIZATION_VERSION = "1.6.3"
-    
+
     // Kotlinx Coroutines
     const val KOTLINX_COROUTINES_VERSION = "1.8.1"
 
+    // PDF
     const val PDF_ITEXT = "7.2.0"
     const val PDF_HTML = "3.0.3"
+
+    // Apache POI
     const val POI_VERSION = "5.2.3"
+
+    // Commons IO
     const val COMMONS_IO = "2.11.0"
 
-    const val GRPC = "1.61.1"
-    const val GRPC_KOTLIN = "1.4.1"
-    const val PROTOBUF = "3.25.3"
-    const val GRPC_CLIENT = "2.15.0.RELEASE"
-    const val GOOGLE_PROTOBUF = "3.25.3"
+    // Spring Cloud (Feign 포함)
+    const val SPRING_CLOUD_VERSION = "2024.0.0"
+    const val OPEN_FEIGN_VERSION = "3.1.4"
+
+    // gRPC
+    const val GRPC = "1.58.0"  // 1.61.1에서 변경
+    const val GRPC_KOTLIN = "1.4.0"  // 1.4.1에서 변경
+    const val GRPC_CLIENT = "2.15.0.RELEASE"  // 유지
+    const val PROTOBUF = "3.24.0"  // 3.25.3에서 변경
+    const val GOOGLE_PROTOBUF = "3.24.0"  // 3.25.3에서 변경
 
+    // Coroutines (main 쪽 버전, KOTLINX_COROUTINES_VERSION 과 구분됨)
     const val COROUTINES = "1.8.0"
+
+    // MapStruct
     const val MAPSTRUCT = "1.6.0"
 
+    // QueryDSL
     const val QUERYDSL = "5.0.0"
+
+    // Jakarta
     const val JAKARTA_PERSISTENCE = "3.1.0"
     const val JAKARTA_ANNOTATION = "2.1.1"
-    const val CAFFEINE = "3.1.8"
 
-    const val SPRING_TRANSACTION = "5.3.22"
-}
+    // Caffeine
+    const val CAFFEINE = "3.1.8"
+}

buildSrc/src/main/kotlin/Plugins.kt

@@ -8,7 +8,12 @@ object Plugins {
     const val SPRING_DEPENDENCY_MANAGEMENT = "io.spring.dependency-management"
     const val KTLINT = "org.jlleitschuh.gradle.ktlint"
     const val CASPER_CONVENTION = "casper.documentation-convention"
+
+    // feature/28-school-info
+    const val KOTLIN_ALL_OPEN = "org.jetbrains.kotlin.plugin.spring"
+
+    // main 브랜치
     const val KAPT = "kapt"
     const val PROTOBUF = "com.google.protobuf"
     const val ALL_OPEN = "plugin.allopen"
-}
+}

casper-application-domain/build.gradle.kts

@@ -1,11 +1,13 @@
 plugins {
     kotlin(Plugins.KOTLIN_JVM) version PluginVersions.KOTLIN_VERSION
     kotlin(Plugins.KOTLIN_SERIALIZATION) version PluginVersions.KOTLIN_VERSION
+    id(Plugins.KOTLIN_ALL_OPEN) version PluginVersions.KOTLIN_VERSION
 }
 
 version = Projects.APPLICATION_DOMAIN_VERSION
 
 dependencies {
+
     implementation(Dependencies.KOTLINX_SERIALIZATION_JSON)
     implementation(Dependencies.KOTLINX_COROUTINES_CORE)
 

casper-application-domain/src/main/kotlin/hs/kr/entrydsm/domain/school/aggregate/School.kt

@@ -0,0 +1,28 @@
+package hs.kr.entrydsm.domain.school.aggregate
+
+import hs.kr.entrydsm.domain.school.exception.SchoolException
+
+/**
+ * 학교 정보를 담는 데이터 클래스 입니다.
+ *
+ * @property code 학교 코드
+ * @property name 학교 이름
+ * @property tel 학교 전화번호
+ * @property type 학교 타입
+ * @property address 학교 주소
+ * @property regionName 지역 이름
+ */
+data class School(
+    val code: String,
+    val name: String,
+    val tel: String,
+    val type: String,
+    val address: String,
+    val regionName: String
+) {
+    init {
+        check(type == "중학교") {
+            throw SchoolException.InvalidSchoolTypeException(type)
+        }
+    }
+}

casper-application-domain/src/main/kotlin/hs/kr/entrydsm/domain/school/dto/QuerySchoolResponse.kt

@@ -0,0 +1,10 @@
+package hs.kr.entrydsm.domain.school.dto
+
+/**
+ * 학교 검색 결과를 담는 데이터 클래스 입니다.
+ *
+ * @property content 학교 검색 결과 리스트
+ */
+data class QuerySchoolResponse(
+    val content: List<SchoolResponse>
+)

casper-application-domain/src/main/kotlin/hs/kr/entrydsm/domain/school/dto/SchoolResponse.kt

@@ -0,0 +1,16 @@
+package hs.kr.entrydsm.domain.school.dto
+
+/**
+ * 학교 정보를 담는 데이터 클래스 입니다.
+ *
+ * @property code 학교 코드
+ * @property name 학교 이름
+ * @property information 학교 정보
+ * @property address 학교 주소
+ */
+data class SchoolResponse(
+    val code: String,
+    val name: String,
+    val information: String,
+    val address: String
+)

casper-application-domain/src/main/kotlin/hs/kr/entrydsm/domain/school/exception/SchoolException.kt

@@ -0,0 +1,22 @@
+package hs.kr.entrydsm.domain.school.exception
+
+import hs.kr.entrydsm.global.exception.DomainException
+import hs.kr.entrydsm.global.exception.ErrorCode
+
+/**
+ * 학교 관련 최상위 예외 클래스 입니다.
+ */
+sealed class SchoolException(
+    errorCode: ErrorCode,  // override 제거
+    message: String
+) : DomainException(errorCode, message) {
+
+
+    /**
+     * 유효하지 않은 학교 타입일 경우 발생하는 예외입니다.
+     */
+    class InvalidSchoolTypeException(schoolType: String) : SchoolException(
+        errorCode = ErrorCode.SCHOOL_INVALID_TYPE,
+        message = "Invalid school type: $schoolType"
+    )
+}

casper-application-domain/src/main/kotlin/hs/kr/entrydsm/domain/school/interfaces/QuerySchoolContract.kt

@@ -0,0 +1,24 @@
+package hs.kr.entrydsm.domain.school.interfaces
+
+import hs.kr.entrydsm.domain.school.aggregate.School
+
+/**
+ * 학교 정보를 조회하는 Contract 입니다.
+ */
+interface QuerySchoolContract {
+    /**
+     * 학교 이름으로 학교 리스트를 조회합니다.
+     *
+     * @param schoolName 학교 이름
+     * @return 학교 리스트
+     */
+    fun querySchoolListBySchoolName(schoolName: String): List<School>
+
+    /**
+     * 학교 코드로 학교를 조회합니다.
+     *
+     * @param schoolCode 학교 코드
+     * @return 학교 정보
+     */
+    fun querySchoolBySchoolCode(schoolCode: String): School?
+}

casper-application-domain/src/main/kotlin/hs/kr/entrydsm/domain/school/interfaces/QuerySchoolUseCaseContract.kt

@@ -0,0 +1,16 @@
+package hs.kr.entrydsm.domain.school.interfaces
+
+import hs.kr.entrydsm.domain.school.dto.QuerySchoolResponse
+
+/**
+ * 학교 정보를 조회하는 UseCase Contract 입니다.
+ */
+interface QuerySchoolUseCaseContract {
+    /**
+     * 학교 이름으로 학교를 조회합니다.
+     *
+     * @param name 학교 이름
+     * @return 학교 검색 결과
+     */
+    fun querySchool(name: String): QuerySchoolResponse
+}