使用EasyPOI实现导入导出

已于 2023-04-11 22:58:44 修改
阅读量2.9k 收藏 2
点赞数 1
分类专栏： java 文章标签： excel java 开发语言
于 2023-03-29 14:00:55 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/u010523967/article/details/129835485
版权

EasyPOI动态表头导入导出,

  1. 实体的’主要负责人’ 和’次要负责人’的列名名称需要根据配置动态替换
  2. 指定字段(“工地分组”) 根据条件判断是否需要导出
  3. 实现下拉列表
  4. 给表头加填充颜色
  5. 因为在导出的时候替换了相应列的名称, 所以在导入的时候需要动态的去匹配列名名称(重写importService)
  6. 导入的时候过滤空行
package com.mok.dms.domain.export;

import cn.afterturn.easypoi.excel.annotation.Excel;
import com.fasterxml.jackson.annotation.JsonFormat;
import lombok.Data;
import lombok.ToString;

import java.util.Date;

/**
 * 
 *
 * @author Elvis
 * @version 1.0, 2021/5/14
 */
@Data
@ToString
public class ProjectImportModel {
    @Excel(name = "工地名称(必填)", width = 25, orderNum = "0")
    private String name;
    @Excel(name = "工地分组(必填)", width = 25)
    private String groupName;
    @Excel(name = "主要负责人(必填)", width = 50)
    private String supervisorName;
    @Excel(name = "次要负责人(必填)", width = 50)
    private String managerName;
    @JsonFormat(pattern = "yyyy-MM-dd", timezone = "GMT+8")
    private Date planStartDate;
    @Excel(name = "周末施工", replace = {"是_true", "否_false"}, addressList = true)
    private Boolean weekendWork;
    @Excel(name = "错误信息", width = 30)
    private String errorMsg;
}


/**
 * '主要负责人' 和'次要负责人'的表头名称需要根据配置动态替换
 *  指定字段("工地分组") 根据条件判断是否需要导出
 * 
 */
private List<ExcelExportEntity> buildExcelExportList() {
    List<ExcelExportEntity> excelExportEntityList = new ArrayList<>();
    Class<ProjectImportModel> projectExportVoClass = ProjectImportModel.class;
    Field[] declaredFields = projectExportVoClass.getDeclaredFields();
    boolean enable = true;	// 根据业务逻辑判断是否需要导出当前字段
    String mainInCharge = "新标题1";// 根据业务逻辑取出对应表头
    String secondaryInCharge = "新标题2";// 根据业务逻辑取出对应表头
    for (Field declaredField : declaredFields) {
        declaredField.setAccessible(true);
        Excel annotation = declaredField.getAnnotation(Excel.class);
        if (annotation != null) {
            String name = annotation.name();
            int width = (int) annotation.width();
            if ("工地分组(必填)".equals(name) && !enable) {
                // 如果不需要导出字段 则忽略
                sColDiff++;
                continue;
            }

            if ("主要负责人(必填)".equals(name)) {
                ExcelExportEntity excelExportEntity = new ExcelExportEntity(mainInCharge, declaredField.getName(), width);
                excelExportEntityList.add(excelExportEntity);
                continue;
            }
            if ("次要负责人(必填)".equals(name)) {
                ExcelExportEntity excelExportEntity = new ExcelExportEntity(secondaryInCharge, declaredField.getName(), width);
                excelExportEntityList.add(excelExportEntity);
                // 导出下拉列表方式1
              	// excelExportEntity.setAddressList(true);
                // 需要一个String数组,字符串格式("李监理_1111")
                // String[] param = new String[]{"李监理_1111"}; 可以参数传入此数组
                // excelExportEntity.setReplace(param);

                continue;
            }

            ExcelExportEntity excelExportEntity = new ExcelExportEntity(name, declaredField.getName(), width);
            String format = annotation.format();
            if (StrUtil.isNotBlank(format)) {
                excelExportEntity.setFormat(format);
            }
            if ("周末施工".equals(name)) {
                excelExportEntity.setAddressList(true);
                excelExportEntity.setReplace(new String[]{"是_true", "否_false"});
            }
            excelExportEntityList.add(excelExportEntity);
        }        
    }
    
   return excelExportEntityList;
}

  /**
  *
  *
  */
