EasyExcel使用心得

最近项目中用到了阿里easyExcel做导入导出功能
下面是我写的一个工具类，带泛型的。拿来即用，有需求的小伙伴可以看看。
同时也欢迎大佬提出修改意见。

一、首先先写一个生成Excel表头的DTO类，也可以直接在自己的要处理的实体类加上@ExcelProperty注解。
value表示表头，index表示第几列。0等于第一列

public class ElecsignCertExcelDTO{
   /**
    * R3编码
    */
   @ApiModelProperty("R3编码")
   @ExcelProperty(value = "R3编码", index = 0)
   private String r3Code;

   /**
    * R3名称
    */
   @ApiModelProperty("R3名称")
   @ExcelProperty(value = "R3名称", index = 1)
   private String r3Name;

   /**
    * 用户名
    */
   @ApiModelProperty("用户名")
   @ExcelProperty(value = "用户名", index = 2)
   private String userName;
}

二、进行写操作所需的Listener类，需要继承easyExcel自带的监听器AnalysisEventListener。
我是参照官方文档进行编写，详情可以参照官方文档https://www.yuque.com/easyexcel/doc/easyexcel。
也可以看其github演示地址https://github.com/alibaba/easyexcel/blob/master/src/test/java/com/alibaba/easyexcel/test/demo/read/ReadTest.java

/**
 * @author hhb
 * @date :2020/10/27 8:57
 */
@Slf4j
public class ReadExcelListener<t> extends AnalysisEventListener<t> {

    List<t> list = new ArrayList<>();
    /**
     * &#x8FD9;&#x4E2A;&#x6BCF;&#x4E00;&#x6761;&#x6570;&#x636E;&#x89E3;&#x6790;&#x90FD;&#x4F1A;&#x6765;&#x8C03;&#x7528;
     *
     * @param data
     *            one row value. Is is same as {@link AnalysisContext#readRowHolder()}
     * @param context
     */
    @Override
    public void invoke(T data, AnalysisContext context) {
        log.info("&#x89E3;&#x6790;&#x5230;&#x4E00;&#x6761;&#x6570;&#x636E;:{}", JSON.toJSONString(data));
        list.add(data);
    }
    /**
     * &#x6240;&#x6709;&#x6570;&#x636E;&#x89E3;&#x6790;&#x5B8C;&#x6210;&#x4E86; &#x90FD;&#x4F1A;&#x6765;&#x8C03;&#x7528;
     *
     * @param context
     */
    @Override
    public void doAfterAllAnalysed(AnalysisContext context) {
        //&#x6E05;&#x9664;&#x6570;&#x636E;
        log.info("&#x6240;&#x6709;&#x6570;&#x636E;&#x89E3;&#x6790;&#x5B8C;&#x6210;&#xFF01;");
    }

    public List<t> getDatas() {
        return list;
    }

</t></t></t></t>

三、这一步就可以开始写Excel工具类了，

/**
 *
 *  用阿里easyExcel实现对Excel的读、写操作
 * @author hhb
 * @date :2020/10/14 15:55
 */

public class ExcelUtils {

    /**
     * 读Excel操作
     * @param file
     * @param cls
     * @param listener
     * @param <t>
     * @return
     */
    public static <t> List<t> readExcel(MultipartFile file,Class<t> cls,ReadExcelListener<t> listener){
//        EasyExcel.read(fileName, DemoData.class, new DemoDataListener()).sheet().doRead();
        List<t> data=new ArrayList<>();
        try {
            EasyExcel.read(file.getInputStream(),cls,listener).sheet().doRead();
            //&#x6839;&#x636E;&#x5B9E;&#x9645;&#x4E1A;&#x52A1;&#x9700;&#x6C42;&#x6765;&#x9009;&#x62E9;&#xFF0C;&#x662F;&#x5426;&#x6709;&#x8FD4;&#x56DE;&#x503C;
            data=listener.getDatas();
        } catch (IOException e) {
            e.printStackTrace();
        }
        return data;
    }

    /**
     * &#x5199;Excel&#x64CD;&#x4F5C;
     *
     *
     * @param response
     * @param fileName
     * @param cls
     * @param dataList
     * @param <t>
     */
    public static <t> void wirteExcel(HttpServletResponse response,String fileName,Class<t> cls,List<t> dataList){
//        EasyExcel.write(fileName, cls).sheet("sheet1").doWrite(dataList);
        try {
            EasyExcel.write(getOutputStream(fileName,response),cls).sheet("sheet1").doWrite(dataList);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    /**
     * &#x5BFC;&#x51FA;&#x6587;&#x4EF6;&#x65F6;&#x4E3A;Writer&#x751F;&#x6210;OutputStream
     * @param fileName
     * @param response
     * @return
     * @throws Exception
     */
    private static OutputStream getOutputStream(String fileName, HttpServletResponse response)
        throws Exception{
        try{
            fileName = URLEncoder.encode(fileName,"utf-8");
            response.setContentType("application/vnd.ms-excel");
            response.setCharacterEncoding("utf-8");
            //&#x6B64;&#x5904;&#x6307;&#x5B9A;&#x4E86;&#x6587;&#x4EF6;&#x7C7B;&#x578B;&#x4E3A;xls&#xFF0C;&#x5982;&#x679C;&#x662F;xlsx&#x7684;&#xFF0C;&#x8BF7;&#x81EA;&#x884C;&#x66FF;&#x6362;&#x4FEE;&#x6539;
            response.setHeader("Content-Disposition", "attachment; filename=" + fileName + ".xlsx");
            response.setHeader("Pragma", "public");
            response.setHeader("Cache-Control", "no-store");
            response.addHeader("Cache-Control", "max-age=0");
            return response.getOutputStream();
        } catch (IOException e){
            throw new Exception("&#x5BFC;&#x51FA;&#x6587;&#x4EF6;&#x5931;&#x8D25;&#xFF01;");
        }
    }

</t></t></t></t></t></t></t></t></t></t>

最后，你可以根据项目实际情况调用工具类，和对其进行修改。
需要注意的是！！！！！！
在写处理Excel数据的DTO类时需要保证类里面有一个无参构造器。我就是当时只写了一个将数据库实体类转化为DTO的有参构造器然后报错，浪费了半天时间。

Original: https://www.cnblogs.com/ydmysm/p/study_in_easyExcel.html
Author: 樱岛麻衣Ss
Title: EasyExcel使用心得