SpringBoot整合EasyPoi实现Excel文件导出导出

1、引入依赖

   <dependency>
      <groupId>cn.afterturn</groupId>
      <artifactId>easypoi-spring-boot-starter</artifactId>
      <version>4.4.0</version>
   </dependency>

2、相关注解

@Excel

这个是必须使用的注解,如果需求简单只使用这一个注解也是可以的,涵盖了常用的Excel需求,需要大家熟悉这个功能,主要分为基础,图片处理,时间处理,合并处理几块

属性	类型	默认值	功能
name	String	null	列名,支持name_id
needMerge	boolean	fasle	是否需要纵向合并单元格(用于含有list中,单个的单元格,合并list创建的多个row)
orderNum	String	"0"	列的排序,支持name_id
replace	String[]	{}	值得替换 导出是{a_id,b_id} 导入反过来
savePath	String	"upload"	导入文件保存路径,如果是图片可以填写,默认是upload/className/ IconEntity这个类对应的就是upload/Icon/
type	int	1	导出类型 1 是文本 2 是图片,3 是函数,10 是数字 默认是文本
width	double	10	列宽
height	double	10	列高,后期打算统一使用@ExcelTarget的height,这个会被废弃,注意
isStatistics	boolean	fasle	自动统计数据,在追加一行统计,把所有数据都和输出 这个处理会吞没异常,请注意这一点
isHyperlink	boolean	false	超链接,如果是需要实现接口返回对象
isImportField	boolean	true	校验字段,看看这个字段是不是导入的Excel中有,如果没有说明是错误的Excel,读取失败,支持name_id
exportFormat	String	""	导出的时间格式,以这个是否为空来判断是否需要格式化日期
importFormat	String	""	导入的时间格式,以这个是否为空来判断是否需要格式化日期
format	String	""	时间格式,相当于同时设置了exportFormat 和 importFormat
databaseFormat	String	"yyyyMMddHHmmss"	导出时间设置,如果字段是Date类型则不需要设置 数据库如果是string 类型,这个需要设置这个数据库格式,用以转换时间格式输出
numFormat	String	""	数字格式化,参数是Pattern,使用的对象是DecimalFormat
imageType	int	1	导出类型 1 从file读取 2 是从数据库中读取 默认是文件 同样导入也是一样的
suffix	String	""	文字后缀,如% 90 变成90%
isWrap	boolean	true	是否换行 即支持\n
mergeRely	int[]	{}	合并单元格依赖关系,比如第二列合并是基于第一列 则{0}就可以了
mergeVertical	boolean	fasle	纵向合并内容相同的单元格
fixedIndex	int	-1	对应excel的列,忽略名字
isColumnHidden	boolean	false	导出隐藏列

@ExcelTarget

限定一个到处实体的注解,以及一些通用设置,作用于最外面的实体

属性	类型	默认值	功能
value	String	null	定义ID
height	double	10	设置行高
fontSize	short	11	设置文字大小

@ExcelEntity

标记是不是导出excel 标记为实体类,一遍是一个内部属性类,标记是否继续穿透,可以自定义内部id

属性	类型	默认值	功能
id	String	null	定义ID

@ExcelCollection

一对多的集合注解,用以标记集合是否被数据以及集合的整体排序

属性	类型	默认值	功能
id	String	null	定义ID
name	String	null	定义集合列名,支持nanm_id
orderNum	int	0	排序,支持name_id
type	Class<?>	ArrayList.class	导入时创建对象使用

@ExcelIgnore

忽略这个属性,多使用需循环引用中

3.导出使用的基本数据对象

@Data、@AllArgsConstructor、@NoArgsConstructor注解需要引入Lombok插件

@Data
@AllArgsConstructor
@NoArgsConstructor
@EqualsAndHashCode(callSuper = false)
public class Student {

    @Excel(name = "姓名",width = 30)
    private String name;

    @Excel(name = "性别",width = 20)
    private String sex;

    @Excel(name = "年龄",width = 20)
    private Integer age;
}

导入Excel

导出代码

    @SneakyThrows
    @PostMapping(value = "/importStudents")
    public void importStudent(MultipartFile file){
        ImportParams params = new ImportParams();
        // 删掉表格的表头行（如果导入有表头的话）
        params.setHeadRows(1);
        //表格标题行数,默认0
        params.setTitleRows(1);
        try {
            List<Student> students = ExcelImportUtil.importExcel(file.getInputStream(), Student.class, params);
            System.out.println(students);
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

 导入的对象打印结果

5、导出

模拟数据

public List<Student> getStudents(){
        ArrayList<Student> students = new ArrayList<>();
        for (int i = 0; i < 20; i++) {
            Student stu = new Student("学生"+i, "男", 10 + i);
            students.add(stu);
        }
        return students;
    }

导出代码：

    @SneakyThrows
    @GetMapping(value = "/exportStudents")
    public void exportStudent(HttpServletResponse response){
        List<Student> students = getStudents();
        ExportParams params = new ExportParams();
        params.setTitle("学生表信息表");
        params.setSheetName("学生表");
        try (ServletOutputStream out = response.getOutputStream()) {
            //设置信息头，告诉浏览器内容为excel类型
            response.setHeader("content-Type", "application/vnd.ms-excel");
            //设置下载名称
            response.setHeader("Content-Disposition", "attachment;filename=" + URLEncoder.encode("学生信息表.xlsx", StandardCharsets.UTF_8.name()));
            Workbook workbook = ExcelExportUtil.exportExcel(params, Student.class, students);
            //输出本地
            FileOutputStream outputStream = new FileOutputStream("D:\\exportdoc\\student.xlsx");

            workbook.write(out);
        }
    }

总结：easypoi使用起来非常便捷！