private void doExport(List<ExcelExportEntity> excelExportEntityList, HttpServletResponse response, List<ProjectImportModel> resultList) {
       try (Workbook workbook = ExcelExportUtil.exportExcel(param, excelExportEntityList, orderExportExcels);
             ServletOutputStream outputStream = response.getOutputStream()) {
            int sheetNum = 1;
         	addCellStyle(workbook, 0, 0, 1, 0, 2, HSSFColor.HSSFColorPredefined.YELLOW.getIndex());
            addCellStyle(workbook, 0, 0, 1, 3, 5, HSSFColor.HSSFColorPredefined.LIGHT_ORANGE.getIndex());
		   // selectList1 = supervisorSets.toArray(new String[supervisorSets.size()])
           	// selectList2 = managerSets.toArray(new String[managerSets.size()])
           	//    String mainInCharge = "新标题1";// 根据业务逻辑取出对应表头
   		    //	 String secondaryInCharge = "新标题2";// 根据业务逻辑取出对应表头
            // 因为上面组装ExcelExportEntity时候替换了表头名称,所以这里需要取替换后的表头名称
            handleTemplateSelectListWithArray(workbook, sheet, selectList1, mainInCharge + "(必填)");
            handleTemplateSelectListWithArray(workbook, sheet, selectList2, secondaryInCharge + "(必填)");
            response.setContentType("application/vnd.ms-excel");
            response.setCharacterEncoding("utf-8");
            response.setHeader("Content-disposition", "attachment;filename=" + URLEncoder.encode(DateUtil.now(), "GBK") + ".xls");
            workbook.write(outputStream);
        }
   }



public class ExcelUtils {

    /**
     * 使用常量给导出的模板设置下拉列表
     * 原理就是创建隐藏sheet,并且把下拉列表放入隐藏sheet,然后用公式关联
     * @param workBook
     * @param sheetNum
     * @param selectArray
     * @param selectListKey
     */
    public static void handleTemplateSelectListWithArray(Workbook workBook, int sheetNum,  String[] selectArray, String selectListKey) {
        Sheet sheet = workbook.getSheetAt(sheetNum);
        // 取表头行
        Row row = sheet.getRow(0);
        Iterator<Cell> iterator = row.cellIterator();
        //处理下拉列表
        int col = -1;
        // 循环表头行的列名称, 找到 列名称等于传入selectListKey, 记录下列的位置索引col
        while (iterator.hasNext()) {
            Cell cell = iterator.next();
            String cellValue = cell.getStringCellValue();
            if (selectListKey.equals(cellValue)) {
                col = cell.getColumnIndex();
                break;
            }
        }
        if (col > -1) {
            DataValidation dataValidation = ExcelUtils.getDataValidation(workBook, selectArray, 1, Integer.MAX_VALUE, col, col);
            sheet.addValidationData(dataValidation);
        }
    }

    /**
     * 创建一个单独的sheet, 存放下拉框, 解决下拉框太多的问题。
     * @param workBook
     * @param textList 下拉列表
     * @param firstRow 开始行
     * @param lastRow 结束行
     * @param firstCol 开始列
     * @param lastCol 结束列
     * @return
     */
    public static DataValidation getDataValidation(Workbook workBook, String[] textList, int firstRow, int lastRow, int firstCol, int lastCol) {
        // 创建隐藏sheet 用于存储下拉列表
        Sheet hidden = workBook.createSheet("hidden" + firstCol);
        // 把下拉列表的内容存到新创建的隐藏列的第一列
        for (int i = 0; i < textList.length; i++) {
            String name = textList[i];
            Row row = hidden.createRow(i);
            Cell cell = row.createCell(0);
            cell.setCellValue(name);
        }
        
        CellRangeAddressList regions = new CellRangeAddressList(firstRow, lastRow, firstCol, lastCol);
        DataValidationHelper hiddenDataValidationHelper = workBook.getSheet("hidden" + firstCol).getDataValidationHelper();
        // 创建公式与需要下拉的列关联
        DataValidationConstraint formulaListConstraint = hiddenDataValidationHelper.createFormulaListConstraint("hidden" + firstCol + "!$A$1:$A$" + textList.length);
        DataValidation dataValidation = hiddenDataValidationHelper.createValidation(formulaListConstraint, regions);
        // 隐藏该sheet
        int sheetIndex = workBook.getSheetIndex(hidden);
        workBook.setSheetHidden(sheetIndex, true);

        return dataValidation;
    }

