Pre Merge pull request !356 from panxiaoyang/readConverterEnum

ruoyi-api/ruoyi-api-system/src/main/java/com/ruoyi/system/api/domain/SysDictData.java

@@ -2,6 +2,7 @@ package com.ruoyi.system.api.domain;
 
 import javax.validation.constraints.NotBlank;
 import javax.validation.constraints.Size;
+import com.ruoyi.system.api.emun.EnableStatusEnum;
 import org.apache.commons.lang3.builder.ToStringBuilder;
 import org.apache.commons.lang3.builder.ToStringStyle;
 import com.ruoyi.common.core.annotation.Excel;
@@ -48,8 +49,11 @@ public class SysDictData extends BaseEntity
     @Excel(name = "是否默认", readConverterExp = "Y=是,N=否")
     private String isDefault;
 
-    /** 状态（0正常 1停用） */
+    /**
-    @Excel(name = "状态", readConverterExp = "0=正常,1=停用")
+     * 状态（0正常 1停用）
+     * @see EnableStatusEnum
+     **/
+    @Excel(name = "状态", readConverterEnum = EnableStatusEnum.class)
     private String status;
 
     public Long getDictCode()

ruoyi-api/ruoyi-api-system/src/main/java/com/ruoyi/system/api/domain/SysDictType.java

@@ -3,6 +3,7 @@ package com.ruoyi.system.api.domain;
 import javax.validation.constraints.NotBlank;
 import javax.validation.constraints.Pattern;
 import javax.validation.constraints.Size;
+import com.ruoyi.system.api.emun.EnableStatusEnum;
 import org.apache.commons.lang3.builder.ToStringBuilder;
 import org.apache.commons.lang3.builder.ToStringStyle;
 import com.ruoyi.common.core.annotation.Excel;
@@ -30,8 +31,11 @@ public class SysDictType extends BaseEntity
     @Excel(name = "字典类型")
     private String dictType;
 
-    /** 状态（0正常 1停用） */
+    /**
-    @Excel(name = "状态", readConverterExp = "0=正常,1=停用")
+     * 状态（0正常 1停用）
+     * @see EnableStatusEnum
+     **/
+    @Excel(name = "状态", readConverterEnum = EnableStatusEnum.class)
     private String status;
 
     public Long getDictId()

ruoyi-api/ruoyi-api-system/src/main/java/com/ruoyi/system/api/domain/SysRole.java

@@ -4,6 +4,7 @@ import java.util.Set;
 import javax.validation.constraints.NotBlank;
 import javax.validation.constraints.NotNull;
 import javax.validation.constraints.Size;
+import com.ruoyi.system.api.emun.EnableStatusEnum;
 import org.apache.commons.lang3.builder.ToStringBuilder;
 import org.apache.commons.lang3.builder.ToStringStyle;
 import com.ruoyi.common.core.annotation.Excel;
@@ -45,8 +46,11 @@ public class SysRole extends BaseEntity
     /** 部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示 ） */
     private boolean deptCheckStrictly;
 
-    /** 角色状态（0正常 1停用） */
+    /**
-    @Excel(name = "角色状态", readConverterExp = "0=正常,1=停用")
+     * 角色状态（0正常 1停用）
+     * @see EnableStatusEnum
+     **/
+    @Excel(name = "角色状态", readConverterEnum = EnableStatusEnum.class)
     private String status;
 
     /** 删除标志（0代表存在 2代表删除） */

ruoyi-api/ruoyi-api-system/src/main/java/com/ruoyi/system/api/domain/SysUser.java

@@ -3,6 +3,7 @@ package com.ruoyi.system.api.domain;
 import java.util.Date;
 import java.util.List;
 import javax.validation.constraints.*;
+import com.ruoyi.system.api.emun.EnableStatusEnum;
 import org.apache.commons.lang3.builder.ToStringBuilder;
 import org.apache.commons.lang3.builder.ToStringStyle;
 import com.ruoyi.common.core.annotation.Excel;
@@ -55,8 +56,11 @@ public class SysUser extends BaseEntity
     /** 密码 */
     private String password;
 
