easyexcel-plus-spring-boot-starter 使用教程

easyexcel-plus-spring-boot-starter 使用教程

easyexcel-plus-spring-boot-starter 项目地址: https://gitcode.com/gh_mirrors/ea/easyexcel-plus-spring-boot-starter

1. 项目介绍

easyexcel-plus-spring-boot-starter 是一个基于 easyexcel 的扩展项目，旨在简化 easyexcel 的使用，并提供一些额外的功能，如自定义合并单元格、字典值映射等。该项目使得通过简单的注解即可实现 Excel 文件的导出和导入。

2. 项目快速启动

2.1 添加依赖

首先，需要在你的项目中添加 easyexcel-plus-spring-boot-starter 的依赖。由于我无法访问网络，请参考项目主页上的说明获取最新版本的依赖配置。

2.2 创建模板对象

定义一个 Java 类作为模板对象，并使用

@ExcelProperty

注解标记需要导出的字段。

@ExcelIgnoreUnannotated // 忽略没有标注 @ExcelProperty 的字段导出
public class FamilyMemberDTO {
    @ExcelProperty("户主")
    private String hzmc;

    @ExcelProperty("成员姓名")
    private String cyxm;

    @ExcelProperty("证件号码")
    private String cyzjhm;

    @ExcelProperty("家庭关系")
    private String yhzgx;

    @ExcelProperty("电话")
    private String lxdh;

    @ExcelProperty("时间")
    private LocalDateTime time;

    @ExcelProperty("时间2")
    private Date date;
}

2.3 创建 Controller

创建一个 Controller 类，并在需要导出 Excel 的方法上使用

@ResponseExcel

注解。

@GetMapping("/export")
@ResponseExcel(name = "测试", sheetName = "测试sheet")
public List<FamilyMemberDTO> exportTest() {
    List<FamilyMemberDTO> dtoList = getData();
    return dtoList;
}

2.4 运行和测试

启动你的 Spring Boot 应用，并访问

/export

路径，即可生成并下载名为 "测试.xlsx" 的 Excel 文件。

3. 应用案例和最佳实践

3.1 字典值映射

若需要将字段值映射为字典描述，可以创建一个枚举类实现

ExcelEnum

接口，并提供

getByCode

方法。

@AllArgsConstructor
@Getter
public enum SexEnum implements ExcelEnum<Integer> {
    MAN(1, "男"),
    WOMAN(2, "女");

    private Integer code;
    private String desc;

    @Override
    public String getByCode(Integer code) {
        for (SexEnum value : SexEnum.values()) {
            if (value.getCode().equals(code)) {
                return value.getDesc();
            }
        }
        return code.toString();
    }
}

然后在模板对象中，为需要映射的字段添加

@ExcelEnumValue

注解。

@ExcelProperty(value = "成员性别", converter = ExcelEnumValueConverter.class)
@ExcelEnumValue(SexEnum.class)
private Integer cyxb;

3.2 合并单元格

若需要合并单元格，可以在

@ExcelProperty

注解中指定合并的列，并使用

@ExcelMergeColumn

注解标记分组字段。

@ExcelProperty(value = ["自定义合并", "户主", "户主"])
@ExcelMergeColumn
private String hzmc;

然后在 Controller 中，设置

@ResponseExcel

注解的

isMerge

属性为

true

，并指定合并的列。

@GetMapping("/export/merge")
@ResponseExcel(name = "测试", sheetName = "测试sheet", isMerge = true, mergeColumn = [0], headNumber = 3)
public List<FamilyMemberMergeDTO> exportMergeTest() {
    List<FamilyMemberMergeDTO> dtoList = getMergeData();
    return dtoList;
}

4. 典型生态项目

由于我无法访问网络，无法获取 easyexcel-plus-spring-boot-starter 的典型生态项目信息。请参考项目主页上的相关链接获取更多信息。

easyexcel-plus-spring-boot-starter 项目地址: https://gitcode.com/gh_mirrors/ea/easyexcel-plus-spring-boot-starter