    /**
     * 给指定的行列添加填充色
     * @param workbook
     * @param sheetNum 
     * @param startRow 开始行
     * @param endRow   结束行(不含)
     * @param startCell
     * @param endCell    不含
     * @param colorIndex org.apache.poi.hssf.util.HSSFColor.HSSFColorPredefined
     */
    public static void addCellStyle(Workbook workbook, int sheetNum, int startRow, int endRow, int startCell, int endCell, short colorIndex) {
        Sheet sheet = workbook.getSheetAt(sheetNum);
        for (int i = startRow; i < endRow; i++) {
            Row row = sheet.getRow(i);
            addCellStyle(row, getCellStyle(workbook, colorIndex), startCell, endCell);
        }
    }

    private static void addCellStyle(Row row, CellStyle cellStyle, int start, int end) {
        for (int i = start; i < end; i++) {
            Cell cell1 = row.getCell(i);
            cell1.setCellStyle(cellStyle);
        }
    }

    private static CellStyle getCellStyle(Workbook workbook, short colorIndex) {
        CellStyle cs = workbook.createCellStyle();
        cs.setFillPattern(FillPatternType.SOLID_FOREGROUND);
        cs.setFillForegroundColor(colorIndex);
        return cs;
    }
}

/*
*
* 导入的时候动态匹配修改后列名称
*
*/
public class MyImportService extends ExcelImportService {
 	private final String secondaryInCharge;
    private final String mainInCharge;
    private final String[] styleSelectList;

    public MyImportService(String mainInCharge,String secondaryInCharge, String[] styleSelectList) {
        String secondaryInCharge = secondaryInCharge;
        String mainInCharge = mainInCharge;
        this.styleSelectList = styleSelectList;
    }

    @Override
    public void addEntityToMap(String targetId, Field field, ExcelImportEntity excelEntity, Class<?> pojoClass, List<Method> getMethods, Map<String, ExcelImportEntity> temp, ExcelEntity excelEntityAnn) throws Exception {
        Excel excel = field.getAnnotation(Excel.class);
        excelEntity = new ExcelImportEntity();
        excelEntity.setType(excel.type());
        excelEntity.setSaveUrl(excel.savePath());
        excelEntity.setSaveType(excel.imageType());
        excelEntity.setReplace(excel.replace());
        excelEntity.setDatabaseFormat(excel.databaseFormat());
        excelEntity.setSuffix(excel.suffix());
        excelEntity.setImportField(Boolean.valueOf(PoiPublicUtil.getValueByTargetId(excel.isImportField(), targetId, "false")));
        excelEntity.setFixedIndex(excel.fixedIndex());
        String name = excel.name();
        // 实体原来的列名
        if ("主要负责人(必填)".equals(name)) {
            name = mainInCharge + "(必填)";
        }
        if ("次要负责人(必填)".equals(name)) {
            name = secondaryInCharge + "(必填)";
        }
       // if ("装修风格".equals(name)) {
       //     excelEntity.setAddressList(true);
       //     excelEntity.setReplace(styleSelectList);
       // }
        excelEntity.setName(PoiPublicUtil.getValueByTargetId(name, targetId, null));
        if (StringUtils.isNoneEmpty(excel.groupName())) {
            excelEntity.setName(excel.groupName() + "_" + excelEntity.getName());
        }
        if (excelEntityAnn != null && excelEntityAnn.show()) {
            excelEntity.setName(excelEntityAnn.name() + "_" + excelEntity.getName());
        }
        if (i18nHandler != null) {
            excelEntity.setName(i18nHandler.getLocaleName(excelEntity.getName()));
        }
        excelEntity.setMethod(PoiReflectorUtil.fromCache(pojoClass).getSetMethod(field.getName()));
        if (StringUtils.isNotEmpty(excel.importFormat())) {
            excelEntity.setFormat(excel.importFormat());
        } else {
            excelEntity.setFormat(excel.format());
        }
        excelEntity.setDict(excel.dict());
        excelEntity.setEnumImportMethod(excel.enumImportMethod());
        if (getMethods != null) {
            List<Method> newMethods = new ArrayList<Method>();
            newMethods.addAll(getMethods);
            newMethods.add(excelEntity.getMethod());
            excelEntity.setMethods(newMethods);
        }
        if (excelEntity.getFixedIndex() != -1) {
            temp.put("FIXED_" + excelEntity.getFixedIndex(), excelEntity);
        } else {
            temp.put(excelEntity.getName(), excelEntity);
        }
    }
}

