POI导出快速入门案例

程序员文章站 2024-03-20 18:20:04

...

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<Map<String, String>> lists = new ArrayList<>();

    static {
        // 模拟有三行数据
        Map<String, String> map1 = new HashMap<>();
        map1.put("name", "张三");
        map1.put("age", "21");
        map1.put("address", "中国");
        lists.add(map1);

        Map<String, String> map2 = new HashMap<>();
        map2.put("name", "李四");
        map2.put("age", "25");
        map2.put("address", "hf");
        lists.add(map2);

        Map<String, String> map3 = new HashMap<>();
        map3.put("name", "张三");
        map3.put("age", "21");
        map3.put("address", "中国");
        lists.add(map3);
    }


    @GetMapping("export.html")
    @ResponseBody
    public 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. 创建sheet
        HSSFSheet 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 < lists.size(); i++) {
            int index = i + 1; //因为row（0）是表头，所有这里下标index要加1
            HSSFRow row1 = sheet.createRow(index);
            Map<String, String> 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（）它会将将无效字符替换为空格（' '）

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

3. CreationHelper

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

示例：

//调用creationHelper.createRichTextString方法构建一个HSSFRichTextString
 HSSFCell 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:

修饰符和类型	方法和说明
`AreaReference`	`createAreaReference(CellReference topLeft, CellReference bottomRight)`从一对“单元格引用”创建一个区域引用。
`AreaReference`	`createAreaReference(java.lang.String reference)`创建一个AreaReference。
`ClientAnchor`	`createClientAnchor()`创建一个ClientAnchor。
`DataFormat`	`createDataFormat()`创建一个新的DataFormat实例
`ExtendedColor`	`createExtendedColor()`创建XSSF样式的Color对象，用于扩展工作表格式和条件格式
`FormulaEvaluator`	`createFormulaEvaluator()`创建FormulaEvaluator-一个评估公式单元格的对象。
`Hyperlink`	`createHyperlink(HyperlinkType type)`创建给定类型的新超链接
`RichTextString`	`createRichTextString(java.lang.String text)`创建一个新的RichTextString实例

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：

`_NONE`未知类型，用于表示初始化之前的状态或缺少具体类型。
`BLANK`空白单元格类型
`BOOLEAN`布尔单元格类型
`ERROR`错误单元格类型
`FORMULA`公式单元格类型
`NUMERIC`数字单元格类型（整数，小数位数，日期）
`STRING`字符串（文本）单元格类型

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：

枚举常量和描述
`CENTER`水平对齐方式居中，这意味着文本在整个单元格中居中。
`CENTER_SELECTION`水平对齐方式以多个像元为中心。
`DISTRIBUTED`指示单元格内每行文本中的每个“单词”在单元格的宽度上均匀分布，左右边距齐平。
`FILL`指示应在单元格的整个宽度上填充单元格的值。
`GENERAL`水平对齐方式是一般对齐方式。
`JUSTIFY`水平对齐是合理的（向左和向右齐平）。
`LEFT`即使在从右到左模式下，水平对齐也是左对齐。
`RIGHT`水平对齐方式是右对齐的，这意味着即使在从右到左的模式下，单元格内容也会在单元格的右边缘对齐。

6. VerticalAlignment

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

案例：

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

api:

枚举常量和描述
`BOTTOM`垂直对齐方式是底部对齐。
`CENTER`垂直对齐在单元格的整个高度上居中。
`DISTRIBUTED`当文本方向为水平时：文本行的垂直对齐方式垂直分布，其中单元格内的每一行文本均沿单元格的高度均匀分布，顶部齐平
`JUSTIFY`当文本方向为水平时：文本行的垂直对齐方式是垂直分布的，其中单元格内的每一行文本在单元格的高度上均匀分布，顶部和底部页边距齐平。
`TOP`垂直对齐方式是顶部对齐。

7. BorderStyle

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

案例：

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

api：

枚举常量和描述
`DASH_DOT`点划线边框
`DASH_DOT_DOT`点划线边框
`DASHED`破折号边框
`DOTTED`点边框
`DOUBLE`双线边框
`HAIR`发际线边框
`MEDIUM`中等边界
`MEDIUM_DASH_DOT`中点划线边框
`MEDIUM_DASH_DOT_DOT`中点划线边框
`MEDIUM_DASHED`中虚线框
`NONE`无边框（默认）
`SLANTED_DASH_DOT`斜虚线边框
`THICK`粗边框
`THIN`细边框

8. IndexedColors

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

案例：

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

api：

枚举常量和描述
`AQUA`
`AUTOMATIC`
`BLACK`
`BLACK1`
`BLUE`
`BLUE_GREY`
`BLUE1`
`BRIGHT_GREEN`
`BRIGHT_GREEN1`
`BROWN`
`CORAL`
`CORNFLOWER_BLUE`
`DARK_BLUE`
`DARK_GREEN`
`DARK_RED`
`DARK_TEAL`
`DARK_YELLOW`
`GOLD`
`GREEN`
`GREY_25_PERCENT`
`GREY_40_PERCENT`
`GREY_50_PERCENT`
`GREY_80_PERCENT`
`INDIGO`
`LAVENDER`
`LEMON_CHIFFON`
`LIGHT_BLUE`
`LIGHT_CORNFLOWER_BLUE`
`LIGHT_GREEN`
`LIGHT_ORANGE`
`LIGHT_TURQUOISE`
`LIGHT_TURQUOISE1`
`LIGHT_YELLOW`
`LIME`
`MAROON`
`OLIVE_GREEN`
`ORANGE`
`ORCHID`
`PALE_BLUE`
`PINK`
`PINK1`
`PLUM`
`RED`
`RED1`
`ROSE`
`ROYAL_BLUE`
`SEA_GREEN`
`SKY_BLUE`
`TAN`
`TEAL`
`TURQUOISE`
`TURQUOISE1`
`VIOLET`
`WHITE`
`WHITE1`
`YELLOW`
`YELLOW1`

上一篇：自定义异常的简单实现

POI导出快速入门案例

POI导出快速入门案例

POI快速入门教程 | HSSF，XSSF，SXSSF的区别

poi的入门使用,实现excel样式自定义导出,复制即可导出

Spring Cloud Feign快速入门案例

SpringMVC学习笔记01——快速入门案例

Ajax原理与应用案例快速入门教程

SpringBoot快速集成jxls-poi(自定义模板,支持本地文件导出,在线文件导出)

大数据技术之_09_Flume学习_Flume概述+Flume快速入门+Flume企业开发案例+Flume监控之Ganglia+Flume高级之自定义MySQLSource+Flume企业真实面试题

POI报表新手入门案例(一)

JavaScript快速入门案例教程