24 Star 407 Fork 111

625 / chain-poi-excel

Create your Gitee Account
Explore and code with more than 8 million developers,Free private repositories !:)
Sign up
Clone or Download
contribute
Sync branch
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
README.md

logo

OSCS Status GitHub code size in bytes star

一. 快速开始

已上传maven中央仓库, 无需下载此项目, 快照版本每个月初发release

POM中maven直接引入

<!-- excel导入导出 POI版本为5.2.2 -->
<dependency>
    <groupId>com.github.stupdit1t</groupId>
    <artifactId>poi-excel</artifactId>
    <version>3.1.1</version>
</dependency>

兼容两个低版本POI

<!-- excel导入导出 POI版本为3.17 -->
<dependency>
<groupId>com.github.stupdit1t</groupId>
<artifactId>poi-excel</artifactId>
<version>poi-317.3</version>
</dependency>

<!-- excel导入导出 POI版本为4.1.2 -->
<dependency>
<groupId>com.github.stupdit1t</groupId>
<artifactId>poi-excel</artifactId>
<version>poi-412.3</version>
</dependency>

Spring使用示例

@ApiOperation("导出异常日志")
@GetMapping("/export")
public void export(HttpServletResponse response, SysErrorLogQueryParam queryParams) {
    // 1.获取列表数据
    List<SysErrorLog> data = sysErrorLogService.selectListPC(queryParams);
    
    // 2.执行导出
    ExcelHelper.opsExport(PoiWorkbookType.XLSX)
            .opsSheet(data)
            .opsHeader().simple()
                .texts("请求地址", "请求方式", "IP地址", "简要信息", "异常时间", "创建人").done()
            .opsColumn()
                .fields("requestUri","requestMethod","ip","errorSimpleInfo","createDate","creatorName").done()
            .done()
            .export(response, "异常日志.xlsx");
}

二. 项目优势

ExcelHelper 结构概览 点击展开
opsExport 导出Excel
opsSheet 声明sheet
opsHeader 设置表头
complex 复杂表头
text 单元格声明
simple 简单表头
title 大标题
text 列标题
texts 列标题批量
noFreeze 不冻结表头
opsColumn 设置导出字段
field 字段设置
color 字体颜色
width 宽度
height 高度
wrapText 自动换行
addgn 水平定位
backColor 背景色
pattern 内容格式化
dropdown 下拉框
comment 注释
mergerRepeat 纵向自动合并
vaddgn 垂直定位
verifyIntNum 验证整数
verifyFloatNum 验证浮点数字
verifyDate 验证日期
verifyText 验证单元格
verifyCustom 自定义验证
outHandle 输出回调钩子
fields 批量字段设置
opsFooter 设置表尾
text 单元格内容
sheetName sheet名称
width 统一宽度
height 统一高度
autoNum 自动序号
autoNumColumnWidth 自动序号列宽度
mergeCells 批量合并单元格
mergeCellsIndex 批量合并单元格(下标形式)
mergeCell 合并单元格
parallelSheet 并行导出sheet
style 全局样式覆盖
password 密码设置
createBook 输出Workbook
fillBook 填充Workbook
export 执行导出
opsReplace 读模板导出Excel
from 文件源
variable 变量替换
variables 批量变量替换
password 设置密码
replace 输出workbook
replaceTo 输出文件
opsParse 解析Excel声明
from 文件源
opsSheet 解析sheet区域声明
opsColumn 解析列定义
field 字段
notNdll 不能为空
asInt 类型int
asBoolean 类型boolean
asString 类型string
asLong 类型Long
asBigDecimal 类型Bigdecimal
asDate 类型Date
asDouble 类型Double
asFloat 类型Float
asImg 类型Img
asShort 类型Short
asChar 类型Char
asByCustom 自定义类型
callBack 解析回调钩子
parse 解析文件
  • 简单快速上手,且满足绝大多数业务场景
  • 屏蔽POI细节,学习成本低。
  • 未使用注解方式实现,纯编码代码块,去除烦人的各种POJO
  • 功能强大,导入支持严格的单元格校验,导出支持公式,复杂表头和尾部设计,以及单元格样式自定义支持
  • 支持读取复杂Excel模板,替换变量输出Excel,变量用${}替代

三. 更新记录

有需求才有进步,这个轮子本身就是从0开始因为需求慢慢叠加起来的。有新需求提出来,我觉得合适会更新. 如有疑问可加群帮解答: 811606008

