캐모마일 엑셀 모듈 가이드

개요

조회된 데이터를 엑셀파일로 만들어주거나 사용자에게 다운받을 수 있도록 제공해준다.

엑셀파일을 import가능한 형태의 데이터로 만들어주어 개발자에게 편의성을 제공한다.

Apache Poi 기반으로 작성되어 있어 apache poi 가 내장되어있고 제공해주는 기능 외에 apche poi를 직접 쓸수있다.

사용법

dependency

<dependency>
  <groupId>net.lotte.chamomile.module</groupId>
  <artifactId>chamomile-file-excel</artifactId>
  <version>3.0.0-SNAPSHOT</version>
</dependency>

엑셀 데이터 import

엑셀 import는 크게 SpreadSheet를 만드는 toSpreadSheet와 만들어진 DTO 클래스 기반으로 바로 변환해주는 toCustomClass 매서드를 제공한다.

1) toCustomClass 매서드 예시

@Data
public class TestExcelImportDTO { // 엑셀 정보를 가져올 DTO 클래스 작성

    private String userId; // 엑셀 컬럼 명과 일치해하는 필드명을 입력함

    private Long age;

    private LocalDateTime date;

    private String nullString;
}

// 파일업로드이력 DB write
List<TestExcelImportDTO> list = new ExcelImporter().toCustomClass(fileVo.getRealFilePath(), TestExcelImportDTO.class);

2) toSpreadSheet 매서드.

String path = [파일 경로]
SpreadSheet ss = ExcelImporter.toSpreadSheet(path);

SpreadSheet객체는 아래와 같은 구조로 이루어져 있다.

SpreadSheet
    - sheet목록
        - sheet명
            - 행 목록
                - 셀 목록

이 객체에서 vo를 가지는 List형태로 값을 변환하고자 할 경우 아래의 과정으로 변환할 수 있다.

List<VO클래스명> listData = (List<VO클래스명>) ExcelCommonUtil.getListFromExcel([SpreadSheet객체], "[sheet명]", VO클래스명.class);

엑셀데이터 export

export는 서버에 파일로 저장하는 방식과 사용자에게 다운로드 하는 방식을 제공한다.
제공하는 어노테이션을 붙인 DTO 클래스를 만들고 다운로드를 구현한다.

@ExcelSheet(name="Auth")
public class AuthDTO {

@ExcelColumn(name="컬럼명1", index=0)
private String column1;
@ExcelColumn(name="컬럼명2", index=1)
private String column2;
...

@GetMapping("/excel/download")
public ResponseEntity<byte[]> excelDownload(AuthQuery authQuery) {
    ExcelExporter excelExporter = new ExcelExporter("authmgmt.xlsx");
    // 위에 작성한 어노테이션을 붙인 DTO
    List<AuthDTO> results = authService.getAuthList(authQuery); 

    // 엑셀 데이터 추가
    excelExporter.addDataList(results);
    return excelExporter.toHttpResponse();
}

엑셀 api

Excel Export시 사용되는 annotation정보