完善 Excel 导入模版下拉选择生成实现

puhui999
1 parent e53a0ca8
Showing 8 changed files with 102 additions and 85 deletions
yudao-framework/yudao-spring-boot-starter-excel/src/main/java/cn/iocoder/yudao/framework/excel/core/enums/ExcelColumn.java
yudao-framework/yudao-spring-boot-starter-excel/src/main/java/cn/iocoder/yudao/framework/excel/core/handler/SelectSheetWriteHandler.java
yudao-framework/yudao-spring-boot-starter-excel/src/main/java/cn/iocoder/yudao/framework/excel/core/util/ExcelUtils.java
yudao-module-crm/yudao-module-crm-biz/src/main/java/cn/iocoder/yudao/module/crm/controller/admin/customer/CrmCustomerController.java
yudao-module-crm/yudao-module-crm-biz/src/main/java/cn/iocoder/yudao/module/crm/service/customer/CrmCustomerServiceImpl.java
yudao-module-crm/yudao-module-crm-biz/src/main/java/cn/iocoder/yudao/module/crm/service/receivable/CrmReceivablePlanServiceImpl.java
yudao-module-crm/yudao-module-crm-biz/src/main/java/cn/iocoder/yudao/module/crm/service/receivable/CrmReceivableServiceImpl.java
yudao-module-infra/yudao-module-infra-api/src/main/java/cn/iocoder/yudao/module/infra/enums/ErrorCodeConstants.java
+package cn.iocoder.yudao.framework.excel.core.enums;
+
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+
+/**
+ * Excel 列名枚举
+ * 默认枚举 26 列列名如果有需求更多的列名请自行补充
+ *
+ * @author HUIHUI
+ */
+@Getter
+@AllArgsConstructor
+public enum ExcelColumn {
+    A(0), B(1), C(2), D(3), E(4), F(5), G(6), H(7), I(8),
+    J(9), K(10), L(11), M(12), N(13), O(14), P(15), Q(16),
+    R(17), S(18), T(19), U(20), V(21), W(22), X(23), Y(24),
+    Z(25);
+
+    /**
+     * 列索引
+     */
+    private final int colNum;
+
+}
 package cn.iocoder.yudao.framework.excel.core.handler;
 import cn.hutool.core.collection.CollUtil;
+import cn.hutool.core.lang.Assert;
 import cn.iocoder.yudao.framework.common.core.KeyValue;
+import cn.iocoder.yudao.framework.excel.core.enums.ExcelColumn;
 import com.alibaba.excel.write.handler.SheetWriteHandler;
 import com.alibaba.excel.write.metadata.holder.WriteSheetHolder;
 import com.alibaba.excel.write.metadata.holder.WriteWorkbookHolder;
@@ -11,6 +13,8 @@ import org.apache.poi.ss.util.CellRangeAddressList;
 import java.util.Comparator;
 import java.util.List;