v3.1.1

  1. 导出支持读取Excel追加sheet页

v3.1.0

  1. 支持单元格级别的批注功能, 参考simpleExport2

v3.0.9

  1. 表头相同名字重复设置报错, fixbug

v3.0.8

  1. 导出添加设置列换行显示属性 参考简单导出simpleExport2
  2. 添加sheet设置全局的单元格宽度属性 参考简单导出simpleExport2

v3.0.7

  1. POI版本升级 5.1.0 ----- 5.2.2

v3.0.6

  1. 增加导出自动感知行数据合并行功能, 方法为mergerRepeat, 参考 简单导出 + 自定义属性完整示例

v3.0.5

  1. 导出参数为空检验
  2. 部分方法名调整

v3.0.4

  1. 日期格式化方法名修改 UPDATE
  2. 保留导出workbook, 提供灵活性 NEW
  3. 支持xlsx添加密码 NEW

v3.0.2 ( 不兼容1.x.x2.x.x 版本)

  1. 提供ExcelHepler链式构建类, 帮助快捷构建. 本身还是调用ExcelUtil类
  2. 优化代码结构和层次
  3. 提供更精确的单元格样式控制

四. 导出

选择xls还是xlsx?

xls速度较快,单sheet最大65535行,体积大. xlsx速度慢,单sheet最大1048576行,体积小

1. 简单导出
  • 代码示例
class a {

    @Test
    public void simpleExport() {
        // 指定导出XLSX格式
        ExcelHelper.opsExport(PoiWorkbookType.XLSX)
                .opsSheet(data)
                .opsHeader().simple().texts("项目名称", "项目图", "所属区域", "省份", "市", "项目所属人", "项目领导人", "得分", "平均分", "创建时间").done()
                .opsColumn().fields("projectName", "img", "areaName", "province", "city", "people", "leader", "scount", "avg", "createTime").done()
                .done()
                .export("src/test/java/excel/export/excel/simpleExport.xlsx")
        ;
    }
}
  • 导出结果

image

2. 简单导出 + 自定义属性完整示例
  • 代码示例
class a {

    @Test
    public void simpleExport2() {
        // 覆盖title全局默认样式
        ICellStyle titleStyle = new ICellStyle() {
            @Override
            public CellPosition getPosition() {
                return CellPosition.TITLE;
            }

            @Override
            public void handleStyle(Font font, CellStyle cellStyle) {
                font.setFontHeightInPoints((short) 100);
                // 红色字体
                font.setColor(IndexedColors.RED.index);
                // 居左
                cellStyle.setAlignment(HorizontalAlignment.LEFT);
            }
        };

        // 指定导出XLS格式,
        ExcelHelper.opsExport(PoiWorkbookType.XLS)
                // 全局样式覆盖
                .style(titleStyle)
                // 导出添加密码
                .password("123456")
                // sheet声明
                .opsSheet(data)
                    // 自动生成序号, 此功能在复杂表头下, 需要自己定义序号列
                    .autoNum()
                    // 自定义数据行高度, 默认excel正常高度
                    .height(CellPosition.CELL, 300)
                    // 全局单元格宽度100000
                    .width(10000)
                    // 自定义序号列宽度, 默认2000
                    .autoNumColumnWidth(3000)
                    // sheet名字
                    .sheetName("简单导出")
                    // 表头标题声明
                    .opsHeader().simple()
                        // 大标题声明
                        .title("我是大标题")
                        // 副标题, 自定义样式
                        .text("项目名称", (font, style) -> {
                            // 红色
                            font.setColor(IndexedColors.RED.index);
                            // 居顶
                            style.setVerticalAlignment(VerticalAlignment.TOP);
                        })
                        // 副标题批量
                        .texts("项目图", "所属区域", "省份", "项目所属人", "市", "创建时间", "项目领导人", "得分", "平均分")
                        .done()
                    // 导出列声明
                    .opsColumn()
                        // 批量导出字段
                        .fields("projectName", "img", "areaName", "province", "people")
                        // 个性化导出字段设置
                        .field("city")
                            // 当前行数据相同合并
                            .mergerRepeat()
                            // 超出宽度换行显示
                            .wrapText()
                            // 下拉框
                            .dropdown("北京", "西安", "上海", "广州")
                            // 行高单独设置
                            .height(500)
                            // 批注
                            .comment("城市选择下拉框内容哦")
                            // 宽度设置
                            .width(6000)
                            // 字段导出回调
                            .outHandle((val, row, style) -> {
                                // 如果是北京, 设置背景色为黄色
                                if (val.equals("北京")) {
                                    style.setBackColor(IndexedColors.YELLOW);
                                    style.setHeight(900);
                                    style.setComment("自定义设置样式批注");
                                    // 属性值自定义
                                    return val + "(自定义)";
                                }
                                return val;
                            })
                            .done()
                        .field("createTime")
                            // 区域相同, 合并时间
                            .mergerRepeat("areaName")
                            // 日期格式化
                            .pattern("yyyy-MM-dd")
                            // 居左
                            .align(HorizontalAlignment.LEFT)
                            // 居中
                            .valign(VerticalAlignment.CENTER)
                            // 背景黄色
                            .backColor(IndexedColors.YELLOW)
                            // 金色字体
                            .color(IndexedColors.GOLD)
                            .done()
                        .fields("leader", "scount", "avg")
                        .done()
                    // 尾行设计
                    .opsFooter()
                        // 字符合并
                        .text("合计", "1,1,A,H")
                        // 公式应用
                        .text(String.format("=SUM(J3:J%s)", 2 + data.size()), "1,1,J,J")
                        .text(String.format("=AVERAGE(K3:K%s)", 2 + data.size()), "1,1,K,K")
                        // 坐标合并
                        .text("作者:625", 0, 0, 8, 8)
                        .done()
                    .done()
                // 执行导出
                .export("src/test/java/excel/export/excel/simpleExport2.xls")
        ;
    }
}
  • 导出结果

