서버모듈 함수 (appendix)

서버모듈(jsp)에서 사용하는 Java API입니다.
엑셀/텍스트 다운로드는 IBSheetDown, 업로드는 IBSheetLoad, PDF 다운로드는 Print2Pdf 클래스를 사용합니다.
서버모듈 설치와 jsp 설정은 엑셀파일 업로드/다운로드를 참고하세요.

API 사용

서버모듈 API를 사용하려면 먼저 생성자를 호출해 객체를 만들어야 합니다.

// request, response를 포함해 IBSheetDown 생성자 호출
IBSheetDown down = new IBSheetDown(request, response);

// 인코딩 설정
down.setEncoding("UTF-8");

// 다운로드 파일명 반환
down.getFileName();

IBSheetDown (다운로드)

XLSX, XLS, CSV, TEXT 파일을 다운로드합니다.

생성자

appendDataArr(data)

시트에 String[] 형태의 데이터를 한 줄 덧붙입니다. (DirectDown2Excel 전용)

appendDataList(data)

시트에 List 형태의 데이터를 한 줄 덧붙입니다. (DirectDown2Excel 전용)

appendDataMap(data)

시트에 Map 형태의 데이터를 한 줄 덧붙입니다. (DirectDown2Excel 전용)

appendMultiData(data)

시트에 데이터를 여러 줄 덧붙입니다. (DirectDown2Excel 전용)

close()

다운로드를 종료하고 메모리를 해제합니다.

downToBrowser()

생성된 문서를 브라우저를 통해 다운로드합니다.

downToStream(OutputStream)

생성된 문서를 OutputStream으로 전송합니다.

getDownError(errorCode, message)

다운로드 중계 페이지(주로 directDown2Excel)에서 조건 불충족 등으로 파일 대신 에러를 내려보낼 때 사용합니다. downToBrowser() 대신 반환된 byte[]를 OutputStream으로 출력하면, 클라이언트 onExportFinish 이벤트에 실패(result 0)로 전달되어 message로 안내할 수 있습니다. 인자 없이 getDownError()를 호출하면 기본 에러 메시지가, getDownError(message)는 메시지만 지정하는 형태입니다.

// 정상은 downToBrowser(), 에러 조건에서만 getDownError 출력
OutputStream out = response.getOutputStream();
out.write(down.getDownError("조회 건수가 너무 많습니다."));
out.flush();

getExtendParam(key)

시트에서 전달한 ExtendParam 정보를 받습니다. (반환: String, key에 해당하는 값)

getFileName()

생성된 파일명을 반환합니다. (반환: String)

saveToFile(path)

생성된 문서를 서버의 특정 폴더에 저장합니다.

setData(data)

클라이언트가 보낸 시트 전문(Data 파라미터)을 세팅합니다.
멀티파트 필터가 걸린 환경이나 multipart: 0(일반 POST) 전송 시, 서버에서 request.getParameter("Data")로 읽어 setService 호출 전에 세팅해야 합니다.

String data = request.getParameter("Data");
down.setData(data);   // setService 호출 전에 먼저 세팅

setDirectRequestData()

HttpRequest에 SHEETDATA라는 Attribute가 저장되어 있는 경우, 해당 데이터를 다운로드합니다. (DirectDown2Excel 전용)

setDownFinish()

다운로드 종료 정보를 시트에 전달하고, 화면의 대기 이미지를 닫기 위한 FileDownloadToken 쿠키를 생성합니다.

setLog(isLog)

서버 콘솔에 다운로드 처리 상세 로그를 출력할지 설정합니다. 브라우저나 서버 콘솔에 별다른 에러 없이 다운로드가 실패할 때 원인 파악에 사용합니다.
출력 로그에는 처리 시점의 JVM 메모리, 파일 정보, 소요 시간 등이 포함되며, excel mode=POI가 표시되면 POI 라이브러리가 정상 로드되어 동작 중인 것입니다.

setEncoding(encoding)

파일을 다운로드받는 HTML 페이지의 인코딩에 맞춰 인코딩을 설정합니다.

setFileHeader()

다운로드할 파일의 정보를 브라우저 헤더로 전송합니다.

setFontName(fontName)

문서에 사용될 글꼴을 설정합니다. (HeaderFontName도 함께 설정됩니다.)

setFontSize(size)

문서에 사용될 글자 크기를 설정합니다. (HeaderFontSize도 함께 설정됩니다.)

setHeaderBackColor(color)

헤더 부분의 배경색을 설정합니다.

setHeaderFontBold(bold)

헤더 부분 글자의 볼드 처리 여부를 설정합니다.

setHeaderFontColor(color)

헤더 부분의 글자색을 설정합니다.

setHeaderFontName(name)

헤더 부분에 사용될 글꼴을 설정합니다.

setHeaderFontSize(fontSize)

헤더 부분에 사용될 글자 크기를 설정합니다.

setWordWrap(isWordWrap)

문서에 줄바꿈 적용 여부를 설정합니다.

