package com.iailab.framework.excel.core.handler; import cn.hutool.core.collection.CollUtil; import cn.hutool.core.lang.Assert; import cn.hutool.core.map.MapUtil; import cn.hutool.core.util.ObjectUtil; import cn.hutool.core.util.StrUtil; import cn.hutool.extra.spring.SpringUtil; import cn.hutool.poi.excel.ExcelUtil; import com.alibaba.excel.annotation.ExcelProperty; import com.alibaba.excel.write.handler.SheetWriteHandler; import com.alibaba.excel.write.metadata.holder.WriteSheetHolder; import com.alibaba.excel.write.metadata.holder.WriteWorkbookHolder; import com.iailab.framework.common.core.KeyValue; import com.iailab.framework.dict.core.DictFrameworkUtils; import com.iailab.framework.excel.core.annotations.ExcelColumnSelect; import com.iailab.framework.excel.core.function.ExcelColumnSelectFunction; import lombok.extern.slf4j.Slf4j; import org.apache.poi.hssf.usermodel.HSSFDataValidation; import org.apache.poi.ss.usermodel.*; import org.apache.poi.ss.util.CellRangeAddressList; import java.lang.reflect.Field; import java.util.*; import static com.iailab.framework.common.util.collection.CollectionUtils.convertList; /** * 基于固定 sheet 实现下拉框 * * @author HUIHUI */ @Slf4j public class SelectSheetWriteHandler implements SheetWriteHandler { /** * 数据起始行从 0 开始 * 约定:本项目第一行有标题所以从 1 开始如果您的 Excel 有多行标题请自行更改 */ public static final int FIRST_ROW = 1; /** * 下拉列需要创建下拉框的行数,默认两千行如需更多请自行调整 */ public static final int LAST_ROW = 2000; private static final String DICT_SHEET_NAME = "字典sheet"; /** * key: 列 value: 下拉数据源 */ private final Map> selectMap = new HashMap<>(); private static Boolean ifSetSelect; public SelectSheetWriteHandler(Class head, Boolean selectFlag) { ifSetSelect = selectFlag; // 加载下拉数据获取接口 Map beansMap = SpringUtil.getBeanFactory().getBeansOfType(ExcelColumnSelectFunction.class); if (MapUtil.isEmpty(beansMap)) { return; } List fields = new ArrayList<>(); for (Class c = head; c != null; c = c.getSuperclass()) { Collections.addAll(fields, c.getDeclaredFields()); } // 解析下拉数据 int colIndex = 0; for (Field field : fields) { if (field.isAnnotationPresent(ExcelColumnSelect.class)) { ExcelProperty excelProperty = field.getAnnotation(ExcelProperty.class); if (excelProperty != null && excelProperty.index() != -1) { getSelectDataList(excelProperty.index(), field); }else{ getSelectDataList(colIndex, field); } } colIndex++; } } /** * 获得下拉数据,并添加到 {@link #selectMap} 中 * * @param colIndex 列索引 * @param field 字段 */ private void getSelectDataList(int colIndex, Field field) { ExcelColumnSelect columnSelect = field.getAnnotation(ExcelColumnSelect.class); String dictType = columnSelect.dictType(); String functionName = columnSelect.functionName(); Assert.isTrue(ObjectUtil.isNotEmpty(dictType) || ObjectUtil.isNotEmpty(functionName), "Field({}) 的 @ExcelColumnSelect 注解,dictType 和 functionName 不能同时为空", field.getName()); // 情况一:使用 dictType 获得下拉数据 if (StrUtil.isNotEmpty(dictType)) { // 情况一: 字典数据 (默认) selectMap.put(colIndex, DictFrameworkUtils.getDictDataLabelList(dictType)); return; } // 情况二:使用 functionName 获得下拉数据 Map functionMap = SpringUtil.getApplicationContext().getBeansOfType(ExcelColumnSelectFunction.class); ExcelColumnSelectFunction function = CollUtil.findOne(functionMap.values(), item -> item.getName().equals(functionName)); Assert.notNull(function, "未找到对应的 function({})", functionName); selectMap.put(colIndex, function.getOptions()); } @Override public void afterSheetCreate(WriteWorkbookHolder writeWorkbookHolder, WriteSheetHolder writeSheetHolder) { if (CollUtil.isEmpty(selectMap)) { return; } // 1. 获取相应操作对象 DataValidationHelper helper = writeSheetHolder.getSheet().getDataValidationHelper(); // 需要设置下拉框的 sheet 页的数据验证助手 Workbook workbook = writeWorkbookHolder.getWorkbook(); // 获得工作簿 List>> keyValues = convertList(selectMap.entrySet(), entry -> new KeyValue<>(entry.getKey(), entry.getValue())); keyValues.sort(Comparator.comparing(item -> item.getValue().size())); // 升序不然创建下拉会报错 if (ifSetSelect){ for (KeyValue> keyValue : keyValues) { /*起始行、终止行、起始列、终止列 起始行为1即表示表头不设置**/ CellRangeAddressList addressList = new CellRangeAddressList(FIRST_ROW, LAST_ROW, keyValue.getKey(), keyValue.getKey()); /*设置下拉框数据**/ DataValidationConstraint constraint = helper.createExplicitListConstraint(keyValue.getValue().toArray(new String[0])); DataValidation dataValidation = helper.createValidation(constraint, addressList); if (dataValidation instanceof HSSFDataValidation) { dataValidation.setSuppressDropDownArrow(false); } else { dataValidation.setSuppressDropDownArrow(true); dataValidation.setShowErrorBox(true); } // 2.2 阻止输入非下拉框的值 dataValidation.setErrorStyle(DataValidation.ErrorStyle.STOP); dataValidation.createErrorBox("提示", "此值不存在于下拉选择中!"); writeSheetHolder.getSheet().addValidationData(dataValidation); } }else{ // 2. 创建数据字典的 sheet 页 Sheet dictSheet = workbook.createSheet(DICT_SHEET_NAME); for (KeyValue> keyValue : keyValues) { int rowLength = keyValue.getValue().size(); // 2.1 设置字典 sheet 页的值,每一列一部字典项 for (int i = 0; i < rowLength; i++) { Row row = dictSheet.getRow(i); if (row == null) { row = dictSheet.createRow(i); } row.createCell(keyValue.getKey()).setCellValue(keyValue.getValue().get(i)); } // 2.2 设置单元格下拉选择 setColumnSelect(writeSheetHolder, workbook, helper, keyValue); } } } /** * 设置单元格下拉选择 */ private static void setColumnSelect(WriteSheetHolder writeSheetHolder, Workbook workbook, DataValidationHelper helper, KeyValue> keyValue) { // 1.1 创建可被其他单元格引用的名称 Name name = workbook.createName(); String excelColumn = ExcelUtil.indexToColName(keyValue.getKey()); // 1.2 下拉框数据来源 eg:字典sheet!$B1:$B2 String refers = DICT_SHEET_NAME + "!$" + excelColumn + "$1:$" + excelColumn + "$" + keyValue.getValue().size(); name.setNameName("dict" + keyValue.getKey()); // 设置名称的名字 name.setRefersToFormula(refers); // 设置公式 // 2.1 设置约束 DataValidationConstraint constraint = helper.createFormulaListConstraint("dict" + keyValue.getKey()); // 设置引用约束 // 设置下拉单元格的首行、末行、首列、末列 CellRangeAddressList rangeAddressList = new CellRangeAddressList(FIRST_ROW, LAST_ROW, keyValue.getKey(), keyValue.getKey()); DataValidation validation = helper.createValidation(constraint, rangeAddressList); if (validation instanceof HSSFDataValidation) { validation.setSuppressDropDownArrow(false); } else { validation.setSuppressDropDownArrow(true); validation.setShowErrorBox(true); } // 2.2 阻止输入非下拉框的值 validation.setErrorStyle(DataValidation.ErrorStyle.STOP); validation.createErrorBox("提示", "此值不存在于下拉选择中!"); // 2.3 添加下拉框约束 writeSheetHolder.getSheet().addValidationData(validation); } }