image

3. 复杂表头导出
  • 代码示例
class a {

    @Test
    public void complexExport() {
        ExcelHelper.opsExport(PoiWorkbookType.XLSX)
                .opsSheet(data)
                    .autoNum()
                    .opsHeader()
                        // 不冻结表头, 默认冻结
                        .noFreeze()
                        // 复杂表头模式, 支持三种合并方式, 1数字坐标 2字母坐标 3Excel坐标
                        .complex()
                            // excel坐标
                            .text("项目资源统计", "A1:K1")
                            // 字母坐标
                            .text("序号", "2,3,A,A")
                            // 数字坐标
                            .text("基本信息", 1,1,1,4)
                            .text("项目名称", "3,3,B,B")
                            .text("所属区域", "3,3,C,C")
                            .text("省份", "3,3,D,D")
                            .text("市", "3,3,E,E")
                            .text("项目所属人", "2,3,F,F")
                            .text("市项目领导人", "2,3,G,G")
                            .text("分值", "2,2,H,I")
                            .text("得分", "3,3,H,H")
                            .text("平均分", "3,3,I,I")
                            .text("项目图片", "2,3,K,K")
                            .text("创建时间", "2,3,J,J")
                            .done()
                        .opsColumn()
                            .fields("projectName", "areaName", "province", "city", "people", "leader", "scount", "avg", "img", "createTime")
                            .done()
                        .opsFooter()
                            // 尾行合计,D1,K2中的 纵坐标从1开始计算,会自动计算数据行高度!  切记! 切记! 切记!
                            .text("=SUM(H4:H13)", "D1:K2")
                            .text("=SUM(H4:H13)", 0, 1, 3, 10)
                            .done()
                        // 自定义合并单元格
                        .mergeCell("F4:G13")
                        .done()
                    .export("src/test/java/excel/export/excel/complexExport.xlsx");
    }
}
  • 导出结果

image

4. 复杂的对象级联导出
  • 代码示例
class a {

    @Test
    public void complexObject() {
        ExcelHelper.opsExport(PoiWorkbookType.XLSX)
                .opsSheet(complexData)
                .opsHeader().simple().texts("學生姓名", "所在班級", "所在學校", "更多父母姓名").done()
                .opsColumn().fields("name", "classRoom.name", "classRoom.school.name", "moreInfo.parent.age").done()
                .done()
                .export("src/test/java/excel/export/excel/complexObject.xlsx");
    }
}
  • 导出结果

image

4. map数据导出
class a {

    List<Map<String, Object>> mapData = new ArrayList<>();

    @Test
    public void mapExport() {
        ExcelHelper.opsExport(PoiWorkbookType.XLSX)
                .opsSheet(mapData)
                .opsHeader().simple().texts("姓名", "年龄").done()
                .opsColumn().fields("name", "age").done()
                .done()
                .export("src/test/java/excel/export/excel/mapExport.xlsx");
    }
}
  • 导出结果

