1. ホーム
  2. Web プログラミング
  3. AJAX関連

AJAXによるExcelレポート出力

2022-01-15 14:58:51

ajaxを使ってExcelレポートのエクスポートを実現する【面倒なコードの問題を解決】、ご参考までに、詳細は以下の通りです。

背景

エクセルレポートをエクスポートするプロジェクトで、あるシナリオが発生しました。トークンのバリデーションが必要なので、タグは使用できません。当初は、フロントエンドでajaxを使用し、バックエンドでストリームを返し、指定されたヘッダーを定義することを検討しています。

バージョン1

メインコード

フロントエンド

jqueryを使ったajax

var queryParams = {"test":"xxx"};
var url = "xxx";
$.ajax({
 type : "POST", //submission method
 url : url,//path
 contentType: "application/json",
 data: JSON.stringify(queryParams),
 beforeSend: function (request) {
  request.setRequestHeader("Authorization", "xxx");
 },
 success : function(result) {
  const blob = new Blob([result], {type:"application/vnd.ms-excel"});
  if(blob.size < 1) {
   alert('Export failed, the export is empty!') ;
   return
  }
  if(window.navigator.msSaveOrOpenBlob) {
   navigator.msSaveOrOpenBlob(blob, 'test.xls')
  } else {
   const aLink = document.createElement('a');
   aLink.style.display = 'none';
   aLink.href = window.URL.createObjectURL(blob);
   aLink.download = 'test.xls';
   document.body.appendChild(aLink);
   aLink.click();
   document.body.removeChild(aLink);
  }
 }
});

バックエンド

easypoiの使用 (easypoiの使用方法については各自Baiduで調べてください)

import cn.afterturn.easypoi.excel.ExcelExportUtil;
import cn.afterturn.easypoi.excel.entity.ExportParams;

@PostMapping(value = "/download")
public void downloadList(@RequestBody Objct obj, HttpServletResponse response) {

 ......

 List<Custom> excelList = new ArrayList<>();
 
   // excel general settings
   ExportParams exportParams = new ExportParams();
   // Specify the sheet name
   exportParams.setSheetName("test");
   Workbook workbook = ExcelExportUtil.exportExcel(exportParams, Custom.class, excelList);
 
   response.setContentType("application/vnd.ms-excel");
   response.addHeader("Content-Disposition", "attachment;filename=" + URLEncoder.encode("test", "utf-8 ") + ".xls");
   OutputStream outputStream = response.getOutputStream();
   workbook.write(outputStream);
   outputStream.flush();
   outputStream.close();
   
 ......
 
}

テスト結果

は正常にエクスポートできるが、ダウンロードしたエクセルはすべて文字化けしてしまう。いろいろと検索してみたところ、以下のようなことが原因ではないかと整理されました。

1. バックエンドが文字セットを設定していない、またはフィルタの春のフレームワークで、統一された文字セットを設定していない。
2、フロントエンドページは、文字セットエンコーディングを設定しません。
3. ajaxでrequest.responseType = "arraybuffer" を追加する必要があります。

常にテストした結果、私のは3番目のポイントが原因であるはずです。しかし、jquery ajaxで追加した後もうまくいかず、コードの文字化けの問題は解決されないままです。

バージョン2

メインコード

フロントエンドは、ネイティブajaxを使用。バックエンドは変更なし。

var xhr = new XMLHttpRequest();
xhr.responseType = "arraybuffer"; 
xhr.open("POST", url, true);
xhr.onload = function () {
 const blob = new Blob([this.response], {type:"application/vnd.ms-excel"});
 if(blob.size < 1) {
  alert('Export failed, the export is empty!') ;
  return;
 }
 if(window.navigator.msSaveOrOpenBlob) {
  navigator.msSaveOrOpenBlob(blob, 'test.xls')
 } else {
  const aLink = document.createElement('a');
  aLink.style.display = 'none';
  aLink.href = window.URL.createObjectURL(blob);
  aLink.download = 'testxls';
  document.body.appendChild(aLink);
  aLink.click();
  document.body.removeChild(aLink);
  return;
 }
}
xhr.setRequestHeader("Authorization", "xxx");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.send(JSON.stringify(queryParams));

テスト結果

ダウンロードしたExcelは文字化けしなくなり、ネイティブajaxでの"arraybuffer"の使用も動作しています。

まとめる

arraybuffer"パラメータは、厄介なExcelエクスポートを引き起こします。これはネイティブajaxでは有効ですが、jquery ajaxではまだ有効ではありません。

以上が今回の記事の全てです。勉強になると思いますので、スクリプトハウスの応援をよろしくお願いします。