Spring 파일 업로드와 다운로드

게시판을 구현하다보면 첨부파일 기능이 필요한 경우가 있습니다. 현재 진행중인 Spring 기반 프로젝트 버전과 맞는 첨부파일 핸들링을 해보며 관련 내용을 정리해보려고 합니다.

선요약 : NIO API를 이용하거나 전통적인 IO API를 이용할 수 있습니다.

# 테이블 구성

게시글 하나당 하나의 첨부파일만 업로드한다면 게시글 테이블 하나로도 구현이 가능하겠지만, 여러개의 첨부파일을 올리고 싶다면 첨부파일 테이블을 따로 구성해야 합니다.
저는 게시판 테이블의 이름을 HappyBoard라 정하였고, 이에 따라 HappyBoardAtfi라는 첨부파일 관리 테이블을 만들었습니다.
두 테이블에는 ATGP_SN(그룹파일번호) 컬럼을 두어 연결을 했습니다.

첨부파일 테이블의 구성은 다음과 같습니다.

ATGP_SN : 그룹파일번호
ATFI_SN : 첨부파일번호(PK)
ATFI_URL : 첨부파일 저장 경로
ATFI_SF_NAME : 첨부파일 저장 이름
ATFI_OG_NAME : 첨부파일 원본 이름
ATFI_EXT : 첨부파일 확장자명

# 파일 업로드

# NIO.2 API (JDK7)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48


public String happyFileUpload(MultipartFile file, String happyAtgpSn) throws Exception {
    String filePath = "happyBoard/atch/";
    String fileExt = file.getOriginalFilename().substring(file.getOriginalFilename().lastIndexOf(".") + 1).toLowerCase();
    String fileName = "happy" + "_" + System.nanoTime() + "." + fileExt;
    Path happyFilePath = Paths.get(filePath, fileName);
    // 원본파일명이 없으면 패스
    if (file.getOriginalFilename().equals("")) {
        happyAtgpSn = "400";
        return happyAtgpSn;
    }
    try {
        //폴더 경로가 없다면 생성
        File chkDir = new File(filePath);

        if (!chkDir.exists()) {
            chkDir.mkdirs();
        }

        // 파일 데이터가 있다면
        try (InputStream inputStream = file.getInputStream()){

            // 파일 저장
            Files.copy(inputStream, happyFilePath, StandardCopyOption.REPLACE_EXISTING);

            // 파일 정보 객체에 저장
            HappyBoardAtfiVO happyBoardAtfiVO = new HappyBoardAtfiVO();
            happyBoardAtfiVO.setHappyAtgpSn(happyAtgpSn);                // 첨부파일 그룹 일련번호
            happyBoardAtfiVO.setHappyAtfiOgName(file.getOriginalFilename());    // 첨부파일 원본명
            happyBoardAtfiVO.setHappyAtfiSfName(fileName);                       // 첨부파일 저장명
            happyBoardAtfiVO.setHappyAtfiExt(fileExt);                               // 첨부파일 확장자명
            happyBoardAtfiVO.setHappyAtfiUrl(filePath);                            // 첨부파일 저장 경로
            // 첨부파일 정보 등록
            happyAtgpSn = mypageService.insertHappyAtfiInfo(happyBoardAtfiVO);
        }

    } catch (NullPointerException np) {
        np.printStackTrace();
        happyAtgpSn = "400";
    } catch (IOException ie) {
        ie.printStackTrace();
        happyAtgpSn = "400";
    } catch (Exception e) {
        e.printStackTrace();
        happyAtgpSn = "400";
    }

    return happyAtgpSn;
}

위 메서드가 정상적으로 종료되어 happyAtgpSn을 return한다면 서버에 첨부파일이 저장되고, 첨부파일 테이블에도 관련 정보가 저장됩니다. 이후 happyAtgpSn을 게시글 데이터에 추가하여 게시글 테이블에 해당 게시글을 등록합니다(코드는 생략).

Files.copy()에서 CopyOption을 설정할 수 있습니다.

StandardCopyOption은 3가지를 제공합니다.

REPLACE_EXISTING : 기존 파일이 존재하는 경우 해당 파일을 대체합니다.
COPY_ATTRIBUTES : 파일의 속성을 새 파일로 복사합니다.
ATOMIC_MOVE : 원자적 이동(파일 이동 작업을 끝까지 보장).

# IO API (Before JDK7)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53


