Merge pull request #18 from EntryDSM/feature/12-layerd-to-hexagonal-screen

Feature/12 layerd to hexagonal screen

Author: coehgns

casper-feed/src/main/kotlin/hs/kr/entrydsm/feed/adapter/in/screen/ScreenWebAdapter.kt

@@ -0,0 +1,67 @@
+package hs.kr.entrydsm.feed.adapter.`in`.screen
+
+import hs.kr.entrydsm.feed.adapter.`in`.screen.dto.response.QueryScreenResponse
+import hs.kr.entrydsm.feed.adapter.`in`.screen.dto.response.ScreenResponse
+import hs.kr.entrydsm.feed.application.screen.port.`in`.CreateScreenUseCase
+import hs.kr.entrydsm.feed.application.screen.port.`in`.QueryScreenUseCase
+import hs.kr.entrydsm.feed.application.screen.port.`in`.UpdateScreenUseCase
+import org.springframework.http.HttpStatus
+import org.springframework.web.bind.annotation.GetMapping
+import org.springframework.web.bind.annotation.PatchMapping
+import org.springframework.web.bind.annotation.PathVariable
+import org.springframework.web.bind.annotation.PostMapping
+import org.springframework.web.bind.annotation.RequestMapping
+import org.springframework.web.bind.annotation.RequestPart
+import org.springframework.web.bind.annotation.ResponseStatus
+import org.springframework.web.bind.annotation.RestController
+import org.springframework.web.multipart.MultipartFile
+import java.util.UUID
+
+/**
+ * 화면 정보 관련 HTTP 요청을 처리하는 웹 어댑터 클래스입니다.
+ *
+ * 이 클래스는 화면 정보와 관련된 모든 HTTP 엔드포인트를 제공하며,
+ * 클라이언트의 요청을 적절한 서비스 메서드로 라우팅합니다.
+ *
+ * @property screenService 화면 정보 비즈니스 로직을 처리하는 서비스
+ */
+@RestController
+@RequestMapping("/screen")
+class ScreenWebAdapter(
+    private val createScreenUseCase: CreateScreenUseCase,
+    private val updateScreenUseCase: UpdateScreenUseCase,
+    private val queryScreenUseCase: QueryScreenUseCase,
+) {
+    /**
+     * 새로운 화면 이미지를 업로드하고 저장합니다.
+     *
+     * @param image 업로드할 화면 이미지 파일
+     * @return 업로드된 화면 이미지 정보가 포함된 응답 객체
+     */
+    @ResponseStatus(value = HttpStatus.CREATED)
+    @PostMapping
+    suspend fun createScreen(
+        @RequestPart(name = "image") image: MultipartFile,
+    ): ScreenResponse = createScreenUseCase.execute(image)
+
+    /**
+     * 기존 화면 이미지를 새로운 이미지로 업데이트합니다.
+     *
+     * @param id 업데이트할 화면의 고유 식별자
+     * @param image 새로운 화면 이미지 파일
+     * @return 업데이트된 화면 이미지 정보가 포함된 응답 객체
+     */
+    @PatchMapping("/{screen-id}")
+    fun updateScreen(
+        @PathVariable(name = "screen-id") id: UUID,
+        @RequestPart(name = "image") image: MultipartFile,
+    ): ScreenResponse = updateScreenUseCase.execute(id, image)
+
+    /**
+     * 모든 화면 이미지 목록을 조회합니다.
+     *
+     * @return 화면 이미지 목록이 포함된 응답 객체 리스트
+     */
+    @GetMapping
+    fun queryScreen(): List<QueryScreenResponse> = queryScreenUseCase.execute()
+}

casper-feed/src/main/kotlin/hs/kr/entrydsm/feed/adapter/in/screen/dto/response/QueryScreenResponse.kt

@@ -0,0 +1,20 @@
+package hs.kr.entrydsm.feed.adapter.`in`.screen.dto.response
+
+import java.time.LocalDateTime
+import java.util.UUID
+
+/**
+ * 화면 정보 조회 응답을 위한 데이터 클래스입니다.
+ * 화면의 상세 정보와 메타데이터를 클라이언트에 반환할 때 사용됩니다.
+ *
+ * @property id 화면 정보의 고유 식별자 (UUID)
+ * @property image 화면에 표시될 이미지의 URL 또는 경로
+ * @property createAt 화면 정보가 생성된 일시
+ * @property modifyAt 화면 정보가 마지막으로 수정된 일시
+ */
+data class QueryScreenResponse(
+    val id: UUID,
+    val image: String,
+    val createAt: LocalDateTime,
+    val modifyAt: LocalDateTime,
+)

