feat: API 모듈을 추가합니다 #20

belljun3395 · 2024-06-07T17:27:00Z

🎫 연관 이슈

resolved: #15

💁‍♂️ PR 내용

API 모듈을 추가합니다

🙏 작업

가장 기본적인 의존성 추가
- webflux
- actuator

🙈 PR 참고 사항

📸 스크린샷

🤖 테스트 체크리스트

체크 미완료
체크 완료

.gitignore

+*.ear
+*.zip
+*.tar.gz
+*.rar


api/build.gradle.kts

+    /** spring starter */
+    implementation("org.springframework.boot:spring-boot-starter-webflux")
+    implementation("org.springframework.boot:spring-boot-starter-actuator")
+}


github-actions · 2024-06-07T17:28:13Z

api/src/main/kotlin/com/few/ApiMain.kt

+
+fun main(args: Array<String>) {
+    runApplication<ApiMain>(*args)
+}


이 코드조각은 간단한 Spring Boot 애플리케이션을 시작하는 데 사용되며 크게 문제가 없어 보입니다. 다음은 향후 유지보수성 및 확장성을 위해 고려할 수 있는 몇 가지 사항입니다:

더 많은 구성: 이 애플리케이션은 단순하니까 아무런 설정도 필요하지 않습니다. 그러나 실제로는 애플리케이션에 프로퍼티 파일(application.properties 또는 application.yaml)과 같은 구성 요소가 포함되어 있어야합니다.

로그 설정: 프로젝트에 로그 설정이 있는지 확인하십시오. 스프링 부트는 기본적으로 내부 로그백으로 구성되어 있지만, 로그 레벨이나 패턴 등 작업 요구에 따라 수정해야 할 수도 있습니다.

테스트: 시스템을 운영하는 데 필요한 테스트 코드가 없습니다. 간단한 애플리케이션의 경우 필요하지 않을 수 있지만, 일반적으로 단위 테스트와 통합 테스트를 추가하는 것이 좋습니다. 이는 JUnit, Mockito, MockMvc 등의 도구들을 사용해서 가능합니다.

버그 위험은 존재하지 않으나, 위의 제안을 고려하는 것이 좋습니다.

build.gradle.kts

+            commandLine("docker", "build", "-t", imageName, "--build-arg", "RELEASE_VERSION=$releaseVersion", ".")
+        }
+    }
+}


buildSrc/build.gradle.kts

+
+repositories {
+    mavenCentral()
+}


github-actions · 2024-06-07T17:29:31Z

buildSrc/src/main/kotlin/DependencyVersion.kt

+    /** swagger */
+    const val SWAGGER_GENERATOR = "2.18.2"
+    const val SWAGGER_UI = "4.11.1"
+}


이 코드 패치는 특정 의존성의 버전을 관리하기 위한 Kotlin 코드로 보입니다. 여기에 대한 코드 검토 결과는 다음과 같습니다:

정확한 버전 관리: 라이브러리들의 버전이 명시적으로 정의되어 있어서 프로젝트의 안정성을 보장합니다.

재검토 해야할 사항:

의존성 업데이트: 라이브러리들의 최신 버전과 비교하여 업데이트가 필요한지 살펴볼 필요가 있다. 단, 이 작업은 호환성 문제를 반드시 고려해야 합니다.

문서화: 주석 혹은 문서화 부분이 부족하여 각 상수가 적용되는 범위나 사용 동기를 명확하게 이해하기 어렵습니다. 설명 추가를 권장드립니다.

구조적 개선:

모듈 별로 분리: 만약 여러 모듈이나 파트가 있을 경우, 모듈별로 의존성 버전 정보를 나누는 것이 관리 측면에서 좋을 수 있습니다.

관리 툴 활용: Gradle의 dependencies 블록이나 Maven의 dependencyManagement 섹션처럼 구조화된 방법을 사용해 버전 관리를 하는 것이 좋을 수 있습니다. 이 구조는, 의존성 충돌에 대한 대응, 다른 프로젝트로부터 의존성 정보를 재사용하거나 일관된 버전 관리를 더 쉽게 할 수 있게 도와줍니다.

버그 리스크:
현재 제시된 코드에서는 직접적인 버그를 유발할 수 있는 요소가 보이지 않습니다. 그러나 위에서 언급한 바와 같이 의존성 버전들은 정기적으로 검토하고 최신 상태로 유지해야합니다.

gradle/wrapper/gradle-wrapper.properties

+networkTimeout=10000
+validateDistributionUrl=true
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists


gradlew

+        tr '\n' ' '
+    )" '"$@"'
+
+exec "$JAVACMD" "$@"


gradlew.bat

+:mainEnd
+if "%OS%"=="Windows_NT" endlocal
+
+:omega


settings.gradle.kts

@@ -0,0 +1,3 @@
+rootProject.name = "few"
+
+include("api")


github-actions · 2024-06-08T10:55:18Z

build.gradle.kts

@@ -79,7 +79,7 @@ subprojects {
        implementation("org.jetbrains.kotlinx:kotlinx-coroutines-reactor")
        implementation("io.projectreactor.kotlin:reactor-kotlin-extensions")
        implementation("com.fasterxml.jackson.module:jackson-module-kotlin")
-
+        
        /** test **/
        testImplementation("org.springframework.boot:spring-boot-starter-test")
        testImplementation("io.mockk:mockk:${DependencyVersion.MOCKK}")


이 코드 패치는 Gradle 상의 프로젝트 의존성 관련 선언을 보여주고 있습니다. 아래는 코멘트입니다:

변경된 부분에서 기존 줄 사이의 공백(-)이 추가 공백(+)으로 바뀌었습니다. 이는 실질적인 코드 변화가 없음을 의미하므로, 이러한 공백 변경은 불필요할 수 있습니다.

새로운 의존성은 추가되지 않았으며, 현재 명시된 모든 의존성이 잘 유지되고 있습니다.

각각의 의존성 개별에 대해 따로 리뷰를 해야 할 필요가 있다면, 해당 패키지들이 가장 최근 안전한 버전으로 지정되어 있는지 확인해보세요.

의존성에 사용되는 버전이 하드코딩되기보다 'DependencyVersion.MOCKK'와 같이 중앙 관리하는 방식이 사용되어 좋습니다. 이 접근법은 프로젝트 전체에서 일관된 버전 관리를 용이하게 합니다.

마지막으로, 각 의존성이 정말 필요한 것인지 다시 한번 검토하세요. 불필요한 의존성은 프로젝트의 복잡성을 증가시키고, 빌드 및 배포 시간을 늘릴 수 있습니다.

참고: 이 코드 리뷰는 변경된 코드에 한정되며, 전체 프로젝트 컨텍스트를 제공하지 않습니다.

belljun3395 added 7 commits June 7, 2024 22:52

feat: 스프링 프로젝트 추가

0cb84dc

feat: buildSrc 모듈 추가

2778360

feat: DependencyVersion 추가

7fcfd72

feat: 프로젝트 root gradle 설정 추가

19523c5

feat: buildDockerImage 테스크 추가

95fca5d

feat: api 모듈 추가

8fd929e

feat: api 모듈 spring starter 추가

64f8289

github-actions bot assigned belljun3395 Jun 7, 2024

github-actions bot added the feature 새로운 기능을 만들 때 사용됩니다 label Jun 7, 2024