public String happyFileUpload(MultipartFile file, String happyAtgpSn) throws Exception {
    String filePath = "happyBoard/atch";

    //확장자명 가져오기
    String fileExt = file.getOriginalFilename().substring(file.getOriginalFilename().lastIndexOf(".") + 1).toLowerCase();
    String fileName = "happy" + "_" + System.nanoTime() + "." + fileExt;

    // 저장할 경로의 파일객체를 생성(transferTo 메서드에 사용)
    File happyFile = new File(filePath + fileName);

    // 원본파일명이 존재하는 경우
    if (!"".equals(file.getOriginalFilename())) {
        happyAtgpSn = "400";
        return happyAtgpSn;
    }
    try {
        // 파일 경로가 없다면 생성
        File chkDir = new File(filePath);

        if (!chkDir.exists()) {
            chkDir.mkdirs();
        }

        // 임시 파일 저장 경로로 이동(서버에 저장)
        file.transferTo(happyFile);

        // 파일 정보 객체에 저장
        HappyBoardAtfiVO happyBoardAtfiVO = new HappyBoardAtfiVO();
        happyBoardAtfiVO.setHappyAtgpSn(happyAtgpSn);                // 첨부파일 그룹 일련번호
        happyBoardAtfiVO.setHappyAtfiOgName(file.getOriginalFilename());    // 첨부파일 원본명
        happyBoardAtfiVO.setHappyAtfiSfName(fileName);                       // 첨부파일 저장명
        happyBoardAtfiVO.setHappyAtfiExt(fileExt);                               // 첨부파일 확장자명
        happyBoardAtfiVO.setHappyAtfiUrl(filePath);                            // 첨부파일 저장 경로

        // 첨부파일 정보 DB에 등록
        happyAtgpSn = mypageService.insertHappyAtfiInfo(happyBoardAtfiVO);

    } catch (NullPointerException np) {
        np.printStackTrace();
        happyFile.delete();
        happyAtgpSn = "400";
    } catch (IOException ie) {
        ie.printStackTrace();
        happyFile.delete();
        happyAtgpSn = "400";
    } catch (Exception e) {
        e.printStackTrace();
        happyFile.delete();
        happyAtgpSn = "400";
    }

    return happyAtgpSn;
}

JAVA IO API를 이용하여 업로드 기능을 구현할 수도 있습니다.

# 파일 다운로드

파일 다운로드를 위한 방법으로 스트림 방식과 URL 제공 방식이 있습니다.

스트리밍 방식 : 데이터를 outputStream에 담아 전송
URL 제공 방식 : 파일이 저장되어 있는 경로를 제공하여 브라우저에서 다운로드

# 스트림 방식

# NIO.2 API (JDK7)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37


public void happyFileDownload(HttpServletRequest request, HttpServletResponse response) throws Exception {
    String happyAtfiSn = request.getParameter("happyAtfiSn");
    String happyAtgpSn = request.getParameter("happyAtgpSn");
    String happyAtfiOgName = request.getParameter("happyAtfiOgName");
    String happyAtfiSfName = request.getParameter("happyAtfiSfName");

    // 요청 파일명 확인
    if (happyAtfiSfName == null) {
        return;
    }
    String filePath = "happyBoard/atch/";
    Path file = Paths.get(filePath, happyAtfiSfName);

    // 파일이 없다면 종료
    if (!Files.exists(file) || !Files.isRegularFile(file)) {
        return;
    }

    // 브라우저에 따른 인코딩
    String browser = request.getHeader("User-Agent");
    String encodedFileName = "";

    // 브라우저 종류에 따른 파일명 인코딩
    if (browser.contains("MSIE") || browser.contains("Trident") || browser.contains("Chrome")) {
        // 브라우저 확인 파일명
        encodedFileName = URLEncoder.encode(happyAtfiOgName, "UTF-8").replaceAll("\\+", "%20").replace("+", "%20");
    } else {
        encodedFileName = new String(happyAtfiOgName.getBytes("UTF-8"), "ISO-8859-1");
    }

    // response 타입 설정
    response.setHeader("Content-Disposition", "attachment;filename=" + encodedFileName);
    response.setContentType("application/octet-stream");

    // 파일 response로 전송
    Files.copy(file, response.getOutputStream());
}

일반적인 파일 다운로드 기능은 NIO API를 이용하여 파일 다운로드 기능을 구현할 수 있습니다.

참고: Files.copy()는 8192byte의 버퍼 사이즈를 가집니다.

# IO API (Before JDK7)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15


File file = new File(filePath + happyAtfiSfName);
// 중략
fis = new FileInputStream(file);
bis = new BufferedInputStream(fis);
so = response.getOutputStream();
bos = new BufferedOutputStream(so);

