!345 增加Excel导出表格时级联下拉选项功能

* fixed(Excel工具类重载): * fixed(字典接口耦合问题): * fixed(调整接口): * fixed(切换条件不正确): * feat(优化注解|反向解析失效): * feat(增加注释|编写Demo|修复bug): * feat(Excel导出附带有下拉框):
2025-09-24 07:19:46 +08:00 · 2023-05-13 14:17:59 +00:00
parent 21570cbd33
commit 72882374be
11 changed files with 1106 additions and 13 deletions
--- a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestExcelController.java
+++ b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestExcelController.java
@ -1,12 +1,18 @@
 package com.ruoyi.demo.controller;

+import cn.dev33.satoken.annotation.SaIgnore;
 import cn.hutool.core.collection.CollUtil;
+import com.ruoyi.common.excel.ExcelResult;
 import com.ruoyi.common.utils.poi.ExcelUtil;
+import com.ruoyi.demo.domain.vo.ExportDemoVo;
+import com.ruoyi.demo.listener.ExportDemoListener;
+import com.ruoyi.demo.service.IExportExcelService;
 import lombok.AllArgsConstructor;
 import lombok.Data;
-import org.springframework.web.bind.annotation.GetMapping;
-import org.springframework.web.bind.annotation.RequestMapping;
-import org.springframework.web.bind.annotation.RestController;
+import lombok.RequiredArgsConstructor;
+import org.springframework.http.MediaType;
+import org.springframework.web.bind.annotation.*;
+import org.springframework.web.multipart.MultipartFile;

 import javax.servlet.http.HttpServletResponse;
 import java.util.ArrayList;
@ -20,9 +26,12 @@ import java.util.Map;
 * @author Lion Li
 */
