http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/

거의... 이 녀석을 기반으로 작성할 건데....

... 다뤄야할 내용이 많다... ㅡ_-);;

... 하기 싫어진다(두렵다).


내 책 이름은... '부트 스프링 부트(boot spring boot)'


"Spring MVC 4 익히기" 라는 이름으로 번역한 책이 2016/08/25 에 출간되었습니다. ^^

종이책은 9월 중순 이후에 나올 예정입니다.


쉽게쉽게할 수 있을거라고 생각하고 시작했는데 쉽지 않았습니다. ㅎ.

처음 번역할 때보다는 절반이상 시간을 줄였습니다.


@_@); 이제 스프링부트 책을 한번 써보지 않겠냐는 제의가 주변에서 쏟아지고 있는데... 부담이 되네요.

써야지 하고 뼈대는 잡아놨는데...


다음 책의 이름은 "Boot Spring Boot" 입니다. 뒤집어 읽어도 "Boot Spring Boot!"


과연 완료할 수 있을지!!


스프링부트 오류출력 페이지

스프링부트에서 기본설정된 오류페이지는 'Whitelable' 페이지다.


스프링부트에는 'whitelabel' 페이지에 대한 언급이 그렇게 상세히 되어있지는 않다( Customize the ‘whitelabel’ error page).

ErrorMvcAutoConfiguration 을 보면 SpelView 를 이용해서 생성하는 Whitelabel Error Page 를 볼 수 있을 것이다.

이 페이지를 이뻐보이는 페이지로 대체하는 것은 나중에 다루기로 하고…​

스프링부트 ErrorMvcAutoConfiguration 에서 다룰 수 있는 속성들을 살펴보도록 하자. ErrorMvcAutoConfiguration 를 살펴보면 그 중에 DefaultErrorAttributes 를 살펴볼 수 있다. 문서에서 보면 알 수 있듯이 오류와 관련된 속성 중에 다룰 수 있는 것들에는:

  • timestamp - 오류가 발생한 시간을 추출

  • status - 상태코드

  • error - 에러 발생원인

  • exception - 상위 예외 클래스명

  • message - 예외 메시지

  • errors - BindingResult 예외가 던져주는 ObjectErrors

  • trace - Exception stack trace

  • path - 예외가 발생한 URL 경로(되돌아가거나? 어디서 발생했는지 파악하는 용도)

를 활용하면 스프링부트에서 발생한 예외에 대한 분석이 용이해진다.

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head lang="en">
    <meta charset="utf-8"/>
    <!-- 중략 -->
</head>
<body class=" page-404-3">
<div class="page-inner">
    <img src="/assets/layout/img/earth.jpg" class="img-responsive" alt=""></div>
<div class="container error-404">
    <h1 th:text="${status}">Status</h1>
    <h2>Houston, we have a problem([[${error}]])</h2>
    <p th:text="${message}"> Error Message</p>
    <p>
        <a href="index.html" th:href="@{/}" class="btn red btn-outline"> Return home </a>
        <br>
    </p>
    <div th:text="${timeStamp}"></div>
    <div th:text="${exception}"></div>
    <div th:utext="${trace}">Trace!</div>
</div>
</body>
</html>

이와 같은 형태로 오류를 탐색하고 분석하는데 용이하도록 구성할 수 있을 것이고 방법은 다양하니 자신에게 맞는 방법을 찾기 바란다.


기본은 스프링 부트 레퍼런스 문서(http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/)를 

기준으로 해서 이런저런 이야기를 풀어가는 식으로 쓰려고 하는데...

올해 중에 마칠 수 있을까??


이걸 쓰려면 놀 시간을 줄여야 하는데...

놀시간 줄이는 건 뭔가 아깝단 말이지. @_@);;


어느버전을 기준으로 할지부터 잡아야겠는데...

Spring Boot 1.4.0.RELEASE  를 기준으로 해야겠다.

the Java API for Microsoft Documents 을 지향하는Apache POI를 이용한 엑셀 생성 및 다운로드 기능 구현을 해보겠다.

현재 배포중인 버전에 대해서는 Maven central Repository 를 통해서 그때그때 확인하기 바란다.

1. 의존성 추가

1.1. pom.xml

<dependency>
    <groupId>org.apache.poi</groupId>
    <artifactId>poi</artifactId>
    <version>3.14</version>
</dependency>

1.2. build.gradle

compile ('org.apache.poi:poi:3.14')

2. 간단한 테스트

POI에 대한 의존성을 추가했으면 간단한 예제를 구현하여 엑셀과 관련된 WorkBook(=file), Sheet, Row, Cell 에 대한 기능을 확인하자.