byte[] data = new byte[2048];
int input = 0;

// 버퍼에 데이터를 담아 없을 때까지 전송
while ((input = bis.read(data)) != -1) {
    bos.write(data, 0, input);
    bos.flush();
}

NIO API가 나오기 전, 직접 stream을 열어 loop를 통해 전달하는 전통적인 방식입니다.
FileInputStream과 ServletOutputStream만 이용해도 되지만 성능을 높이기 위해 Buffer를 붙입니다.

FileInputStream: 이 클래스는 파일로부터 바이트 단위로 데이터를 읽어오는데 사용됩니다. 파일을 열고 그 내용을 읽어들일 때 주로 활용됩니다.
BufferedInputStream: 이 클래스는 데이터를 읽어올 때 성능을 향상시키기 위해 사용됩니다. FileInputStream과 같이 사용되며, 데이터를 버퍼에 저장해두고 필요할 때 버퍼로부터 읽어오는 방식으로 동작합니다. 이는 입출력 작업을 보다 효율적으로 수행할 수 있도록 도와줍니다.
ServletOutputStream: 이 클래스는 서블릿에서 클라이언트로 데이터를 보낼 때 사용됩니다. 서블릿 컨테이너에서 제공되며, HTTP 응답의 출력 스트림을 나타냅니다. 클라이언트로 데이터를 보내기 위해 사용됩니다.
BufferedOutputStream: 이 클래스는 데이터를 쓸 때 성능을 향상시키기 위해 사용됩니다. ServletOutputStream과 같이 사용되며, 데이터를 버퍼에 저장해두고 필요할 때 버퍼의 내용을 출력하는 방식으로 동작합니다. 이는 입출력 작업을 보다 효율적으로 수행할 수 있도록 도와줍니다.

이렇게 설정된 스트림들은 파일의 내용을 읽어들여 클라이언트에게 전송하는 데 사용됩니다. FileInputStream과 BufferedInputStream은 파일에서 데이터를 읽어오고, ServletOutputStream과 BufferedOutputStream은 클라이언트로 데이터를 전송합니다.

그 밖에

Apache Commons IO
Guava(Google)

등을 이용하여 구현할 수도 있습니다.

# 성능 비교

NIO API와 IO API의 파일 처리 속도를 테스트했습니다.
81.4MB 크기의 PDF 파일로 테스트했으며 괄호는 buffer 크기입니다.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27


- NIO API(8192)
메서드 실행 시간: 284밀리초
메서드 실행 시간: 228밀리초
메서드 실행 시간: 219밀리초
메서드 실행 시간: 197밀리초
메서드 실행 시간: 206밀리초

- JAVA IO(2048)
메서드 실행 시간: 1000밀리초
메서드 실행 시간: 594밀리초
메서드 실행 시간: 887밀리초
메서드 실행 시간: 730밀리초
메서드 실행 시간: 895밀리초

- JAVA IO(4096)
메서드 실행 시간: 288밀리초
메서드 실행 시간: 281밀리초
메서드 실행 시간: 359밀리초
메서드 실행 시간: 360밀리초
메서드 실행 시간: 570밀리초

- JAVA IO(8192)
메서드 실행 시간: 448밀리초
메서드 실행 시간: 343밀리초
메서드 실행 시간: 312밀리초
메서드 실행 시간: 351밀리초
메서드 실행 시간: 341밀리초

NIO API의 평균값이 더 좋은 성능을 보이며 이는 buffer 크기 차이는 아닙니다.

Using NIO.2 can significantly increase file copying performance since the NIO.2 utilizes lower-level system entry points.

이는 NIO API의 files.copy() 메소드는 Direct Buffer를 사용하여 데이터를 전송하기 때문에 뛰어난 퍼포먼스를 보여준다고 합니다.
Direct Buffer는 JVM 힙 메모리 외부에 위치하므로, 데이터 복사 시 메모리 복사 오버헤드가 줄어듭니다.

Files.copy() 메서드 중

1
2
3
4
5
6
7
8


public static long copy(Path source, OutputStream out) throws IOException {
        // ensure not null before opening file
        Objects.requireNonNull(out);

        try (InputStream in = newInputStream(source)) {
            return copy(in, out);
        }
    }

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13


