[JAVA] FTP Util Video Streaming Refactoring - java.lang.IllegalStateException: getOutputStream() has already been called for this response

🌟 INDEX

• FTP 서버 영상 스트리밍 개선
• 오류 내용
  • getOutputStream() has already been called for this response
  • 서블릿에서 HTTP 응답을 작성할 때, 응답의 바디를 작성하는 두 가지 주요 방법
• 오류 분석
  • 1. out.close() 호출 시점
  • 2. 중복된 스트림 처리
  • 3. 예외 처리
• 코드 개선 및 오류 해결
  • 수정 내용
  • 수정 완료
• 개발 환경

---

FTP 서버 영상 스트리밍 개선

FTP 서버 영상 스트리밍이 잘 되는 것 까지 테스트를 완료하고 프로젝트 진행 중.. 
getOutputStream() has already been called for this response 오류가 발생했다.

전체 적인 FTP 서버 생성 및 설정, FTP 와 연결하는 API 내용은 벨로그에서 작성 해두었으나 추후에 티스토리로 옮길 예정이다.. ㅎㅎ

오류 내용

liyo-ftp | 2024-08-14T15:11:06.615+09:00 ERROR 1 --- [service-ftp] [nio-8811-exec-3] [] o.a.c.c.C.[.[.[/].[dispatcherServlet]   
: Servlet.service() for servlet [dispatcherServlet] in context with path [] threw exception [Request processing failed: java.lang.IllegalStateException: getOutputStream() has already been called for this response] with root cause
liyo-ftp | 
liyo-ftp | java.lang.IllegalStateException: getOutputStream() has already been called for this response
liyo-ftp |       at org.apache.catalina.connector.Response.getWriter(Response.java:549)
liyo-ftp |       at org.apache.catalina.connector.ResponseFacade.getWriter(ResponseFacade.java:188)
liyo-ftp |       at jakarta.servlet.ServletResponseWrapper.getWriter(ServletResponseWrapper.java:108)
liyo-ftp |       at jakarta.servlet.ServletResponseWrapper.getWriter(ServletResponseWrapper.java:108)
liyo-ftp |       at jakarta.servlet.ServletResponseWrapper.getWriter(ServletResponseWrapper.java:108)

---

getOutputStream() has already been called for this response

이 에러 메시지는 getOutputStream() 메서드가 이미 호출된 후에 getWriter() 메서드를 호출하려고 해서 발생하는 IllegalStateException입니다.

Java 서블릿에서 HTTP 응답을 작성할 때, 응답의 바디를 작성하는 두 가지 주요 방법

• getOutputStream(): 바이너리 데이터를 작성할 때 사용합니다.
• getWriter(): 텍스트 데이터를 작성할 때 사용합니다.

이 두 메서드는 동시에 사용할 수 없으며,  getOutputStream()을 호출하여 응답 스트림을 열었으면 그 후에는 getWriter()를 호출할 수 없고, 그 반대도 마찬가지입니다.

 

해당 에러 메시지는 getOutputStream() 이 이미 호출 되어 있는데, getWriter()를 호출하려 해서, IllegalStateException 예외가 발생했습니다.

 

한 번은 동작 했지만 두 번은 안 됐던 이유... 

---

오류 분석

/**
* 비디오 스트리밍
* @author liyo
* @param vo
* @param resp
* @throws IOException
*/
public void video(FtpVo vo, HttpServletResponse resp) throws IOException {
	String fileNm = vo.getFileNm();
	FTPClient ftpClient = pool.getFTPClient();
    
	try {
		// ftpClient.enterLocalActiveMode(); // 능동
		ftpClient.enterLocalPassiveMode(); // 수동
        
		// 확장자별 MIME 타입 설정
		String mimeType = getMimeType(fileNm);

		resp.setContentType(mimeType);
		resp.setHeader("Content-Transfer-Encoding", "binary");
		resp.setHeader("Pragma", "no-cache");
		resp.setHeader("Expires", "0");
		resp.setHeader("Content-Disposition", "inline;filename=" + URLEncoder.encode(fileNm, "UTF-8") + ";");

		OutputStream out = resp.getOutputStream();
		InputStream inputStream = null;

		if (vo.isGroup()) {
			inputStream = ftpClient.retrieveFileStream(fileNm);
		} else {
			inputStream = ftpClient.retrieveFileStream(BesysConstants.NOGROUP + BesysConstants.SLASH + fileNm);
		}

		if (inputStream == null) {
			throw new IOException(ftpClient.getReplyString());
		}

		int len;
		byte[] buf = new byte[8192];
		while ((len = inputStream.read(buf)) != -1) {
			out.write(buf, 0, len);
		}

		out.flush();
		inputStream.close();
		out.close();

		if (!ftpClient.completePendingCommand()) {
			throw new IOException("Could not complete FTP command");
		}

	} catch (Exception e) {
		log.error("Video streaming failed: {}", e);
		throw new IOException("Video streaming failed", e);
	} finally {
		if (ftpClient != null && ftpClient.isConnected()) {
			try {
				ftpClient.logout();
			} catch (IOException ex) {
				log.error("Error logging out from FTP server: {}", ex);
			}
			pool.returnFTPClient(ftpClient);
		}
	}
}

 

오류가 발생한 코드는 위와 같습니다.

1. out.close() 호출 시점

• OutputStream을 직접 닫기[close()] 전에, 스트림이 닫힌 상태에서 다른 스트림을 시도하거나, 이미 응답이 끝난 후 추가적인 처리를 시도하는 경우 문제가 발생할 수 있습니다.
• out.close()가 inputStream.close() 이후에 호출되고, 그 후에도 더 이상 응답에 작성되지 않도록 해야 합니다.

2. 중복된 스트림 처리

• 메서드가 정상적으로 스트림을 처리한 후, 다른 곳에서 같은 응답에 대해 또 다른 스트림을 열려고 시도하면 문제가 발생할 수 있습니다.
• 주의 깊게 확인해야 하는 것은 코드 외부에서 이 메서드가 호출된 이후, 동일한 응답 객체(HttpServletResponse)를 사용하는 다른 코드에서 getOutputStream() 또는 getWriter()를 호출하려고 하는지 여부입니다.

3. 예외처리

• 예외가 발생하면 스트림을 닫지 않고, 그대로 남아 있는 경우 finally 블록에서 또는 다른 후속 코드에서 또 다른 스트림을 시도할 때 문제가 발생할 수 있습니다.
• 예외가 발생하더라도 스트림이 정상적으로 닫히도록 신경 써야 합니다.

---

코드 개선 및 오류 해결

/**
* 비디오 스트리밍
* @author liyo
* @param vo
* @param resp
* @throws IOException
*/
public void video(FtpVo vo, HttpServletResponse resp) throws IOException {
    String fileNm = vo.getFileNm();
    FTPClient ftpClient = pool.getFTPClient();
    OutputStream out = null;
    InputStream inputStream = null;

    try {
        // FTP 모드 설정
        ftpClient.enterLocalPassiveMode();

        // 확장자별 MIME 타입 설정
        String mimeType = getMimeType(fileNm);
        resp.setContentType(mimeType);
        resp.setHeader("Content-Transfer-Encoding", "binary");
        resp.setHeader("Pragma", "no-cache");
        resp.setHeader("Expires", "0");
        resp.setHeader("Content-Disposition", "inline;filename=" + URLEncoder.encode(fileNm, "UTF-8") + ";");

        // 응답 OutputStream과 FTP InputStream 초기화
        out = resp.getOutputStream();
        inputStream = vo.isGroup() ? ftpClient.retrieveFileStream(fileNm) 
                                   : ftpClient.retrieveFileStream(BesysConstants.NOGROUP + BesysConstants.SLASH + fileNm);

        if (inputStream == null) {
            throw new IOException(ftpClient.getReplyString());
        }

        // 데이터 전송
        byte[] buf = new byte[8192];
        int len;
        while ((len = inputStream.read(buf)) != -1) {
            out.write(buf, 0, len);
        }
        out.flush();

        // FTP 명령 완료 확인
        if (!ftpClient.completePendingCommand()) {
            throw new IOException("Could not complete FTP command");
        }

    } catch (Exception e) {
        log.error("Video streaming failed: {}", e);
        throw new IOException("Video streaming failed", e);
    } finally {
        // 스트림 안전하게 닫기
        if (inputStream != null) {
            try {
                inputStream.close();
            } catch (IOException ex) {
                log.error("Error closing input stream: {}", ex);
            }
        }

        if (out != null) {
            try {
                out.close();
            } catch (IOException ex) {
                log.error("Error closing output stream: {}", ex);
            }
        }

        // FTP 연결 해제 및 반환
        if (ftpClient != null && ftpClient.isConnected()) {
            try {
                ftpClient.logout();
            } catch (IOException ex) {
                log.error("Error logging out from FTP server: {}", ex);
            }
            pool.returnFTPClient(ftpClient);
        }
    }
}

수정 내용

1. 스트림(InputStream 및 OutputStream)을 finally 블록에서 안전하게 닫습니다.

2. FTP 연결 해제 및 반환도 finally 블록에서 이루어집니다.

3. close() 메서드 호출을 적절한 위치에 배치하여, 한 번 스트림을 닫으면 이후에 더 이상 응답을 처리하지 않도록 합니다.

수정 완료!

위와 같이 수정하여 getOutputStream() 또는 getWriter()를 반복해서 호출하는 문제를 방지하였습니다.

포스트맨 테스트 결과 성공적으로 영상이 스트리밍 됩니다.

 

 

해당 API 를 웹에서 호출해도 잘나타나는 모습입니다!

---

개발 환경

• Backend
  • Framework: Spring Boot 3.2.2
  • Language: Java
  • Gateway: Spring Cloud Gateway
• Database
  • DBMS: MS SQL Server
  • Container: Docker
• Development Tools
  • IDE: Visual Studio Code (VSCode)