SpringMVCを使用したExcelファイルのアップロードと表示

投稿日: 2019-10-18 2022-10-25
タグ: excel, Spring MVC

1. 序章

この記事では、 Spring MVC フレームワークを使用して、Excelファイルをアップロードし、そのコンテンツをWebページに表示する方法を示します。

2. Excelファイルのアップロード

ファイルをアップロードできるようにするために、最初に MultipartFile を受け取り、それを現在の場所に保存するコントローラーマッピングを作成します。

private String fileLocation;

@PostMapping("/uploadExcelFile")
public String uploadFile(Model model, MultipartFile file) throws IOException {
    InputStream in = file.getInputStream();
    File currDir = new File(".");
    String path = currDir.getAbsolutePath();
    fileLocation = path.substring(0, path.length() - 1) + file.getOriginalFilename();
    FileOutputStream f = new FileOutputStream(fileLocation);
    int ch = 0;
    while ((ch = in.read()) != -1) {
        f.write(ch);
    }
    f.flush();
    f.close();
    model.addAttribute("message", "File: " + file.getOriginalFilename() 
      + " has been uploaded successfully!");
    return "excel";
}

次に、accept属性のみに設定されたtypefileのinputを含むフォームでJSPファイルを作成しましょう。 Excelファイルを許可する：

<c:url value="/uploadExcelFile" var="uploadFileUrl" />
<form method="post" enctype="multipart/form-data"
  action="${uploadFileUrl}">
    <input type="file" name="file" accept=".xls,.xlsx" /> <input
      type="submit" value="Upload file" />
</form>

3. Excelファイルを読む

アップロードされたExcelファイルを解析するために、 ApachePOIライブラリを使用します。このライブラリは.xlsファイルと.xlsxファイルの両方で機能します。

MyCell というヘルパークラスを作成してみましょう。このクラスには、コンテンツと書式設定に関連するExcelセルのプロパティが含まれています。

public class MyCell {
    private String content;
    private String textColor;
    private String bgColor;
    private String textSize;
    private String textWeight;

    public MyCell(String content) {
        this.content = content;
    }
    
    //standard constructor, getters, setters
}

Excelファイルの内容をMyCellオブジェクトのリストを含むMapに読み込みます。

3.1. .xlsファイルの解析

.xlsファイルは、Apache POIライブラリで、HSSFSheetオブジェクトで構成されるHSSFWorkbookclassによって表されます。 .xls ファイルの内容を開いて読み取るには、JavaでのMicrosoftExcelの操作に関する記事を参照してください。

セルのフォーマットを解析するために、HSSFCellStyle object、を取得します。これは、背景色やフォントなどのプロパティを決定するのに役立ちます。すべての読み取りプロパティは、MyCellオブジェクトの属性に設定されます。

HSSFCellStyle cellStyle = cell.getCellStyle();

MyCell myCell = new MyCell();

HSSFColor bgColor = cellStyle.getFillForegroundColorColor();
if (bgColor != null) {
    short[] rgbColor = bgColor.getTriplet();
    myCell.setBgColor("rgb(" + rgbColor[0] + ","
      + rgbColor[1] + "," + rgbColor[2] + ")");
    }
HSSFFont font = cell.getCellStyle().getFont(workbook);

色はrgb（rVal、gVal、bVal）形式で読み取られるため、JSPページでCSSを使用して簡単に表示できます。

フォントのサイズ、太さ、色も取得しましょう。

myCell.setTextSize(font.getFontHeightInPoints() + "");
if (font.getBold()) {
    myCell.setTextWeight("bold");
}
HSSFColor textColor = font.getHSSFColor(workbook);
if (textColor != null) {
    short[] rgbColor = textColor.getTriplet();
    myCell.setTextColor("rgb(" + rgbColor[0] + ","
      + rgbColor[1] + "," + rgbColor[2] + ")");
}

3.2. .xlsxファイルの解析

新しい.xlsx形式のファイルの場合、ワークブックのコンテンツにXSSFWorkbookクラスおよび同様のクラスを使用できます。これは、JavaでのMicrosoftExcelの操作の記事にも記載されています。

.xlsx形式のセルの形式を詳しく見てみましょう。まず、セルに関連付けられているXSSFCellStyleオブジェクトを取得し、それを使用して背景色とフォントを決定します。

XSSFCellStyle cellStyle = cell.getCellStyle();

