Apache Poi로 엑셀 다운로드 기능 구현하기

 

최근에 간단한 추가 개발로 엑셀 다운로드 기능 요청이 들어왔다. 

엑셀 다운로드 기능 구현이야 쉽지~ 하고 제일 마지막으로 미뤄뒀다가 나의 개발 무지 (?) 로 인해서 1 ~ 2시간이면 완성할 것을 중간에 다른 일도 하면서 오류 파악하느라.. 3일동안 끌었던 것 같다. 

일단 이걸 몰라서 3일 동안 끌었던 내가 너무 한심 (?) 해서.. 다음엔 똑같은 실수 하고 싶지 않아서 기록한다. 

( Okky 에서 7년전에 질문하신 분 덕분에 제가 살았습니다.. 감사를.. 😭 )

 

이상 tmi 였고,

밑에서부터는 이제 자바로 Apache Poi를 이용해 간단한 엑셀 파일을 만들어 다운로드 하는 방법입니다. 

 

0️⃣ Apache poi 라이브러리 다운 

https://mvnrepository.com/artifact/org.apache.poi/poi/4.1.2

-> 이 사이트에서 Apache Poi 라이브러리를 다운받을 수 있다. 나는 예전 프로젝트라서 (거의 ~~ 10년전 프로젝트인것 같음,, ) Apache Poi 라이브러리 버전은 3.9이지만 이 글을 보시는 분들은 비교적 최근 + 많이 다운받은 라이브러리를 사용하시기를 ..!

(버전별로 차이 있다는 글을 어디선가 본 것 같기는 합니다만... 이건 제피셜입니다) 굳이 예전 라이브러리 사용할 필요는 없으니... 

 

 

1️⃣ Controller 생성 

@RequestMapping(value = "/downloadExcel")
public void downloadExcel(HttpServletRequest request,  HttpServletResponse response)
{
    xxxService.selectExcelDataList(request, response);
}

-> 이런식으로 클라이언트에서 엑셀 다운로드 GET 요청을 하면, 서버에서 엑셀 데이터를 생성해서 엑셀 파일 다운로드 할 수 있도록 한다! 

위에 코드는 예제 코드로 테스트용이라면 굳이 DB 조회를 하지 않아도 되니, 직접 엑셀 데이터를 조금 만들어서 구현해도 될 듯하다. 저는 DB 조회를 해서 만들어야 하기 때문에 Service도 따로 만든 것입니다 ~_~ 

 

 

2️⃣ Service 생성 

@Override
public void selectExcelDataList(HttpServletRequest request, HttpServletResponse response)
{
    List<xxxVo> resultList = xxxDao.selectExcelDataList(smishingVo);
    ExcelUtil.downloadExcel(resultList, request, response);
}

-> 이런식으로 서비스를 만들어서 우선 엑셀 파일에 넣을 데이터를 DB에서 조회해서 resultList에 담고, ExcelUtil이라는 Util 클래스를 만들고 거기서 엑셀 다운 메서드에 resultList를 넘겨줬다. 

 

 

3️⃣ Excel, Sheet, Header 생성 

