Easypoi-导出excel单元格添加下拉列表

我们在使用excel进行批量导入的时候，通常会提供导入模板excel来给用户来规范用户的输入，其中就会用到下拉选项来约束这一种方式

方法一：@Excel

  @Excel(name = "状态", width = 25, replace = {"待审_1", "通过_2", "驳回_3"},addressList = true,orderNum = "25")
  private Integer status;

主要是replace和addressList这两个属性配置。

replace：替换字段内容，通常用于状态字段的显示（例如：“男_1,女_2”）。

addressList：是否生成下拉的选项。

@Excel 是 easypoi 中用于 Excel 导入导出的注解，可以用于实体类的字段上，用以定义该字段数据与 Excel 文件中的列的对应关系以及进行导入导出时的各种设置。以下是 @Excel 注解的一些主要属性和它们的功能：

1. name：设置导出时在表格中的显示名称。
2. width：列宽度，单位为字符。
3. height：行高度，单位为字符。
4. orderNum：导出排序顺序，数值小的先导出。
5. needMerge：是否需要合并单元格。
6. mergeVertical：纵向合并内容相同的单元格。
7. mergeRely：合并依赖于某些列的情况。
8. replace：替换字段内容，通常用于状态字段的显示（例如：“男_1,女_2”）。
9. suffix：文本后缀，如%、元、个。
10. isImportField：是否为导入字段，导入模板时是否需要显示。
11. exportType：导出类型，指导出文本还是导出图片等类型。
12. format：时间格式化，比如：“yyyy-MM-dd”。
13. databaseFormat：数据库格式，通常配合 format 使用。
14. dict：数据字典标识。
15. savePath：图片等文件保存路径。
16. type：字段类型（文本、图片、文件）。
17. imageType：图片类型，控制导出图片的方式。
18. suffix：文本类型的字段后缀标记。
19. statistics：是否统计当前列，生成统计行。

方法二：DataValidation

由于有的时候我们的下拉列表选项来自数据库，可以使用dict属性搭配IExcelDictHandler，也可以直接在workbook上操作，把列表约束作用到指定单元格

/**
     * firstRow 开始行号 根据此项目，默认为2(下标0开始)
     * lastRow  根据此项目，默认为最大65535
     * firstCol 区域中第一个单元格的列号 (下标0开始)
     * lastCol 区域中最后一个单元格的列号
     * strings 下拉内容
     * */
    public static void addDropdown(Workbook workbook,int firstRow, int col, String[] strings ){
       //对工作簿中第一个工作表进行操作
        Sheet sheet = workbook.getSheetAt(0);
       // 创建`CellRangeAddressList`对象，该对象指定下拉列表的适用区域：
     	 //该区域从`firstRow`起始行（包含）到第65535行（包含），在`col`列上。（由于我们作用于同一列，所以firstCol=lastCol）
        CellRangeAddressList cellRangeAddressList = new CellRangeAddressList(firstRow, 65535, col,col);
        DataValidationHelper helper = sheet.getDataValidationHelper();
       //使用传入的字符串数组创建一个显式列表约束，确定下拉列表中的选项
        DataValidationConstraint dvConstraint = helper.createExplicitListConstraint(strings);
       //把创建的列表约束作用到那些范围内的单元格
        DataValidation validation = helper.createValidation(dvConstraint, cellRangeAddressList);
       //  作用到sheet上
        sheet.addValidationData(validation);
    }

但是以上代码有个问题就是，如果下拉选项过多，会无法显示，这时候我们就需要借助一个隐藏的字典sheet，这时候我们就需要修改一下代码

 public static void addLongDropdown(Workbook workbook,int firstRow, int col, String[] strings ){
        XSSFSheet sheet = (XSSFSheet)workbook.getSheetAt(0);
        //默认为最大65535
        int endRow =65535;
        //随便起个sheet名
        String hiddenName = "hidden"+col;
        //1.创建隐藏的sheet页。
        XSSFSheet hidden = (XSSFSheet)workbook.createSheet(hiddenName);
        //2.循环赋值（为了防止下拉框的行数与隐藏域的行数相对应，将隐藏域加到结束行之后）
        for (int i = 0, length = strings.length; i < length; i++) {
            hidden.createRow(endRow + i).createCell(col).setCellValue(strings[i]);
        }
        //创建可被其他单元格引用的名称
        Name workbookName = workbook.createName();
        workbookName.setNameName(hiddenName);
        //3 A1:A代表隐藏域创建第N列createCell(N)时。以A1列开始A行数据获取下拉数组
        workbookName.setRefersToFormula(hiddenName + "!A1:A" + (strings.length + endRow));
        DataValidationHelper helper = sheet.getDataValidationHelper();
        DataValidationConstraint constraint = helper.createFormulaListConstraint(hiddenName);
        CellRangeAddressList addressList = new CellRangeAddressList(firstRow, endRow, col, col);
        DataValidation dataValidation = helper.createValidation(constraint, addressList);
        if (dataValidation instanceof XSSFDataValidation) {
            // 数据校验
            dataValidation.setSuppressDropDownArrow(true);
            dataValidation.setShowErrorBox(true);
        } else {
            dataValidation.setSuppressDropDownArrow(false);
        }
        // 作用在目标sheet上
        sheet.addValidationData(dataValidation);
        // 为了用户友好，设置hiddenSheet隐藏
        workbook.setSheetHidden(workbook.getSheetIndex(hiddenName), true);
    }

更多博客文章尽在：https://cason.work/
自我整理的编程工具集合：https://tool.cason.work/