Merge branch 'master-jdk21' of https://gitee.com/zhijiantianya/ruoyi-vue-pro

# Conflicts: # yudao-module-crm/yudao-module-crm-biz/src/main/java/cn/iocoder/yudao/module/crm/controller/admin/business/vo/business/CrmBusinessTransferReqVO.java # yudao-module-crm/yudao-module-crm-biz/src/main/java/cn/iocoder/yudao/module/crm/controller/admin/contact/vo/CrmContactTransferReqVO.java # yudao-module-crm/yudao-module-crm-biz/src/main/java/cn/iocoder/yudao/module/crm/controller/admin/contract/vo/contract/CrmContractTransferReqVO.java # yudao-module-crm/yudao-module-crm-biz/src/main/java/cn/iocoder/yudao/module/crm/controller/admin/customer/vo/customer/CrmCustomerTransferReqVO.java # yudao-module-crm/yudao-module-crm-biz/src/main/java/cn/iocoder/yudao/module/crm/controller/admin/permission/CrmPermissionController.java # yudao-module-crm/yudao-module-crm-biz/src/main/java/cn/iocoder/yudao/module/crm/service/permission/CrmPermissionServiceImpl.java # yudao-module-crm/yudao-module-crm-biz/src/main/java/cn/iocoder/yudao/module/crm/service/receivable/CrmReceivablePlanServiceImpl.java # yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/cart/vo/AppCartAddReqVO.java
2024-04-12 19:18:30 +08:00
parent 048c6ed7b9 62c6c4b9bd
commit b44eab7f93
104 changed files with 3186 additions and 404 deletions
--- a/yudao-framework/yudao-spring-boot-starter-excel/src/main/java/cn/iocoder/yudao/framework/dict/core/DictFrameworkUtils.java
+++ b/yudao-framework/yudao-spring-boot-starter-excel/src/main/java/cn/iocoder/yudao/framework/dict/core/DictFrameworkUtils.java
@@ -11,6 +11,7 @@ import lombok.SneakyThrows;
 import lombok.extern.slf4j.Slf4j;

 import java.time.Duration;
+import java.util.List;

 /**
 * 字典工具类
@@ -24,6 +25,7 @@ public class DictFrameworkUtils {

    private static final DictDataRespDTO DICT_DATA_NULL = new DictDataRespDTO();

+    // TODO @puhui999：GET_DICT_DATA_CACHE、GET_DICT_DATA_LIST_CACHE、PARSE_DICT_DATA_CACHE 这 3 个缓存是有点重叠，可以思考下，有没可能减少 1 个。微信讨论好私聊，再具体改哈
    /**
     * 针对 {@link #getDictDataLabel(String, String)} 的缓存
     */
@@ -38,6 +40,20 @@ public class DictFrameworkUtils {

            });

+    /**
+     * 针对 {@link #getDictDataLabelList(String)} 的缓存
+     */
+    private static final LoadingCache<String, List<String>> GET_DICT_DATA_LIST_CACHE = CacheUtils.buildAsyncReloadingCache(
+            Duration.ofMinutes(1L), // 过期时间 1 分钟
+            new CacheLoader<String, List<String>>() {
+
+                @Override
+                public List<String> load(String dictType) {
+                    return dictDataApi.getDictDataLabelList(dictType);
+                }
+
+            });
+
    /**
     * 针对 {@link #parseDictDataValue(String, String)} 的缓存
     */
@@ -67,6 +83,11 @@ public class DictFrameworkUtils {
        return GET_DICT_DATA_CACHE.get(new KeyValue<>(dictType, value)).getLabel();
    }