-    /** 帐号状态（0正常 1停用） */
+    /**
-    @Excel(name = "帐号状态", readConverterExp = "0=正常,1=停用")
+     * 帐号状态（0正常 1停用）
+     * @see EnableStatusEnum
+     **/
+    @Excel(name = "帐号状态", readConverterEnum = EnableStatusEnum.class)
     private String status;
 
     /** 删除标志（0代表存在 2代表删除） */

ruoyi-api/ruoyi-api-system/src/main/java/com/ruoyi/system/api/emun/EnableStatusEnum.java

@@ -0,0 +1,69 @@
+package com.ruoyi.system.api.emun;
+
+import com.ruoyi.common.core.annotation.DictTag;
+
+/**
+ * ===========================================
+ * Copyright  2024 xiaoyang
+ * All rights reserved
+ * <p>项 目 名 :RuoYi-Cloud</p>
+ * <p>文 件 名 :EnableStatusEnum</p>
+ * <p>描    述 :启用状态枚举</p>
+ *
+ * @author :xiaoyang
+ * @date : 2024/1/12 20:26
+ * ============================================
+ */
+public enum EnableStatusEnum implements DictTag
+{
+    /**
+     * 正常
+     */
+    enable("0", "正常"),
+    /**
+     * 停用
+     */
+    disable("1", "停用");
+
+    private String code;
+
+    private String name;
+    ;
+
+    EnableStatusEnum(String code, String name)
+    {
+        this.code = code;
+        this.name = name;
+    }
+    @Override
+    public String getKey()
+    {
+        return code;
+    }
+    /**
+     * 获取名称
+     *
+     * @return
+     */
+    @Override
+    public String getName()
+    {
+        return name;
+    }
+    /**
+     * 获取编码
+     *
+     * @return
+     */
+    public String getCode()
+    {
+        return code;
+    }
+
+    /**
+     * 获取键(集成字典类型)
+     *
+     * @return
+     */
+
+}

ruoyi-common/ruoyi-common-core/src/main/java/com/ruoyi/common/core/annotation/DictTag.java

@@ -0,0 +1,30 @@
+package com.ruoyi.common.core.annotation;
+
+/**
+ * ===========================================
+ * Copyright  2024 xiaoyang
+ * All rights reserved
+ * <p>项 目 名 :RuoYi-Cloud</p>
+ * <p>文 件 名 :DictTag</p>
+ * <p>描    述 :字典类型</p>
+ *
+ * @author :xiaoyang
+ * @date : 2024/1/12 20:27
+ * ============================================
+ */
+public interface DictTag
+{
+    /**
+     * 绑定键
+     *
+     * @return 绑定的键值
+     */
+    String getKey();
+
+    /**
+     * 绑定名称
+     *
+     * @return 绑定的名称
+     */
+    String getName();
+}

ruoyi-common/ruoyi-common-core/src/main/java/com/ruoyi/common/core/annotation/Excel.java

@@ -37,6 +37,14 @@ public @interface Excel
      * 读取内容转表达式 (如: 0=男,1=女,2=未知)
      */
     public String readConverterExp() default "";
