专栏名称: Java基基
一个苦练基本功的 Java 公众号，所以取名 Java 基基
目录
相关文章推荐
BNU统计  ·  助力就业，就业工作室阶段性工作总结 ·  10 小时前  
BNU统计  ·  统计赋能|第七季“新统学”培训来袭 ·  10 小时前  
教育之江  ·  心有所向，何惧日长！高考倒计时100天，这些 ... ·  昨天  
教育之江  ·  心有所向，何惧日长！高考倒计时100天，这些 ... ·  昨天  
武汉大学  ·  武大本科生！拿下“国自然”，再获“雷军奖” ·  5 天前  
武汉大学  ·  百亿票房男主现身武大(bushi） ·  6 天前  
51好读  ›  专栏  ›  Java基基

公司大佬对 Excel 导入、导出的封装，那叫一个妙啊！

Java基基  · 公众号  ·  · 2024-12-16 11:55

主要观点总结

本文介绍了「芋道快速开发平台」知识星球的社群服务以及提供的部分资料，如《项目实战（视频）》、《互联网高频面试题》、《架构 x 系统设计》、《精进 Java 学习指南》和《必读 Java 源码专栏》等。同时，还介绍了开源项目「yudao-cloud」的功能、环境准备、使用方法和视频教程。此外，文章还详细描述了基于 Spring Boot + MyBatis Plus + Vue & Element 实现的后台管理系统 + 用户小程序，并说明了支持的功能和遇到的问题，以及遗留问题。

关键观点总结

关键观点1: 「芋道快速开发平台」知识星球服务

一对一交流、面试小册、简历优化、求职解惑。

关键观点2: 提供的部分资料

包括《项目实战（视频）》、《互联网高频面试题》等。

关键观点3: 开源项目「yudao-cloud」

功能涵盖RBAC权限、SaaS多租户、数据权限等，提供Boot和Cloud仓库，支持JDK 21+和JDK 8双版本。

关键观点4: 基于 Spring Boot + MyBatis Plus + Vue & Element 的后台管理系统 + 用户小程序

支持RBAC动态权限、多租户、数据权限等功能，视频教程和项目地址提供。

关键观点5: 遇到的问题

包括日期格式不正确、POI版本不一致、LocalDateTime转换问题等，并提供解决方案。

关键观点6: 遗留问题

EasyExcel按模板导出时xlsx不支持的问题。


正文

👉 这是一个或许对你有用 的社群

🐱 一对一交流/面试小册/简历优化/求职解惑，欢迎加入 「 芋道快速开发平台 」 知识星球。 下面是星球提供的部分资料：

👉 这是一个或许对你有用的开源项目

国产 Star 破 10w+ 的开源项目，前端包括管理后台 + 微信小程序，后端支持单体和微服务架构。

功能涵盖 RBAC 权限、SaaS 多租户、数据权限、商城、支付、工作流、大屏报表、微信公众号等等功能：

  • Boot 仓库：https://gitee.com/zhijiantianya/ruoyi-vue-pro
  • Cloud 仓库：https://gitee.com/zhijiantianya/yudao-cloud
  • 视频教程：https://doc.iocoder.cn
【国内首批】支持 JDK 21 + SpringBoot 3.2.2、JDK 8 + Spring Boot 2.7.18 双版本

来源：juejin.cn/post/
7328242736027762739

最近在封装公司统一使用的组件，主要目的是要求封装后开发人员调用简单，不用每个项目组中重复去集成同一个依赖l，写的五花八门，代码不规范，后者两行泪。

为此，我们对EasyExcel进行了二次封装，我会先来介绍下具体使用，然后再给出封装过程

环境准备

开发环境：SpringBoot+mybatis-plus+db

数据库： 

 -- `dfec-tcht-platform-dev`.test definition

CREATE TABLE `test` (
  `num` decimal(10,0) DEFAULT NULL COMMENT




    
 '数字',
  `sex` varchar(100) DEFAULT NULL COMMENT '性别',
  `name` varchar(100) DEFAULT NULL COMMENT '姓名',
  `born_date` datetime DEFAULT NULL
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci;
使用
  • 第一步、在接口类中引入以下 
@Aurowired 
ExcelService excelService;
  • 第二步、标注字段

这些个注解是EasyExcel的注解，我们做了保留，仍然使用他的注解 

/**
 * 【请填写功能名称】对象 test
 *
 * @author trg
 * @date Fri Jan 19 14:14:08 CST 2024
 */
@Data
@TableName("test")
public class TestEntity  {

    /**
     * 数字
     */
    @Schema(description = "数字")
    @ExcelProperty("数字")
    private BigDecimal num;


    /**
     * 性别
     */
    @Schema(description = "性别")
    @ExcelProperty("性别")
    private String sex;


    /**
     * 姓名
     */
    @Schema(description = "姓名")
    @ExcelProperty("姓名")
    private String name;


    /**
     * 创建时间
     */
    @Schema(description = "创建时间")
    @ExcelProperty(value = "创建时间")
    private Date bornDate;

 
}
  • 第三步、使用 
@PostMapping("/importExcel")
public void importExcel(@RequestParam MultipartFile file){
   excelService.importExcel(file, TestEntity.class,2,testService::saveBatch);
}


@PostMapping("/exportExcel")
public void exportExcel(HttpServletResponse response) throws IOException {
   excelService.exportExcel(testService.list(),TestEntity.class,response);
} 
  • 完整代码 
package com.dfec.server.controller;


import com.baomidou.mybatisplus.core.toolkit.IdWorker;
import com.dfec.framework.excel.service.ExcelService;
import com.dfec.server.entity.TestEntity;
import com.dfec.server.entity.TestVo;
import com.dfec.server.service.TestService;
import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.util.List;
import java.util.function.Function;

/**
 * @author trg
 * @title: TestController
 * @projectName df-platform
 * @description: TODO
 * @date 2023/6/1915:22
 */

@RestController
@RequestMapping("test")
@RequiredArgsConstructor
public class TestController {


    private  final ExcelService excelService;

    private final TestService testService;


    @PostMapping("/importExcel")
    public void importExcel(@RequestParam MultipartFile file){
        excelService.importExcel(file, TestEntity.class,2,testService::saveBatch);
    }


    @PostMapping("/exportExcel")
    public void exportExcel(HttpServletResponse response) throws IOException {
        excelService.exportExcel(testService.list(),TestEntity.class,filePath,response);
    }


}

哈哈哈，是不是非常简洁

以上只是一个简单的使用情况，我们还封装了支持模板的导入、导出，数据转换等问题，客官请继续向下看。

如果遇到有读取到的数据和实际保存的数据不一致的情况下，可以使用如下方式导入，这里给出一个示例 

@PostMapping("/importExcel")
public void importExcel(@RequestParam MultipartFile file){
    Function map = new Function() {
        @Override
        public TestVo apply(TestEntity testEntities) {
            TestVo testVo = new TestVo();
            testVo.setNum(testEntities.getNum());
            testVo.setSex(testEntities.getSex());
            testVo.setBaseName(testEntities.getName());
            return testVo;
        }
    };
    excelService.importExcel(file, TestEntity.class,2,map,testService::saveBatchTest);
}

基于 Spring Boot + MyBatis Plus + Vue & Element 实现的后台管理系统 + 用户小程序，支持 RBAC 动态权限、多租户、数据权限、工作流、三方登录、支付、短信、商城等功能

  • 项目地址：https://github.com/YunaiV/ruoyi-vue-pro
  • 视频教程：https://doc.iocoder.cn/video/

封装过程

核心思想：

“

对导入和导出提供接口、保持最少依赖原则

我们先从ExcelService接口类出发，依次看下封装的几个核心类 

package com.dfec.framework.excel.service;


import org.springframework.web.multipart.MultipartFile;

import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.util.List;
import java.util.function.Consumer;
import java.util.function.Function;

/**
 * ExcelService
 *
 * @author LiuBin
 * @interfaceName ExcelService
 * @date 2024/1/16 11:21
 **/
public interface ExcelService {

    /**
     * 导出Excel，默认
     * @param list 导出的数据
     * @param tClass 带有excel注解的实体类
     * @param response 相应
     * @return T
     * @author trg
     * @date 2024/1/15 17:32
     */
     void exportExcel(List list, Class tClass, HttpServletResponse response) throws IOException;

    /**
     * 导出Excel，增加类型转换
     * @param list 导出的数据
     * @param tClass 带有excel注解的实体类
     * @param response 相应
     * @return T
     * @author trg
     * @date 2024/1/15 17:32
     */
     void exportExcel(List list, Function map, Class tClass, HttpServletResponse response) throws IOException;


    /**
     * 导出Excel，按照模板导出，这里是填充模板
     * @param list 导出的数据
     * @param tClass 带有excel注解的实体类
     * @param template 模板
     * @param response 相应
     * @return T
     * @author trg
     * @date 2024/1/15 17:32
     */
     void exportExcel(List list, Class tClass, String template, HttpServletResponse response) throws IOException;

    /**
     * 导入Excel
     * @param file 文件
     * @param tClass 带有excel注解的实体类
     * @param headRowNumber 表格头行数据
     * @param map 类型转换
     * @param consumer 消费数据的操作
     * @return T
     * @author trg
     * @date 2024/1/15 17:32
     */
     void importExcel(MultipartFile file, Class tClass, Integer headRowNumber, Function map, Consumer> consumer);


    /**
     * 导入Excel
     * @param file 文件
     * @param tClass 带有excel注解的实体类
     * @param headRowNumber 表格头行数据
     * @param consumer 消费数据的操作
     * @return T
     * @author trg
     * @date 2024/1/15 17:32
     */
     void importExcel(MultipartFile file, Class tClass, Integer headRowNumber, Consumer> consumer);

}

以上接口只有个导入、导出，只是加了几个重载方法而已

再看下具体的实现类 

package com.dfec.framework.excel.service.impl;

import com.alibaba.excel.EasyExcel;
import com.alibaba.excel.support.ExcelTypeEnum;
import com.dfec.framework.excel.convert.LocalDateTimeConverter;
import com.dfec.framework.excel.service.ExcelService;
import com.dfec.framework.excel.util.ExcelUtils;
import org.springframework.stereotype.Service;
import org.springframework.web.multipart.MultipartFile;

import javax.servlet.http.HttpServletResponse;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.util.List;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;

/**
 * DefaultExcelServiceImpl
 *
 * @author LiuBin
 * @className DefaultExcelServiceImpl
 * @date 2024/1/16 11:42
 **/
@Service
public class DefaultExcelServiceImpl implements ExcelService {

    @Override
    public  void exportExcel(List list, Class tClass, HttpServletResponse response) throws IOException {
        setResponse(response);
        EasyExcel.write(response.getOutputStream())
                .head(tClass)
                .excelType(ExcelTypeEnum.XLSX)
                .registerConverter(new LocalDateTimeConverter())
                .sheet("工作簿1")
                .doWrite(list);

    }

    @Override
    public  void exportExcel(List list, Function map, Class tClass, HttpServletResponse response) throws IOException {
        setResponse(response);
        List result = list.stream().map(map::apply).collect(Collectors.toList());
        exportExcel(result, tClass, response);
    }

    @Override
    public  void exportExcel(List list, Class tClass,String template, HttpServletResponse response) throws IOException {
        setResponse(response);
        EasyExcel.write(response.getOutputStream())
                .withTemplate(template)
                .excelType(ExcelTypeEnum.XLS)
                .useDefaultStyle(false)
                .registerConverter(new LocalDateTimeConverter())
                .sheet(0)
                .doFill(list) ;

    }

    @Override
    public  void importExcel(MultipartFile file, Class tClass,Integer headRowNumber, Function map,Consumer> consumer) {
        List excelData = ExcelUtils.readExcelData(file,tClass,headRowNumber);
        List result = excelData.stream().map(map::apply).collect(Collectors.toList());
        consumer.accept(result);
    }

    @Override
    public  void importExcel(MultipartFile file, Class tClass,Integer headRowNumber, Consumer> consumer) {
        List excelData = ExcelUtils.readExcelData(file,tClass,headRowNumber);
        consumer.accept(excelData);

    }


    public void setResponse(HttpServletResponse response) throws UnsupportedEncodingException {
        response.setContentType("application/vnd.ms-excel");
        response.setCharacterEncoding("utf-8");
        // 这里URLEncoder.encode可以防止中文乱码 当然和easyexcel没有关系
        String fileName = URLEncoder.encode("data", "UTF-8").replaceAll("\\+", "%20");
        response.setHeader("Content-disposition", "attachment;filename*=utf-8''" + fileName + ".xls");
    }
}

ExcelUtils 

package com.dfec.framework.excel.util;

import com.alibaba.excel.EasyExcel;
import com.alibaba.excel.ExcelReader;
import




    
 com.alibaba.excel.read.builder.ExcelReaderBuilder;
import com.alibaba.excel.read.metadata.ReadSheet;
import com.alibaba.excel.util.MapUtils;
import com.alibaba.fastjson.JSON;
import com.dfec.common.exception.ServiceException;
import com.dfec.framework.excel.listener.ExcelListener;
import com.dfec.framework.excel.service.ExcelBaseService;
import org.springframework.web.multipart.MultipartFile;

import javax.servlet.http.HttpServletResponse;
import java.io.BufferedInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.List;
import java.util.Map;
import java.util.Set;

/**
 * @author trg
 * @description: Excel 工具类
 * @title: ExcelUtils
 * @email [email protected]
 * @date 2023/9/14 9:18
 */
public class ExcelUtils {


    /**
     * 将列表以 Excel 响应给前端
     *
     * @param response  响应
     * @param fileName  文件名
     * @param sheetName Excel sheet 名
     * @param head      Excel head 头
     * @param data      数据列表哦
     * @param        泛型，保证 head 和 data 类型的一致性
     * @throws IOException 写入失败的情况
     */
    public static  void excelExport(HttpServletResponse response, String fileName, String sheetName,
                                       Class head, List data) throws IOException {
        write(response, fileName);
        // 这里需要设置不关闭流
        EasyExcel.write(response.getOutputStream(), head).autoCloseStream(Boolean.FALSE).sheet(sheetName)
                .doWrite(data);
    }


    /**
     * 根据模板导出
     *
     * @param response     响应
     * @param templatePath 模板名称
     * @param fileName     文件名
     * @param sheetName    Excel sheet 名
     * @param head         Excel head 头
     * @param data         数据列表哦
     * @param           泛型，保证 head 和 data 类型的一致性
     * @throws IOException 写入失败的情况
     */
    public static  void excelExport(HttpServletResponse response, String templatePath, String fileName, String sheetName,
                                       Class head, List data) throws IOException {
        write(response, fileName);
        // 这里需要设置不关闭流
        EasyExcel.write(response.getOutputStream(), head).withTemplate(templatePath).autoCloseStream(Boolean.FALSE).sheet(sheetName)
                .doWrite(data);
    }

    /**
     * 根据参数，只导出指定列
     *
     * @param response                响应
     * @param fileName                文件名
     * @param sheetName               Excel sheet 名
     * @param head                    Excel head 头
     * @param data                    数据列表哦
     * @param excludeColumnFiledNames 排除的列
     * @param                      泛型，保证 head 和 data 类型的一致性
     * @throws IOException 写入失败的情况
     */
    public static  void excelExport(HttpServletResponse response, String fileName, String sheetName,
                                       Class head, List data, Set excludeColumnFiledNames) throws IOException {
        write(response, fileName);
        // 这里需要设置不关闭流
        EasyExcel.write(response.getOutputStream(), head).autoCloseStream(Boolean.FALSE).excludeColumnFiledNames(excludeColumnFiledNames).sheet(sheetName)
                .doWrite(data);
    }


    private static void write(HttpServletResponse response, String fileName) {
        try {
            response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
            response.setCharacterEncoding("utf-8");
            // 这里URLEncoder.encode可以防止中文乱码 当然和easyexcel没有关系
            response.setHeader("Content-disposition", "attachment;filename*=utf-8''" + fileName + ".xlsx");

        } catch (Exception e) {
            // 重置response
            response.reset();
            response.setContentType("application/json");
            response.setCharacterEncoding("utf-8");
            Map map = MapUtils.newHashMap();
            map.put("status", "failure");
            map.put("message", "下载文件失败" + e.getMessage());
            try {
                response.getWriter().println(JSON.toJSONString(map));
            } catch (IOException ex) {
                throw new RuntimeException(ex);
            }
        }
    }

    public static  List read(MultipartFile file, Class head) throws IOException {
        return EasyExcel.read(file.getInputStream(), head, null)
                // 不要自动关闭，交给 Servlet 自己处理
                .autoCloseStream(false)
                .doReadAllSync();
    }


    /**
     * 读取 Excel(多个 sheet)
     *
     * @param excel    文件
     * @param rowModel 实体类映射
     * @return Excel 数据 list
     */
    public static  List readExcelData(MultipartFile excel, Class rowModel, Integer headRowNumber) {
        ExcelListener excelListener = new ExcelListener();
        ExcelReaderBuilder readerBuilder = getReader(excel, excelListener);
        if (readerBuilder == null) {
            return null;
        }
        if (headRowNumber == null) {
            headRowNumber = 1;
        }
        readerBuilder.head(rowModel).headRowNumber(headRowNumber).doReadAll();
        return excelListener.getData();
    }


    /**
     * 读取 Excel(多个 sheet)
     *
     * @param excel    文件
     * @param rowModel 实体类映射
     * @return Excel 数据 list
     */
    public static  List excelImport(MultipartFile excel, ExcelBaseService excelBaseService, Class rowModel) {
        ExcelListener excelListener = new ExcelListener(excelBaseService);
        ExcelReaderBuilder readerBuilder = getReader(excel, excelListener);
        if (readerBuilder == null) {
            return null;
        }
        readerBuilder.head(rowModel).doReadAll();
        return excelListener.getData();
    }

    /**
     * 读取某个 sheet 的 Excel
     *
     * @param excel       文件
     * @param rowModel    实体类映射
     * @param sheetNo     sheet 的序号 从1开始
     * @param headLineNum 表头行数，默认为1
     * @return Excel 数据 list
     */
    public static  List excelImport(MultipartFile excel, ExcelBaseService excelBaseService, Class rowModel, int sheetNo,
                                          Integer headLineNum) {
        ExcelListener excelListener = new ExcelListener(excelBaseService);
        ExcelReaderBuilder readerBuilder = getReader(excel, excelListener);
        if (readerBuilder == null) {
            return null;
        }
        ExcelReader reader = readerBuilder.headRowNumber(headLineNum).build();
        ReadSheet readSheet = EasyExcel.readSheet(sheetNo).head(rowModel).build();
        reader.read(readSheet);
        return excelListener.getData();
    }

    /**
     * 返回 ExcelReader
     *
     * @param excel         需要解析的 Excel 文件
     * @param excelListener 监听器
     */
    private static ExcelReaderBuilder getReader(MultipartFile excel,
                                                ExcelListener excelListener) {
        String filename = excel.getOriginalFilename();
        if (filename == null || (!filename.toLowerCase().endsWith(".xls") && !filename.toLowerCase().endsWith(".xlsx"))) {
            throw new ServiceException("文件格式错误！");
        }
        InputStream inputStream;
        try {
            inputStream = new BufferedInputStream(excel.getInputStream());
            return EasyExcel.read(inputStream, excelListener);
        } catch (IOException e) {
            e.printStackTrace();
        }
        return null;
    }

}

ExcelListener.java 

package com.dfec.framework.excel.listener;

import com.alibaba.excel.context.AnalysisContext;
import com.alibaba.excel.event.AnalysisEventListener;
import com.alibaba.fastjson.JSON;
import com.dfec.framework.excel.service.ExcelBaseService;
import lombok.extern.slf4j.Slf4j;


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

/**
 * @author trg
 * @description: Excel导入的监听类
 * @title: ExcelListener
 * @projectName df-platform
 * @email [email protected]
 * @date 2023/9/14 16:23
 */
@Slf4j
public  class  ExcelListener<T> extends AnalysisEventListener<T> {

    private ExcelBaseService excelBaseService;

    public ExcelListener(){}

    public ExcelListener






请到「今天看啥」查看全文


推荐文章
BNU统计  ·  助力就业，就业工作室阶段性工作总结
10 小时前
BNU统计  ·  统计赋能|第七季“新统学”培训来袭
10 小时前
教育之江  ·  心有所向，何惧日长！高考倒计时100天，这些高校喊话：等你
昨天
教育之江  ·  心有所向，何惧日长！高考倒计时100天，这些高校喊话：等你
昨天
武汉大学  ·  武大本科生！拿下“国自然”，再获“雷军奖”
5 天前
武汉大学  ·  百亿票房男主现身武大(bushi）
6 天前
南都周刊  ·  桃花坞年画：原来真正的苏州年味就在这里
8 年前
中国历史解密  ·  47岁火葬场职工在火化一具尸体时，透过炉口看到一件前所未有的蹊跷事...
8 年前
滑州百事通  ·  滑县20次以上非现场交通违法未处理车辆通告
7 年前
廣告狂人  ·  品牌的清明借势海报，文案还没网友写的好！
7 年前
齐鲁晚报  ·  济南街拍大赛开锣！你晒照片我送奖，就这么定了！
7 年前
Sov5搜索   ·   小百科   ·   今天看啥   ·   移动版
51好读 - 好文章就要读起来!