easyexcel导出动态标题，以及动态设置下拉选择，并设置下拉选择校验

linab112

于 2024-05-23 19:22:54 发布

阅读量624

点赞数 5

分类专栏： java常用文章标签： windows linux 运维

本文链接：https://blog.csdn.net/m0_72167535/article/details/139155298

版权

java常用专栏收录该内容

69 篇文章 0 订阅

订阅专栏

1.说明

2.示例

3.总结

1.说明

平时使用easyexcel进行导出时，标题的名字通过在表的实体类上添加注解的方式进行实现，然后传入表的实体类的集合进行下载即可。

有这么一个需求，用户可以自定义导出的模板，也就是说导出的模板的列信息时变化的，并且要根据对应的列信息实现列的下拉选择。

2.示例

easyexcel版本

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

service

            List<String> colId = dowDomain.getColId();
            // 获取列的详细信息
            List<ColEntryEntity> colList = colEntryMsapi.getColList(colId);
            // 生成标题
            List<List<String>> heads = new ArrayList<>();
            colList.forEach(item -> {
                heads.add(Arrays.asList(item.getDisplayName(), item.getColId(), item.getDbName()));
            });
            // list类型的列生成下拉选择
            List<String> listColIdList = colList.stream()
                    .filter(item -> ColumnTypeEnum.LIST.type.equals(item.getColType()))
                    .map(ColEntryEntity::getColId)
                    .collect(Collectors.toList());
            List<ColEntryListEntity> colValList = new ArrayList<>();
            if (CollUtil.isNotEmpty(listColIdList)) {
                colValList = colEntryMsapi.getColValList(listColIdList);
            }
            Map<Integer, List<String>> valList = new HashMap<>();
            for (int i = 0; i < colList.size(); i++) {
                ColEntryEntity colEntry = colList.get(i);
                if (ColumnTypeEnum.LIST.type.equals(colEntry.getColType())) {
                    List<String> list = colValList.stream()
                            .filter(x -> x.getColId().equals(colEntry.getColId()))
                            .map(ColEntryListEntity::getListValue)
                            .collect(Collectors.toList());
                    valList.put(i, list);
                }
            }
            domain.setHeads(heads);
            domain.setValList(valList);
            return domain;

controller

        String fileName = "导入模板" + DateFormatUtils.format(new Date(), CommonContants.DATE_TYPE) + CommonContants.TYPE_XLSX;
        response.setContentType(CommonContants.CONTENT_TYPE);
        response.setCharacterEncoding(CommonContants.UTF8);
        response.setHeader(Header.CONTENT_DISPOSITION.getValue(), CommonContants.CONTENT_TYPE + URLEncoder.encode(fileName, CommonContants.UTF8));
        DowloadDomain dowloadDomain = attributeCustomizeService.dowloadTemplate(dowDomain);
        List<List<Object>> total = new ArrayList<>();
        EasyExcel.write(response.getOutputStream()).head(dowloadDomain.getHeads())
                .registerWriteHandler(new LongestMatchColumnWidthStyleStrategy())
                .registerWriteHandler(new CustomSheetWriteHandler(dowloadDomain.getValList()))
                .sheet("模板").doWrite(total);

通过自定义拦截器实现下拉选择

package com.kingagroot.info.handler;

import com.alibaba.excel.write.handler.SheetWriteHandler;
import com.alibaba.excel.write.metadata.holder.WriteSheetHolder;
import com.alibaba.excel.write.metadata.holder.WriteWorkbookHolder;
import lombok.extern.slf4j.Slf4j;
import org.apache.poi.ss.usermodel.DataValidation;
import org.apache.poi.ss.usermodel.DataValidationConstraint;
import org.apache.poi.ss.usermodel.DataValidationHelper;
import org.apache.poi.ss.usermodel.Sheet;
import org.apache.poi.ss.util.CellRangeAddressList;

import java.util.*;

/**
 * 自定义拦截器.对第一列第一行和第二行的数据新增下拉框，显示 测试1 测试2
 *
 * @author Jiaju Zhuang
 */
@Slf4j
public class CustomSheetWriteHandler implements SheetWriteHandler {

    private Map<Integer, List<String>> optionGroupMap;

    public CustomSheetWriteHandler(Map<Integer, List<String>> mapList) {
        Map<Integer, List<String>> data = new HashMap<>(mapList);
        optionGroupMap = data;
    }

    @Override
    public void beforeSheetCreate(WriteWorkbookHolder writeWorkbookHolder, WriteSheetHolder writeSheetHolder) {

    }

