SpringBoot集成EasyExcel快速人们

1.背景介绍

EasyExcel 是阿里巴巴开发的一款基于 Java 的专业化Excel 操作工具 ，主要用于在 Java 应用程序中快速、高效地读写 Excel 文件。EasyExcel 提供了简单易用的API ，使开发人员可以轻松地处理 Excel 文件，包括读取数据、写入数据、格式化等操作。

像前面文章中提到的Apache POI 也是一个用于操作Excel的API，当然同时能操作Word、PPT这样的Microsoft Ofiice文档，EasyExcel 是一个基于 Apache POI 封装的 Java Excel 操作工具库，它简化了使用 Apache POI 进行 Excel 文件读写操作的复杂性，提供了更加简洁易用的 API 接口。EasyExcel 在底层仍然依赖于 Apache POI 库来实现 Excel 文件的读写功能，但通过封装和优化，使得开发者能够更方便地处理 Excel 文件，减少了编码量。

它在保留 Apache POI 功能的基础上，提供了更高层次的抽象 和更友好的接口，使得开发者能够更快速地实现 Excel 文件的读写操作，降低了学习成本和开发难度。

2.EasyExcel的使用

1.添加依赖

XML 复制代码

        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>easyexcel</artifactId>
            <version>3.0.5</version>
        </dependency>

2.相关代码准备

1.实体类

java 复制代码

import com.alibaba.excel.annotation.ExcelProperty;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;

@ApiModel("用户实体类")
public class User {

    @ApiModelProperty("用户名")
    @ExcelProperty(index = 0, value = "账号")
    private String username;

    @ExcelProperty(index = 1, value = "密码")
    @ApiModelProperty("密码")
    private String password;

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

}

注意:@ApiModelProperty是Swagger的注解，EasyExcel的注解是@ExcelProperty

2.ExcelUtil工具类

java 复制代码

import com.alibaba.excel.EasyExcel;
import com.alibaba.excel.context.AnalysisContext;
import com.alibaba.excel.event.AnalysisEventListener;
import org.springframework.stereotype.Component;

import java.util.ArrayList;
import java.util.List;

@Component
public class ExcelUtil {

    public void writeExcel(String filePath, List<?> data, Class<?> clazz) {
        EasyExcel.write(filePath, clazz).sheet("Sheet1").doWrite(data);
    }

    public List<Object> readExcel(String filePath, Class<?> clazz) {
        List<Object> dataList = new ArrayList<>();
        EasyExcel.read(filePath, clazz, new AnalysisEventListener<Object>() {
            @Override
            public void invoke(Object data, AnalysisContext context) {
                dataList.add(data);
            }

            @Override
            public void doAfterAllAnalysed(AnalysisContext context) {
                // 解析完成后的操作
            }
        }).sheet().doRead();
        return dataList;
    }
}

如果不封装，则像写入Excel的代码，可以是这样：准备需要写入的路径filePath、对应的反射类以及该类的集合：

java 复制代码

 @GetMapping("/export")
       public void export(HttpServletResponse response) throws IOException {

           List<User> userList = userMapper.getAll();

           String filePath = "D:/zhan215/src/main/java/com/zhan/zhan215/FileStorage/账号信息2.xlsx";

           // 设置响应头信息
           response.setContentType("application/vnd.ms-excel");
           response.setCharacterEncoding("utf-8");
           String fileName = URLEncoder.encode("账号信息2.xlsx", "UTF-8");
           response.setHeader("Content-disposition", "attachment;filename=" + fileName);

           // 将数据写入 Excel 文件
           ExcelWriter excelWriter = EasyExcel.write(filePath, User.class).build();

           // 创建WriteSheet对象
           WriteSheet writeSheet = EasyExcel.writerSheet("账号信息").build();
           // 将数据写入Excel
           excelWriter.write(userList, writeSheet);

           // 关闭ExcelWriter对象
           excelWriter.finish();


       }

上述代码可以先作为单元测试，确保能正常使用

测试结果：

这里的账号密码是我自定义User表，可以先随意写入

3.写入控制类

由于我们写好了ExcelUtil工具类，里面包含了对Excel的读和写，因此在控制类中直接调用即可：

写：

java 复制代码

       @GetMapping("/export")
       public void export(HttpServletResponse response，@RequestParam String filePath) throws IOException {

           List<User> userList = userMapper.getAll();


           // 设置响应头信息
           response.setContentType("application/vnd.ms-excel");
           response.setCharacterEncoding("utf-8");
           String fileName = URLEncoder.encode("账号信息2.xlsx", "UTF-8");
           response.setHeader("Content-disposition", "attachment;filename=" + fileName);
           
           // 这样用User类作示例，因此是User.class, 可根据自己实际使用的作更改
           excelUtil.writeExcel(filePath, userList, User.class);

       }

读：

java 复制代码

       @GetMapping("/readExcel")
       public ResponseBean readExcel(@RequestParam String filePath) {
            
           // 因为我这里是在UserController下写的  因此用的是针对User实体，放入的静态参数是User.class
           List<Object> dataList = excelUtil.readExcel(filePath, User.class);

           return ResponseBean.success(dataList);
       }

这里提供ResponseBean的返回结果集封装代码：、

java 复制代码

public class ResponseBean<T> {

    /** 200:操作成功  -1：操作失败**/

    // http 状态码
    private boolean success;

    // 返回的数据
    private T data;

    public boolean isSuccess() {
        return success;
    }

    public void setSuccess(boolean success) {
        this.success = success;
    }

    public T getData() {
        return data;
    }

    public void setData(T data) {
        this.data = data;
    }

    public static <T> ResponseBean<T> success(T data) {
        ResponseBean<T> responseBean = new ResponseBean<>();
        responseBean.setSuccess(true);
        responseBean.setData(data);
        return responseBean;
    }

    public static <T> ResponseBean<T> error(T errorData) {
        ResponseBean<T> responseBean = new ResponseBean<>();
        responseBean.setSuccess(false);
        responseBean.setData(errorData);
        return responseBean;
    }

    public static <T> ResponseBean<T> success() {
        ResponseBean<T> responseBean = new ResponseBean<>();
        responseBean.setSuccess(true);
        return responseBean;
    }

}