@RestController
+@RequiredArgsConstructor
@RequestMapping("/demo/excel")
 public class TestExcelController {

+    private final IExportExcelService exportExcelService;
+
    /**
     * 单列表多数据
     */
@ -76,6 +85,28 @@ public class TestExcelController {
        ExcelUtil.exportTemplateMultiList(multiListMap, "多列表.xlsx", "excel/多列表.xlsx", response);
    }

+    /**
+     * 导出下拉框
+     *
+     * @param response /
+     */
+    @SaIgnore
+    @GetMapping("/exportWithOptions")
+    public void exportWithOptions(HttpServletResponse response) {
+        exportExcelService.exportWithOptions(response);
+    }
+
+    /**
+     * 导入表格
+     */
+    @SaIgnore
+    @PostMapping(value = "/importWithOptions", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
+    public List<ExportDemoVo> importWithOptions(@RequestPart("file") MultipartFile file) throws Exception {
+        // 处理解析结果
+        ExcelResult<ExportDemoVo> excelResult = ExcelUtil.importExcel(file.getInputStream(), ExportDemoVo.class, new ExportDemoListener());
+        return excelResult.getList();
+    }
+
    @Data
    @AllArgsConstructor
    static class TestObj1 {
--- a/ruoyi-demo/src/main/java/com/ruoyi/demo/domain/vo/ExportDemoVo.java
+++ b/ruoyi-demo/src/main/java/com/ruoyi/demo/domain/vo/ExportDemoVo.java
@ -0,0 +1,119 @@
+package com.ruoyi.demo.domain.vo;
+
+import com.alibaba.excel.annotation.ExcelIgnoreUnannotated;
+import com.alibaba.excel.annotation.ExcelProperty;
+import com.ruoyi.common.annotation.ExcelDictFormat;
+import com.ruoyi.common.annotation.ExcelEnumFormat;
+import com.ruoyi.common.convert.ExcelDictConvert;
+import com.ruoyi.common.convert.ExcelEnumConvert;
+import com.ruoyi.common.core.validate.AddGroup;
+import com.ruoyi.common.core.validate.EditGroup;
+import com.ruoyi.common.enums.UserStatus;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import javax.validation.constraints.NotEmpty;
+import javax.validation.constraints.NotNull;
+
+/**
+ * 带有下拉选的Excel导出
+ *
+ * @author Emil.Zhang
+ */
+@Data
+@ExcelIgnoreUnannotated
+@AllArgsConstructor
+@NoArgsConstructor
+public class ExportDemoVo {
+
+    private static final long serialVersionUID = 1L;
+
+    /**
+     * 用户昵称
+     */
+    @ExcelProperty(value = "用户名", index = 0)
+    @NotEmpty(message = "用户名不能为空", groups = AddGroup.class)
+    private String nickName;
+
+    /**
+     * 用户类型
+     * </p>
+     * 使用ExcelEnumFormat注解需要进行下拉选的部分
+     */
+    @ExcelProperty(value = "用户类型", index = 1, converter = ExcelEnumConvert.class)
+    @ExcelEnumFormat(enumClass = UserStatus.class, textField = "info")
+    @NotEmpty(message = "用户类型不能为空", groups = AddGroup.class)
+    private String userStatus;
+
+    /**
+     * 性别
+     * <p>
+     * 使用ExcelDictFormat注解需要进行下拉选的部分
+     */
+    @ExcelProperty(value = "性别", index = 2, converter = ExcelDictConvert.class)
+    @ExcelDictFormat(dictType = "sys_user_sex")
+    @NotEmpty(message = "性别不能为空", groups = AddGroup.class)
+    private String gender;
+
+    /**
+     * 手机号
+     */
+    @ExcelProperty(value = "手机号", index = 3)
+    @NotEmpty(message = "手机号不能为空", groups = AddGroup.class)
+    private String phoneNumber;
+
+    /**
+     * Email
+     */
+    @ExcelProperty(value = "Email", index = 4)
+    @NotEmpty(message = "Email不能为空", groups = AddGroup.class)
+    private String email;
+
+    /**
+     * 省
+     * <p>
+     * 级联下拉，仅判断是否选了
+     */
+    @ExcelProperty(value = "省", index = 5)
+    @NotNull(message = "省不能为空", groups = AddGroup.class)
+    private String province;
+
+    /**
+     * 数据库中的省ID
+     * </p>
+     * 处理完毕后再判断是否市正确的值
+     */
+    @NotNull(message = "请勿手动输入", groups = EditGroup.class)
+    private Integer provinceId;
+
+    /**
+     * 市
+     * <p>
+     * 级联下拉
+     */
+    @ExcelProperty(value = "市", index = 6)
+    @NotNull(message = "市不能为空", groups = AddGroup.class)
+    private String city;
+
+    /**
+     * 数据库中的市ID
+     */
+    @NotNull(message = "请勿手动输入", groups = EditGroup.class)
+    private Integer cityId;
+
+    /**
+     * 县
+     * <p>
+     * 级联下拉
+     */
+    @ExcelProperty(value = "县", index = 7)
+    @NotNull(message = "县不能为空", groups = AddGroup.class)
+    private String area;
+
+    /**
+     * 数据库中的县ID
+     */
+    @NotNull(message = "请勿手动输入", groups = EditGroup.class)
+    private Integer areaId;
+}
--- a/ruoyi-demo/src/main/java/com/ruoyi/demo/listener/ExportDemoListener.java
+++ b/ruoyi-demo/src/main/java/com/ruoyi/demo/listener/ExportDemoListener.java
@ -0,0 +1,68 @@
+package com.ruoyi.demo.listener;
+
+import cn.hutool.core.util.NumberUtil;
+import com.alibaba.excel.context.AnalysisContext;
+import com.ruoyi.common.core.validate.AddGroup;
+import com.ruoyi.common.core.validate.EditGroup;
+import com.ruoyi.common.excel.DefaultExcelListener;
+import com.ruoyi.common.excel.DropDownOptions;
+import com.ruoyi.common.utils.ValidatorUtils;
+import com.ruoyi.demo.domain.vo.ExportDemoVo;
+
+import java.util.List;
+
+/**
+ * Excel带下拉框的解析处理器
+ *
+ * @author Emil.Zhang
+ */
+public class ExportDemoListener extends DefaultExcelListener<ExportDemoVo> {
+
+    public ExportDemoListener() {
+        // 显示使用构造函数，否则将导致空指针
+        super(true);
+    }
+
+    @Override
+    public void invoke(ExportDemoVo data, AnalysisContext context) {
+        // 先校验必填
+        ValidatorUtils.validate(data, AddGroup.class);
+
+        // 处理级联下拉的部分
+        String province = data.getProvince();
+        String city = data.getCity();
+        String area = data.getArea();
+        // 本行用户选择的省
+        List<String> thisRowSelectedProvinceOption = DropDownOptions.analyzeOptionValue(province);
+        if (thisRowSelectedProvinceOption.size() == 2) {
+            String provinceIdStr = thisRowSelectedProvinceOption.get(1);
+            if (NumberUtil.isNumber(provinceIdStr)) {
+                // 严格要求数据的话可以在这里做与数据库相关的判断
+                // 例如判断省信息是否在数据库中存在等，建议结合RedisCache做缓存10s，减少数据库调用
+                data.setProvinceId(Integer.parseInt(provinceIdStr));
+            }
+        }
+        // 本行用户选择的市
+        List<String> thisRowSelectedCityOption = DropDownOptions.analyzeOptionValue(city);
+        if (thisRowSelectedCityOption.size() == 2) {
+            String cityIdStr = thisRowSelectedCityOption.get(1);
+            if (NumberUtil.isNumber(cityIdStr)) {
+                data.setCityId(Integer.parseInt(cityIdStr));
+            }
+        }
+        // 本行用户选择的县
+        List<String> thisRowSelectedAreaOption = DropDownOptions.analyzeOptionValue(area);
+        if (thisRowSelectedAreaOption.size() == 2) {
+            String areaIdStr = thisRowSelectedAreaOption.get(1);
+            if (NumberUtil.isNumber(areaIdStr)) {
+                data.setAreaId(Integer.parseInt(areaIdStr));
+            }
+        }
+
+        // 处理完毕以后判断是否符合规则
+        ValidatorUtils.validate(data, EditGroup.class);
+
+        // 添加到处理结果中
+        getExcelResult().getList().add(data);
+    }
+}
--- a/ruoyi-demo/src/main/java/com/ruoyi/demo/service/IExportExcelService.java
+++ b/ruoyi-demo/src/main/java/com/ruoyi/demo/service/IExportExcelService.java
@ -0,0 +1,18 @@
+package com.ruoyi.demo.service;
+
+import javax.servlet.http.HttpServletResponse;
+
+/**
+ * 导出下拉框Excel示例
+ *
+ * @author Emil.Zhang
+ */
+public interface IExportExcelService {
+
+    /**
+     * 导出下拉框
+     *
+     * @param response /
+     */
+    void exportWithOptions(HttpServletResponse response);
+}
--- a/ruoyi-demo/src/main/java/com/ruoyi/demo/service/impl/ExportExcelServiceImpl.java
+++ b/ruoyi-demo/src/main/java/com/ruoyi/demo/service/impl/ExportExcelServiceImpl.java
@ -0,0 +1,262 @@
+package com.ruoyi.demo.service.impl;
+
+import com.ruoyi.common.enums.UserStatus;
+import com.ruoyi.common.excel.DropDownOptions;
+import com.ruoyi.common.utils.poi.ExcelUtil;
+import com.ruoyi.demo.domain.vo.ExportDemoVo;
+import com.ruoyi.demo.service.IExportExcelService;
+import lombok.Data;
+import lombok.RequiredArgsConstructor;
+import org.springframework.stereotype.Service;
+
+import javax.servlet.http.HttpServletResponse;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.stream.Collectors;
+
+/**
+ * 导出下拉框Excel示例
+ *
+ * @author Emil.Zhang
+ */
+@Service
+@RequiredArgsConstructor
+public class ExportExcelServiceImpl implements IExportExcelService {
+
+    @Override
+    public void exportWithOptions(HttpServletResponse response) {
+        // 创建表格数据，业务中一般通过数据库查询
+        List<ExportDemoVo> excelDataList = new ArrayList<>();
+        for (int i = 0; i < 3; i++) {
+            // 模拟数据库中的一条数据
+            ExportDemoVo everyRowData = new ExportDemoVo();
+            everyRowData.setNickName("用户-" + i);
+            everyRowData.setUserStatus(UserStatus.OK.getCode());
+            everyRowData.setGender("1");
+            everyRowData.setPhoneNumber(String.format("175%08d", i));
+            everyRowData.setEmail(String.format("175%08d", i) + "@163.com");
+            everyRowData.setProvinceId(i);
+            everyRowData.setCityId(i);
+            everyRowData.setAreaId(i);
+            excelDataList.add(everyRowData);
+        }
+
+        // 通过@ExcelIgnoreUnannotated配合@ExcelProperty合理显示需要的列
+        // 并通过@DropDown注解指定下拉值，或者通过创建ExcelOptions来指定下拉框
+        // 使用ExcelOptions时建议指定列index，防止出现下拉列解析不对齐
+
+        // 首先从数据库中查询下拉框内的可选项
+        // 这里模拟查询结果
+        List<DemoCityData> provinceList = getProvinceList();
+        List<DemoCityData> cityList = getCityList(provinceList);
+        List<DemoCityData> areaList = getAreaList(cityList);
+
+        // 把所有的结果提取为规范的下拉选可选项
+        // 规范的一级省，用于级联省-市
+        List<String> provinceOptions =
+            provinceList.stream()
+                .map(everyProvince ->
+                    DropDownOptions.createOptionValue(
+                        everyProvince.getName(),
+                        everyProvince.getId()
+                    ))
+                .collect(Collectors.toList());
+        // 规范的二级市，用于级联省-市
+        Map<String, List<String>> provinceToCityOptions = new HashMap<>();
+        cityList.stream()
+            .collect(Collectors.groupingBy(DemoCityData::getPData))
+            .forEach((province, thisProvinceCityList) -> {
+                // 每个省下二级的市可选项
+                provinceToCityOptions.put(
+                    DropDownOptions.createOptionValue(province.getName(), province.getId()),
+                    thisProvinceCityList.stream()
+                        .map(everyCity ->
+                            DropDownOptions.createOptionValue(everyCity.getName(), everyCity.getId())
+                        )
+                        .collect(Collectors.toList())
+                );
+            });
+
+        // 规范的一级市，用于级联市-县
+        List<String> cityOptions = cityList.stream()
+            .map(everyCity ->
+                DropDownOptions.createOptionValue(
+                    everyCity.getName(),
+                    everyCity.getId()
+                ))
+            .collect(Collectors.toList());
+        // 规范的二级县，用于级联市-县
+        Map<String, List<String>> cityToAreaOptions = new HashMap<>();
+        areaList.stream()
+            .collect(Collectors.groupingBy(DemoCityData::getPData))
+            .forEach((city, thisCityAreaList) -> {
+                // 每个市下二级的县可选项
+                cityToAreaOptions.put(
+                    DropDownOptions.createOptionValue(city.getName(), city.getId()),
+                    thisCityAreaList.stream()
+                        .map(everyArea ->
+                            DropDownOptions.createOptionValue(everyArea.getName(), everyArea.getId())
+                        )
+                        .collect(Collectors.toList())
+                );
+            });
+
+        // 因为省市县三个都是联动，省级联市，市级联县，因此需要创建两个级联下拉，分别以省和市为判断依据创建
+        // 创建省-市级联
+        DropDownOptions provinceToCity = new DropDownOptions();
+        // 以省为一级
+        provinceToCity.setIndex(5);
+        // 以市为二级
+        provinceToCity.setNextIndex(6);
+        // 补充省的内容以及市的内容
+        provinceToCity.setOptions(provinceOptions);
+        provinceToCity.setNextOptions(provinceToCityOptions);
+
+        // 创建市-县级联
+        DropDownOptions cityToArea = new DropDownOptions();
+        cityToArea.setIndex(6);
+        cityToArea.setNextIndex(7);
+        cityToArea.setOptions(cityOptions);
+        cityToArea.setNextOptions(cityToAreaOptions);
+
+        // 把所有的下拉框存储
+        List<DropDownOptions> options = new ArrayList<>();
+        options.add(provinceToCity);
+        options.add(cityToArea);
+
+        // 到此为止所有的下拉框可选项已全部配置完毕
+
+        // 接下来需要将Excel中的展示数据转换为对应的下拉选
+        List<ExportDemoVo> outList = excelDataList.stream().map(everyRowData -> {
+            // 只需要处理没有使用@ExcelDictFormat注解的下拉框
+            // 一般来说，可以直接在数据库查询即查询出省市县信息，这里通过模拟操作赋值
+            everyRowData.setProvince(buildOptions(provinceList, everyRowData.getProvinceId()));
+            everyRowData.setCity(buildOptions(cityList, everyRowData.getCityId()));
+            everyRowData.setArea(buildOptions(areaList, everyRowData.getAreaId()));
+            return everyRowData;
+        }).collect(Collectors.toList());
+
+        ExcelUtil.exportExcel(outList, "下拉框示例", ExportDemoVo.class, response, options);
+    }
+
+    private String buildOptions(List<DemoCityData> cityDataList, Integer id) {
+        Map<Integer, List<DemoCityData>> groupByIdMap =
+            cityDataList.stream().collect(Collectors.groupingBy(DemoCityData::getId));
+        if (groupByIdMap.containsKey(id)) {
+            DemoCityData demoCityData = groupByIdMap.get(id).get(0);
+            return DropDownOptions.createOptionValue(demoCityData.getName(), demoCityData.getId());
+        } else {
+            return "";
+        }
+    }
+
+    /**
+     * 模拟查询数据库操作
+     *
+     * @return /
+     */
+    private List<DemoCityData> getProvinceList() {
+        List<DemoCityData> provinceList = new ArrayList<>();
+
+        // 实际业务中一般采用数据库读取的形式，这里直接拼接创建
+        provinceList.add(new DemoCityData(0, null, "安徽省"));
+        provinceList.add(new DemoCityData(1, null, "江苏省"));
+
+        return provinceList;
+    }
+
+    /**
+     * 模拟查找数据库操作，需要连带查询出省的数据
+     *
+     * @param provinceList 模拟的父省数据
+     * @return /
+     */
+    private List<DemoCityData> getCityList(List<DemoCityData> provinceList) {
+        List<DemoCityData> cityList = new ArrayList<>();
+
+        // 实际业务中一般采用数据库读取的形式，这里直接拼接创建
+        cityList.add(new DemoCityData(0, 0, "合肥市"));
+        cityList.add(new DemoCityData(1, 0, "芜湖市"));
+        cityList.add(new DemoCityData(2, 1, "南京市"));
+        cityList.add(new DemoCityData(3, 1, "无锡市"));
+        cityList.add(new DemoCityData(4, 1, "徐州市"));
+
+        selectParentData(provinceList, cityList);
+
+        return cityList;
+    }
+
+    /**
+     * 模拟查找数据库操作，需要连带查询出市的数据
+     *
+     * @param cityList 模拟的父市数据
+     * @return /
+     */
+    private List<DemoCityData> getAreaList(List<DemoCityData> cityList) {
+        List<DemoCityData> areaList = new ArrayList<>();
+
+        // 实际业务中一般采用数据库读取的形式，这里直接拼接创建
+        areaList.add(new DemoCityData(0, 0, "瑶海区"));
+        areaList.add(new DemoCityData(1, 0, "庐江区"));
+        areaList.add(new DemoCityData(2, 1, "南宁县"));
+        areaList.add(new DemoCityData(3, 1, "镜湖区"));
+        areaList.add(new DemoCityData(4, 2, "玄武区"));
+        areaList.add(new DemoCityData(5, 2, "秦淮区"));
+        areaList.add(new DemoCityData(6, 3, "宜兴市"));
+        areaList.add(new DemoCityData(7, 3, "新吴区"));
+        areaList.add(new DemoCityData(8, 4, "鼓楼区"));
+        areaList.add(new DemoCityData(9, 4, "丰县"));
+
+        selectParentData(cityList, areaList);
+
+        return areaList;
+    }
+
+    /**
+     * 模拟数据库的查询父数据操作
+     *
+     * @param parentList /
+     * @param sonList    /
+     */
+    private void selectParentData(List<DemoCityData> parentList, List<DemoCityData> sonList) {
+        Map<Integer, List<DemoCityData>> parentGroupByIdMap =
+            parentList.stream().collect(Collectors.groupingBy(DemoCityData::getId));
+
+        sonList.forEach(everySon -> {
+            if (parentGroupByIdMap.containsKey(everySon.getPid())) {
+                everySon.setPData(parentGroupByIdMap.get(everySon.getPid()).get(0));
+            }
+        });
+    }
+
+    /**
+     * 模拟的数据库省市县
+     */
+    @Data
+    private static class DemoCityData {
+        /**
+         * 数据库id字段
+         */
+        private Integer id;
+        /**
+         * 数据库pid字段
+         */
+        private Integer pid;
+        /**
+         * 数据库name字段
+         */
+        private String name;
+        /**
+         * MyBatisPlus连带查询父数据
+         */
+        private DemoCityData pData;
+
+        public DemoCityData(Integer id, Integer pid, String name) {
+            this.id = id;
+            this.pid = pid;
+            this.name = name;
+        }
+    }
+}