_(underscore)로 연결된 uuid와 원본 파일명 잘라서 보관하기

📌환경

IntelliJ Ultimate

Java 17

 

Spring boot 3.2.3

Gradle - Groovy

Dependencies: 

Spring Web

Thymeleaf

Spring Data JPA

lombok

MariaDB 10.11

Spring Dev tool

 

📌문제

게시글 DTO인 `BoardDTO`를 DB에 저장하기 위해 엔티티인 `Board`와 `BoardImage`로 변환하고자 한다.

`BoardDTO`는 파일 이름 `String`이 담긴 `List`를 필드로 가진다.

`BoardImage`는 각각 uuid, 원본 파일명, 순서인 `uuid`,  `fileName`, `ord`를 필드로 가지며 상위 엔티티인 `Board`를 참조한다. 이미지가 포함된 글 작성 시 `BoardDTO`를 파라미터로 받았을 때 DB에 저장하기 위하여 `BoardDTO`와 `List`에 담긴 `String`을 엔티티인 `Board`와 그 하위 엔티티인 `BoardImage`로 변환하는 과정에서, `BoardDTO`가 `uuid_원본파일명.확장자명`의 형태로 `String`을 가져왔을 때 `uuid`와 `fileName`으로 나누어진 필드로 따로 저장하는 로직을 작성한다.

 

이때  파일명을 `split("_")`처리하는 경우 파일명에 `_`가 포함되어 있으면 올바르지 않은 파일명이 저장되는 현상이 발생하여 해결하고자 한다.

 

 

//	이미지 파일명 List를 가지고 있는 게시글 DTO
//	BoardDTO

package org.zerock.b02.dto;

import jakarta.validation.constraints.NotEmpty;
import jakarta.validation.constraints.Size;
import lombok.AllArgsConstructor;

import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.time.LocalDateTime;
import java.util.List;

@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class BoardDTO {

    private Long bno;

    @NotEmpty
    @Size(min = 3, max = 100)
    private String title;

    @NotEmpty
    private String content;

    @NotEmpty
    private String writer;
    private LocalDateTime regDate;
    private LocalDateTime modDate;

//    첨부 파일 이름 목록
    private List<String> fileNames;
}

 

 

//	Board

package org.zerock.b02.domain;

import jakarta.persistence.*;
import lombok.*;
import org.hibernate.annotations.BatchSize;

import java.util.HashSet;
import java.util.Set;

@Entity
@Builder
@NoArgsConstructor
@AllArgsConstructor
@Getter
@ToString(exclude = "imageSet")
public class Board extends BaseEntity {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY) //  Auto Increment
    private Long bno;

    @Column(length = 500, nullable = false)
    private String title;

    @Column(length = 2000, nullable = false)
    private String content;

    @Column(length = 50, nullable = false)
    private String writer;


//    엔티티 객체는 불변하도록 설계하는 것이 좋으나, 강제적인 사항은 아니므로 수정이 필요하다면 수정이 가능한 부분만 메서드로 설계한다
    public void update(String title, String content){
        this.title = title;
        this.content = content;
    }

    @OneToMany(mappedBy = "board", cascade = {CascadeType.ALL}, fetch = FetchType.LAZY, orphanRemoval = true)
    @Builder.Default
    @BatchSize(size = 20)   //  BatchSize 가 없으면 페이지 하나를 불러올 때 페이지 당 게시글 개수 만큼의 쿼리를 실행해서 문제가 됨. 이 N번의 쿼리를 한번에 실행할 수 있게 해준다.
    private Set<BoardImage> imageSet = new HashSet<>();

//    Board 객체 내에서 BoardImage를 모두 관리함.
    public void addImage(String uuid, String fileName){

        BoardImage boardImage = BoardImage.builder()
                .uuid(uuid)
                .fileName(fileName)
                .board(this)
                .ord(imageSet.size())
                .build();

        imageSet.add(boardImage);
    }


//    BoardImage의 Board 참조를 null로 변경함
    public void clearImage(){
        imageSet.forEach(boardImage -> {
            boardImage.changeBoard(null);
        });

        this.imageSet.clear();
    }


}

 

 

 