+    /**
+     * 字典转换器的枚举，该枚举需要实现DictTag标签,否则不生效
+     * <p>
+     * 枚举字典有值时,优先取枚举字典
+     *
+     * @return 字典转换枚举
+     */
+    Class<? extends Enum> readConverterEnum() default Enum.class;
 
     /**
      * 分隔符，读取字符串组内容

ruoyi-common/ruoyi-common-core/src/main/java/com/ruoyi/common/core/utils/DateUtils.java

@@ -8,8 +8,10 @@ import java.time.LocalDateTime;
 import java.time.LocalTime;
 import java.time.ZoneId;
 import java.time.ZonedDateTime;
+import java.time.format.DateTimeFormatter;
 import java.util.Date;
 import org.apache.commons.lang3.time.DateFormatUtils;
+import org.springframework.util.StringUtils;
 
 /**
  * 时间工具类
@@ -127,6 +129,82 @@ public class DateUtils extends org.apache.commons.lang3.time.DateUtils
         }
     }
 
+    /**
+     * 日期型字符串转化为日期 格式
+     */
+    public static LocalDate parseLocalDate(Object str)
+    {
+        if (str == null)
+        {
+            return null;
+        }
+        try
+        {
+            return toLocalDate(str.toString(), parsePatterns);
+        }
+        catch (ParseException e)
+        {
+            return null;
+        }
+    }
+    /**
+     * 日期型字符串转化为日期 格式
+     */
+    public static LocalDateTime parseLocalDateTime(Object str)
+    {
+        if (str == null)
+        {
+            return null;
+        }
+        try
+        {
+            return toLocalDateTime(str.toString(), parsePatterns);
+        }
+        catch (ParseException e)
+        {
+            return null;
+        }
+    }
+    public static LocalDate toLocalDate(String dateTime, String... formats) throws ParseException{
+        if (StringUtils.isEmpty(dateTime)) {
+            return null;
+        }
+        if (formats == null || formats.length == 0) {
+            formats = new String[]{"yyyy-MM-dd"};
+        }
+        for(String format:formats){
+            try
+            {
+                DateTimeFormatter df = DateTimeFormatter.ofPattern(format);
+                LocalDate ldt = LocalDate.parse(dateTime, df);
+                return ldt;
+            }catch (Exception ignored)
+            {
+
+            }
+        }
+        throw new ParseException("转换异常",formats.length);
+    }
+    public static LocalDateTime toLocalDateTime(String dateTime, String... formats) throws ParseException{
+        if (StringUtils.isEmpty(dateTime)) {
+            return null;
+        }
+        if (formats == null || formats.length == 0) {
+            formats = new String[]{"yyyy-MM-dd HH:mm:ss"};
+        }
+        for(String format:formats){
+            try
+            {
+                DateTimeFormatter df = DateTimeFormatter.ofPattern(format);
+                LocalDateTime ldt = LocalDateTime.parse(dateTime, df);
+                return ldt;
+            }catch (Exception ignored)
+            {
+
+            }
+        }
+        throw new ParseException("转换异常",formats.length);
+    }
     /**
      * 获取服务器启动时间
      */

ruoyi-common/ruoyi-common-core/src/main/java/com/ruoyi/common/core/utils/poi/ExcelUtil.java

@@ -20,6 +20,7 @@ import java.util.Map;
 import java.util.Set;
 import java.util.stream.Collectors;
 import javax.servlet.http.HttpServletResponse;
+import com.ruoyi.common.core.annotation.DictTag;
 import org.apache.commons.lang3.ArrayUtils;
 import org.apache.commons.lang3.RegExUtils;
 import org.apache.commons.lang3.reflect.FieldUtils;
@@ -292,6 +293,39 @@ public class ExcelUtil<T>
         return importExcel(StringUtils.EMPTY, is, titleNum);
     }
 