/**
* 导入数据
*
*/
public List<ProjectImportModel> doImport(@RequestPart(value = "file") MultipartFile file) throws Exception {
    try (InputStream inputStream = file.getInputStream()) {
     	ImportParams params = buildImportParams();
      List<ProjectImportModel> result = new MyImportService(mainInCharge, secondaryInCharge, selectList).importExcelByIs(inputStream, ProjectImportModel.class, params, false).getList();
        return result;
    }
}
/**
*
* 构建验证的handler,过滤空行,防止产生空对象,也就是对象所有的属性都为null
*
*/
private ImportParams buildImportPramas() {
    ImportParams params = new ImportParams();
    params.setVerifyHandler(new IExcelVerifyHandler() {
        @Override
        public ExcelVerifyHandlerResult verifyHandler(Object obj) {
            ExcelVerifyHandlerResult result = new ExcelVerifyHandlerResult(true);
            if (ObjectUtil.isNotNull(obj)) {
                // 判断对象属性是否全部为空
                boolean b = checkFieldAllNull(obj);
                result.setSuccess(!b);
            }
            return result;
        }

        private boolean checkFieldAllNull(Object obj) {
            // 得到类对象
            Class clazz = obj.getClass();
            Field[] fs = clazz.getDeclaredFields();
            boolean flag = true;
            for (Field f : fs) {
                f.setAccessible(true);
                if (!f.isAnnotationPresent(Excel.class)) {
                    continue;
                }
                // 得到此属性的值
                Object val = null;
                try {
                    val = f.get(obj);
                } catch (IllegalAccessException e) {
                    throw new RuntimeException(e);
                }
                if (Objects.nonNull(val)) {
                    flag = false;
                    break;
                }
            }
            return flag;
        }
    });
}
空空如也d
关注
专栏目录
SpringBoot项目使用EasyPoi实现导入导出，就是这么的丝滑
java_beautiful的博客
09-08 4186
EasyPoi功能如同名字easy，主打的功能就是容易,让一个没见接触过poi的人员就可以方便的写出Excel导出，Excel模板导出，Excel导入，Word模板导出，通过简单的注解和模板语言(熟悉的表达式语法)，完成以前复杂的写法。最新官方文档：官方源码地址：通用的校验满足不了所有的校验，例如还需要通过查询数据库，校验数据的唯一性，此时需要自定义一个校验规则，实现IExcelVerifyHandler接口。
SpringBoot项目使用EasyPoi实现导入导出
希爷的博客
08-10 749
在项目的开发工程中，经常有导入导出数据的常见功能场景，Apache的POI是处理导入导出中最常用的，但是其原生的用法太复杂，很繁琐，总是在Copy… ，无意间发现一款简单粗暴的神器EasyPoi，EasyPoi也是基于POI的，在SpringBoot中也是做了很好的封装，让我们能够在SpringBoot 快速地使用 EasyPoi 进行开发，很方便，而且支持多种格式的导入导出。 本篇文章就给大家介绍下EasyPoi。如果对你有帮助的话，还不忘点赞支持一下，感谢！ ...
easypoi导入校验跳过空行_EasyPoi导入验证功能
诚的博客
10-28 3344
ImportParams importParams = new ImportParams(); importParams.setTitleRows(0); importParams.setHeadRows(1); importParams.setNeedVerfiy(true); importParams.setVerifyHandler(dnImportExcelVerifyHandler); package com.pig4cloud.pigx.fashion.component..
EasyPOI导入遇到空白行问题
热门推荐
weixin_44491974的博客
10-27 1万+
在使用easypoi过程中，如果excel的单元格被编辑之后，会导致在解析的时候，读出空数据。容易产生空白数据入库。 public JsonResult importExcel(@RequestParam("file") MultipartFile file) { try { ImportParams params = new ImportParams(); // 表头设置为1行 params.setHeadRows(1
Easypoi模板导出
最新发布
qq_26817225的博客
09-21 1927
Easypoi模板导出 优点 快速导出：使用预定义的Excel模板，可以快速导出数据，特别是在数据量大的情况下。 简化代码：通过模板导出，减少了编写大量POI代码的需要，使得代码更简洁易懂。 灵活性：模板可以根据需求进行自定义，可以包含复杂的格式和公式。 缺点 依赖性强：EasyPOI模板导出依赖于Apache POI库，如果没有这个库，它将无法工作。 模板维护：模板文件需要被维护，如果模板更改，可能需要重新生成模板文件。 限制性：模板导出的结果受限于模板的定义，不能完全自定义Excel文件的所有特性
EasyExcel 动态表头 导出
11-20
EasyExcel 动态表头 导出 ，非注解，后台导出， 可分页，可限制每页显示行数，依赖 com.alibaba easyexcel
easypoi实现动态表头导出
qi15689782508的博客
10-18 6097
在我们的工作中有时候需要导出的表格为动态的，这个时候我们就无法在实体类定义表头，需要创建一个模板，用模板生成模板，然后在根据生成的模板导出数据。
easypoi动态表头导出数据
Stone.鱼儿的博客
05-10 1015
动态导出某年某月用户和用户评分数据信息，表头(序号、姓名、用户姓名)，数据(所有用户对应的评分以及平均分)；
easypoi导出数据的两种方式（动态表头导出和静态表头导出）
X_kai_style的博客
02-25 8228
一.选定easypoi版本（maven依赖） <dependency> <groupId>org.apache.poi</groupId> <artifactId>poi</artifactId> <version>4.1.2</version> </dependency> <dependency> <groupId>cn.aftertu
使用EasyPoi导出动态列头的Excel文件
kxz123666的博客
11-14 634
EasyPoi导出动态列头及数据
Spring Boot集成EasyPoi实现导入导出操作
极客鼠之家
08-06 2100
**/**/**/**/**/**/**/**/**/**/**/**/**/**log . info("【耗时：】{}s" ,(end - start));} }/**log . info("【耗时：】{}s" ,(end - start));} }/**
使用EasyPoi轻松导入导出Excel文档的方法示例
08-25
EasyPoi轻松导入导出Excel文档的方法示例 EasyPoi是一个功能强大、使用简单的Excel处理工具，能够轻松地导入和导出Excel文档。它的主要特点是设计精巧、使用简单、接口丰富、扩展简单、默认值多、支持Spring MVC等...
easypoi实现数据导出与动态表头
杨海吉
07-14 418
话不多说，直接上代码，这里也包含一些代源码重写的方式。
easypoi 导入excel
weixin_42563880的博客
12-16 703
easypoi 导入excelmaven工具类Excel实体类（注意这里注解中的值对应 Excel表格中列名）调用样例 maven x<dependency> <groupId>cn.afterturn</groupId> <artifactId>easypoi-spring-boot-starter</artifactId> <version>4.2.0</version> </dependency> <
EasyPoi导入与导出
略
04-25 1881
1.导入依赖 <dependency> <groupId>cn.afterturn</groupId> <artifactId>easypoi-spring-boot-starter</artifactId> <version>4.2.0</version> </dependency> 2.工具类 package com.geidco.dcp.util; import cn.a
使用easyPoi的动态列导出，行转列
qq_40603183的博客
03-29 2419
2. 动态列使用一个List集合，用 @ExcelCollection 标注，里面的每一项就是每一个动态列标题，一个字段作为表头名称，一个字段作为对应的数据。有一个导出excel的需求，要求导出部分固定列和部分动态列，固定列使用字段写死，动态列使用list集合存放。使用cglib动态向实体类内添加字段，添加的字段为需要动态添加的表头和对应的值。1. 使用easypoi的注解方式进行导出，固定列部分使用 @Excel标注。模拟自己的业务逻辑，组装好需要的数据格式调用工具类中的方法即可。idea开启方式如下。
EasyPOI导入导出
weixin_44840242的博客
03-29 2456
操作办公软件分：03 07 JXL:只支持excel,内存优化 POI：功能强大,支持广泛 目录 1.POI的基本使用 1.导包 2.创建excel文件 3.读取excel 2.导出 1.导包(注意冲突) 2.添加注解 3.添加导出按钮 4.控制层进行导出 5.配置视图解析器--->优先执行 3.导入 1.准备页面--->enctype="multip...
java- excel工具类（EasyPoi）
iampatrick_star的博客
06-15 1766
EasyPoi 1 导入依赖 <!-- EasyPoiUtil导入依赖--> <dependency> <groupId>cn.afterturn</groupId> <artifactId>easypoi-base</artifactId> <version>4.1.0</version> ...
EasyPoi导入导出
weixin_48965172的博客
06-13 262
easypoi导入导出
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值