public InputStream newInputStream(Path path, OpenOption... options)
        throws IOException
    {
        if (options.length > 0) {
            for (OpenOption opt: options) {
                // All OpenOption values except for APPEND and WRITE are allowed
                if (opt == StandardOpenOption.APPEND ||
                    opt == StandardOpenOption.WRITE)
                    throw new UnsupportedOperationException("'" + opt + "' not allowed");
            }
        }
        return Channels.newInputStream(Files.newByteChannel(path, options));
    }

내부 코드를 보면 newInputStream()을 호출하는데 해당 메서드에서 Channel을 이용하는 것을 확인할 수 있습니다.

# 채널

입출력 채널(I/O channel)은 프로세서가 다른 일을 하지 못하는 문제를 해결하기 위해 개발되었습니다.
채널은 중앙 처리 장치와 주변 장치의 동작을 분리시켜, 프로세서가 다른 작업을 수행할 수 있도록 합니다.
채널은 주기억 장치에 직접 접근하여 정보를 저장하거나 검색할 수 있습니다.

채널 방식을 이용할 때 다음과 같은 장점이 있습니다.

양방향 통신 지원
- 채널 방식은 단일 채널로 양방향 입출력이 가능합니다.
- 이를 통해 데이터 송수신을 동시에 처리할 수 있어 효율적입니다.
버퍼 메커니즘 활용
- 채널 방식은 버퍼를 사용하여 입출력 데이터를 관리합니다.
- 버퍼를 통해 데이터를 일시적으로 저장하고 관리할 수 있어, 프로세서가 다른 작업을 수행할 수 있습니다.
프로세서 활용도 향상
- 채널 방식은 프로세서와 주변 장치의 동작을 분리시켜, 프로세서가 다른 작업을 수행할 수 있도록 합니다.
- 이를 통해 프로세서의 활용도가 높아져 전체적인 시스템 성능이 향상됩니다.
비동기 처리 지원
- 채널 방식은 비동기 입출력을 지원하여, 데이터 전송 중에도 다른 작업을 수행할 수 있습니다.
- 이를 통해 전체적인 시스템 응답성이 향상됩니다.

따라서 채널 방식은 버퍼 메커니즘, 양방향 통신, 비동기 처리 등의 기능을 통해 스트림 방식보다 성능이 우수합니다. 이는 프로세서의 활용도를 높이고 전체적인 시스템 성능을 향상시킬 수 있습니다.

# 결론

NIO API의 files.copy() 메소드는 Direct Buffer 사용, FileChannel 활용, 비동기 처리 지원 등의 기능을 통해 기존 java.io 방식보다 더 높은 성능을 발휘할 수 있다고 정리할 수 있습니다.

# URL 제공 방식

1
2
3
4
5
6
7
8
9


@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/files/**")
        .addResourceLocations("file:///your/path/location");      
    }
}

url 지정(localhost:8080/files/)

1

registry.addResourceHandler("/files/**")

리소스 파일의 실제 주소 설정

1
2
3
4
5
6
7
8


// 리눅스 경우 root에서 시작하는 폴더 경로 지정 할 경우 
.addResourceLocations("file:///usr/download/") 

// 리소스 템플릿 경로를 지정할 경우
.addResourceLocations("classpath:/templates/", "classpath:/static/")

// 윈도우에서 실행 시 다음과 같은 형태로 드라이브 문자 포함 경로 지정 
.addResourceLocations("file:///C:/~/")

파일 리소스의 경로와 URL 경로를 맵핑하여 파일에 접근할 수 있습니다.

테스트

경로를 통해 정상적으로 다운로드가 가능한 것을 확인했습니다.

# 파일 삭제

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33


public int happyFileDel(String happyAtfiSfName, String happyAtfiSn) throws Exception {
    int code = 400;
  try {

        String filePath = "happyBoard/atch";

        File happyFile = new File(filePath + happyAtfiSfName);

        // 첨부파일 삭제
        boolean progress = happyFile.delete();

    if (progress) {
      // 첨부파일 정보 삭제
      mypageService.happyAtfiDelete(happyAtfiSn);

      code = 200;
    }

  } catch (NullPointerException np) {
    np.printStackTrace();
    code = 400;
    return code;
  } catch (IOException ie) {
    ie.printStackTrace();
    code = 400;
    return code;
  } catch (Exception e) {
    e.printStackTrace();
    code = 400;
    return code;
  }
  return code;
}

파일 삭제의 경우, 서버에 올라간 파일을 삭제 후 DB테이블의 파일도 삭제를 해주셔야 합니다.
해당 메서드를 파일삭제, 게시글 삭제 등 적절한 요청에 붙여서 사용했습니다.