+    /**
+     * 初始excel值转换为字段的转换器
+     * @return 值和字段的映射表
+     */
+    public Map<String,String> initValueToFieldConversionMap(Excel attr){
+        HashMap<String, String> conversionMap = new HashMap<>();
+        //如果存在转换exp,提取转换exp
+        if (StringUtils.isNotEmpty(attr.readConverterExp()))
+        {
+            String allList = attr.readConverterExp();
+            String[] split = allList.split(",");
+            for (String dictTagItem : split)
+            {
+                String[] split1 = dictTagItem.split("=");
+                conversionMap.put(split1[1], split1[0]);
+            }
+        }
+        //字段转换初始化(通过枚举字段转换)
+        if (!attr.readConverterEnum().getName().equals(Enum.class.getName()))
+        {
+            Class<? extends Enum> aClass = attr.readConverterEnum();
+            Object[] enumConstants = aClass.getEnumConstants();
+            for (Object enumItem : enumConstants)
+            {
+                if (enumItem instanceof DictTag)
+                {
+                    DictTag dictTag = (DictTag) enumItem;
+                    conversionMap.put(dictTag.getName(), dictTag.getKey());
+                }
+            }
+        }
+        return conversionMap;
+    }
     /**
      * 对excel表单指定表格索引名转换成list
      *
@@ -336,6 +370,8 @@ public class ExcelUtil<T>
             // 有数据时才处理 得到类的所有field.
             List<Object[]> fields = this.getFields();
             Map<Integer, Object[]> fieldsMap = new HashMap<Integer, Object[]>();
+            // 定义所有的excel值和java对象的值的转换映射表
+            Map<String,Map<String,String>> allFieldConversionMap=new HashMap<>();
             for (Object[] objects : fields)
             {
                 Excel attr = (Excel) objects[1];
@@ -343,6 +379,13 @@ public class ExcelUtil<T>
                 if (column != null)
                 {
                     fieldsMap.put(column, objects);
+                    //如果存在解析键值映射,则直接初始化
+                    if(StringUtils.isNotEmpty(attr.readConverterExp())
+                    || !attr.readConverterEnum().getName().equals(Enum.class.getName()))
+                    {
+                        Map<String, String> fieldConversionMap = initValueToFieldConversionMap(attr);
+                        allFieldConversionMap.put(attr.name(),fieldConversionMap);
+                    }
                 }
             }
             for (int i = titleNum + 1; i <= rows; i++)
@@ -417,6 +460,14 @@ public class ExcelUtil<T>
                             val = DateUtil.getJavaDate((Double) val);
                         }
                     }
+                    else if (LocalDate.class == fieldType)
+                    {
+                        val = DateUtils.parseLocalDate(val);
+                    }
+                    else if (LocalDateTime.class == fieldType)
+                    {
+                        val = DateUtils.parseLocalDateTime(val);
+                    }
                     else if (Boolean.TYPE == fieldType || Boolean.class == fieldType)
                     {
                         val = Convert.toBool(val, false);
@@ -428,9 +479,9 @@ public class ExcelUtil<T>
                         {
                             propertyName = field.getName() + "." + attr.targetAttr();
                         }
-                        if (StringUtils.isNotEmpty(attr.readConverterExp()))
+                        if (allFieldConversionMap.get(attr.name())!=null)
                         {
-                            val = reverseByExp(Convert.toStr(val), attr.readConverterExp(), attr.separator());
+                            val = getConvertValueByExpMap(Convert.toStr(val), attr.separator(), allFieldConversionMap.get(attr.name()));
                         }
                         else if (!attr.handler().equals(ExcelHandlerAdapter.class))
                         {
@@ -533,7 +584,8 @@ public class ExcelUtil<T>
         for (int index = 0; index < sheetNo; index++)
         {
             createSheet(sheetNo, index);
-
+            //字段转换列表<列下标,<待转值,转换值>>
+            Map<Integer, Map<String, String>> fieldConversionMap = new HashMap<>();
             // 产生一行
             Row row = sheet.createRow(rownum);
             int column = 0;
@@ -547,17 +599,17 @@ public class ExcelUtil<T>
                     for (Field subField : subFields)
                     {
                         Excel subExcel = subField.getAnnotation(Excel.class);
-                        this.createHeadCell(subExcel, row, column++);
+                        this.createHeadCellAndInitFieldConversion(subExcel, row, column++,fieldConversionMap);
                     }
                 }
                 else
                 {
-                    this.createHeadCell(excel, row, column++);
+                    this.createHeadCellAndInitFieldConversion(excel, row, column++,fieldConversionMap);
                 }
             }
             if (Type.EXPORT.equals(type))
             {
-                fillExcelData(index, row);
+                fillExcelData(index, row, fieldConversionMap);
                 addStatisticsRow();
             }
         }
@@ -568,9 +620,10 @@ public class ExcelUtil<T>
      *
      * @param index 序号
      * @param row 单元格行
+     * @param fieldConversionMap 字段转换Map
      */
     @SuppressWarnings("unchecked")
-    public void fillExcelData(int index, Row row)
+    public void fillExcelData(int index, Row row, Map<Integer, Map<String, String>> fieldConversionMap)
     {
         int startNo = index * sheetSize;
         int endNo = Math.min(startNo + sheetSize, list.size());
@@ -618,7 +671,7 @@ public class ExcelUtil<T>
                             {
                                 subField.setAccessible(true);
                                 Excel attr = subField.getAnnotation(Excel.class);
-                                this.addCell(attr, row, (T) obj, subField, column + subIndex);
+                                this.addCell(attr, row, (T) obj, subField, column + subIndex, fieldConversionMap);
                             }
                             subIndex++;
                         }
