Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 8 commits into from
Jun 8, 2024
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 91 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
HELP.md
.gradle
build/
!gradle/wrapper/gradle-wrapper.jar
!**/src/main/**/build/
!**/src/test/**/build/


### STS ###
.apt_generated
.classpath
.factorypath
.project
.settings
.springBeans
.sts4-cache
bin/
!**/src/main/**/bin/
!**/src/test/**/bin/

### IntelliJ IDEA ###
.idea
*.iws
*.iml
*.ipr
out/
!**/src/main/**/out/
!**/src/test/**/out/

### NetBeans ###
/nbproject/private/
/nbbuild/
/dist/
/nbdist/
/.nb-gradle/

### VS Code ###
.vscode/

.DS_Store
.env
*.dylib
Footer

# User-specific stuff
.idea/**/workspace.xml
.idea/**/tasks.xml
.idea/**/usage.statistics.xml
.idea/**/dictionaries
.idea/**/shelf

# AWS User-specific
.idea/**/aws.xml

# Generated files
.idea/**/contentModel.xml

# Sensitive or high-churn files
.idea/**/dataSources/
.idea/**/dataSources.ids
.idea/**/dataSources.local.xml
.idea/**/sqlDataSources.xml
.idea/**/dynamic.xml
.idea/**/uiDesigner.xml
.idea/**/dbnavigator.xml

# Gradle
.idea/**/gradle.xml
.idea/**/libraries

### Java ###
# Compiled class file
*.class

# Log file
*.log

# BlueJ files
*.ctxt

# Mobile Tools for Java (J2ME)
.mtj.tmp/

# Package Files #
*.jar
*.war
*.nar
*.ear
*.zip
*.tar.gz
*.rar

This comment was marked as duplicate.

5 changes: 5 additions & 0 deletions api/build.gradle.kts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
dependencies {
/** spring starter */
implementation("org.springframework.boot:spring-boot-starter-webflux")
implementation("org.springframework.boot:spring-boot-starter-actuator")
}

This comment was marked as duplicate.

11 changes: 11 additions & 0 deletions api/src/main/kotlin/com/few/ApiMain.kt
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
package com.few

import org.springframework.boot.autoconfigure.SpringBootApplication
import org.springframework.boot.runApplication

@SpringBootApplication
class ApiMain

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

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

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

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

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

124 changes: 124 additions & 0 deletions build.gradle.kts
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
import org.jetbrains.kotlin.gradle.tasks.KotlinCompile

plugins {
kotlin("jvm") version DependencyVersion.KOTLIN
kotlin("plugin.spring") version DependencyVersion.KOTLIN
kotlin("plugin.allopen") version DependencyVersion.KOTLIN
kotlin("kapt") version DependencyVersion.KOTLIN

/** spring */
id("org.springframework.boot") version DependencyVersion.SPRING_BOOT
id("io.spring.dependency-management") version DependencyVersion.SPRING_DEPENDENCY_MANAGEMENT

/** ktlint */
id("org.jlleitschuh.gradle.ktlint") version DependencyVersion.KTLINT

/** docs */
id("org.asciidoctor.jvm.convert") version DependencyVersion.ASCIIDOCTOR
id("com.epages.restdocs-api-spec") version DependencyVersion.EPAGES_REST_DOCS_API_SPEC
id("org.hidetake.swagger.generator") version DependencyVersion.SWAGGER_GENERATOR
}

java.sourceCompatibility = JavaVersion.VERSION_17

allprojects {
group = "com.few"

apply(plugin = "org.jetbrains.kotlin.jvm")
apply(plugin = "org.jetbrains.kotlin.plugin.spring")

repositories {
mavenCentral()
}

tasks.withType<KotlinCompile> {
kotlinOptions {
freeCompilerArgs = listOf("-Xjsr305=strict")
}
}

tasks.withType<Wrapper> {
gradleVersion = "8.5"
}

tasks.withType<Test> {
useJUnitPlatform()
}
}

tasks.getByName("bootJar") {
enabled = false
}

