資訊專欄INFORMATION COLUMN
摘要：將查詢到的結(jié)果生成和文件，再以字節(jié)流的形式返回給前端。則是用于創(chuàng)建字節(jié)輸出流，在導(dǎo)出文件的代碼結(jié)尾，通過(guò)工具類中的復(fù)制文件函數(shù)將字節(jié)流寫入到輸出流中，從而將文件以字節(jié)流的形式返回給客戶端。
title: 想在Java中實(shí)現(xiàn)Excel和Csv的導(dǎo)出嗎？看這就對(duì)了
date: 2019-03-01 20:07:07
tags: Java
keywords: Java導(dǎo)出Excel和Csv
最近在項(xiàng)目中遇到一個(gè)需求，需要后端提供一個(gè)下載Csv和Excel表格的接口。這個(gè)接口接收前端的查詢參數(shù)，針對(duì)這些參數(shù)對(duì)數(shù)據(jù)庫(kù)做查詢操作。將查詢到的結(jié)果生成Excel和Csv文件，再以字節(jié)流的形式返回給前端。
前端拿到這個(gè)流文件之后，最開(kāi)始用ajax來(lái)接收，但是前端發(fā)送的請(qǐng)求卻被瀏覽器cancel掉了。后來(lái)發(fā)現(xiàn)，發(fā)展了如此之久的Ajax居然不支持流文件下載。后來(lái)前端換成了最原始的XMLHttpRequest，才修復(fù)了這個(gè)問(wèn)題。
首先給出項(xiàng)目源碼的地址。這是源碼，歡迎大家star或者提MR。
Csv 新建controller先來(lái)一個(gè)簡(jiǎn)單的例子。首先在controller中新建這樣一個(gè)接口。
@GetMapping("csv")
public void csv(
HttpServletRequest request,
HttpServletResponse response
) throws IOException {
String fileName = this.getFileName(request, "測(cè)試數(shù)據(jù).csv");
response.setContentType(MediaType.APPLICATION_OCTET_STREAM.toString());
response.setHeader("Content-Disposition", "attachment; filename="" + fileName + "";");
LinkedHashMap header = new LinkedHashMap<>();
LinkedHashMap body = new LinkedHashMap<>();
header.put("1", "姓名");
header.put("2", "年齡");
List> data = new ArrayList<>();
body.put("1", "小明");
body.put("2", "小王");
data.add(header);
data.add(body);
data.add(body);
data.add(body);
FileCopyUtils.copy(ExportUtil.exportCSV(data), response.getOutputStream());
}
其中this.getFileName(request, "測(cè)試數(shù)據(jù).csv")函數(shù)是用來(lái)獲取導(dǎo)出文件名的函數(shù)。多帶帶提出來(lái)是因?yàn)椴煌瑸g覽器使用的默認(rèn)的編碼不同。例如，如果使用默認(rèn)的UTF-8編碼。在chrome瀏覽器中下載會(huì)出現(xiàn)中文亂碼。代碼如下。
private String getFileName(HttpServletRequest request, String name) throws UnsupportedEncodingException {
String userAgent = request.getHeader("USER-AGENT");
return userAgent.contains("Mozilla") ? new String(name.getBytes(), "ISO8859-1") : name;
}
response.getOutputStream()則是用于創(chuàng)建字節(jié)輸出流，在導(dǎo)出csv文件的controller代碼結(jié)尾，通過(guò)工具類中的復(fù)制文件函數(shù)將字節(jié)流寫入到輸出流中，從而將csv文件以字節(jié)流的形式返回給客戶端。
當(dāng)前端通過(guò)http請(qǐng)求訪問(wèn)服務(wù)器接口的時(shí)候，http中的所有的請(qǐng)求信息都會(huì)封裝在HttpServletRequest對(duì)象中。例如，你可以通過(guò)這個(gè)對(duì)象獲取到請(qǐng)求的URL地址，請(qǐng)求的方式，請(qǐng)求的客戶端IP和完整主機(jī)名，Web服務(wù)器的IP和完整主機(jī)名，請(qǐng)求行中的參數(shù)，獲取請(qǐng)求頭的參數(shù)等等。
針對(duì)每一次的HTTP請(qǐng)求，服務(wù)器會(huì)自動(dòng)創(chuàng)建一個(gè)HttpServletResponse對(duì)象和請(qǐng)求對(duì)象相對(duì)應(yīng)。響應(yīng)對(duì)象可以對(duì)當(dāng)前的請(qǐng)求進(jìn)行重定向，自定義響應(yīng)體的頭部，設(shè)置返回流等等。
新建導(dǎo)出工具類我們新建一個(gè)導(dǎo)出工具類，來(lái)專門負(fù)責(zé)導(dǎo)出各種格式的文件。代碼如下。
public class ExportUtil {
public static byte[] exportCSV(List> exportData) {
ByteArrayOutputStream out = new ByteArrayOutputStream();
BufferedWriter buffCvsWriter = null;
try {
buffCvsWriter = new BufferedWriter(new OutputStreamWriter(out, StandardCharsets.UTF_8));
// 將body數(shù)據(jù)寫入表格
for (Iterator> iterator = exportData.iterator(); iterator.hasNext(); ) {
fillDataToCsv(buffCvsWriter, iterator.next());
if (iterator.hasNext()) {
buffCvsWriter.newLine();
}
}
// 刷新緩沖
buffCvsWriter.flush();
} catch (IOException e) {
e.printStackTrace();
} finally {
// 釋放資源
if (buffCvsWriter != null) {
try {
buffCvsWriter.close();
} catch (IOException e) {
e.printStackTrace();
}
}
}
return out.toByteArray();
}
private static void fillDataToCsv(BufferedWriter buffCvsWriter, LinkedHashMap row) throws IOException {
Map.Entry propertyEntry;
for (Iterator propertyIterator = row.entrySet().iterator(); propertyIterator.hasNext(); ) {
propertyEntry = propertyIterator.next();
buffCvsWriter.write(""" + propertyEntry.getValue().toString() + """);
if (propertyIterator.hasNext()) {
buffCvsWriter.write(",");
}
}
}
}
fillDataToCsv主要是抽離出來(lái)為csv填充一行一行的數(shù)據(jù)的。
運(yùn)行然后運(yùn)行項(xiàng)目，調(diào)用http://localhost:8080/csv，就可以下載示例的csv文件。示例如下。
Excel 新建controller新建下載xlsx文件的接口。
@GetMapping("xlsx")
public void xlsx(
HttpServletRequest request,
HttpServletResponse response
) throws IOException {
String fileName = this.getFileName(request, "測(cè)試數(shù)據(jù).xlsx");
response.setContentType(MediaType.APPLICATION_OCTET_STREAM.toString());
response.setHeader("Content-Disposition", "attachment; filename="" + fileName + "";");
List> datas = new ArrayList<>();
LinkedHashMap data = new LinkedHashMap<>();
data.put("1", "姓名");
data.put("2", "年齡");
datas.add(data);
for (int i = 0; i < 5; i++) {
data = new LinkedHashMap<>();
data.put("1", "小青");
data.put("2", "小白");
datas.add(data);
}
Map>> tableData = new HashMap<>();
tableData.put("日?qǐng)?bào)表", datas);
tableData.put("周報(bào)表", datas);
tableData.put("月報(bào)表", datas);
FileCopyUtils.copy(ExportUtil.exportXlsx(tableData), response.getOutputStream());
}
補(bǔ)充工具類
上面新建的導(dǎo)出工具類中，只有導(dǎo)出csv的函數(shù)，接下來(lái)我們要添加導(dǎo)出xlsx的函數(shù)。