@Slf4j
public class SheetServiceTest {
    /**
     * @throws Exception
     * @see <a href="https://poi.apache.org/spreadsheet/quick-guide.html#NewWorkbook"></a>
     */
    @Test
    public void generateWorkBook() throws Exception {
        List<Dump> dumps = generateDump(10, "a", "b", "c", "d");
        String excelFileName = "test.xls";
        String sheetname = "send-check-1";
 
        Workbook workbook = new HSSFWorkbook();
        workbook.createSheet(sheetname);
 
 
        Sheet sheet = workbook.getSheet(sheetname);
 
        int size = dumps.size();
        Row headerRow = sheet.createRow(0);
        headerRow.createCell(0).setCellValue("A column");
        headerRow.createCell(1).setCellValue("B column");
        headerRow.createCell(2).setCellValue("C column");
        headerRow.createCell(3).setCellValue("D column");
 
        for (int rownum = 0; rownum < size; rownum++) {
            Row row = sheet.createRow(rownum + 1);
            row.createCell(0).setCellValue(dumps.get(rownum).getA());
            row.createCell(1).setCellValue(dumps.get(rownum).getB());
            row.createCell(2).setCellValue(dumps.get(rownum).getC());
            row.createCell(3).setCellValue(dumps.get(rownum).getD());
        }
 
        generateExcel(Paths.get(excelFileName).toString(), workbook);
 
        assertThat(Paths.get(excelFileName).toFile().exists()).isTrue();
        assertThat(workbook.getSheet(sheetname)).isNotNull();
        assertThat(sheet.getLastRowNum()).isEqualTo(10);
        assertThat(sheet.getRow(sheet.getFirstRowNum()).getCell(0).toString()).isEqualTo("A column");
        assertThat(sheet.getRow(sheet.getLastRowNum()).getCell(0).toString()).isEqualTo("a9");
 
        Paths.get(excelFileName).toFile().delete();
    }
 
    private List<Dump> generateDump(int it, String a, String b, String c, String d) {
        List<Dump> dumps = Lists.newArrayList();
        for (int i = 0; i < it; i++) {
            dumps.add(Dump.builder().a(+ "" + i).b(+ "" + i).c(+ "" + i).d(+ "" + i).build());
        }
        return dumps;
    }
 
    private void generateExcel(String filePath, Workbook workbook) {
        log.debug("generate excel: {}", filePath);
        try (FileOutputStream fileOut = new FileOutputStream(filePath);) {
            workbook.write(fileOut);
        } catch (Exception e) {
            log.error("Occur exception: {}", e);
        }
    }
 
    @Data
    @NoArgsConstructor
    @AllArgsConstructor
    @Builder
    public static class Dump {
        String a;
        String b;
        String c;
        String d;
    }
}

3. 스프링MVC 에서 구현

스프링에서 제공하던 AbstractExcelView 는 4.2 에서 Deprecated되었다. AbstractXlsView 를 사용해볼까 했는데 apache POI 3.14 버전에서는 XSSFWorkbook 관련한 패키지가 사라져서 쓸 수 없다. 3.16 버전에는 SXSSFWorkbook 관련 패키지가 추가될 것으로 보이니 3.16 쓸 때는 SXSSFWorkbook 사용을 고려해보자. AbstractXlsView를 사용하도록 하자.

3.1. AbstractXlsView 을 구현

@Component("downloadXlsView") // 공통적으로 사용할 수도 있고... 특정 기능에 따라 뷰이름을 구분지어 사용할 수 있겠다. 
public class SendCheckRequestExportXlsView extends AbstractXlsView {
  // 코드는 중략... 상상의 나래를 활짝 펴라~ 
  @Override
    protected void buildExcelDocument(Map<String, Object> model, Workbook workbook, HttpServletRequest request, HttpServletResponse response) throws Exception {
 
    }
}

org.springframework.web.servlet.view.document 패키지에AbstractXlsView 와 AbstractPdfView 가 있다. AbstractXlsxView는 AbstractXlsView 를 확장했는데 import org.apache.poi.xssf.usermodel.XSSFWorkbook 를 필요로 한다. 그런데 POI 3.14 에는 org.apache.poi.xssf 패키지가 빠져있다. 히스토리는 모르겠다.

3.2. Controller 에서 view 를 반환

@Controller
public class DownloadController {
  @RequestMapping("/download-xls")
  public ModelAndView() {
    // view 에서 처리하는데 필요한 데이터를 담아주면 되겠다. 
    return new ModelAndView("downloadXlsView", "model", model);
  }
}

이렇게 하고 이 컨트롤러에 대한 링크를 제공하면 다운로드 처리가 완료된다.

<a href="/download-xls"></a>

4. 정리

엑셀에 필요한 정보를 담기 위해서는 여전히 많은 노력이 필요하다. 뭐 그래도 어떤 데이터들을 출력할지만 정의하면 비교적 처리가 수월해진다.


+ Recent posts