MyCell myCell = new MyCell();
XSSFColor bgColor = cellStyle.getFillForegroundColorColor();
if (bgColor != null) {
    byte[] rgbColor = bgColor.getRGB();
    myCell.setBgColor("rgb(" 
      + (rgbColor[0] < 0 ? (rgbColor[0] + 0xff) : rgbColor[0]) + ","
      + (rgbColor[1] < 0 ? (rgbColor[1] + 0xff) : rgbColor[1]) + ","
      + (rgbColor[2] < 0 ? (rgbColor[2] + 0xff) : rgbColor[2]) + ")");
}
XSSFFont font = cellStyle.getFont();

この場合、色の RGB 値は符号付きバイト値になるため、0xffを追加して符号なし値を取得します。負の値に。

フォントのプロパティも決定しましょう。

myCell.setTextSize(font.getFontHeightInPoints() + "");
if (font.getBold()) {
    myCell.setTextWeight("bold");
}
XSSFColor textColor = font.getXSSFColor();
if (textColor != null) {
    byte[] rgbColor = textColor.getRGB();
    myCell.setTextColor("rgb("
      + (rgbColor[0] < 0 ? (rgbColor[0] + 0xff) : rgbColor[0]) + "," 
      + (rgbColor[1] < 0 ? (rgbColor[1] + 0xff) : rgbColor[1]) + "," 
      + (rgbColor[2] < 0 ? (rgbColor[2] + 0xff) : rgbColor[2]) + ")");
}

3.3. 空の行の処理

上記の方法では、Excelファイルの空の行は考慮されません。空の行も表示するファイルを忠実に表現する場合は、結果のでこれらをシミュレートする必要があります。空のStringsをコンテンツとして含むMyCellオブジェクトのArrayListを含むHashMap。

最初に、Excelファイルを読み取った後、ファイル内の空の行は、サイズが0のArrayListオブジェクトになります。

追加する必要のある空のStringオブジェクトの数を決定するために、最初に maxNrCols 変数を使用して、Excelファイルの最長の行を決定します。次に、その数の空の String オブジェクトを、サイズが0のHashMap内のすべてのリストに追加します。

int maxNrCols = data.values().stream()
  .mapToInt(List::size)
  .max()
  .orElse(0);

data.values().stream()
  .filter(ls -> ls.size() < maxNrCols)
  .forEach(ls -> {
      IntStream.range(ls.size(), maxNrCols)
        .forEach(i -> ls.add(new MyCell("")));
  });

4. Excelファイルの表示

Spring MVC を使用して読み取ったExcelファイルを表示するには、コントローラーマッピングとJSPページを定義する必要があります。

4.1. SpringMVCコントローラー

上記のコードを呼び出してアップロードされたファイルのコンテンツを読み取る@RequestMappingメソッドを作成し、返されたMapをModel属性として追加しましょう。

@Resource(name = "excelPOIHelper")
private ExcelPOIHelper excelPOIHelper;

@RequestMapping(method = RequestMethod.GET, value = "/readPOI")
public String readPOI(Model model) throws IOException {

  if (fileLocation != null) {
      if (fileLocation.endsWith(".xlsx") || fileLocation.endsWith(".xls")) {
          Map<Integer, List<MyCell>> data
            = excelPOIHelper.readExcel(fileLocation);
          model.addAttribute("data", data);
      } else {
          model.addAttribute("message", "Not a valid excel file!");
      }
  } else {
      model.addAttribute("message", "File missing! Please upload an excel file.");
  }
  return "excel";
}

4.2. JSP

ファイルの内容を視覚的に表示するために、 HTML table を作成し、各テーブルセルの style 属性に、に対応するフォーマットプロパティを追加します。 Excelファイルの各セル：

<c:if test="${not empty data}">
    <table style="border: 1px solid black; border-collapse: collapse;">
        <c:forEach items="${data}" var="row">
            <tr>
                <c:forEach items="${row.value}" var="cell">
                    <td style="border:1px solid black;height:20px;width:100px;
                      background-color:${cell.bgColor};color:${cell.textColor};
                      font-weight:${cell.textWeight};font-size:${cell.textSize}pt;">
                      ${cell.content}
                    </td>
                </c:forEach>
            </tr>
        </c:forEach>
    </table>
</c:if>

5. 結論

この記事では、Excelファイルをアップロードし、 SpringMVCフレームワークを使用してそれらをWebページに表示するためのサンプルプロジェクトを示しました。

完全なソースコードは、GitHubプロジェクトにあります。

getdocs

13036