public static void downloadExcel(List<xxxVo> resultLit,
        HttpServletRequest request, HttpServletResponse response)
{
    String fileName = "Excel_" + DateUtil.getTodayDateTime("yyyyMMddHHmmss") + ".xlsx";
    String sheetName = "데이터 시트";
    
    try
    {
        // WorkBook 초기화
        Workbook workbook = new SXSSFWorkbook();
       
        // Sheet 초기화
        Sheet sheet = workbook.createSheet(sheetName);
        
        // Row 생성
        Row row = sheet.createRow(0);
        
        // Cell 생성
        Cell cell1 = row.createCell(1);
        cell1.setCellValue("Cell1");
        cell1.setCellStyle(titleStyle);
        
        Cell cell2 = row.createCell(2);
        cell2.setCellValue("Cell2");
        cell2.setCellStyle(titleStyle);
        
        Cell cell3 = row.createCell(3);
        cell3.setCellValue("Cell3");
        cell3.setCellStyle(titleStyle);
        
        Cell cell4 = row.createCell(4);
        cell4.setCellValue("Cell4");
        cell4.setCellStyle(titleStyle);
        
        Cell cell5 = row.createCell(5);
        cell5.setCellValue("Cell15");
        cell5.setCellStyle(titleStyle);
        
        int i = 0;
        if (!resultLit.isEmpty()) {
for (xxxVo vo : resultLit)
{
    row = sheet.createRow((i + 1));
    
    cell1 = row.createCell(1);
    cell1.setCellValue();
    cell1.setCellStyle(stringStyle);
    
    cell2 = row.createCell(2);
    cell2.setCellValue();
    cell2.setCellStyle(stringStyle);
    
    cell3 = row.createCell(3);
    cell3.setCellValue();
    cell3.setCellStyle(stringStyle);
    
    cell4 = row.createCell(4);
    cell4.setCellValue();
    cell4.setCellStyle(stringStyle);
    
    cell5 = row.createCell(5);
    cell5.setCellValue();
    cell5.setCellStyle(stringStyle);
    
    i++;
}
        }
        
        //수동 컬럼 사이즈 (대략 10글자)
        sheet.setColumnWidth(1, 30*256);
        sheet.setColumnWidth(2, 20*256);
        sheet.setColumnWidth(3, 20*256);
        sheet.setColumnWidth(4, 20*256);
        sheet.setColumnWidth(5, 20*256);
        
        response.setContentType("application/x-msdownload");
        String encodedFileName = HttpUtil.getDisposition(fileName, HttpUtil.getBrowser(request));
        response.setHeader("Content-Disposition", encodedFileName);
        workbook.write(response.getOutputStream());
    }
    catch (Exception e) {
        e.printStackTrace();
    }
    
}

 

- 먼저 다운로드 받을 파일의 이름을 fileName에 설정해준다. (나는 다운 받을 때 마다, 파일명이 (1), (2)... 이렇게 다운받는게 싫어서 날짜 + 시간을 포함해서 제목에 넣어뒀다.) 

- 그리고 시트 이름은 그냥 예시로 '데이터 시트'라고 했는데 이건 사용하는 사람이 원하는 시트명을 넣으면 된다. 

 

- WorkBook을 초기화해준다. 

 Workbook workbook = new SXSSFWorkbook();

이때 SXSSF 는 대용량 엑셀 파일을 출력할 때 사용한다. 

HSSF : .xls 파일 포맷을 사용할 때 사용 
XSSF : .xlsx 파일 포맷을 사용할 때 사용 
SXSSF : 대용량 엑셀 파일을 출력할 때 사용 

 

- 그리고 스타일을 직접 변경할 수도 있는데.. 스타일이 지금 중요하지 않기 때문에 그냥 기본 스타일로 진행할 예정이다. 

(구글링하면 엑셀 스타일 바꾸는 방법은 많습니다..!) 

 

- WorkBoot 초기화후에는 우리가 만든 시트 이름으로 시트를 생성한다. 

        // Sheet 초기화
        Sheet sheet = workbook.createSheet(sheetName);

 

 

- 맨 처음 타이틀 row를 만들어줘야 하기 때문에 row를 생성하고, 타이틀 값들을 정의해준다. 

        // Row 생성
        Row row = sheet.createRow(0);
        
        // Cell 생성
        Cell cell1 = row.createCell(1);
        cell1.setCellValue("Cell1");
        cell1.setCellStyle(titleStyle);
        
        Cell cell2 = row.createCell(2);
        cell2.setCellValue("Cell2");
        cell2.setCellStyle(titleStyle);
        
        Cell cell3 = row.createCell(3);
        cell3.setCellValue("Cell3");
        cell3.setCellStyle(titleStyle);
        
        Cell cell4 = row.createCell(4);
        cell4.setCellValue("Cell4");
        cell4.setCellStyle(titleStyle);
        
        Cell cell5 = row.createCell(5);
        cell5.setCellValue("Cell15");
        cell5.setCellStyle(titleStyle);

 

 