setMarkupTagDeilmiter(startTag1, startTag2, closingTag1, closingTag2)

기본 마크업 태그 외에 별도의 태그를 사용할 때 설정합니다. IBSheet8 환경설정(ibsheet.cfg)의 MarkupTagDelimiter 설정 값과 동일해야 합니다.

setDelimMode(mode)

시트 문자열에 STX(\u0002), ETX(\u0003)가 포함된 경우 설정합니다.

setFileType(fileType, ignoreFileExtention)

다운로드할 문서의 타입을 설정합니다.

setNumberExMode(numberExMode)

엑셀에 포함될 숫자 형식 데이터를 '통화’나 '사용자정의’가 아닌 '숫자' 서식으로 다운로드합니다. 클라이언트의 down2Excel 옵션 numberExMode보다 우선 적용됩니다.

setXlsxTempFolderMode(useXssfMode)

POI 라이브러리 사용 중 XLSX 형식 다운로드 시 임시폴더를 사용하지 않고 메모리에서 직접 다운받도록 설정합니다.
메모리 사용량이 늘어나므로 임시폴더를 사용할 수 없는 환경에서만 권장합니다.

setExcelBuffer(rowBuffer)

엑셀(XLSX) 다운로드 시 메모리에 유지할 행 수를 설정합니다. 지정한 행 수만 메모리에 두고 나머지는 디스크로 내보내(flush) 워크북 메모리를 줄입니다.

기본값은 100이라 미설정이어도 스트리밍됩니다. 메모리 여유가 있으면 값을 키워(예: 500~1000) 디스크 flush 횟수를 줄일 수 있습니다.

setImageProcessType(typ)

엑셀 다운로드 시 포함된 이미지의 비율 처리 방식을 설정합니다.

setUseGroupTree(useGroupTree)

트리 사용 시트에서 트리 구조를 엑셀 파일에 반영할지 여부를 설정합니다.

setExcelRowHeight(excelRowHeight)

엑셀 문서의 행 높이를 설정합니다. 클라이언트에서 설정하는 excelRowHeight보다 우선 반영됩니다.

setExcelHeaderRowHeight(excelHeaderRowHeight)

엑셀 문서의 헤더행 높이를 설정합니다. 클라이언트에서 설정하는 excelHeaderRowHeight보다 우선 반영됩니다.

setService(HttpServletRequest, HttpServletResponse)

request와 response를 할당합니다. (기본 생성자 사용 시에만 적용)

setTempRoot(tempRoot)

템플릿 파일이 저장된 경로를 지정합니다. 지정하지 않으면 시트의 TempFile에 사용된 경로만 이용합니다.

setTextLine(textLine)

텍스트 파일의 행 구분자를 설정합니다. (시트의 RowDelim 설정이 우선 적용)

setTextSpliter(textSpliter)

텍스트 파일의 열 구분자를 설정합니다. (시트의 ColDelim 설정이 우선 적용)

setTreeChar(treeChar)

트리 레벨 문자를 설정합니다.

setWebServerDomain(webServerDomain)

문서에 이미지가 포함된 경우 이미지의 Root 폴더/웹 서버 도메인을 설정합니다. 설정하지 않으면 현재 서버 도메인을 사용합니다.

IBSheetLoad (업로드)

XLS, XLSX, CSV, TXT 파일을 로드합니다.

생성자

close()

업로드를 종료하고 메모리를 해제합니다.

directLoadExcel()

업로드한 문서를 List<Map<String, String>> 형태로 반환합니다. (DirectLoadExcel 전용)

loadFile(file)

업로드한 엑셀 파일을 IBSheet가 읽을 수 있도록 로드/파싱합니다.
getUploadFile()로 받은 파일을 DRM 복호화 등으로 가공한 뒤 넘길 때 사용합니다. 파일 경로(loadFile(path))나 인자 없이(loadFile())도 호출할 수 있습니다.

setData(data, filePath)

멀티파트/XSS 필터로 request가 먼저 소비되는 환경에서, 클라이언트가 보낸 시트 전문(Data)과 업로드된 엑셀 파일 경로를 함께 세팅합니다. setService 호출 전에 호출합니다.

String data = request.getParameter("columnTag");
load.setData(data, tempFile.getAbsolutePath());   // setService 전에 세팅
load.setService(request, response);

getExtendParam(key)

시트에서 전달한 ExtendParam 정보를 받습니다. (반환: String)

getUploadFile()

업로드한 파일 객체를 반환합니다. (반환: java.io.File, 업로드 파일 객체)

getUploadFileName()

업로드한 파일의 파일명을 반환합니다. (반환: String)

getLoadError(errorCode, message)

업로드 처리 페이지(LoadExcel.jsp 등)의 catch 블록에서 에러를 클라이언트로 내려보낼 때 사용합니다.
반환된 byte[]를 OutputStream으로 출력하면 클라이언트 onImportFinish 이벤트의 result(코드)와 message로 전달됩니다.
onImportFinish에 내부적으로 정의된 오류 코드/메시지와 겹치지 않게 지정합니다.
인자 없이 getLoadError()를 호출하면 기본 에러가, getLoadError(message)는 메시지만 지정하는 형태입니다.