@@ -628,7 +681,7 @@ public class ExcelUtil<T>
                 }
                 else
                 {
-                    this.addCell(excel, row, vo, field, column++);
+                    this.addCell(excel, row, vo, field, column++, fieldConversionMap);
                 }
             }
         }
@@ -760,9 +813,9 @@ public class ExcelUtil<T>
     }
 
     /**
-     * 创建单元格
+     * 创建首行单元格,并且初始化字段的转换
      */
-    public Cell createHeadCell(Excel attr, Row row, int column)
+    public Cell createHeadCellAndInitFieldConversion(Excel attr, Row row, int column, Map<Integer, Map<String, String>> fieldConversionMap)
     {
         // 创建列
         Cell cell = row.createCell(column);
@@ -770,6 +823,35 @@ public class ExcelUtil<T>
         cell.setCellValue(attr.name());
         setDataValidation(attr, row, column);
         cell.setCellStyle(styles.get(StringUtils.format("header_{}_{}", attr.headerColor(), attr.headerBackgroundColor())));
+        //字段转换初始化(通过readConverterExp字符转换)
+        if (StringUtils.isNotEmpty(attr.readConverterExp()))
+        {
+            HashMap<String, String> conversionMap = new HashMap<>();
+            String allList = attr.readConverterExp();
+            String[] split = allList.split(",");
+            for (String dictTagItem : split)
+            {
+                String[] split1 = dictTagItem.split("=");
+                conversionMap.put(split1[0], split1[1]);
+            }
+            fieldConversionMap.put(column, conversionMap);
+        }
+        //字段转换初始化(通过枚举字段转换)
+        if (!attr.readConverterEnum().getName().equals(Enum.class.getName()))
+        {
+            HashMap<String, String> conversionMap = new HashMap<>();
+            Class<? extends Enum> aClass = attr.readConverterEnum();
+            Object[] enumConstants = aClass.getEnumConstants();
+            for (Object enumItem : enumConstants)
+            {
+                if (enumItem instanceof DictTag)
+                {
+                    DictTag dictTag = (DictTag) enumItem;
+                    conversionMap.put(dictTag.getKey(), dictTag.getName());
+                }
+            }
+            fieldConversionMap.put(column, conversionMap);
+        }
         if (isSubList())
         {
             // 填充默认样式，防止合并单元格样式失效
@@ -885,8 +967,15 @@ public class ExcelUtil<T>
 
     /**
      * 添加单元格
+     * @param attr               当前单元格表注解
+     * @param row                当前单元格归属行
+     * @param vo                 单元格内容
+     * @param field              单元格字段
+     * @param column             单元格的列号
+     * @param fieldConversionMap 所有单元格的解析值字典
+     * @return 生成后的单元格
      */
-    public Cell addCell(Excel attr, Row row, T vo, Field field, int column)
+    public Cell addCell(Excel attr, Row row, T vo, Field field, int column,Map<Integer, Map<String, String>> fieldConversionMap)
     {
         Cell cell = null;
         try
@@ -908,15 +997,14 @@ public class ExcelUtil<T>
                 // 用于读取对象中的属性
                 Object value = getTargetValue(vo, field, attr);
                 String dateFormat = attr.dateFormat();
-                String readConverterExp = attr.readConverterExp();
                 String separator = attr.separator();
                 if (StringUtils.isNotEmpty(dateFormat) && StringUtils.isNotNull(value))
                 {
                     cell.setCellValue(parseDateToStr(dateFormat, value));
                 }
-                else if (StringUtils.isNotEmpty(readConverterExp) && StringUtils.isNotNull(value))
+                else if (fieldConversionMap.get(column)!=null && StringUtils.isNotNull(value))
                 {
-                    cell.setCellValue(convertByExp(Convert.toStr(value), readConverterExp, separator));
+                    cell.setCellValue(getConvertValueByExpMap(Convert.toStr(value), separator, fieldConversionMap.get(column)));
                 }
                 else if (value instanceof BigDecimal && -1 != attr.scale())
                 {
@@ -1031,77 +1119,34 @@ public class ExcelUtil<T>
     }
 
     /**
-     * 解析导出值 0=男,1=女,2=未知
+     * 通过解析字典,寻找解析值
-     *
-     * @param propertyValue 参数值
-     * @param converterExp 翻译注解
-     * @param separator 分隔符
-     * @return 解析后值
-     */
-    public static String convertByExp(String propertyValue, String converterExp, String separator)
-    {
-        StringBuilder propertyString = new StringBuilder();
-        String[] convertSource = converterExp.split(",");
-        for (String item : convertSource)
-        {
-            String[] itemArray = item.split("=");
-            if (StringUtils.containsAny(propertyValue, separator))
-            {
-                for (String value : propertyValue.split(separator))
-                {
-                    if (itemArray[0].equals(value))
-                    {
-                        propertyString.append(itemArray[1] + separator);
-                        break;
-                    }
-                }
-            }
-            else
-            {
-                if (itemArray[0].equals(propertyValue))
-                {
-                    return itemArray[1];
-                }
-            }
-        }
-        return StringUtils.stripEnd(propertyString.toString(), separator);
-    }
-
-    /**
-     * 反向解析值 男=0,女=1,未知=2
      *
-     * @param propertyValue 参数值
+     * @param propertyValue 解析前的值
-     * @param converterExp 翻译注解
      * @param separator     分隔符
+     * @param conversionMap 解析字典
      * @return 解析后值
      */
-    public static String reverseByExp(String propertyValue, String converterExp, String separator)
+    public static String getConvertValueByExpMap(String propertyValue,String separator,Map<String,String> conversionMap){
-    {
+        List<String> afterConversionValueList=new ArrayList<>();
-        StringBuilder propertyString = new StringBuilder();
+        //如果某个对象值为"1,2,3",则根据转换Map表全都进修转换
-        String[] convertSource = converterExp.split(",");
-        for (String item : convertSource)
-        {
-            String[] itemArray = item.split("=");
         if (StringUtils.containsAny(propertyValue, separator))
         {
             for (String value : propertyValue.split(separator))
             {
-                    if (itemArray[1].equals(value))
+                String conversionValue = conversionMap.get(value);
+                if(StringUtils.isNotEmpty(conversionValue))
                 {
-                        propertyString.append(itemArray[0] + separator);
+                    afterConversionValueList.add(conversionValue);
-                        break;
                 }
             }
-            }
+        }else
-            else
         {
-                if (itemArray[1].equals(propertyValue))
+            if(StringUtils.isNotEmpty(conversionMap.get(propertyValue)))
             {
-                    return itemArray[0];
+                afterConversionValueList.add(conversionMap.get(propertyValue));
-                }
             }
         }
-        return StringUtils.stripEnd(propertyString.toString(), separator);
+        return String.join(separator,afterConversionValueList);
     }
 
     /**

ruoyi-modules/ruoyi-system/src/main/java/com/ruoyi/system/domain/SysPost.java

@@ -3,6 +3,7 @@ package com.ruoyi.system.domain;
 import javax.validation.constraints.NotBlank;
 import javax.validation.constraints.NotNull;
 import javax.validation.constraints.Size;
+import com.ruoyi.system.api.emun.EnableStatusEnum;
 import org.apache.commons.lang3.builder.ToStringBuilder;
 import org.apache.commons.lang3.builder.ToStringStyle;
 import com.ruoyi.common.core.annotation.Excel;
@@ -34,8 +35,11 @@ public class SysPost extends BaseEntity
     @Excel(name = "岗位排序")
     private Integer postSort;
 
-    /** 状态（0正常 1停用） */
+    /**
-    @Excel(name = "状态", readConverterExp = "0=正常,1=停用")
+     * 状态（0正常 1停用）
+     * @see EnableStatusEnum
+     **/
+    @Excel(name = "状态", readConverterEnum = EnableStatusEnum.class)
     private String status;
 
     /** 用户是否存在此岗位标识 默认不存在 */