🔥 TIL - Day 73 Kotlin & Springboot 04 파일 업로드 (MultipartFormData 다루기) & Junit 파일업로드 테스트

전체소스 Github

제목, 내용과 함께 이미지 하나를 입력받아 저장하는 기능을 구현하고자 한다.
UI 없이 Junit을 이용한 테스트만 진행한다.

📌 Domain

파일 업로드에 집중하기 위해 귀찮은 일이 발생할 수 있는 양방향 관계는 두지 않았다.
BoardImage에서 Board를 보는 단방향 관계만 설정한다.

@Entity
class Board(
    title: String,
    content: String,
    member: Member
) {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    var id: Long? = null

    @Column(nullable = false)
    var title: String = title
        protected set

    @Column(nullable = false)
    var content: String = content
        protected set

    @ManyToOne(fetch = FetchType.LAZY)
    var member: Member = member
        protected set

    fun addMember(member: Member){
        this.member = member
        member.boards.add(this)
    }

    fun updateBoard(updateDto: BoardUpdateDto) {
        this.title = updateDto.title
        this.content = updateDto.content
    }

    fun modifyMember(member: Member) {
        this.member = member    
    }
}

파일을 관리할 BoardImage 엔티티

saveFileName은 서버 측에서 관리하는 파일의 이름이다.
UUID를 이용해서 난수화 된 이름이 설정되도록 할 것이다. 업로드 되는 파일의 이름이 중복되는 것을 방지하기 위함이다.

originalFileName은 사용자가 업로드 한 파일이름을 저장한다.

@Entity
class BoardImage(
    originalFileName: String,
    saveFileName: String,
    board: Board) {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    var id: Long? = null

    @Column(nullable = false)
    val saveFileName: String = saveFileName

    @Column(nullable = false)
    val originalFileName: String = originalFileName

    @ManyToOne(fetch = FetchType.LAZY)
    val board: Board = board
}

📌 Controller

이미지는 선택적으로 넘어오도록 (required = false) 한다.
(이전 프로젝트와 연결되어 Security가 적용된 상태이다.)

현재 인증된 사용자와 받은 데이터를 Service 계층으로 넘겨서 비즈니스 로직을 수행한다.

MultipartFile을 이용해서 넘어오는 바이너리 파일을 받아준다.
Multipart 참고

@RequestMapping("/api/boards")
@RestController
class BoardController (private val boardService: BoardService) {

    @PostMapping
    fun postBoard(
        @AuthenticationPrincipal userDetails: UserDetailsImpl,
        @RequestParam title: String,
        @RequestParam content: String,
        @RequestPart(required = false) file: MultipartFile?): ResponseEntity<String> {

        val member = userDetails.member
        boardService.saveBoard(member, title, content, file)
        return ResponseEntity.ok().body("저장완료")
    }
}

---

📌 Service

MultipartFile의 originalFilename 메서드로 업로드 될 파일의 이름을 얻어오고 이 이름을 이용해서 서버에서 관리할 파일이름까지 만들어준다.

원본이름과 서버에서 관리할 이름이 생성됐다면 transferTo 메서드를 이용해서 파일을 지정한 경로에 저장하고 BoardImage 엔티티를 생성해서 DB에 저장한다.
실제파일을 저장하는 부분은 이후 S3에 업로드하는 것으로 변경할 예정이다.

@Service
class BoardService(
    private val boardRepository: BoardRepository,
    private val boardImageRepository: BoardImageRepository,
) {

    val uploadeDir = "업로드_될_경로"

    @Transactional
    fun saveBoard(member: Member, title: String, content: String, file: MultipartFile?) {

        val board = Board(title, content, member)
        boardRepository.save(board)
        
        // 원본파일이름, 저장될 파일이름  
        val originalFilename: String? = file?.originalFilename
        val saveFileName = getSaveFileName(originalFilename)

	// 파일 저장(transferTo), 파일정보 DB에 저장
        if (file != null && originalFilename != null) {
            file.transferTo(File(uploadeDir + saveFileName))
            val boardImage = BoardImage(originalFilename, saveFileName, board)
            boardImageRepository.save(boardImage)
        }
    }
    
    // 저장될 파일이름 생성
    private fun getSaveFileName(originalFilename: String?): String {
        val extPosIndex: Int? = originalFilename?.lastIndexOf(".")
        val ext = originalFilename?.substring(extPosIndex?.plus(1) as Int)

        return UUID.randomUUID().toString() + "." + ext
    }
}

---

📌 Junit Test

테스트는 MockMultipartFile를 이용해서 간단하게 진행한다.
MockMultipartFile은 파일을 API로 넘길 때 매핑될 이름과 파일이름, contentType, 실제데이터까지 만들어서 테스트할 수 있는 좋~~은 도구이다.

테스트를 위해서 특정 경로에 파일을 위치시키는 등의 작업이 필요 없어서 보다 독립적인 테스트가 가능하다.

MockMultipartFile(매핑될_이름, 원본파일이름, ContentType, 데이터(byte))

먼저 MockMultipartFile를 이용해서 text 파일 하나를 생성한다.
파일부분은 file로, String 데이터는 part로 지정해서 서버로 넘긴다.
(headers 부분은 security가 적용된 상태라 테스트를 위해 설정했다.)

서버로 요청이 끝나면 DB 저장여부까지 확인하는 것으로 테스트를 마친다.

@Test
@DisplayName("업로드 테스트")
fun `Board 저장 - 파일업로드 포함`() {

    val imagePart = MockMultipartFile("file","test.txt" , "text/plain" , "hello file".byteInputStream(StandardCharsets.UTF_8))

    mockMvc.multipart("/api/boards")
    {
        file(imagePart)
            .part(MockPart("title", "title1".toByteArray(StandardCharsets.UTF_8)))
            .part(MockPart("content", "content1".toByteArray(StandardCharsets.UTF_8)))
        headers {
            header("Authorization", "bearer ".plus(token))
        }
    }
        .andDo {
            print()
        }
        .andExpect {
            status { isOk() }
        }

    val boardImages = boardImageRepository.findAll()

    Assertions.assertEquals(1, boardImages.size)
    Assertions.assertEquals("test.txt", boardImages.get(0).originalFileName)
}

테스트 결과

지정한 경로에 파일이 저장된 것 까지 확인할 수 있다.