casper-feed/src/main/kotlin/hs/kr/entrydsm/feed/adapter/in/screen/dto/response/ScreenResponse.kt

@@ -0,0 +1,11 @@
+package hs.kr.entrydsm.feed.adapter.`in`.screen.dto.response
+
+/**
+ * 화면 정보 응답을 위한 데이터 클래스입니다.
+ * 클라이언트에게 반환되는 화면 관련 정보를 담고 있습니다.
+ *
+ * @property image 화면에 표시될 이미지의 URL 또는 경로
+ */
+data class ScreenResponse(
+    val image: String,
+)

casper-feed/src/main/kotlin/hs/kr/entrydsm/feed/adapter/out/entity/screen/ScreenJpaEntity.kt

@@ -0,0 +1,21 @@
+package hs.kr.entrydsm.feed.adapter.out.entity.screen
+
+import hs.kr.entrydsm.feed.global.entity.BaseEntity
+import jakarta.persistence.Column
+import jakarta.persistence.Entity
+import java.util.UUID
+
+/**
+ * 화면 정보를 데이터베이스에 저장하기 위한 JPA 엔티티 클래스입니다.
+ *
+ * @property image 화면에 표시될 이미지의 경로 또는 URL
+ * @property adminId 화면을 등록한 관리자 ID (UUID)
+ * @param id 엔티티의 고유 식별자 (생성 시 자동 생성됨)
+ */
+@Entity(name = "tbl_screen")
+class ScreenJpaEntity(
+    id: UUID? = null,
+    var image: String,
+    @Column(columnDefinition = "BINARY(16)")
+    val adminId: UUID,
+) : BaseEntity(id)

casper-feed/src/main/kotlin/hs/kr/entrydsm/feed/adapter/out/mapper/screen/ScreenMapper.kt

@@ -0,0 +1,28 @@
+package hs.kr.entrydsm.feed.adapter.out.mapper.screen
+
+import hs.kr.entrydsm.feed.adapter.out.entity.screen.ScreenJpaEntity
+import hs.kr.entrydsm.feed.model.screen.Screen
+import org.mapstruct.Mapper
+
+/**
+ * 화면(Screen) 도메인 모델과 JPA 엔티티 간의 변환을 담당하는 매퍼 인터페이스입니다.
+ * MapStruct를 사용하여 구현체가 자동으로 생성됩니다.
+ */
+@Mapper(componentModel = "spring")
+interface ScreenMapper {
+    /**
+     * Screen 도메인 모델을 JPA 엔티티로 변환합니다.
+     *
+     * @param model 변환할 Screen 도메인 모델
+     * @return 변환된 ScreenJpaEntity 인스턴스
+     */
+    fun toEntity(model: Screen): ScreenJpaEntity
+
+    /**
+     * JPA 엔티티를 Screen 도메인 모델로 변환합니다.
+     *
+     * @param entity 변환할 ScreenJpaEntity 인스턴스
+     * @return 변환된 Screen 도메인 모델
+     */
+    fun toModel(entity: ScreenJpaEntity): Screen
+}

casper-feed/src/main/kotlin/hs/kr/entrydsm/feed/adapter/out/persistence/screen/ScreenPersistenceAdapter.kt