+import java.util.Map;
+import java.util.stream.Collectors;
 /**
  * 基于固定 sheet 实现下拉框
@@ -20,18 +24,20 @@ import java.util.List;
 public class SelectSheetWriteHandler implements SheetWriteHandler {
     private static final String DICT_SHEET_NAME = "字典sheet";
+    public static final int FIRST_ROW = 1; // 数据起始行从 0 开始，本项目第一行有标题所以从 1 开始如果您的 Excel 有多行标题请自行更改
+    public static final int LAST_ROW = 2000; // 下拉列需要创建下拉框的行数，默认两千行如需更多请自行调整
+    private final List<KeyValue<ExcelColumn, List<String>>> selectMap;
-    // TODO @puhui999：key 不使用 int 值么？感觉不是很优雅哈。
-    private final List<KeyValue<Integer, List<String>>> selectMap;
-
-    private static final char[] ALPHABET = new char[]{'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L',
-            'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z'};
-
-    public SelectSheetWriteHandler(List<KeyValue<Integer, List<String>>> selectMap) {
+    public SelectSheetWriteHandler(List<KeyValue<ExcelColumn, List<String>>> selectMap) {
         if (CollUtil.isEmpty(selectMap)) {
             this.selectMap = null;
             return;
         }
+        // 校验一下 key 是否唯一
+        Map<String, Long> nameCounts = selectMap.stream()
+                .collect(Collectors.groupingBy(item -> item.getKey().name(), Collectors.counting()));
+        Assert.isFalse(nameCounts.entrySet().stream().allMatch(entry -> entry.getValue() > 1), "下拉数据 key 重复请排查！！！");
+
         selectMap.sort(Comparator.comparing(item -> item.getValue().size())); // 升序不然创建下拉会报错
         this.selectMap = selectMap;
     }
@@ -41,16 +47,14 @@ public class SelectSheetWriteHandler implements SheetWriteHandler {
         if (CollUtil.isEmpty(selectMap)) {
             return;
         }
-        // 需要设置下拉框的 sheet 页
-        Sheet currentSheet = writeSheetHolder.getSheet();
-        DataValidationHelper helper = currentSheet.getDataValidationHelper();
-        Workbook workbook = writeWorkbookHolder.getWorkbook();
-        // 数据字典的 sheet 页
+        // 1.1 获取相应操作对象
+        DataValidationHelper helper = writeSheetHolder.getSheet().getDataValidationHelper(); // 需要设置下拉框的 sheet 页的数据验证助手
+        Workbook workbook = writeWorkbookHolder.getWorkbook(); // 获得工作簿
+
+        // 1.2 创建数据字典的 sheet 页
         Sheet dictSheet = workbook.createSheet(DICT_SHEET_NAME);
-        for (KeyValue<Integer, List<String>> keyValue : selectMap) {
-            // 设置下拉单元格的首行、末行、首列、末列
-            CellRangeAddressList rangeAddressList = new CellRangeAddressList(1, 65533, keyValue.getKey(), keyValue.getKey());
+        for (KeyValue<ExcelColumn, List<String>> keyValue : selectMap) {
             int rowLen = keyValue.getValue().size();
             // 设置字典 sheet 页的值 每一列一个字典项
             for (int i = 0; i < rowLen; i++) {
@@ -58,58 +62,42 @@ public class SelectSheetWriteHandler implements SheetWriteHandler {
                 if (row == null) {
                     row = dictSheet.createRow(i);
                 }
-                row.createCell(keyValue.getKey()).setCellValue(keyValue.getValue().get(i));
+                row.createCell(keyValue.getKey().getColNum()).setCellValue(keyValue.getValue().get(i));
             }
-
-            // TODO @puhui999：下面 1. 2.1 2.2 2.3 我是按照已经理解的，调整了下格式；这样可读性更好；在 52 到 62 行，你可以看看，是不是也弄下序号；
-            // 1. 创建可被其他单元格引用的名称
-            Name name = workbook.createName();
-            // TODO @puhui999：下面的 excelColumn 和 refers 两行，是不是可以封装成一个方法，替代 getExcelColumn；
-            String excelColumn = getExcelColumn(keyValue.getKey());
-            String refers = DICT_SHEET_NAME + "!$" + excelColumn + "$1:$" + excelColumn + "$" + rowLen; // 下拉框数据来源 eg:字典sheet!$B1:$B2
-            name.setNameName("dict" + keyValue.getKey()); // 设置名称的名字
-            name.setRefersToFormula(refers); // 设置公式
-
-            // 2.1 设置约束
-            DataValidationConstraint constraint = helper.createFormulaListConstraint("dict" + 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);
+            // 1.3 设置单元格下拉选择
+            setColSelect(writeSheetHolder, workbook, helper, keyValue);
         }
     }
     /**
-     * 将数字列转化成为字母列
-     *
-     * @param num 数字
-     * @return 字母
+     * 设置单元格下拉选择
      */
