spring boot 根据easyexcel导出excel 设置下拉框（字典值）

sumMStar

已于 2024-03-01 15:55:30 修改

阅读量2.6k

点赞数 14

于 2024-02-26 21:57:14 首次发布

本文链接：https://blog.csdn.net/summstar/article/details/136309305

版权

文章介绍了如何使用EasyExcel和ApachePOI库在Excel导出中创建动态下拉选项，通过CustomSheetWriteHandler处理前端传来的数据，并在单元格中引用其他sheet的值。作者详细展示了如何配置数据验证和创建字典sheet来提供下拉选项。

摘要由CSDN通过智能技术生成

一、实现效果

二、写一个handler类用来处理下拉框里面的值

通过构造方法获取前端传过来的String字符串列表（一般是字典值）

需要修改的地方，selectParamMap.put(7, selectData);里面的数字，

表示excel里面的第几列（excel是从0开始）

import com.alibaba.excel.write.handler.SheetWriteHandler;
import com.alibaba.excel.write.metadata.holder.WriteSheetHolder;
import com.alibaba.excel.write.metadata.holder.WriteWorkbookHolder;
import org.apache.poi.ss.usermodel.*;
import org.apache.poi.ss.util.CellRangeAddressList;

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

public class CustomSheetWriteHandler implements SheetWriteHandler {

    private List<String> selectDataList;
    public CustomSheetWriteHandler(List<String> selectDataList) {
        this.selectDataList = selectDataList;
    }
    @Override
    public void beforeSheetCreate(WriteWorkbookHolder writeWorkbookHolder, WriteSheetHolder writeSheetHolder) {
    }

    /**
     * 想实现Excel引用其他sheet页数据作为单元格下拉选项值，
     * 需要重写该方法
     *
     * @param writeWorkbookHolder
     * @param writeSheetHolder
     */
    @Override
    public void afterSheetCreate(WriteWorkbookHolder writeWorkbookHolder, WriteSheetHolder writeSheetHolder) {
        // 构造样例数据，该数据可根据实际需要，换成业务数据
        // 实际数据可通过构造方法，get、set方法等由外界传入
//        for (int i = 0; i < 100; i++) {
//            selectDataList.add("下拉选项" + i);
//        }

        // 构造下拉选项单元格列的位置，以及下拉选项可选参数值的map集合
        // key：下拉选项要放到哪个单元格，比如A列的单元格那就是0，C列的单元格，那就是2
        // value：key对应的那个单元格下拉列表里的数据项，比如这里就是下拉选项1..100
        Map<Integer, List<String>> selectParamMap = new HashMap<>();
        selectParamMap.put(7, selectDataList);

        // 获取第一个sheet页
        Sheet sheet = writeSheetHolder.getCachedSheet();
        // 获取sheet页的数据校验对象
        DataValidationHelper helper = sheet.getDataValidationHelper();
        // 获取工作簿对象，用于创建存放下拉数据的字典sheet数据页
        Workbook workbook = writeWorkbookHolder.getWorkbook();

        // 迭代索引，用于存放下拉数据的字典sheet数据页命名
        int index = 1;
        for (Map.Entry<Integer, List<String>> entry : selectParamMap.entrySet()) {

            // 设置存放下拉数据的字典sheet，并把这些sheet隐藏掉，这样用户交互更友好
            String dictSheetName = "dict_hide_sheet" + index;
            Sheet dictSheet = workbook.createSheet(dictSheetName);
            // 隐藏字典sheet页
            workbook.setSheetHidden(index++, true);

            // 设置下拉列表覆盖的行数，从第一行开始到最后一行，这里注意，Excel行的
            // 索引是从0开始的，我这边第0行是标题行，第1行开始时数据化，可根据实
            // 际业务设置真正的数据开始行，如果要设置到最后一行，那么一定注意，
            // 最后一行的行索引是1048575，千万别写成1048576，不然会导致下拉列表
            // 失效，出不来
            CellRangeAddressList infoList = new CellRangeAddressList(1, 1048575, entry.getKey(), entry.getKey());
            int rowLen = entry.getValue().size();
            for (int i = 0; i < rowLen; i++) {
                // 向字典sheet写数据，从第一行开始写，此处可根据自己业务需要，自定
                // 义从第几行还是写，写的时候注意一下行索引是从0开始的即可
                dictSheet.createRow(i).createCell(0).setCellValue(entry.getValue().get(i));
            }

            // 设置关联数据公式，这个格式跟Excel设置有效性数据的表达式是一样的
            String refers = dictSheetName + "!$A$1:$A$" + entry.getValue().size();
            Name name = workbook.createName();
            name.setNameName(dictSheetName);
            // 将关联公式和sheet页做关联
            name.setRefersToFormula(refers);

            // 将上面设置好的下拉列表字典sheet页和目标sheet关联起来
            DataValidationConstraint constraint = helper.createFormulaListConstraint(dictSheetName);
            DataValidation dataValidation = helper.createValidation(constraint, infoList);
            sheet.addValidationData(dataValidation);
        }
    }
}