catch (IBSheetException e) {
    OutputStream out = response.getOutputStream();
    out.write(load.getLoadError(e.getErrorCode(), e.getErrorMessage()));
    out.flush();
}

getLoadFinish(type, result, message)

업로드 처리에 성공했을 때 완료를 클라이언트로 알립니다.
반환된 byte[]를 OutputStream으로 출력하면 onImportFinish 이벤트의 result(0 이상 = 정상)와 message로 전달됩니다.

OutputStream out = response.getOutputStream();
out.write(load.getLoadFinish("EXCEL", 1, "업로드 완료"));
out.flush();

sendDirectTo(url)

업로드한 문서를 Map 형태로 SHEETDATA라는 HttpRequest Attribute에 저장하고 특정 경로로 전달합니다.

sendDirectToFP()

업로드한 문서를 Map 형태로 SHEETDATA라는 HttpRequest Attribute에 저장하고, 시트에서 전달받은 FP 경로로 전달합니다.

setEncoding(encoding)

페이지의 인코딩을 설정합니다.

setMarkupTagDeilmiter(startTag1, startTag2, closingTag1, closingTag2)

기본 마크업 태그 외에 별도의 태그를 사용할 때 설정합니다. ibsheet.cfg의 MarkupTagDelimiter 설정 값과 동일해야 합니다.

setDelimMode(mode)

시트 문자열에 STX(\u0002), ETX(\u0003)가 포함된 경우 설정합니다.

setStrictHeaderMatch(strictHeaderMatch)

엄격하게 헤더 매치를 검사할지 여부를 설정합니다. 설정 시 시트 헤더가 엑셀에 하나라도 존재하지 않으면 데이터를 로드하지 않습니다.

setDisallowDuplicatedHeader(disallow)

업로드한 엑셀 파일의 헤더 행에 중복된 컬럼명이 있으면 로드를 중단하고 예외를 발생시킬지 설정합니다. true로 설정하면 중복 헤더 시 IBSheetException(에러 코드 -18)이 발생해 catch로 처리할 수 있습니다.

서버모듈 2.0.9 이상에서 지원합니다.

setMaxRows(maxRows)

LoadExcel 처리를 허용할 최대 행 수를 설정합니다. 로드하는 데이터가 지정한 행 수보다 많으면 에러를 발생시키고 처리가 종료됩니다.

setMaxColumns(maxColumns)

LoadExcel 처리를 허용할 최대 열 수를 설정합니다. 로드하는 데이터가 지정한 열 수보다 많으면 에러를 발생시키고 처리가 종료됩니다.

setSkipEmptyRow(skipEmptyRow)

엑셀의 빈 행을 로드할지 여부를 설정합니다.

setMaxFileSize(maxFileSize)

업로드 가능한 최대 파일 사이즈를 설정합니다.

setService(HttpServletRequest, HttpServletResponse)

request와 response를 할당합니다. (기본 생성자 사용 시에만 적용)

setTextSpliter(textSpliter)

텍스트 파일의 열 구분자를 설정합니다. (시트의 ColDelim 설정이 우선 적용)

writeToBrowser()

업로드한 파일을 파싱해서 브라우저의 시트에 전달합니다.

writeToStream(OutputStream)

업로드한 파일을 파싱해서 OutputStream으로 전달합니다.

Print2Pdf (PDF 다운로드)

생성자

print()

생성된 문서를 브라우저를 통해 다운로드합니다.

saveTo(path)

생성된 문서를 서버의 특정 폴더에 저장합니다.

setDPI(dpi)

생성될 PDF 문서의 해상도를 지정합니다. 값이 작을수록 크게 출력됩니다.

setFontFolder(path)

TTF 폰트 파일이 저장된 경로를 지정합니다. (PDF 한글 표시를 위해 한글 폰트 ttf가 필요)

setPageEncoding(encoding)

페이지의 인코딩을 설정합니다.

setRequest(HttpServletRequest, HttpServletResponse)

request와 response를 할당합니다. (기본 생성자 사용 시에만 적용)

서버모듈/라이브러리 버전 확인

배포된 서버모듈과 로드된 라이브러리(POI 등)의 버전을 서버 콘솔에 출력해 정상 배포 여부를 확인할 수 있습니다.

<%
System.out.println(com.ibleaders.ibsheet8.util.Version.getVersion());
%>

정상이면 서버모듈 버전과 함께 POI 계열 jar의 경로/버전이 콘솔에 표시됩니다. 출력이 없거나 ClassNotFoundException / NoClassDefFoundError가 발생하면 해당 jar가 WEB-INF/lib에 없거나 버전이 맞지 않는 것이므로, 개발 환경과 동일한 jar를 배포하세요.

Read More

• 엑셀파일 업로드/다운로드 appendix
• down2Excel method
• loadExcel method
• down2Pdf method
• directDown2Excel method
• directLoadExcel method
• Export cfg