//	게시글에 포함되는 이미지 uuid, 원본 파일명, 순서, 상위 엔티티인 Board를 참조함
//	BoardImage

package org.zerock.b02.domain;

import jakarta.persistence.Entity;
import jakarta.persistence.Id;
import jakarta.persistence.ManyToOne;
import lombok.*;

@Entity
@Getter
@Builder
@AllArgsConstructor
@NoArgsConstructor
@ToString
public class BoardImage implements Comparable<BoardImage>{

    @Id
    private String uuid;

    private String fileName;
    private int ord;

    @ManyToOne
    private Board board;


    @Override
    public int compareTo(BoardImage other) {
        return this.ord - other.ord;
    }

    public void changeBoard(Board board){
        this.board = board;
    }

}

 

 

 

 

 

//	boardService 내 dtoToEntity 메서드의 일부

boardDTO.getFileNames().forEach(fileNames -> {
    String[] arr = fileNames.split("_");
    System.out.println(Arrays.toString(arr));
    board.addImage(arr[0], arr[1]);
});

 

//	dtoToEntity Test

@Test
public void dtoToEntityTest(){

    String[] strs = {"thisisuuid_aaa_a_.jpg", "thisisuuid_abc.jpg"};
    List<String> fileNames = new ArrayList<>(List.of(strs));

    BoardDTO boardDTO = BoardDTO.builder()
            .title("test title")
            .content("test content")
            .writer("test writer")
            .fileNames(fileNames)
            .build();

    Board board = boardService.dtoToEntity(boardDTO);
    log.info("dtoToEntity " + board);
    log.info("board imageSet " + board.getImageSet());
}

 

board imageSet [BoardImage(uuid=thisisuuid, fileName=abc.jpg, ord=1, board=Board(bno=null, title=test title, content=test content, writer=test writer)), 
			BoardImage(uuid=thisisuuid, fileName=aaa, ord=0, board=Board(bno=null, title=test title, content=test content, writer=test writer))]

 

 

`fileName`에 원본 파일명인 `aaa_a_.jpg`와 `abc.jpg`가 담겨야하는데 `aaa`와 `abc.jpg`가 저장되어있다. `_`가 포함된 파일이름의 경우 파일명이 온전치 못하게 잘려 올바르지 않은 값이 저장되는 것을 확인할 수 있다.

예를 들어 `uuid_aaa_a_.jpg`는 `_`로 split할 경우 `uuid` `aaa` `a` `.jpg`로 잘리게 된다. `addImage()`메서드에 `_`로 나눈 값의 첫번째 String과 두번째 String을 인자로 넣어주기 때문에 `BoardImage`의 `uuid`와 `fileName`은 `uuid`와 `aaa`가 된다.

 

 

 

📌해결

문제가 발생하는 원인은 원본 파일명에 `_`가 없다는 가정 하에 String을 `_`로 나누는 로직을 작성했기 때문이다. 유저가 업로드하는 파일명에 `_`가 포함될 가능성이 높으므로 이를 보완하기 위해 첫번째 `_`가 시작되는 인덱스를 찾아 그를 기준으로 파일명을 자르기로 했다.

 

 

//	BoardService 내 dtoToEntity의 일부


//	"_"로 나누게 되면 "_"가 여러 개 포함된 이미지일 경우 올바르지 않은 파일명이 저장되는 오류 발생
//	String[] arr = fileNames.split("_");

//	맨 처음에 오는 "_"의 인덱스를 찾아내 그 인덱스를 기준으로 String 을 잘라낸다.
int start = fileNames.indexOf("_");
String[] arr = {fileNames.substring(0, start), fileNames.substring(start + 1)};

System.out.println(Arrays.toString(arr));
board.addImage(arr[0], arr[1]);

 

 

테스트 코드는 위와 동일하므로 생략한다.

 

 

 

board imageSet [BoardImage(uuid=thisisuuid, fileName=abc.jpg, ord=1, board=Board(bno=null, title=test title, content=test content, writer=test writer)), 
			BoardImage(uuid=thisisuuid, fileName=aaa_a_.jpg, ord=0, board=Board(bno=null, title=test title, content=test content, writer=test writer))]

 

 

원본 파일 값이 올바르게 입력된 것을 확인할 수 있다.