三、在easy excel导出想要导出的数据的基础上

数据参考：基于poi3.17使用easyexcel导出含前后端-CSDN博客
新增一个.registerWriteHandler(new CustomSheetWriteHandler(selectDataList))方法调用上面写的Handler类

    /**
     * 根据时间导出,easyExcel
     * @param response
     * @param params 操作工，时间区间前后
     * @throws Exception
     */
    @RequestMapping("/outPutEasyExcel")
    public void outPutEasyExcel(HttpServletResponse response,@RequestParam Map<String, Object> params) throws Exception {
        // 这个是业务数据
        List<Register> registerList = registerService.listByUserId(params);

        // 这里注意 有同学反应使用swagger 会导致各种问题，请直接用浏览器或者用postman
        response.setContentType("application/vnd.ms-excel");
        response.setCharacterEncoding("utf-8");
        // 这里URLEncoder.encode可以防止中文乱码 当然和easyexcel没有关系
        String fileName = URLEncoder.encode("测试", "UTF-8");
        response.setHeader("Content-disposition", "attachment;filename=" + fileName + ".xlsx");


        // 下拉框选择数据，调用方法
        List<String> selectDataList = registerService.listByCode("faultCode");
        EasyExcel.write(response.getOutputStream(), Register.class).registerWriteHandler(new CustomSheetWriteHandler(selectDataList)).sheet("模板").doWrite(registerList);
    }

四、service层处理字典对象得到字符串

该返回值会放到controller层的easyexcel的registerritehandler方法里

    @Override
    public List<String> listByCode(String code) {
        List<String> selectDataList = new ArrayList<>();
        // 查询对应字典列表
        List<SysDictEntity> dictEntities = dictService.maintenanceList(code);
        // 放入list里放回
        for (SysDictEntity dictEntity : dictEntities) {
            selectDataList.add(dictEntity.getName());
        }
        return selectDataList;
    }

五、重新处理数据，要不然显示为数字状态

所有需要重新的处理数据，方法参考：基于poi3.17使用easyexcel导出含前后端-CSDN博客

    @Override
    public List<Register> listByUserId(Map<String, Object> params) {
        int userId = Integer.parseInt(params.get("userId").toString());
        String start = (String) params.get("start");
        String end = (String) params.get("end");

        LambdaQueryWrapper<Register> wrapper = new LambdaQueryWrapper<>();
        wrapper.eq(userId != 0,Register::getSysUserId, userId)
                .eq(Register::getDelete, 0)
                .between(Register::getRedStartTime, start, end);

        List<Register> list = this.list(wrapper);
        // 查询字典数据
        List<SysDictEntity> dictEntities = dictService.maintenanceList("faultCode");
        for (Register register : list) {
            long repTime = register.getRepTime();
            long redTime = register.getRedTime();
            String repTimeFormattedDuration = formatDuration(repTime);
            String redTimeFormattedDuration = formatDuration(redTime);

            register.setRepTimeChar(repTimeFormattedDuration);
            register.setRedTimeChar(redTimeFormattedDuration);

            // 对数据进行处理显示字典值
            // 遍历故障库表数据的前提再遍历字典数据
            for (SysDictEntity dictEntity : dictEntities) {
                // 如果两表value值和faultCode的值相等
                if (dictEntity.getValue().equals(register.getFaultCode())) {
                    // 设置状态为字符
                    register.setFaultCode(dictEntity.getName());
                }
            }
        }
        return list;
    }