- 그리고 DB에서 조회해 온 데이터인 resultList를 반복문을 통해 row 생성해준다. 

        int i = 0;
        if (!resultLit.isEmpty()) {
for (xxxVo vo : resultLit)
{
    row = sheet.createRow((i + 1));
    
    cell1 = row.createCell(1);
    cell1.setCellValue();
    cell1.setCellStyle(stringStyle);
    
    cell2 = row.createCell(2);
    cell2.setCellValue();
    cell2.setCellStyle(stringStyle);
    
    cell3 = row.createCell(3);
    cell3.setCellValue();
    cell3.setCellStyle(stringStyle);
    
    cell4 = row.createCell(4);
    cell4.setCellValue();
    cell4.setCellStyle(stringStyle);
    
    cell5 = row.createCell(5);
    cell5.setCellValue();
    cell5.setCellStyle(stringStyle);
    
    i++;
}
        }

 

 

- 그리고 데이터 길이때문에 엑셀 처음 다운받고 데이터 확인할 때 칸이 좁으니까 수동으로 컬럼 사이즈를 조절했다. 

(이것도 찾아보면 자동으로 컬럼 사이즈 조절하는 글들이 많이 있어요 !) 

//수동 컬럼 사이즈 (대략 10글자)
        sheet.setColumnWidth(1, 30*256);
        sheet.setColumnWidth(2, 20*256);
        sheet.setColumnWidth(3, 20*256);
        sheet.setColumnWidth(4, 20*256);
        sheet.setColumnWidth(5, 20*256);

 

 

- 이렇게 하면 엑셀 파일은 스타일은 별로겠지만 기본적으로는 완성이 됐다..! 

그리고 이제 웹이라고 한다면 엑셀 다운로드 버튼이 있을 것이고 그 버튼을 눌렀을 때 엑셀을 파일로 다운로드 할 수 있는 방법이다. 

        response.setContentType("application/x-msdownload");
        String encodedFileName = HttpUtil.getDisposition(fileName, HttpUtil.getBrowser(request));
        response.setHeader("Content-Disposition", encodedFileName);
        workbook.write(response.getOutputStream());

그리고 혹시 한글 파일로 다운로드 하고 싶다면 인코딩을 해야 한다. 

 

String encodedFileName = new String(filename.getBytes("UTF-8"), "ISO-8859-1");
rtnFileName = String.format("attachment; filename=\"%s\";", encodedFileName);

-> 크롬일 경우에는 이렇게 인코딩한 rtnFileName으로 response header에 담아야 한다. 

 

+ 그리고 혹시 엑셀 다운로드 기능 구현했는데 '파일 형식 또는 파일 확장명이 잘못되어 xlsx 파일을 열 수 없습니다.' 이런 오류가 발생한다면  workbook.write(response.getOutputStream()); <= 이 코드 작성 했는지 확인해보세요..ㅎㅎ 저는 빼먹고 했다가 계~속 당연히 다운만 되고 안열려서 또 한참을 봤네요 ㅎㅋㅋ 하... 

 

+ 그리고 혹시 다 ~~ 구현 했는데 다운로드 버튼을 눌렀는데 동작을 안한다면... ajax로 동작하도록 했는지 확인해보세요... location.href로 해야 한다고 하더라고요...? 기본적으로 ajax는 파일 다운로드를 못한다는 사실을 제대로 알지 못했습니다..... 진짜 멍청.... 😂😂😂😂 교훈 씨게 얻고 갑니다 ㅋㅋ ㅠ 

 

 

암튼 이렇게 간단하게 엑셀 파일 다운로드 구현하는 방법에 대해서 기록을 남깁니다. 

제 글이... 어떤 한 분에게라도 도움이 되길 😀😀😀