[feature/12] feat: 온보딩 선택을 등록하는 API 구현

README.md

@@ -0,0 +1,7 @@
+#
+
+# 문서
+swagger: http://localhost:8080/swagger-ui
+
+# 설정
+vm options: `-Duser.timezone=Asia/Seoul`

build.gradle.kts

@@ -4,6 +4,18 @@ plugins {
 	kotlin("plugin.jpa") version "1.9.24"
 	kotlin("jvm") version "1.9.24"
 	kotlin("plugin.spring") version "1.9.24"
+	kotlin("plugin.allopen") version "1.5.31"
+	kotlin("plugin.noarg") version "1.5.31"
+}
+
+allOpen {
+	annotation("javax.persistence.Entity")
+	annotation("javax.persistence.Convert")
+}
+
+noArg {
+	annotation("javax.persistence.Entity")
+	annotation("javax.persistence.Convert")
 }
 
 group = "com.nexters"
@@ -23,13 +35,21 @@ dependencies {
 	implementation("org.springframework.boot:spring-boot-starter-data-jdbc")
 	implementation("org.springframework.boot:spring-boot-starter-data-jpa")
 	implementation("org.springframework.boot:spring-boot-starter-web")
+
+	implementation("io.springfox:springfox-boot-starter:3.0.0")
+	implementation("io.springfox:springfox-swagger-ui:3.0.0")
+
+	implementation("com.fasterxml.jackson.core:jackson-databind:2.15.0")
 	implementation("com.fasterxml.jackson.module:jackson-module-kotlin")
+
+	implementation("io.github.microutils:kotlin-logging:3.0.5")
+	implementation("org.slf4j:slf4j-simple:2.0.7")
+
 	implementation("org.jetbrains.kotlin:kotlin-reflect")
 
 	runtimeOnly("com.h2database:h2")
 	runtimeOnly("mysql:mysql-connector-java")
 
-
 	testImplementation("org.springframework.boot:spring-boot-starter-test")
 	testImplementation("org.jetbrains.kotlin:kotlin-test-junit5")
 	testRuntimeOnly("org.junit.platform:junit-platform-launcher")

src/main/kotlin/com/nexters/bottles/BottlesApplication.kt

@@ -7,5 +7,5 @@ import org.springframework.boot.runApplication
 class BottlesApplication
 
 fun main(args: Array<String>) {
-	runApplication<BottlesApplication>(*args)
+    runApplication<BottlesApplication>(*args)
 }

src/main/kotlin/com/nexters/bottles/config/JacksonConfig.kt

@@ -0,0 +1,28 @@
+package com.nexters.bottles.config
+
+import com.fasterxml.jackson.databind.ObjectMapper
+import com.fasterxml.jackson.module.kotlin.KotlinFeature
+import com.fasterxml.jackson.module.kotlin.KotlinModule
+import org.springframework.context.annotation.Bean
+import org.springframework.context.annotation.Configuration
+
+@Configuration
+class JacksonConfig {
+
+    companion object {
+        val kotlinModule = KotlinModule.Builder()
+            .withReflectionCacheSize(512)
+            .configure(KotlinFeature.NullToEmptyCollection, false)
+            .configure(KotlinFeature.NullToEmptyMap, false)
+            .configure(KotlinFeature.NullIsSameAsDefault, false)
+            .configure(KotlinFeature.StrictNullChecks, false)
+            .build()
+    }
+
+    @Bean
+    fun objectMapper(): ObjectMapper {
+        return ObjectMapper().registerModule(
+            kotlinModule
+        )
+    }
+}

src/main/kotlin/com/nexters/bottles/config/SwaggerConfig.kt

@@ -0,0 +1,21 @@
+package com.nexters.bottles.config
+
+import org.springframework.context.annotation.Bean
+import org.springframework.context.annotation.Configuration
+import springfox.documentation.builders.PathSelectors
+import springfox.documentation.builders.RequestHandlerSelectors
+import springfox.documentation.spi.DocumentationType
+import springfox.documentation.spring.web.plugins.Docket
+
+@Configuration
+class SwaggerConfig {
+
+    @Bean
+    fun api(): Docket {
+        return Docket(DocumentationType.SWAGGER_2)
+            .select()
+            .apis(RequestHandlerSelectors.basePackage("com.nexters.bottles"))
+            .paths(PathSelectors.any())
+            .build()
+    }
+}

src/main/kotlin/com/nexters/bottles/user/controller/UserProfileController.kt

@@ -0,0 +1,27 @@
+package com.nexters.bottles.user.controller
+
+import com.nexters.bottles.user.controller.dto.ProfileChoiceResponseDto
+import com.nexters.bottles.user.controller.dto.RegisterProfileRequestDto
+import com.nexters.bottles.user.facade.UserProfileFacade
+import org.springframework.web.bind.annotation.GetMapping
+import org.springframework.web.bind.annotation.PostMapping
+import org.springframework.web.bind.annotation.RequestBody
+import org.springframework.web.bind.annotation.RequestMapping
+import org.springframework.web.bind.annotation.RestController
+
+@RestController
+@RequestMapping("/api/v1")
+class UserProfileController(
+    private val profileFacade: UserProfileFacade,
+) {
+
+    @PostMapping("/profile/choice")
+    fun registerProfile(@RequestBody registerProfileRequestDto: RegisterProfileRequestDto) {
+        profileFacade.saveProfile(registerProfileRequestDto)
+    }
+
+    @GetMapping("/profile/choice")
+    fun getProfileChoiceList() : ProfileChoiceResponseDto {
+        return profileFacade.getProfileChoice()
+    }
+}

src/main/kotlin/com/nexters/bottles/user/controller/dto/InterestDto.kt

@@ -0,0 +1,8 @@
+package com.nexters.bottles.user.controller.dto
+
+data class InterestDto(
+    val culture: List<String> = arrayListOf(),
+    val sports: List<String> = arrayListOf(),
+    val entertainment: List<String> = arrayListOf(),
+    val etc: List<String> = arrayListOf(),
+)

src/main/kotlin/com/nexters/bottles/user/controller/dto/ProfileChoiceResponseDto.kt

@@ -0,0 +1,5 @@
+package com.nexters.bottles.user.controller.dto
+
+data class ProfileChoiceResponseDto(
+    val regions: List<Map<String, Any>>
+)

src/main/kotlin/com/nexters/bottles/user/controller/dto/RegionDto.kt

@@ -0,0 +1,6 @@
+package com.nexters.bottles.user.controller.dto
+
+data class RegionDto(
+    val city: String,
+    val state: String
+)

src/main/kotlin/com/nexters/bottles/user/controller/dto/RegisterProfileRequestDto.kt

@@ -0,0 +1,13 @@
+package com.nexters.bottles.user.controller.dto
+
+data class RegisterProfileRequestDto(
+    val mbti: String,
+    val keyword: List<String>,
+    val interest: InterestDto,
+    val job: String,
+    var smoking: String,
+    var alcohol: String,
+    val religion: String,
+    val region: RegionDto
+) {
+}

src/main/kotlin/com/nexters/bottles/user/domain/BaseEntity.kt

@@ -0,0 +1,15 @@
+package com.nexters.bottles.user.domain
+
+import org.hibernate.annotations.CreationTimestamp
+import org.hibernate.annotations.UpdateTimestamp
+import java.time.LocalDateTime
+import javax.persistence.MappedSuperclass
+
+@MappedSuperclass
+open class BaseEntity(
+    @CreationTimestamp
+    open val createdAt: LocalDateTime = LocalDateTime.now(),
+
+    @UpdateTimestamp
+    open var updatedAt: LocalDateTime = LocalDateTime.now()
+)

src/main/kotlin/com/nexters/bottles/user/domain/User.kt

@@ -0,0 +1,25 @@
+package com.nexters.bottles.user.domain
+
+import com.nexters.bottles.user.domain.enum.Gender
+import javax.persistence.*
+
+@Entity
+class User(
+    @Id
+    @GeneratedValue(strategy = GenerationType.IDENTITY)
+    val id: Long = 0,
+
+    var name: String? = null,
+
+    var kakaoId: String? = null,
+
+    var phoneNumber: String? = null,
+
+    @OneToOne(mappedBy = "user", cascade = [CascadeType.ALL])
+    var userProfile: UserProfile? = null,
+
+    @Enumerated(EnumType.STRING)
+    var gender: Gender = Gender.MALE,
+
+) : BaseEntity() {
+}

src/main/kotlin/com/nexters/bottles/user/domain/UserProfile.kt

@@ -0,0 +1,32 @@
+package com.nexters.bottles.user.domain
+
+import com.nexters.bottles.user.controller.dto.InterestDto
+import com.nexters.bottles.user.controller.dto.RegionDto
+import com.nexters.bottles.user.repository.converter.UserProfileSelectConverter
+import javax.persistence.*
+
+@Entity
+class UserProfile(
+    @Id
+    @GeneratedValue(strategy = GenerationType.IDENTITY)
+    val id: Long? = null,
+
+    @OneToOne
+    @JoinColumn(name = "user_id")
+    var user: User? = null,
+
+    @Convert(converter = UserProfileSelectConverter::class)
+    var profileSelect: UserProfileSelect,
+) :  BaseEntity()
+
+data class UserProfileSelect(
+    val mbti: String,
+    val keyword: List<String> = arrayListOf(),
+    val interest: InterestDto,
+    val job: String,
+    val smoking: String,
+    val alcohol: String,
+    val religion: String,
+    val region: RegionDto,
+)
+

src/main/kotlin/com/nexters/bottles/user/domain/enum/Gender.kt

@@ -0,0 +1,9 @@
+package com.nexters.bottles.user.domain.enum
+
+enum class Gender(
+    val displayName: String,
+) {
+    MALE("남자"),
+    FEMALE("여자"),
+    ;
+}

src/main/kotlin/com/nexters/bottles/user/facade/UserProfileFacade.kt

@@ -0,0 +1,66 @@
+package com.nexters.bottles.user.facade
+
+import com.nexters.bottles.user.controller.dto.ProfileChoiceResponseDto
+import com.nexters.bottles.user.controller.dto.RegisterProfileRequestDto
+import com.nexters.bottles.user.domain.UserProfile
+import com.nexters.bottles.user.domain.UserProfileSelect
+import com.nexters.bottles.user.service.UserProfileService
+import org.springframework.stereotype.Component
+import regions
+
+@Component
+class UserProfileFacade(
+    private val profileService: UserProfileService,
+) {
+
+    fun saveProfile(profileDto: RegisterProfileRequestDto) {
+        validateProfile(profileDto)
+        val convertedProfileDto = convertProfileDto(profileDto)
+
+        profileService.saveProfile(
+            UserProfile(
+                profileSelect = UserProfileSelect(
+                    mbti = convertedProfileDto.mbti,
+                    keyword = convertedProfileDto.keyword,
+                    interest = convertedProfileDto.interest,
+                    job = convertedProfileDto.job,
+                    smoking = convertedProfileDto.smoking,
+                    alcohol = convertedProfileDto.alcohol,
+                    religion = convertedProfileDto.religion,
+                    region = convertedProfileDto.region,
+                )
+            )
+        )
+    }
+
+    fun getProfileChoice(): ProfileChoiceResponseDto {
+        return ProfileChoiceResponseDto(
+            regions = regions
+        )
+    }
+
+    private fun validateProfile(profileDto: RegisterProfileRequestDto) {
+        require(profileDto.keyword.size <= 5) {
+            "키워드는 5개 이하여야 해요"
+        }
+        val interestCount = profileDto.interest.culture.size + profileDto.interest.sports.size
+        +profileDto.interest.entertainment.size + profileDto.interest.etc.size
+        require(interestCount <= 5) {
+            "취미는 5개 이하여야 해요"
+        }
+    }
+
+    private fun convertProfileDto(profileDto: RegisterProfileRequestDto): RegisterProfileRequestDto {
+        when(profileDto.smoking) {
+            "전혀 피우지 않아요" -> profileDto.smoking = "흡연 안해요"
+            "가끔 피워요" -> profileDto.smoking = "흡연은 가끔"
+            "자주 피워요" -> profileDto.smoking = "흡연해요"
+        }
+        when(profileDto.alcohol) {
+            "한 방울도 마시지 않아요" -> profileDto.smoking = "술은 안해요"
+            "때에 따라 적당히 즐겨요" -> profileDto.smoking = "술은 적당히"
+            "자주 찾는 편이에요" -> profileDto.smoking = "술을 즐겨요"
+        }
+        return profileDto
+    }
+}

src/main/kotlin/com/nexters/bottles/user/repository/UserProfileRepository.kt

@@ -0,0 +1,6 @@
+package com.nexters.bottles.user.repository
+
+import com.nexters.bottles.user.domain.UserProfile
+import org.springframework.data.jpa.repository.JpaRepository
+
+interface UserProfileRepository : JpaRepository<UserProfile, Long>

src/main/kotlin/com/nexters/bottles/user/repository/UserRepository.kt

@@ -0,0 +1,7 @@
+package com.nexters.bottles.user.repository
+
+import com.nexters.bottles.user.domain.User
+import org.springframework.data.jpa.repository.JpaRepository
+
+interface UserRepository : JpaRepository<User, Long> {
+}

src/main/kotlin/com/nexters/bottles/user/repository/converter/UserProfileSelectConverter.kt

@@ -0,0 +1,31 @@
+package com.nexters.bottles.user.repository.converter
+
+import com.fasterxml.jackson.databind.ObjectMapper
+import com.fasterxml.jackson.module.kotlin.KotlinFeature
+import com.fasterxml.jackson.module.kotlin.KotlinModule
+import com.nexters.bottles.config.JacksonConfig.Companion.kotlinModule
+import com.nexters.bottles.user.domain.UserProfileSelect
+import javax.persistence.AttributeConverter
+import javax.persistence.Converter
+
+@Converter(autoApply = true)
+class UserProfileSelectConverter : AttributeConverter<UserProfileSelect, String> {
+
+    private val objectMapper = ObjectMapper().registerModule(kotlinModule)
+
+    override fun convertToDatabaseColumn(attribute: UserProfileSelect?): String {
+        return try {
+            objectMapper.writeValueAsString(attribute)
+        } catch (e: Exception) {
+            throw RuntimeException("Error converting JSON to String", e)
+        }
+    }
+
+    override fun convertToEntityAttribute(dbData: String?): UserProfileSelect? {
+        return try {
+            dbData?.let { objectMapper.readValue(it, UserProfileSelect::class.java) }
+        } catch (e: Exception) {
+            throw RuntimeException("Error converting String to JSON", e)
+        }
+    }
+}

src/main/kotlin/com/nexters/bottles/user/service/UserProfileService.kt

@@ -0,0 +1,26 @@
+package com.nexters.bottles.user.service
+
+import com.nexters.bottles.user.domain.UserProfile
+import com.nexters.bottles.user.repository.UserProfileRepository
+import com.nexters.bottles.user.repository.UserRepository
+import mu.KotlinLogging
+import org.springframework.data.repository.findByIdOrNull
+import org.springframework.stereotype.Service
+import javax.transaction.Transactional
+
+@Service
+class UserProfileService(
+    private val profileRepository: UserProfileRepository,
+    private val userRepository: UserRepository,
+) {
+
+    private val log = KotlinLogging.logger { }
+
+    @Transactional
+    fun saveProfile(userProfile: UserProfile): UserProfile {
+        val user = userRepository.findByIdOrNull(1L) // TODO User 회원 가입 기능 구현후 수정
+
+        userProfile.user = user
+        return profileRepository.save(userProfile)
+    }
+}