[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,6 +35,8 @@ 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.module:jackson-module-kotlin")
 	implementation("org.jetbrains.kotlin:kotlin-reflect")
 

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,25 @@
+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 {
+
+    @Bean
+    fun objectMapper(): ObjectMapper {
+        return ObjectMapper().registerModule(
+            KotlinModule.Builder()
+                .withReflectionCacheSize(512)
+                .configure(KotlinFeature.NullToEmptyCollection, false)
+                .configure(KotlinFeature.NullToEmptyMap, false)
+                .configure(KotlinFeature.NullIsSameAsDefault, false)
+                .configure(KotlinFeature.SingletonSupport, DISABLED)
+                .configure(KotlinFeature.StrictNullChecks, false)
+                .build()
+        )
+    }
+}

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/profile/controller/ProfileController.kt

@@ -0,0 +1,20 @@
+package com.nexters.bottles.profile.controller
+
+import com.nexters.bottles.profile.controller.dto.RegisterProfileRequestDto
+import com.nexters.bottles.profile.facade.ProfileFacade
+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")
+class ProfileController(
+    private val profileFacade: ProfileFacade,
+) {
+
+    @PostMapping("/profile/choice")
+    fun registerProfile(@RequestBody registerProfileRequestDto: RegisterProfileRequestDto) {
+        profileFacade.saveProfile(registerProfileRequestDto)
+    }
+}

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

@@ -0,0 +1,8 @@
+package com.nexters.bottles.profile.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/profile/controller/dto/RegionDto.kt

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

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

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

src/main/kotlin/com/nexters/bottles/profile/domain/ProfileSelect.kt

@@ -0,0 +1,15 @@
+package com.nexters.bottles.profile.domain
+
+import com.nexters.bottles.profile.controller.dto.InterestDto
+import com.nexters.bottles.profile.controller.dto.RegionDto
+
+data class ProfileSelect(
+    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/profile/domain/UserProfile.kt

@@ -0,0 +1,29 @@
+package com.nexters.bottles.profile.domain
+
+import com.nexters.bottles.profile.repository.converter.ProfileSelectConverter
+import org.hibernate.annotations.CreationTimestamp
+import org.hibernate.annotations.UpdateTimestamp
+import java.time.LocalDateTime
+import javax.persistence.*
+
+@Entity
+class UserProfile(
+    @Id
+    @GeneratedValue(strategy = GenerationType.IDENTITY)
+    val id: Long? = null,
+
+    @Column(name = "user_id")
+    var userId: Long,
+
+    @Column(name = "profile_select")
+    @Convert(converter = ProfileSelectConverter::class)
+    var profileSelect: ProfileSelect,
+
+    @Column(name = "created_at", updatable = false)
+    @CreationTimestamp
+    val createdAt: LocalDateTime = LocalDateTime.now(),
+
+    @Column(name = "updated_at")
+    @UpdateTimestamp
+    var updatedAt: LocalDateTime = LocalDateTime.now()
+)

src/main/kotlin/com/nexters/bottles/profile/facade/ProfileFacade.kt

@@ -0,0 +1,44 @@
+package com.nexters.bottles.profile.facade
+
+import com.nexters.bottles.profile.controller.dto.RegisterProfileRequestDto
+import com.nexters.bottles.profile.domain.ProfileSelect
+import com.nexters.bottles.profile.domain.UserProfile
+import com.nexters.bottles.profile.service.ProfileService
+import org.springframework.stereotype.Component
+
+@Component
+class ProfileFacade(
+    private val profileService: ProfileService,
+) {
+
+    fun saveProfile(profileDto: RegisterProfileRequestDto) {
+        validateProfile(profileDto)
+
+        profileService.saveProfile(
+            UserProfile(
+                userId = 1L,
+                profileSelect = ProfileSelect(
+                    mbti = profileDto.mbti,
+                    keyword = profileDto.keyword,
+                    interest = profileDto.interest,
+                    job = profileDto.job,
+                    smoking = profileDto.smoking,
+                    alcohol = profileDto.alcohol,
+                    religion = profileDto.religion,
+                    region = profileDto.region,
+                )
+            )
+        )
+    }
+
+    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개 이하여야 해요"
+        }
+    }
+}

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

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

src/main/kotlin/com/nexters/bottles/profile/repository/converter/ProfileSelectConverter.kt

@@ -0,0 +1,39 @@
+package com.nexters.bottles.profile.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.profile.domain.ProfileSelect
+import javax.persistence.AttributeConverter
+import javax.persistence.Converter
+
+@Converter(autoApply = true)
+class ProfileSelectConverter : AttributeConverter<ProfileSelect, String> {
+
+    private val objectMapper = ObjectMapper().registerModule(
+        KotlinModule.Builder()
+            .withReflectionCacheSize(512)
+            .configure(KotlinFeature.NullToEmptyCollection, false)
+            .configure(KotlinFeature.NullToEmptyMap, false)
+            .configure(KotlinFeature.NullIsSameAsDefault, false)
+            .configure(KotlinFeature.SingletonSupport, DISABLED)
+            .configure(KotlinFeature.StrictNullChecks, false)
+            .build()
+    )
+
+    override fun convertToDatabaseColumn(attribute: ProfileSelect?): String {
+        return try {
+            objectMapper.writeValueAsString(attribute)
+        } catch (e: Exception) {
+            throw RuntimeException("Error converting JSON to String", e)
+        }
+    }
+
+    override fun convertToEntityAttribute(dbData: String?): ProfileSelect? {
+        return try {
+            dbData?.let { objectMapper.readValue(it, ProfileSelect::class.java) }
+        } catch (e: Exception) {
+            throw RuntimeException("Error converting String to JSON", e)
+        }
+    }
+}

src/main/kotlin/com/nexters/bottles/profile/service/ProfileService.kt

@@ -0,0 +1,17 @@
+package com.nexters.bottles.profile.service
+
+import com.nexters.bottles.profile.domain.UserProfile
+import com.nexters.bottles.profile.repository.UserProfileRepository
+import org.springframework.stereotype.Service
+import javax.transaction.Transactional
+
+@Service
+class ProfileService(
+    private val profileRepository: UserProfileRepository
+) {
+
+    @Transactional
+    fun saveProfile(userProfile: UserProfile): UserProfile {
+        return profileRepository.save(userProfile)
+    }
+}

src/main/resources/application.yml

@@ -0,0 +1,27 @@
+server:
+  port: 8080
+
+spring:
+  profiles:
+    active: local
+  jpa:
+    properties:
+      hibernate:
+        jdbc:
+          time_zone: UTC
+  mvc:
+    pathmatch:
+      matching-strategy: ant_path_matcher
+
+---
+spring:
+  profiles: local
+  datasource:
+    url: jdbc:mysql://localhost:3306/bottles?useSSL=false
+    username: root
+    password: root
+
+logging:
+  level:
+    org:
+      springframework: INFO

src/main/resources/sql/table_query.sql

@@ -0,0 +1,7 @@
+CREATE TABLE user_profile (
+    id BIGINT AUTO_INCREMENT PRIMARY KEY,
+    user_id BIGINT NOT NULL,
+    profile_select JSON,
+    created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL,
+    updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP NOT NULL
+);