-    // TODO @puhui999：这个是必须字母列哇？还是数字其实也可以哈？主要想看看，怎么能把这个逻辑，进一步简化
-    private String getExcelColumn(int num) {
-        String column;
-        int len = ALPHABET.length - 1;
-        int first = num / len;
-        int second = num % len;
-        if (num <= len) {
-            column = ALPHABET[num] + "";
+    private static void setColSelect(WriteSheetHolder writeSheetHolder, Workbook workbook, DataValidationHelper helper,
+                                     KeyValue<ExcelColumn, List<String>> keyValue) {
+        // 1.1 创建可被其他单元格引用的名称
+        Name name = workbook.createName();
+        String excelColumn = keyValue.getKey().name();
+        // 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().getColNum(), keyValue.getKey().getColNum());
+        DataValidation validation = helper.createValidation(constraint, rangeAddressList);
+        if (validation instanceof HSSFDataValidation) {
+            validation.setSuppressDropDownArrow(false);
         } else {
-            column = ALPHABET[first - 1] + "";
-            if (second == 0) {
-                column = column + ALPHABET[len];
-            } else {
-                column = column + ALPHABET[second - 1];
-            }
+            validation.setSuppressDropDownArrow(true);
+            validation.setShowErrorBox(true);
         }
-        return column;
+        // 2.2 阻止输入非下拉框的值
+        validation.setErrorStyle(DataValidation.ErrorStyle.STOP);
+        validation.createErrorBox("提示", "此值不存在于下拉选择中！");
+        // 2.3 添加下拉框约束
+        writeSheetHolder.getSheet().addValidationData(validation);
     }
 }
 \ No newline at end of file
 package cn.iocoder.yudao.framework.excel.core.util;
 import cn.iocoder.yudao.framework.common.core.KeyValue;
+import cn.iocoder.yudao.framework.excel.core.enums.ExcelColumn;
 import cn.iocoder.yudao.framework.excel.core.handler.SelectSheetWriteHandler;
 import com.alibaba.excel.EasyExcel;
 import com.alibaba.excel.converters.longconverter.LongStringConverter;
@@ -44,11 +45,11 @@ public class ExcelUtils {
      * @param sheetName Excel sheet 名
      * @param head      Excel head 头
      * @param data      数据列表哦
-     * @param selectMap 下拉选择数据 Map
+     * @param selectMap 下拉选择数据 Map<下拉所对应的列表名，下拉数据>
      * @throws IOException 写入失败的情况
      */
     public static <T> void write(HttpServletResponse response, String filename, String sheetName,
-                                 Class<T> head, List<T> data, List<KeyValue<Integer, List<String>>> selectMap) throws IOException {
+                                 Class<T> head, List<T> data, List<KeyValue<ExcelColumn, List<String>>> selectMap) throws IOException {
         // 输出 Excel
         EasyExcel.write(response.getOutputStream(), head)
                 .autoCloseStream(false) // 不要自动关闭，交给 Servlet 自己处理
@@ -10,6 +10,7 @@ import cn.iocoder.yudao.framework.common.util.collection.MapUtils;
 import cn.iocoder.yudao.framework.common.util.date.LocalDateTimeUtils;
 import cn.iocoder.yudao.framework.common.util.number.NumberUtils;
 import cn.iocoder.yudao.framework.common.util.object.BeanUtils;
+import cn.iocoder.yudao.framework.excel.core.enums.ExcelColumn;
 import cn.iocoder.yudao.framework.excel.core.util.ExcelUtils;
 import cn.iocoder.yudao.framework.ip.core.Area;
 import cn.iocoder.yudao.framework.ip.core.utils.AreaUtils;
@@ -268,21 +269,21 @@ public class CrmCustomerController {
         ExcelUtils.write(response, "客户导入模板.xls", "客户列表", CrmCustomerImportExcelVO.class, list, builderSelectMap());
     }
-    private List<KeyValue<Integer, List<String>>> builderSelectMap() {
-        List<KeyValue<Integer, List<String>>> selectMap = new ArrayList<>();
+    private List<KeyValue<ExcelColumn, List<String>>> builderSelectMap() {
+        List<KeyValue<ExcelColumn, List<String>>> selectMap = new ArrayList<>();
         // 获取地区下拉数据
         // TODO @puhui999：嘿嘿，这里改成省份、城市、区域，三个选项，难度大么？
         Area area = AreaUtils.parseArea(Area.ID_CHINA);
-        selectMap.add(new KeyValue<>(6, AreaUtils.getAreaNodePathList(area.getChildren())));
+        selectMap.add(new KeyValue<>(ExcelColumn.G, AreaUtils.getAreaNodePathList(area.getChildren())));
         // 获取客户所属行业
         List<String> customerIndustries = dictDataApi.getDictDataLabelList(CRM_CUSTOMER_INDUSTRY);
-        selectMap.add(new KeyValue<>(8, customerIndustries));
+        selectMap.add(new KeyValue<>(ExcelColumn.I, customerIndustries));
         // 获取客户等级
         List<String> customerLevels = dictDataApi.getDictDataLabelList(CRM_CUSTOMER_LEVEL);
-        selectMap.add(new KeyValue<>(9, customerLevels));
+        selectMap.add(new KeyValue<>(ExcelColumn.J, customerLevels));
         // 获取客户来源
         List<String> customerSources = dictDataApi.getDictDataLabelList(CRM_CUSTOMER_SOURCE);
-        selectMap.add(new KeyValue<>(10, customerSources));
+        selectMap.add(new KeyValue<>(ExcelColumn.K, customerSources));
         return selectMap;
     }
@@ -41,6 +41,7 @@ import java.time.LocalDateTime;
 import java.util.*;
 import static cn.iocoder.yudao.framework.common.exception.util.ServiceExceptionUtil.exception;
+import static cn.iocoder.yudao.framework.common.util.collection.CollectionUtils.filterList;
 import static cn.iocoder.yudao.module.crm.enums.ErrorCodeConstants.*;
 import static cn.iocoder.yudao.module.crm.enums.LogRecordConstants.*;
 import static cn.iocoder.yudao.module.crm.enums.customer.CrmCustomerLimitConfigTypeEnum.CUSTOMER_LOCK_LIMIT;
@@ -203,7 +204,7 @@ public class CrmCustomerServiceImpl implements CrmCustomerService {
         // 2.1 数据权限转移
         permissionService.transferPermission(new CrmPermissionTransferReqBO(userId, CrmBizTypeEnum.CRM_CUSTOMER.getType(),
-                        reqVO.getId(), reqVO.getNewOwnerUserId(), reqVO.getOldOwnerPermissionLevel()));
+                reqVO.getId(), reqVO.getNewOwnerUserId(), reqVO.getOldOwnerPermissionLevel()));
         // 2.2 转移后重新设置负责人
         customerMapper.updateById(new CrmCustomerDO().setId(reqVO.getId())
                 .setOwnerUserId(reqVO.getNewOwnerUserId()).setOwnerTime(LocalDateTime.now()));
@@ -260,6 +261,8 @@ public class CrmCustomerServiceImpl implements CrmCustomerService {
         if (CollUtil.isEmpty(importCustomers)) {
             throw exception(CUSTOMER_IMPORT_LIST_IS_EMPTY);
         }
+        // 因为有下拉所以需要过滤掉空行
+        importCustomers = filterList(importCustomers, item -> Objects.nonNull(item.getName()));
         CrmCustomerImportRespVO respVO = CrmCustomerImportRespVO.builder().createCustomerNames(new ArrayList<>())
                 .updateCustomerNames(new ArrayList<>()).failureCustomerNames(new LinkedHashMap<>()).build();
         importCustomers.forEach(importCustomer -> {
@@ -70,11 +70,10 @@ public class CrmReceivablePlanServiceImpl implements CrmReceivablePlanService {
         validateRelationDataExists(createReqVO);
         // 1.2 查验关联合同回款数量
         Long count = receivableService.getReceivableCountByContractId(createReqVO.getContractId());
-        int period = (int) (count + 1);
-        createReqVO.setPeriod(createReqVO.getPeriod() != period ? period : createReqVO.getPeriod()); // 如果期数不对则纠正
         // 2. 插入还款计划
-        CrmReceivablePlanDO receivablePlan = BeanUtils.toBean(createReqVO, CrmReceivablePlanDO.class).setId(null).setFinishStatus(false);
+        CrmReceivablePlanDO receivablePlan = BeanUtils.toBean(createReqVO, CrmReceivablePlanDO.class).setId(null)
+                .setPeriod((int) (count + 1)).setFinishStatus(false);
         receivablePlanMapper.insert(receivablePlan);
         // 3. 创建数据权限
@@ -67,7 +67,7 @@ public class CrmReceivableServiceImpl implements CrmReceivableService {
     private CrmContractService contractService;
     @Resource
     private CrmCustomerService customerService;
-//    @Resource
+    @Resource
     @Lazy // 延迟加载，避免循环依赖
     private CrmReceivablePlanService receivablePlanService;
     @Resource
@@ -33,19 +33,19 @@ public interface ErrorCodeConstants {
     ErrorCode FILE_IS_EMPTY = new ErrorCode(1_001_003_002, "文件为空");
     // ========== 代码生成器 1-001-004-000 ==========
-    ErrorCode CODEGEN_TABLE_EXISTS = new ErrorCode(1_003_001_000, "表定义已经存在");
-    ErrorCode CODEGEN_IMPORT_TABLE_NULL = new ErrorCode(1_003_001_001, "导入的表不存在");
-    ErrorCode CODEGEN_IMPORT_COLUMNS_NULL = new ErrorCode(1_003_001_002, "导入的字段不存在");
-    ErrorCode CODEGEN_TABLE_NOT_EXISTS = new ErrorCode(1_003_001_004, "表定义不存在");
-    ErrorCode CODEGEN_COLUMN_NOT_EXISTS = new ErrorCode(1_003_001_005, "字段义不存在");
-    ErrorCode CODEGEN_SYNC_COLUMNS_NULL = new ErrorCode(1_003_001_006, "同步的字段不存在");
-    ErrorCode CODEGEN_SYNC_NONE_CHANGE = new ErrorCode(1_003_001_007, "同步失败，不存在改变");
-    ErrorCode CODEGEN_TABLE_INFO_TABLE_COMMENT_IS_NULL = new ErrorCode(1_003_001_008, "数据库的表注释未填写");
-    ErrorCode CODEGEN_TABLE_INFO_COLUMN_COMMENT_IS_NULL = new ErrorCode(1_003_001_009, "数据库的表字段({})注释未填写");
-    ErrorCode CODEGEN_MASTER_TABLE_NOT_EXISTS = new ErrorCode(1_003_001_010, "主表(id={})定义不存在，请检查");
-    ErrorCode CODEGEN_SUB_COLUMN_NOT_EXISTS = new ErrorCode(1_003_001_011, "子表的字段(id={})不存在，请检查");
-    ErrorCode CODEGEN_MASTER_GENERATION_FAIL_NO_SUB_TABLE = new ErrorCode(1_003_001_012, "主表生成代码失败，原因：它没有子表");
-    ErrorCode CODEGEN_MASTER_GENERATION_FAIL_NO_SUB_COLUMN = new ErrorCode(1_003_001_013, "主表生成代码失败，原因：它的子表({})没有字段");
+    ErrorCode CODEGEN_TABLE_EXISTS = new ErrorCode(1_001_004_002, "表定义已经存在");
+    ErrorCode CODEGEN_IMPORT_TABLE_NULL = new ErrorCode(1_001_004_001, "导入的表不存在");
+    ErrorCode CODEGEN_IMPORT_COLUMNS_NULL = new ErrorCode(1_001_004_002, "导入的字段不存在");
+    ErrorCode CODEGEN_TABLE_NOT_EXISTS = new ErrorCode(1_001_004_004, "表定义不存在");
+    ErrorCode CODEGEN_COLUMN_NOT_EXISTS = new ErrorCode(1_001_004_005, "字段义不存在");
+    ErrorCode CODEGEN_SYNC_COLUMNS_NULL = new ErrorCode(1_001_004_006, "同步的字段不存在");
+    ErrorCode CODEGEN_SYNC_NONE_CHANGE = new ErrorCode(1_001_004_007, "同步失败，不存在改变");
+    ErrorCode CODEGEN_TABLE_INFO_TABLE_COMMENT_IS_NULL = new ErrorCode(1_001_004_008, "数据库的表注释未填写");
+    ErrorCode CODEGEN_TABLE_INFO_COLUMN_COMMENT_IS_NULL = new ErrorCode(1_001_004_009, "数据库的表字段({})注释未填写");
+    ErrorCode CODEGEN_MASTER_TABLE_NOT_EXISTS = new ErrorCode(1_001_004_010, "主表(id={})定义不存在，请检查");
+    ErrorCode CODEGEN_SUB_COLUMN_NOT_EXISTS = new ErrorCode(1_001_004_011, "子表的字段(id={})不存在，请检查");
+    ErrorCode CODEGEN_MASTER_GENERATION_FAIL_NO_SUB_TABLE = new ErrorCode(1_001_004_012, "主表生成代码失败，原因：它没有子表");
+    ErrorCode CODEGEN_MASTER_GENERATION_FAIL_NO_SUB_COLUMN = new ErrorCode(1_001_004_013, "主表生成代码失败，原因：它的子表({})没有字段");
     // ========== 文件配置 1-001-006-000 ==========
     ErrorCode FILE_CONFIG_NOT_EXISTS = new ErrorCode(1_001_006_000, "文件配置不存在");