+    @SneakyThrows
+    public static List<String> getDictDataLabelList(String dictType) {
+        return GET_DICT_DATA_LIST_CACHE.get(dictType);
+    }
+
    @SneakyThrows
    public static String parseDictDataValue(String dictType, String label) {
        return PARSE_DICT_DATA_CACHE.get(new KeyValue<>(dictType, label)).getValue();
--- a/yudao-framework/yudao-spring-boot-starter-excel/src/main/java/cn/iocoder/yudao/framework/excel/core/annotations/ExcelColumnSelect.java
+++ b/yudao-framework/yudao-spring-boot-starter-excel/src/main/java/cn/iocoder/yudao/framework/excel/core/annotations/ExcelColumnSelect.java
@@ -0,0 +1,27 @@
+package cn.iocoder.yudao.framework.excel.core.annotations;
+
+import java.lang.annotation.*;
+
+/**
+ * 给 Excel 列添加下拉选择数据
+ *
+ * 其中 {@link #dictType()} 和 {@link #functionName()} 二选一
+ *
+ * @author HUIHUI
+ */
+@Target({ElementType.FIELD})
+@Retention(RetentionPolicy.RUNTIME)
+@Inherited
+public @interface ExcelColumnSelect {
+
+    /**
+     * @return 字典类型
+     */
+    String dictType() default "";
+
+    /**
+     * @return 获取下拉数据源的方法名称
+     */
+    String functionName() default "";
+
+}
--- a/yudao-framework/yudao-spring-boot-starter-excel/src/main/java/cn/iocoder/yudao/framework/excel/core/enums/ExcelColumn.java
+++ b/yudao-framework/yudao-spring-boot-starter-excel/src/main/java/cn/iocoder/yudao/framework/excel/core/enums/ExcelColumn.java
@@ -1,27 +0,0 @@
-package cn.iocoder.yudao.framework.excel.core.enums;
-
-import lombok.AllArgsConstructor;
-import lombok.Getter;
-
-// TODO @puhui999：列表有办法通过 field name 么？主要考虑一个点，可能导入模版的顺序可能会变
-/**
- * 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;
-
-}
--- a/yudao-framework/yudao-spring-boot-starter-excel/src/main/java/cn/iocoder/yudao/framework/excel/core/function/ExcelColumnSelectFunction.java
+++ b/yudao-framework/yudao-spring-boot-starter-excel/src/main/java/cn/iocoder/yudao/framework/excel/core/function/ExcelColumnSelectFunction.java
@@ -0,0 +1,28 @@
+package cn.iocoder.yudao.framework.excel.core.function;
+
+import java.util.List;
+
+/**
+ * Excel 列下拉数据源获取接口
+ *
+ * 为什么不直接解析字典还搞个接口？考虑到有的下拉数据不是从字典中获取的所有需要做一个兼容
+
+ * @author HUIHUI
+ */
+public interface ExcelColumnSelectFunction {
+
+    /**
+     * 获得方法名称
+     *
+     * @return 方法名称
+     */
+    String getName();
+
+    /**
+     * 获得列下拉数据源
+     *
+     * @return 下拉数据源
+     */
+    List<String> getOptions();
+
+}
--- a/yudao-framework/yudao-spring-boot-starter-excel/src/main/java/cn/iocoder/yudao/framework/excel/core/handler/SelectSheetWriteHandler.java
+++ b/yudao-framework/yudao-spring-boot-starter-excel/src/main/java/cn/iocoder/yudao/framework/excel/core/handler/SelectSheetWriteHandler.java
@@ -2,25 +2,38 @@ package cn.iocoder.yudao.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 cn.iocoder.yudao.framework.common.core.KeyValue;
-import cn.iocoder.yudao.framework.excel.core.enums.ExcelColumn;
+import cn.iocoder.yudao.framework.dict.core.DictFrameworkUtils;
+import cn.iocoder.yudao.framework.excel.core.annotations.ExcelColumnSelect;
+import cn.iocoder.yudao.framework.excel.core.function.ExcelColumnSelectFunction;
+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 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.Comparator;
+import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
-import java.util.stream.Collectors;
+
+import static cn.iocoder.yudao.framework.common.util.collection.CollectionUtils.convertList;

 /**
 * 基于固定 sheet 实现下拉框
 *
 * @author HUIHUI
 */
+@Slf4j
 public class SelectSheetWriteHandler implements SheetWriteHandler {

    /**
@@ -36,21 +49,56 @@ public class SelectSheetWriteHandler implements SheetWriteHandler {

    private static final String DICT_SHEET_NAME = "字典sheet";

-    // TODO @puhui999：Map<ExcelColumn, List<String>> 可以么？之前用 keyvalue 的原因，返回给前端，无法用 linkedhashmap，默认 key 会乱序
-    private final List<KeyValue<ExcelColumn, List<String>>> selectMap;
+    /**
+     * key: 列 value: 下拉数据源
+     */
+    private final Map<Integer, List<String>> selectMap = new HashMap<>();

-    public SelectSheetWriteHandler(List<KeyValue<ExcelColumn, List<String>>> selectMap) {
-        if (CollUtil.isEmpty(selectMap)) {
-            this.selectMap = null;
+    public SelectSheetWriteHandler(Class<?> head) {
+        // 加载下拉数据获取接口
+        Map<String, ExcelColumnSelectFunction> beansMap = SpringUtil.getBeanFactory().getBeansOfType(ExcelColumnSelectFunction.class);
+        if (MapUtil.isEmpty(beansMap)) {
            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;
+        // 解析下拉数据
+        int colIndex = 0;
+        for (Field field : head.getDeclaredFields()) {
+            if (field.isAnnotationPresent(ExcelColumnSelect.class)) {
+                ExcelProperty excelProperty = field.getAnnotation(ExcelProperty.class);
+                if (excelProperty != null && excelProperty.index() != -1) {
+                    colIndex = excelProperty.index();
+                }
+                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<String, ExcelColumnSelectFunction> 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
@@ -62,18 +110,20 @@ public class SelectSheetWriteHandler implements SheetWriteHandler {
        // 1. 获取相应操作对象
        DataValidationHelper helper = writeSheetHolder.getSheet().getDataValidationHelper(); // 需要设置下拉框的 sheet 页的数据验证助手
        Workbook workbook = writeWorkbookHolder.getWorkbook(); // 获得工作簿
+        List<KeyValue<Integer, List<String>>> keyValues = convertList(selectMap.entrySet(), entry -> new KeyValue<>(entry.getKey(), entry.getValue()));
+        keyValues.sort(Comparator.comparing(item -> item.getValue().size())); // 升序不然创建下拉会报错

        // 2. 创建数据字典的 sheet 页
        Sheet dictSheet = workbook.createSheet(DICT_SHEET_NAME);
-        for (KeyValue<ExcelColumn, List<String>> keyValue : selectMap) {
+        for (KeyValue<Integer, List<String>> keyValue : keyValues) {
            int rowLength = keyValue.getValue().size();
-            // 2.1 设置字典 sheet 页的值 每一列一个字典项
+            // 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().getColNum()).setCellValue(keyValue.getValue().get(i));
+                row.createCell(keyValue.getKey()).setCellValue(keyValue.getValue().get(i));
            }
            // 2.2 设置单元格下拉选择
            setColumnSelect(writeSheetHolder, workbook, helper, keyValue);
@@ -84,10 +134,10 @@ public class SelectSheetWriteHandler implements SheetWriteHandler {
     * 设置单元格下拉选择
     */
    private static void setColumnSelect(WriteSheetHolder writeSheetHolder, Workbook workbook, DataValidationHelper helper,
-                                        KeyValue<ExcelColumn, List<String>> keyValue) {
+                                        KeyValue<Integer, List<String>> keyValue) {
        // 1.1 创建可被其他单元格引用的名称
        Name name = workbook.createName();
-        String excelColumn = keyValue.getKey().name();
+        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()); // 设置名称的名字
@@ -97,7 +147,7 @@ public class SelectSheetWriteHandler implements SheetWriteHandler {
        DataValidationConstraint constraint = helper.createFormulaListConstraint("dict" + keyValue.getKey()); // 设置引用约束
        // 设置下拉单元格的首行、末行、首列、末列
        CellRangeAddressList rangeAddressList = new CellRangeAddressList(FIRST_ROW, LAST_ROW,
-                keyValue.getKey().getColNum(), keyValue.getKey().getColNum());
+                keyValue.getKey(), keyValue.getKey());
        DataValidation validation = helper.createValidation(constraint, rangeAddressList);
        if (validation instanceof HSSFDataValidation) {
            validation.setSuppressDropDownArrow(false);
--- a/yudao-framework/yudao-spring-boot-starter-excel/src/main/java/cn/iocoder/yudao/framework/excel/core/util/ExcelUtils.java
+++ b/yudao-framework/yudao-spring-boot-starter-excel/src/main/java/cn/iocoder/yudao/framework/excel/core/util/ExcelUtils.java
@@ -1,7 +1,5 @@
 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;
@@ -34,27 +32,11 @@ public class ExcelUtils {
     */
    public static <T> void write(HttpServletResponse response, String filename, String sheetName,
                                 Class<T> head, List<T> data) throws IOException {
-        write(response, filename, sheetName, head, data, null);
-    }
-
-    /**
-     * 将列表以 Excel 响应给前端
-     *
-     * @param response  响应
-     * @param filename  文件名
-     * @param sheetName Excel sheet 名
-     * @param head      Excel head 头
-     * @param data      数据列表哦
-     * @param selectMap 下拉选择数据 Map<下拉所对应的列表名，下拉数据>
-     * @throws IOException 写入失败的情况
-     */
-    public static <T> void write(HttpServletResponse response, String filename, String sheetName,
-                                 Class<T> head, List<T> data, List<KeyValue<ExcelColumn, List<String>>> selectMap) throws IOException {
        // 输出 Excel
        EasyExcel.write(response.getOutputStream(), head)
                .autoCloseStream(false) // 不要自动关闭，交给 Servlet 自己处理
                .registerWriteHandler(new LongestMatchColumnWidthStyleStrategy()) // 基于 column 长度，自动适配。最大 255 宽度
-                .registerWriteHandler(new SelectSheetWriteHandler(selectMap)) // 基于固定 sheet 实现下拉框
+                .registerWriteHandler(new SelectSheetWriteHandler(head)) // 基于固定 sheet 实现下拉框
                .registerConverter(new LongStringConverter()) // 避免 Long 类型丢失精度
                .sheet(sheetName).doWrite(data);
        // 设置 header 和 contentType。写在最后的原因是，避免报错时，响应 contentType 已经被修改了