@@ -0,0 +1,35 @@
+package hs.kr.entrydsm.feed.adapter.out.persistence.screen
+
+import hs.kr.entrydsm.feed.adapter.out.mapper.screen.ScreenMapper
+import hs.kr.entrydsm.feed.adapter.out.persistence.screen.repository.ScreenRepository
+import hs.kr.entrydsm.feed.application.screen.port.out.FindScreenPort
+import hs.kr.entrydsm.feed.application.screen.port.out.SaveScreenPort
+import hs.kr.entrydsm.feed.model.screen.Screen
+import org.springframework.data.repository.findByIdOrNull
+import org.springframework.stereotype.Component
+import java.util.UUID
+
+/**
+ * 화면 정보 도메인과 데이터베이스 간의 상호작용을 담당하는 어댑터 클래스입니다.
+ *
+ * @property screenRepository 화면 정보 엔티티를 데이터베이스에서 조작하기 위한 리포지토리
+ * @property screenMapper 화면 정보 도메인 객체와 엔티티 간의 변환을 담당하는 매퍼
+ */
+@Component
+class ScreenPersistenceAdapter(
+    private val screenRepository: ScreenRepository,
+    private val screenMapper: ScreenMapper,
+) : SaveScreenPort, FindScreenPort {
+    override fun saveScreen(screen: Screen) {
+        screenRepository.save(screenMapper.toEntity(screen))
+    }
+
+    override fun findAll(): List<Screen> {
+        return screenRepository.findAll().map { screenMapper.toModel(it) }
+    }
+
+    override fun findByIdOrNull(screenId: UUID): Screen? =
+        screenRepository.findByIdOrNull(screenId)?.let {
+            screenMapper.toModel(it)
+        }
+}

casper-feed/src/main/kotlin/hs/kr/entrydsm/feed/adapter/out/persistence/screen/repository/ScreenRepository.kt

@@ -0,0 +1,11 @@
+package hs.kr.entrydsm.feed.adapter.out.persistence.screen.repository
+
+import hs.kr.entrydsm.feed.adapter.out.entity.screen.ScreenJpaEntity
+import org.springframework.data.jpa.repository.JpaRepository
+import java.util.UUID
+
+/**
+ * 화면(Screen) 데이터에 접근하기 위한 JPA Repository 인터페이스입니다.
+ * 화면 엔티티의 CRUD 작업을 위한 기본 메서드를 상속받아 사용합니다.
+ */
+interface ScreenRepository : JpaRepository<ScreenJpaEntity, UUID>

casper-feed/src/main/kotlin/hs/kr/entrydsm/feed/application/screen/exception/ScreenNotFoundException.kt

@@ -0,0 +1,14 @@
+package hs.kr.entrydsm.feed.application.screen.exception
+
+import hs.kr.entrydsm.feed.global.error.exception.CasperException
+import hs.kr.entrydsm.feed.global.error.exception.ErrorCode
+
+/**
+ * 화면 정보를 찾을 수 없을 때 발생하는 예외 클래스입니다.
+ *
+ * @property status HTTP 상태 코드 (404)
+ * @property message 에러 메시지
+ */
+object ScreenNotFoundException : CasperException(
+    ErrorCode.SCREEN_NOT_FOUND,
+)

casper-feed/src/main/kotlin/hs/kr/entrydsm/feed/application/screen/port/in/CreateScreenUseCase.kt

@@ -0,0 +1,13 @@
+package hs.kr.entrydsm.feed.application.screen.port.`in`
+
+import hs.kr.entrydsm.feed.adapter.`in`.screen.dto.response.ScreenResponse
+import org.springframework.web.multipart.MultipartFile
+
+/**
+ * 화면 생성을 위한 유스케이스 인터페이스입니다.
+ * 화면 도메인에서 새로운 화면 이미지를 업로드하고 생성하는 역할을 담당합니다.
+ */
+interface CreateScreenUseCase {
+
+    suspend fun execute(file: MultipartFile): ScreenResponse
+}

casper-feed/src/main/kotlin/hs/kr/entrydsm/feed/application/screen/port/in/QueryScreenUseCase.kt

@@ -0,0 +1,16 @@
+package hs.kr.entrydsm.feed.application.screen.port.`in`
+
+import hs.kr.entrydsm.feed.adapter.`in`.screen.dto.response.QueryScreenResponse
+
+/**
+ * 화면 목록 조회를 위한 유스케이스 인터페이스입니다.
+ * 화면 도메인에서 모든 화면 목록을 조회하는 역할을 담당합니다.
+ */
+interface QueryScreenUseCase {
+    /**
+     * 모든 화면 목록을 조회합니다.
+     *
+     * @return 화면 목록 응답
+     */
+    fun execute(): List<QueryScreenResponse>
+}