Hello大家好，本章我們新增匯出Excel表格功能 。有問題可以聯絡我mr_beany@163.com。另求各路大神指點，感謝
在實際工作中，有時候會需要將列表資料匯出為Excel形式，方便列印，同事間傳閱等，所以本章將新增將列表資料匯出為Excel形式
一：新增POI依賴
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi-ooxml</artifactId>
<version>3.9</version>
</dependency>複製程式碼二：建立Excel實體類
package com.example.demo.model;
import java.io.Serializable;
import java.util.List;
public class ExcelData implements Serializable {
private static final long serialVersionUID = 6133772627258154184L;
/**
* 表頭
*/
private List<String> titles;
/**
* 資料
*/
private List<List<Object>> rows;
/**
* 頁簽名稱
*/
private String name;
public List<String> getTitles() {
return titles;
}
public void setTitles(List<String> titles) {
this.titles = titles;
}
public List<List<Object>> getRows() {
return rows;
}
public void setRows(List<List<Object>> rows) {
this.rows = rows;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
}複製程式碼三：建立表格工具類
建立core→utils→ExcelUtils
package com.example.demo.core.utils;
import com.example.demo.model.ExcelData;
import org.apache.poi.ss.usermodel.*;
import org.apache.poi.ss.usermodel.Font;
import org.apache.poi.xssf.usermodel.XSSFCellStyle;
import org.apache.poi.xssf.usermodel.XSSFColor;
import org.apache.poi.xssf.usermodel.XSSFSheet;
import org.apache.poi.xssf.usermodel.XSSFWorkbook;
import org.apache.poi.xssf.usermodel.extensions.XSSFCellBorder.BorderSide;
import javax.servlet.http.HttpServletResponse;
import java.awt.Color;
import java.io.File;
import java.io.FileOutputStream;
import java.io.OutputStream;
import java.net.URLEncoder;
import java.util.List;
public class ExcelUtils {
/**
* 使用瀏覽器選擇路徑下載
* @param response
* @param fileName
* @param data
* @throws Exception
*/
public static void exportExcel(HttpServletResponse response, String fileName, ExcelData data) throws Exception {
// 告訴瀏覽器用什麼軟體可以開啟此檔案
response.setHeader("content-Type", "application/vnd.ms-excel");
// 下載檔案的預設名稱
response.setHeader("Content-Disposition", "attachment;filename=" + URLEncoder.encode(fileName + ".xls", "utf-8"));
exportExcel(data, response.getOutputStream());
}
public static int generateExcel(ExcelData excelData, String path) throws Exception {
File f = new File(path);
FileOutputStream out = new FileOutputStream(f);
return exportExcel(excelData, out);
}
private static int exportExcel(ExcelData data, OutputStream out) throws Exception {
XSSFWorkbook wb = new XSSFWorkbook();
int rowIndex = 0;
try {
String sheetName = data.getName();
if (null == sheetName) {
sheetName = "Sheet1";
}
XSSFSheet sheet = wb.createSheet(sheetName);
rowIndex = writeExcel(wb, sheet, data);
wb.write(out);
} catch (Exception e) {
e.printStackTrace();
} finally {
//此處需要關閉 wb 變數
out.close();
}
return rowIndex;
}
private static int writeExcel(XSSFWorkbook wb, Sheet sheet, ExcelData data) {
int rowIndex = 0;
writeTitlesToExcel(wb, sheet, data.getTitles());
rowIndex = writeRowsToExcel(wb, sheet, data.getRows(), rowIndex);
autoSizeColumns(sheet, data.getTitles().size() + 1);
return rowIndex;
}
/**
* 設定表頭
*
* @param wb
* @param sheet
* @param titles
* @return
*/
private static int writeTitlesToExcel(XSSFWorkbook wb, Sheet sheet, List<String> titles) {
int rowIndex = 0;
int colIndex = 0;
Font titleFont = wb.createFont();
//設定字型
titleFont.setFontName("simsun");
//設定粗體
titleFont.setBoldweight(Short.MAX_VALUE);
//設定字號
titleFont.setFontHeightInPoints((short) 14);
//設定顏色
titleFont.setColor(IndexedColors.BLACK.index);
XSSFCellStyle titleStyle = wb.createCellStyle();
//水平居中
titleStyle.setAlignment(XSSFCellStyle.ALIGN_CENTER);
//垂直居中
titleStyle.setVerticalAlignment(XSSFCellStyle.VERTICAL_CENTER);
//設定圖案顏色
titleStyle.setFillForegroundColor(new XSSFColor(new Color(182, 184, 192)));
//設定圖案樣式
titleStyle.setFillPattern(XSSFCellStyle.SOLID_FOREGROUND);
titleStyle.setFont(titleFont);
setBorder(titleStyle, BorderStyle.THIN, new XSSFColor(new Color(0, 0, 0)));
Row titleRow = sheet.createRow(rowIndex);
titleRow.setHeightInPoints(25);
colIndex = 0;
for (String field : titles) {
Cell cell = titleRow.createCell(colIndex);
cell.setCellValue(field);
cell.setCellStyle(titleStyle);
colIndex++;
}
rowIndex++;
return rowIndex;
}
/**
* 設定內容
*
* @param wb
* @param sheet
* @param rows
* @param rowIndex
* @return
*/
private static int writeRowsToExcel(XSSFWorkbook wb, Sheet sheet, List<List<Object>> rows, int rowIndex) {
int colIndex;
Font dataFont = wb.createFont();
dataFont.setFontName("simsun");
dataFont.setFontHeightInPoints((short) 14);
dataFont.setColor(IndexedColors.BLACK.index);
XSSFCellStyle dataStyle = wb.createCellStyle();
dataStyle.setAlignment(XSSFCellStyle.ALIGN_CENTER);
dataStyle.setVerticalAlignment(XSSFCellStyle.VERTICAL_CENTER);
dataStyle.setFont(dataFont);
setBorder(dataStyle, BorderStyle.THIN, new XSSFColor(new Color(0, 0, 0)));
for (List<Object> rowData : rows) {
Row dataRow = sheet.createRow(rowIndex);
dataRow.setHeightInPoints(25);
colIndex = 0;
for (Object cellData : rowData) {
Cell cell = dataRow.createCell(colIndex);
if (cellData != null) {
cell.setCellValue(cellData.toString());
} else {
cell.setCellValue("");
}
cell.setCellStyle(dataStyle);
colIndex++;
}
rowIndex++;
}
return rowIndex;
}
/**
* 自動調整列寬
*
* @param sheet
* @param columnNumber
*/
private static void autoSizeColumns(Sheet sheet, int columnNumber) {
for (int i = 0; i < columnNumber; i++) {
int orgWidth = sheet.getColumnWidth(i);
sheet.autoSizeColumn(i, true);
int newWidth = (int) (sheet.getColumnWidth(i) + 100);
if (newWidth > orgWidth) {
sheet.setColumnWidth(i, newWidth);
} else {
sheet.setColumnWidth(i, orgWidth);
}
}
}
/**
* 設定邊框
*
* @param style
* @param border
* @param color
*/
private static void setBorder(XSSFCellStyle style, BorderStyle border, XSSFColor color) {
style.setBorderTop(border);
style.setBorderLeft(border);
style.setBorderRight(border);
style.setBorderBottom(border);
style.setBorderColor(BorderSide.TOP, color);
style.setBorderColor(BorderSide.LEFT, color);
style.setBorderColor(BorderSide.RIGHT, color);
style.setBorderColor(BorderSide.BOTTOM, color);
}
}複製程式碼注意，這裡封裝了常用的屬性，具體api大家可以自行百度
四：建立ExcelConstant
建立core→constant→ExcelConstant
package com.example.demo.core.constant;
public class ExcelConstant {
/**
* 生成檔案存放路徑
*/
public static final String FILE_PATH = "C:\\Users\\Administrator\\Desktop\\";
/**
* 表格預設名稱
*/
public static final String FILE_NAME = "TEST.xls";
}複製程式碼五：建立ExcelController
package com.example.demo.controller;
import com.example.demo.core.aop.AnnotationLog;
import com.example.demo.core.constant.ExcelConstant;
import com.example.demo.core.ret.RetResponse;
import com.example.demo.core.ret.RetResult;
import com.example.demo.core.ret.ServiceException;
import com.example.demo.core.utils.ExcelUtils;
import com.example.demo.model.ExcelData;
import com.example.demo.model.UserInfo;
import com.example.demo.service.UserInfoService;
import com.github.pagehelper.PageHelper;
import com.github.pagehelper.PageInfo;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.apache.shiro.SecurityUtils;
import org.apache.shiro.authc.IncorrectCredentialsException;
import org.apache.shiro.authc.UsernamePasswordToken;
import org.apache.shiro.subject.Subject;
import org.springframework.web.bind.annotation.*;
import javax.annotation.Resource;
import javax.servlet.http.HttpServletResponse;
import java.util.ArrayList;
import java.util.List;
@RestController
@RequestMapping("excel")
public class ExcelController {
@Resource
private UserInfoService userInfoService;
@PostMapping("/test")
public RetResult<Integer> test(){
int rowIndex = 0;
List<UserInfo> list = userInfoService.selectAlla(0, 0);
ExcelData data = new ExcelData();
data.setName("hello");
List<String> titles = new ArrayList();
titles.add("ID");
titles.add("userName");
titles.add("password");
data.setTitles(titles);
List<List<Object>> rows = new ArrayList();
for(int i = 0, length = list.size();i<length;i++){
UserInfo userInfo = list.get(i);
List<Object> row = new ArrayList();
row.add(userInfo.getId());
row.add(userInfo.getUserName());
row.add(userInfo.getPassword());
rows.add(row);
}
data.setRows(rows);
try{
rowIndex = ExcelUtils.generateExcel(data, ExcelConstant.FILE_PATH + ExcelConstant.FILE_NAME);
}catch (Exception e){
e.printStackTrace();
}
return RetResponse.makeOKRsp(Integer.valueOf(rowIndex));
}
@GetMapping("/test2")
public void test2(HttpServletResponse response){
int rowIndex = 0;
List<UserInfo> list = userInfoService.selectAlla(0, 0);
ExcelData data = new ExcelData();
data.setName("hello");
List<String> titles = new ArrayList();
titles.add("ID");
titles.add("userName");
titles.add("password");
data.setTitles(titles);
List<List<Object>> rows = new ArrayList();
for(int i = 0, length = list.size();i<length;i++){
UserInfo userInfo = list.get(i);
List<Object> row = new ArrayList();
row.add(userInfo.getId());
row.add(userInfo.getUserName());
row.add(userInfo.getPassword());
rows.add(row);
}
data.setRows(rows);
try{
ExcelUtils.exportExcel(response,"test2",data);
}catch (Exception e){
e.printStackTrace();
}
}
}
複製程式碼六：新增介面許可權
INSERT INTO `sys_permission_init` VALUES ('7', '/excel/test', 'anon', '7');
INSERT INTO `sys_permission_init` VALUES ('8', '/excel/test2', 'anon', '8');複製程式碼這裡我們需要測試在瀏覽器中下載，所以我們先把介面設定為不登入也可以訪問
七：測試
輸入localhost:8080/excel/test
開啟桌面的TEST.xls
在瀏覽器中輸入localhost:8080/excel/test2
出現如圖所示頁面，開啟檔案，資料與TEST.xls一致
專案地址
碼雲地址： gitee.com/beany/mySpr…
GitHub地址： github.com/MyBeany/myS…
寫文章不易，如對您有幫助，請幫忙點下star
結尾
新增匯出Excel表格功能已完成，後續功能接下來陸續更新，有問題可以聯絡我mr_beany@163.com。另求各路大神指點，感謝大家。