POI导出快速入门案例

Apache POI Excel

1. 案例

package com.xy.poi.test.poitest.controller;
​
import org.apache.poi.hssf.usermodel.*;
import org.apache.poi.ss.usermodel.BorderStyle;
import org.apache.poi.ss.usermodel.HorizontalAlignment;
import org.apache.poi.ss.usermodel.VerticalAlignment;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;
​
import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.OutputStream;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
​
/*** @author yangzy* @date 2021/04/12 09:45**/
@RestController
public class PoiTestDemoController {
​private static List> lists = new ArrayList<>();
​static {// 模拟有三行数据Map map1 = new HashMap<>();map1.put("name", "张三");map1.put("age", "21");map1.put("address", "中国");lists.add(map1);
​Map map2 = new HashMap<>();map2.put("name", "李四");map2.put("age", "25");map2.put("address", "hf");lists.add(map2);
​Map map3 = new HashMap<>();map3.put("name", "张三");map3.put("age", "21");map3.put("address", "中国");lists.add(map3);}
​
​@GetMapping("export.html")@ResponseBodypublic void export(HttpServletRequest request, HttpServletResponse response) throws IOException {
​/*** 1.创建工作簿* 2.创建单元格样式* 3.创建sheet* 4.创建表头* 5.创建单元格* 6.response响应头设置* 7.响应*/
​//1.创建工作簿HSSFWorkbook workbook = new HSSFWorkbook();
​//2.1 创建表头单元格样式HSSFCellStyle titleStyle = workbook.createCellStyle();//设置水平、垂直居中titleStyle.setAlignment(HorizontalAlignment.CENTER);titleStyle.setVerticalAlignment(VerticalAlignment.CENTER);//设置单元格边框titleStyle.setBorderBottom(BorderStyle.THIN);titleStyle.setBorderTop(BorderStyle.THIN);titleStyle.setBorderLeft(BorderStyle.THIN);titleStyle.setBorderRight(BorderStyle.THIN);//设置字体HSSFFont fOnt= workbook.createFont();font.setBold(true);font.setFontHeightInPoints((short) 10);titleStyle.setFont(font);
​//2.2 创建普通单元格样式HSSFCellStyle cellStyle = workbook.createCellStyle();cellStyle.setAlignment(HorizontalAlignment.CENTER);cellStyle.setVerticalAlignment(VerticalAlignment.CENTER);cellStyle.setBorderRight(BorderStyle.THIN);cellStyle.setBorderLeft(BorderStyle.THIN);cellStyle.setBorderTop(BorderStyle.THIN);cellStyle.setBorderBottom(BorderStyle.THIN);HSSFFont hssfFOnt= workbook.createFont();hssfFont.setFontHeightInPoints((short) 10);cellStyle.setFont(hssfFont);
​// 3. 创建sheetHSSFSheet sheet = workbook.createSheet("POI导出测试");// 3.1 设置列宽// 模拟三列for (int i = 0; i <3; i++) {sheet.setColumnWidth(i, 4000); //每个列宽都设置为4000. 实际情况列宽是不等的}
​// 4. 创建表头HSSFRow row = sheet.createRow(0);for (int i = 0; i <3; i++) {HSSFCell cell = row.createCell(i);titleStyle.setWrapText(true);cell.setCellStyle(titleStyle);cell.setCellValue("标题" + (i + 1));}
​//5. 创建单元格for (int i = 0; i values = lists.get(i);String name = values.get("name");String age = values.get("age");String address = values.get("address");String[] value = {name, age, address};for (int j = 0; j <3; j++) {HSSFCell cell = row1.createCell(j);cell.setCellStyle(cellStyle);cell.setCellValue(value[j].toString());}}
​//6.response响应头设置response.setHeader("Access-Control-Allow-Origin", "*");response.addHeader("pragma", "no-cache");response.setContentType("application/msexcel;charset=UTF-8");response.setHeader("Content-disposition", "attachment; filename=" + URLEncoder.encode("POI导出测试.xls", "UTF-8"));
​//7.响应try (OutputStream outputStream = response.getOutputStream();) {workbook.write(outputStream);} catch (Exception e) {e.printStackTrace();try (PrintWriter writer = response.getWriter();) {writer.write("导出失败");}}}
}

​

2. 注意

//工作表名称为Excel不得超过31个字符

//，且不得包含以下任何字符：

// 0x0000

// 0x0003

// 冒号 （：）

//反斜杠（\）

//星号（*）

//问号（？）

//正斜杠（/）

//打开方括号（[）

//右方括号（]）

可以使用org.apache.poi.ss.util.WorkbookUtil＃createSafeSheetName（String nameProposal）来规避不合法的sheet名称。

WorkbookUtil.createSafeSheetName（）它会将将无效字符替换为空格（&＃39; &＃39;）

HSSFWorkbook workbook = new HSSFWorkbook();HSSFSheet sheet = workbook.createSheet(WorkbookUtil.createSafeSheetName("[[POI测试*？]"));System.out.println(sheet.getSheetName()); // POI测试 ？ --> 不合法的字符被&＃39; &＃39;替换了

3. CreationHelper

用于实例化HSSF和XSSF所需的各种实例的具体类

示例：

//调用creationHelper.createRichTextString方法构建一个HSSFRichTextStringHSSFCell cell = row.createCell(0);CreationHelper creatiOnHelper= workbook.getCreationHelper();cell.setCellValue(creationHelper.createRichTextString("富文本Abc"));  //调用creationHelper.createRichTextString方法构建一个DataFormat对象。用于格式化单元格日期
CreationHelper createHelper = wb.getCreationHelper();
CellStyle cellStyle = wb.createCellStyle();
cellStyle.setDataFormat(creationHelper.createDataFormat().getFormat("yyyy-mm-dd hh:mm"));
cell.setCellValue(new Date());
cell.setCellStyle(cellStyle);

API:

4. CellType

枚举类，表示单元格类型。

案例：

switch (cell.getCellType()) {case CellType.STRING:System.out.println(cell.getRichStringCellValue().getString());break;case CellType.NUMERIC:if (DateUtil.isCellDateFormatted(cell)) {System.out.println(cell.getDateCellValue());} else {System.out.println(cell.getNumericCellValue());}break;case CellType.BOOLEAN:System.out.println(cell.getBooleanCellValue());break;case CellType.FORMULA:System.out.println(cell.getCellFormula());break;case CellType.BLANK:System.out.println();break;default:System.out.println();}

org.apache.poi.ss.usermodel.DateUtil.isCellDateFormatted(cell) ： 该方法用于检查单元格是否包含日期。由于日期在Excel中内部存储为双精度值，因此我们推断日期格式是否为日期。

api：

5.创建HSSFWorkbook几种方式

HSSFWorkbook workbook = new HSSFWorkbook();Workbook wb = WorkbookFactory.create(new File("MyExcel.xls"));
POIFSFileSystem fs = new POIFSFileSystem(new File("file.xls"));HSSFWorkbook wb = new HSSFWorkbook(fs.getRoot(), true);
或者
FileInputStream fileInputStream = new FileInputStream("file.xls");
HSSFWorkbook workbook = new HSSFWorkbook(new POIFSFileSystem(fileInputStream));

当打开工作簿（.xls HSSFWorkbook或.xlsx XSSFWorkbook）时，可以从File 或InputStream加载工作簿。使用File对象可以减少内存消耗，而InputStream需要更多内存，因为它必须缓冲整个文件。

如果直接使用HSSFWorkbook或XSSFWorkbook，通常应遍历POIFSFileSystem或 OPCPackage，以完全控制生命周期（包括完成后关闭文件）：

5. HorizontalAlignment

表示单元格水平对齐的枚举值，即，它是一般对齐，左对齐，右对齐，水平居中，填充（复制），对齐，跨多个单元居中对齐还是分布。

案例：

HSSFCellStyle titleStyle = workbook.createCellStyle();
//设置水平、垂直居中
titleStyle.setAlignment(HorizontalAlignment.CENTER);
titleStyle.setVerticalAlignment(VerticalAlignment.CENTER);

api：

6. VerticalAlignment

此枚举值指示单元格的垂直对齐方式的类型，即，它是对齐在顶部，底部，垂直居中，对齐还是分布。

案例：

HSSFCellStyle titleStyle = workbook.createCellStyle();
//设置水平、垂直居中
titleStyle.setAlignment(HorizontalAlignment.CENTER);
titleStyle.setVerticalAlignment(VerticalAlignment.CENTER);

api:

7. BorderStyle

枚举值，指示单元格中边框的线型，即是否带边框的破折点，破折点，虚线，点划线，双线，头发，中等，中等破折点，中等破折点，中等破折，无，倾斜的破折号，粗或细。

案例：

//设置单元格边框
titleStyle.setBorderBottom(BorderStyle.THIN);
titleStyle.setBorderTop(BorderStyle.THIN);
titleStyle.setBorderLeft(BorderStyle.THIN);
titleStyle.setBorderRight(BorderStyle.THIN);

api：

8. IndexedColors

每个元素对应一个颜色索引（从零开始）。使用默认的索引调色板时，不会写出值，而是暗指它们。默认情况下修改调色板后，将使用整个调色板。 （不推荐使用）

案例：

HSSFCellStyle cellStyle = workbook.createCellStyle();cellStyle.setFillBackgroundColor(IndexedColors.AQUA.getIndex());cellStyle.setFillPattern(FillPatternType.BIG_SPOTS);

api：