image

5. 模板导出
  • 代码示例
class a {

    @Test
    public void templateExport() {
        name.set("templateExport");
        ExcelHelper.opsExport(PoiWorkbookType.XLSX)
                .opsSheet(Collections.emptyList())
                    .opsHeader().simple().texts("宝宝姓名", "手机号码", "宝宝生日", "月龄", "宝宝性别", "来源渠道", "备注").done()
                    .opsColumn()
                        .field("宝宝姓名").done()
                        .field("手机号码").verifyText("11~11", "请输入11位的手机号码!").done()
                        .field("宝宝生日").pattern("yyyy-MM-dd").verifyDate("2000-01-01~3000-12-31").done()
                        .field("月龄").width(4).verifyCustom("VALUE(F3:F6000)", "月齡格式:如1年2个月则输入14").done()
                        .field("宝宝性别").dropdown("男", "女").done()
                        .field("来源渠道").width(12).dropdown("品推", "市场").done()
                        .field("备注").done()
                        .done()
                    .done()
                .export("src/test/java/excel/export/excel/templateExport.xlsx");
    }
}
  • 导出结果

image

6. 支持多sheet导出
  • 代码示例
class a {

    @Test
    public void mulSheet() {
        ExcelHelper.opsExport(PoiWorkbookType.XLSX)
                // 多线程导出多sheet, 默认单线程
                .parallelSheet()
                .opsSheet(mapData)
                    .sheetName("sheet1")
                    .opsHeader().simple().texts("姓名", "年龄").done()
                    .opsColumn().fields("name", "age").done()
                    .done()
                .opsSheet(complexData)
                    .sheetName("sheet2")
                    .opsHeader().simple().texts("學生姓名", "所在班級", "所在學校", "更多父母姓名").done()
                    .opsColumn().fields("name", "classRoom.name", "classRoom.school.name", "moreInfo.parent.age").done()
                    .done()
                .opsSheet(bigData)
                    .sheetName("sheet3")
                    .opsHeader().simple().texts("项目名称", "项目图", "所属区域", "省份", "市", "项目所属人", "项目领导人", "得分", "平均分", "创建时间").done()
                    .opsColumn().fields("projectName", "img", "areaName", "province", "city", "people", "leader", "scount", "avg", "createTime").done()
                    .done()
                .export("src/test/java/excel/export/excel/mulSheet.xlsx");
    }
}
  • 导出示例

image

7. 支持大数据内存导出,防止OOM
  • 代码示例

@Test
class a {
    public void bigData() {
        // 声明导出BIG XLSX
        ExcelHelper.opsExport(PoiWorkbookType.BIG_XLSX)
                .opsSheet(bigData)
                .sheetName("1")
                .opsHeader().simple().texts("项目名称", "项目图", "所属区域", "省份", "市", "项目所属人", "项目领导人", "得分", "平均分", "创建时间").done()
                .opsColumn().fields("projectName", "img", "areaName", "province", "city", "people", "leader", "scount", "avg", "createTime").done()
                .done()
                .export("src/test/java/excel/export/excel/bigData.xlsx");
    }
}
8. 读模板替换变量导出

image

  • 代码示例
class a {

    @Test
    public void parseMap1() {
        ExcelHelper.opsReplace()
                .from("src/test/java/excel/replace/replace.xlsx")
                .variable("projectName", "中青旅")
                .variable("buildName", "管材生产")
                .variable("sendDate", "2020-02-02")
                .variable("reciveSb", "张三")
                .variable("phone", "15594980303")
                .variable("address", "陕西省xxxx")
                .variable("company", "社保局")
                .variable("remark", "李四")
                .replaceTo("src/test/java/excel/replace/replace2.xlsx");
    }
}
  • 导出结果

image

五. 解析导入

1. 支持严格的单元格校验,可以定位到单元格坐标校验
2. 支持数据行的图片导入
3. 支持导入过程中,对数据处理添加回调逻辑,满足其他业务场景
4. xls和xlsx都支持导入
  • 导入文件示例图

image

  • 数据要转换的Java对象
public class ProjectEvaluate implements Serializable {

    private Long id;

    private Long projectId;

    private Long createUserId;

    private Date createTime;

    private String projectName;

    private String areaName;

    private String province;

    private String city;

    private String statusName;

    private Integer scount;

    private double avg;

    private String people;

    private String leader;

    private byte[] img;
}
  • 快速解析为Map, 不验证excel内容