subprojects {
apply(plugin = "org.springframework.boot")
apply(plugin = "io.spring.dependency-management")
apply(plugin = "org.jetbrains.kotlin.plugin.allopen")
apply(plugin = "org.jetbrains.kotlin.kapt")
apply(plugin = "org.jlleitschuh.gradle.ktlint")
apply(plugin = "org.hidetake.swagger.generator")

/**
* https://kotlinlang.org/docs/reference/compiler-plugins.html#spring-support
* automatically supported annotation
* @Component, @Async, @Transactional, @Cacheable, @SpringBootTest,
* @Configuration, @Controller, @RestController, @Service, @Repository.
* jpa meta-annotations not automatically opened through the default settings of the plugin.spring
*/
allOpen {
}

dependencies {
/** spring starter */
implementation("org.springframework.boot:spring-boot-starter-validation")
kapt("org.springframework.boot:spring-boot-configuration-processor")

/** kotlin */
implementation("org.jetbrains.kotlin:kotlin-reflect")
implementation("org.jetbrains.kotlinx:kotlinx-coroutines-slf4j")
implementation("org.jetbrains.kotlinx:kotlinx-coroutines-reactor")
implementation("io.projectreactor.kotlin:reactor-kotlin-extensions")
implementation("com.fasterxml.jackson.module:jackson-module-kotlin")

/** logger */
implementation("net.logstash.logback:logstash-logback-encoder:${DependencyVersion.LOGBACK_ENCODER}")

/** test **/
testImplementation("org.springframework.boot:spring-boot-starter-test")
testImplementation("io.mockk:mockk:${DependencyVersion.MOCKK}")
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

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

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

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

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

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

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


/** kotest */
testImplementation("io.kotest:kotest-runner-junit5:${DependencyVersion.KOTEST}")
testImplementation("io.kotest:kotest-assertions-core:${DependencyVersion.KOTEST}")
testImplementation("io.kotest.extensions:kotest-extensions-spring:${DependencyVersion.KOTEST_EXTENSION}")
testImplementation("org.jetbrains.kotlinx:kotlinx-coroutines-test:${DependencyVersion.COROUTINE_TEST}")

/** swagger */
swaggerUI("org.webjars:swagger-ui:${DependencyVersion.SWAGGER_UI}")
}

tasks.getByName("bootJar") {
enabled = false
}

tasks.getByName("jar") {
enabled = true
}

defaultTasks("bootRun")
}

/** Build Docker Image */
val imageName = project.hasProperty("imageName") ?: "api:local"
val releaseVersion = project.findProperty("releaseVersion")

tasks.create("buildDockerImage") {
dependsOn(":bootJar")

doLast {
exec {
workingDir(".")
commandLine("docker", "build", "-t", imageName, "--build-arg", "RELEASE_VERSION=$releaseVersion", ".")
}
}
}

This comment was marked as duplicate.

7 changes: 7 additions & 0 deletions buildSrc/build.gradle.kts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
plugins {
`kotlin-dsl`
}

repositories {
mavenCentral()
}

This comment was marked as duplicate.

30 changes: 30 additions & 0 deletions buildSrc/src/main/kotlin/DependencyVersion.kt
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
object DependencyVersion {
/** kotlinVersion */
const val KOTLIN = "1.9.24"

/** ktlint */
const val KTLINT = "11.6.1"

/** springBootVersion */
const val SPRING_BOOT = "3.2.5"

/** springDependencyManagementVersion */
const val SPRING_DEPENDENCY_MANAGEMENT = "1.1.5"

/** log */
const val LOGBACK_ENCODER = "7.4"

/** test */
const val MOCKK = "1.13.9"
const val KOTEST = "5.8.0"
const val KOTEST_EXTENSION = "1.1.3"
const val COROUTINE_TEST = "1.8.0"

/** docs */
const val ASCIIDOCTOR = "3.3.2"
const val EPAGES_REST_DOCS_API_SPEC = "0.16.0"

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

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

재검토 해야할 사항:

  1. 의존성 업데이트: 라이브러리들의 최신 버전과 비교하여 업데이트가 필요한지 살펴볼 필요가 있다. 단, 이 작업은 호환성 문제를 반드시 고려해야 합니다.
  2. 문서화: 주석 혹은 문서화 부분이 부족하여 각 상수가 적용되는 범위나 사용 동기를 명확하게 이해하기 어렵습니다. 설명 추가를 권장드립니다.

구조적 개선:

  1. 모듈 별로 분리: 만약 여러 모듈이나 파트가 있을 경우, 모듈별로 의존성 버전 정보를 나누는 것이 관리 측면에서 좋을 수 있습니다.
  2. 관리 툴 활용: Gradle의 dependencies 블록이나 Maven의 dependencyManagement 섹션처럼 구조화된 방법을 사용해 버전 관리를 하는 것이 좋을 수 있습니다. 이 구조는, 의존성 충돌에 대한 대응, 다른 프로젝트로부터 의존성 정보를 재사용하거나 일관된 버전 관리를 더 쉽게 할 수 있게 도와줍니다.

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

Binary file added gradle/wrapper/gradle-wrapper.jar
Binary file not shown.
7 changes: 7 additions & 0 deletions gradle/wrapper/gradle-wrapper.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-8.8-bin.zip
networkTimeout=10000
validateDistributionUrl=true
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists

This comment was marked as duplicate.

Loading
Loading