    /**
     * 自定义拦截器.填充下拉选项 key 就是 第几列（从0开始），value 就是这一列 你的下拉数据
     */
    @Override
    public void afterSheetCreate(WriteWorkbookHolder writeWorkbookHolder, WriteSheetHolder writeSheetHolder) {
        Sheet sheet = writeSheetHolder.getSheet();
        // 区间设置 第一列第一行和第二行的数据。由于第一行是头，所以第一、二行的数据实际上是第二三行
        Optional.ofNullable(optionGroupMap).orElse(new HashMap<>()).forEach((columnIndex, options) -> {
            // 区间设置 第一列第一行和第二行的数据。由于第一行是头，所以第一、二行的数据实际上是第二三行
            CellRangeAddressList cellRangeAddressList = new CellRangeAddressList(3, 65535, columnIndex, columnIndex);
            DataValidationHelper helper = sheet.getDataValidationHelper();
            DataValidationConstraint constraint = helper.createExplicitListConstraint(options.toArray(new String[options.size()]));
            DataValidation dataValidation = helper.createValidation(constraint, cellRangeAddressList);
            // 这行代码是用于设置数据验证时是否显示错误提示框的,为true，如果用户在单元格中输入了不符合数据验证条件的数值，会弹出提示
            dataValidation.setShowErrorBox(true);
            // 这行代码是用于设置数据验证中的错误提示框的样式。当设置为DataValidation.ErrorStyle.STOP时，表示如果用户输入了不符合数据验证条件的数值，将阻止用户继续输入并弹出错误提示框，防止不合规范的数据被输入。
            dataValidation.setErrorStyle(DataValidation.ErrorStyle.STOP);
            // 这行代码表示设置数据验证时是否允许空单元格。当将参数设置为false时，即不允许空单元格
            // dataValidation.setEmptyCellAllowed(false);
            // 这行代码表示设置数据验证时是否显示下拉箭头。当将参数设置为false时，会在具有数据验证的单元格中显示下拉箭头，以提示用户可以从预定义的选项中进行选择。如果设置为true，则不会显示下拉箭头。
            // dataValidation.setSuppressDropDownArrow(false);
            // 这行代码表示设置数据验证时是否显示提示框。当将参数设置为true时，如果用户选择了拥有数据验证的单元格，会弹出一个提示框，向用户提供关于该单元格数据输入的指导或说明
            // dataValidation.setShowPromptBox(true);
            // 这行代码是用于创建数据验证的错误提示框。其中，第一个参数"错误"表示错误提示框的标题，第二个参数"请从下拉列表中选择一个选项！"是具体的错误提示信息。当用户输入了不符合数据验证条件的数值时，将会弹出这个错误提示框，提醒用户输入的数据不符合规定，并给出相应的错误说明。
            dataValidation.createErrorBox("错误", "请从下拉列表中选择一个选项！");
            // 这行代码用于设置数据验证的标题和提示信息。第一个参数"下拉选择限制"表示数据验证对话框的标题，第二个参数"请在下拉列表中选择一个选项！"是具体的提示信息。当用户在单元格输入了不符合数据验证条件的数值时，会弹出一个警告框，其中包含了设置的标题和提示信息，以提醒用户必须从下拉列表中进行选择。
            // 有的版本可能没有这个设置，需要升级到对应的版本
            // dataValidation.setTitle("下拉选择限制", "请在下拉列表中选择一个选项！");
            writeSheetHolder.getSheet().addValidationData(dataValidation);
        });
    }
}

说明

①获取要下载模板中的列信息，生成标题，代码如下：

            // 生成标题
            List<List<String>> heads = new ArrayList<>();
            colList.forEach(item -> {
                heads.add(Arrays.asList(item.getDisplayName(), item.getColId(), item.getDbName()));
            });

动态标题的信息需要存储到一个List<List<String>>集合中，集合中的数据是一个string类型的集合，代表第一列标题的信息，上面中每列标题中存储了3个值，代表每列的标题行有3行。通过循环处理生成导出文件的标题。

②动态下拉的实现

要做到哪一列可以进行下拉选择，哪一列没有下拉选择，首先要获取下拉选择列表，循环列信息，进行匹配，存储到Map<Integer, List<String>>集合中，key代表是哪一列，从0开始，value则代表下拉选择列表。

然后通过上面的自定义拦截器，将集合内容传递到拦截器中进行循环处理，设置下拉选择

使用了Optional.ofNullable(optionGroupMap).orElse(new HashMap<>())方法进行处理避免空指针的问题。

③下拉选择输入内容不正确时可以进行校验处理，主要是下面这三行代码，分别是开启数据验证，输入错误时阻止输入并弹出信息以及弹出信息的内容设置

            // 这行代码是用于设置数据验证时是否显示错误提示框的,为true，如果用户在单元格中输入了不符合数据验证条件的数值，会弹出提示
            dataValidation.setShowErrorBox(true);
            // 这行代码是用于设置数据验证中的错误提示框的样式。当设置为DataValidation.ErrorStyle.STOP时，表示如果用户输入了不符合数据验证条件的数值，将阻止用户继续输入并弹出错误提示框，防止不合规范的数据被输入。
            dataValidation.setErrorStyle(DataValidation.ErrorStyle.STOP);
            // 这行代码是用于创建数据验证的错误提示框。其中，第一个参数"错误"表示错误提示框的标题，第二个参数"请从下拉列表中选择一个选项！"是具体的错误提示信息。当用户输入了不符合数据验证条件的数值时，将会弹出这个错误提示框，提醒用户输入的数据不符合规定，并给出相应的错误说明。
            dataValidation.createErrorBox("错误", "请从下拉列表中选择一个选项！");

④导出数据的设置

格式为List<List<Object>> ，集合中的每条数据代表一行数据，注意顺序要和列一一对应。