public class MainClass {

    @Test
    public void parseMap1() {
        PoiResult<HashMap> parse = ExcelHelper.opsParse(HashMap.class)
                .from("src/test/java/excel/export/excel/simpleExport.xlsx")
                // 指定数据区域
                .opsSheet(0, 1, 0)
                .parse();
        if (!parse.isSuccess()) {
            // 输出验证不通过的信息
            System.out.println(parse.getMessageToString());
        }
        // 打印解析的数据
        parse.getData().forEach(System.out::println);
    }
}
  • 快速解析为Map, 验证excel内容
public class MainClass {

    @Test
    public void parseMap2() {
        PoiResult<HashMap> parse = ExcelHelper.opsParse(HashMap.class)
                .from("src/test/java/excel/parse/excel/simpleExport.xlsx")
                // 指定数据区域
                .opsSheet(0, 1, 0)
                // 自定义列映射
                .opsColumn()
                    // 强制输入字符串, 且不能为空
                    .field("A", "projectName", "项目名称").asString().notNull().done()
                    // img类型. 导入图片必须这样写, 且字段为byte[]
                    .field("B", "img", "项目图片").asImg().done()
                    .field("C", "areaName", "所属区域").done()
                    .field("D", "province", "省份").done()
                    .field("E", "city", "市").done()
                    // 不能为空
                    .field("F", "people", "项目所属人").notNull().done()
                    // 不能为空
                    .field("G", "leader", "项目领导人").notNull().done()
                    // 必须是数字
                    .field("H", "scount", "总分").asLong().done()
                    .field("I", "avg", "历史平均分").done()
                    .field("J", "createTime", "创建时间").asDate("yyyy-MM-dd").done()
                    .done()
                .callBack((row, index) -> {
                    // 行回调, 可以在这里改数据
                    System.out.println("当前是第:" + index + " 数据是: " + row);
                })
                .parse();
        if (!parse.isSuccess()) {
            // 输出验证不通过的信息
            System.out.println(parse.getMessageToString());
        }

        // 打印解析的数据
        parse.getData().forEach(System.out::println);
    }
}
  • 解析为Java对象, 验证excel内容
public class MainClass {

    @Test
    public void parseBean() {
        PoiResult<ProjectEvaluate> parse = ExcelHelper.opsParse(ProjectEvaluate.class)
                .from("src/test/java/excel/parse/excel/simpleExport.xlsx")
                // 指定数据区域
                .opsSheet(0, 1, 0)
                // 自定义列映射
                .opsColumn()
                    // 强制输入字符串, 且不能为空
                    .field("A", "projectName", "项目名称").asString().notNull().done()
                    // img类型. 导入图片必须这样写, 且字段为byte[]
                    .field("B", "img", "项目图片").asImg().done()
                    .field("C", "areaName", "所属区域").done()
                    .field("D", "province", "省份").done()
                    .field("E", "city", "市").done()
                    // 不能为空
                    .field("F", "people", "项目所属人").notNull().done()
                    // 不能为空
                    .field("G", "leader", "项目领导人").notNull().done()
                    // 必须是数字
                    .field("H", "scount", "总分").asInt().done()
                    .field("I", "avg", "历史平均分").asDouble().done()
                    .field("J", "createTime", "创建时间").asDate("yyyy-MM-dd").done()
                    .done()
                .callBack((row, index) -> {
                    // 行回调, 可以在这里改数据
                    System.out.println("当前是第:" + index + " 数据是: " + row);
                })
                .parse();
        if (!parse.isSuccess()) {
            // 输出验证不通过的信息
            System.out.println(parse.getMessageToString());
        }

        // 打印解析的数据
        parse.getData().forEach(System.out::println);
    }
}
  • 以上如果excel数据不满足, 会收集到以下错误内容
第4行: 项目领导人-不能为空(G4)  总分-格式不正确(H4) 
第8行: 项目领导人-不能为空(G8) 

About

链式POI,屏蔽POI细节快速上手导入导出,支持复杂表头,单元格样式、图片、公式、校验、批注,多sheet、单元格合并、模板导出等。 expand collapse
Cancel

Releases (3)

All

chain-poi-excel

Contributors

All

Activities

Load More
can not load any more
Java
1
https://git.oschina.net/stupid1t/poi-excel.git
git@git.oschina.net:stupid1t/poi-excel.git
stupid1t
poi-excel
chain-poi-excel
master

Search