apache poi 实现下拉框联动校验

apache poi 提供了 DataValidation​ 接口 让我们可以轻松实现 Excel 下拉框数据局校验。但是下拉框联动校验是无法直接通过 DataValidation ​实现,所以我们可以通过其他方式间接实现。

步骤如下:

  1. 创建一个隐藏 sheet

     private static void createHiddenSheet(List<String> provinceList, Map<String, String[]> regionMap, Workbook workbook) {
            String hiddenSheetName = "region";
            Sheet hiddenSheet = workbook.createSheet(hiddenSheetName);
    
            // 这里也可以设置 hidden 为 false 这样可以直接看到 sheet 内容
            workbook.setSheetHidden(workbook.getSheetIndex(hiddenSheet), true);
        }
    
  2. 将数据放入隐藏 sheet

    		int rowNum = 0;
            // 第一行存放省数据
            Row row = hiddenSheet.createRow(rowNum);
            for (int i = 0; i < provinceList.size(); i++) {
                Cell cell = row.createCell(i);
                cell.setCellValue(provinceList.get(i));
            }
    
            rowNum++;
            for (String key : regionMap.keySet()) {
                String[] dataArray = regionMap.get(key);
                // 循环创建行,每行存放一个数组
                row = hiddenSheet.createRow(rowNum);
                // key 放在每行第一个,value 放在每行的后面
                Cell keyCell = row.createCell(0);
                keyCell.setCellValue(key);
                for (int i = 0, length = dataArray.length; i < length; i++) {
                    Cell cell = row.createCell(i + 1);
                    cell.setCellValue(dataArray[i]);
                }
                Name name = workbook.createName();
                // 将key 设置为下拉框的key
                name.setNameName(key);
                String formula = hiddenSheetName + "!$B$" + (rowNum + 1) + ":$" + (convertNumberToLetter(dataArray.length + 1)) + "$" + (rowNum + 1);
                name.setRefersToFormula(formula);
    
                // 可以将formula 放在最后一列
                Cell formulaCell = row.createCell(dataArray.length + 1);
                formulaCell.setCellValue(formula);
    
                rowNum++;
            }
    
  3. 在主 sheet 中使用 formula 来使用隐藏 sheet 的数据

        DataValidationHelper helper = mainSheet.getDataValidationHelper();
    
        // 设置省份下拉框
        CellRangeAddressList provRangeAddressList = new CellRangeAddressList(1, 1000, 0, 0);
        // formula 为  region!$A$1:$E$1
        DataValidationConstraint dvConstraint = helper.createFormulaListConstraint("region!$A$1:$" + (convertNumberToLetter(provinceList.size())) + "$1");
        DataValidation provinceDataValidation = helper.createValidation(dvConstraint, provRangeAddressList);
    
    
        provinceDataValidation.setSuppressDropDownArrow(true);
        mainSheet.addValidationData(provinceDataValidation);
    
    
  4. 设置联动下拉框 DataValidation

     // 设置市下拉框  firstCol lastCol 根据实际情况设置
     CellRangeAddressList cityRange = new CellRangeAddressList(1, 1000, 1, 1);
     DataValidationConstraint cityConstraint = helper.createFormulaListConstraint("INDIRECT(A2)");
     DataValidation cityValidation = helper.createValidation(cityConstraint, cityRange);
     mainSheet.addValidationData(cityValidation);
    
    
     // 设置县下拉框 firstCol lastCol 根据实际情况设置
     CellRangeAddressList districtRange = new CellRangeAddressList(1, 1000, 2, 2);
     DataValidation districtValidation = helper.createValidation(helper.createFormulaListConstraint("INDIRECT(B2)"), districtRange);
     mainSheet.addValidationData(districtValidation);
    
  5. 完整代码如下:

    package com.shang;
    
    import org.apache.poi.ss.usermodel.*;
    import org.apache.poi.ss.util.CellRangeAddressList;
    import org.apache.poi.xssf.usermodel.XSSFWorkbook;
    
    import java.io.FileOutputStream;
    import java.util.Arrays;
    import java.util.HashMap;
    import java.util.List;
    import java.util.Map;
    
    /**
     * @author: shangwei
     * @date: 2024/11/3 13:01
     */
    public class ExcelUtil {
    
        public static void createExcel(String path, List<String> provinceList, Map<String, String[]> regionMap) {
            try {
                Workbook workbook = new XSSFWorkbook();
                createHiddenSheet(provinceList, regionMap, workbook);
    
    
                Sheet mainSheet = workbook.createSheet("mainSheet");
                // 主sheet 第一行数据
                String[] titles = {"省", "市", "县"};
                int rowNum = 0;
                Row row = mainSheet.createRow(rowNum);
                for (int i = 0; i < titles.length; i++) {
                    Cell cell = row.createCell(i);
                    cell.setCellValue(titles[i]);
                }
    
                DataValidationHelper helper = mainSheet.getDataValidationHelper();
    
                // 设置省份下拉框
                CellRangeAddressList provRangeAddressList = new CellRangeAddressList(1, 1000, 0, 0);
                // formula 为  region!$A$1:$E$1
                DataValidationConstraint dvConstraint = helper.createFormulaListConstraint("region!$A$1:$" + (convertNumberToLetter(provinceList.size())) + "$1");
                DataValidation provinceDataValidation = helper.createValidation(dvConstraint, provRangeAddressList);
    
                provinceDataValidation.setSuppressDropDownArrow(true);
                mainSheet.addValidationData(provinceDataValidation);
    
                // 设置市下拉框  firstCol lastCol 根据实际情况设置
                CellRangeAddressList cityRange = new CellRangeAddressList(1, 1000, 1, 1);
                DataValidationConstraint cityConstraint = helper.createFormulaListConstraint("INDIRECT(A2)");
                DataValidation cityValidation = helper.createValidation(cityConstraint, cityRange);
                mainSheet.addValidationData(cityValidation);
    
    
                // 设置县下拉框 firstCol lastCol 根据实际情况设置
                CellRangeAddressList districtRange = new CellRangeAddressList(1, 1000, 2, 2);
                DataValidation districtValidation = helper.createValidation(helper.createFormulaListConstraint("INDIRECT(B2)"), districtRange);
                mainSheet.addValidationData(districtValidation);
    
    
                FileOutputStream fileOutputStream = new FileOutputStream(path);
                workbook.write(fileOutputStream);
    
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    
        private static void createHiddenSheet(List<String> provinceList, Map<String, String[]> regionMap, Workbook workbook) {
            String hiddenSheetName = "region";
            Sheet hiddenSheet = workbook.createSheet(hiddenSheetName);
            int rowNum = 0;
            // 第一行存放省数据
            Row row = hiddenSheet.createRow(rowNum);
            for (int i = 0; i < provinceList.size(); i++) {
                Cell cell = row.createCell(i);
                cell.setCellValue(provinceList.get(i));
            }
    
            rowNum++;
            for (String key : regionMap.keySet()) {
                String[] dataArray = regionMap.get(key);
                // 循环创建行,每行存放一个数组
                row = hiddenSheet.createRow(rowNum);
                // key 放在每行第一个,value 放在每行的后面
                Cell keyCell = row.createCell(0);
                keyCell.setCellValue(key);
                for (int i = 0, length = dataArray.length; i < length; i++) {
                    Cell cell = row.createCell(i + 1);
                    cell.setCellValue(dataArray[i]);
                }
                Name name = workbook.createName();
                // 将key 设置为下拉框的key
                name.setNameName(key);
                String formula = hiddenSheetName + "!$B$" + (rowNum + 1) + ":$" + (convertNumberToLetter(dataArray.length + 1)) + "$" + (rowNum + 1);
                name.setRefersToFormula(formula);
    
                // 可以将formula 放在最后一列
                Cell formulaCell = row.createCell(dataArray.length + 1);
                formulaCell.setCellValue(formula);
    
                rowNum++;
            }
            // 这里也可以设置 hidden 为 false 这样可以直接看到 sheet 内容
            workbook.setSheetHidden(workbook.getSheetIndex(hiddenSheet), true);
        }
    
        /**
         * 将数字 1 到 26 转换为对应的字母 A 到 Z。
         *
         * @param number 要转换的数字,范围是 1 到 26。
         * @return 对应的字母。
         */
        public static String convertNumberToLetter(int number) {
            if (number < 1 || number > 26) {
                throw new IllegalArgumentException("Number must be between 1 and 26");
            }
            return String.valueOf((char) ('A' + number - 1));
        }
    
    
        public static void main(String[] args) {
            Map<String, String[]> regionMap = new HashMap<>();
            List<String> provinceList = Arrays.asList("湖北省", "湖南省", "广东省", "江苏省", "浙江省");
    
            regionMap.put("湖北省", new String[]{"武汉市", "黄石市", "十堰市", "宜昌市", "襄樊市", "鄂州市", "荆门市", "孝感市", "荆州市", "黄冈市", "咸宁市", "随州市"});
            regionMap.put("湖南省", new String[]{"长沙市", "株洲市", "湘潭市", "衡阳市", "邵阳市", "岳阳市", "常德市", "张家界市", "益阳市", "郴州市", "永州市", "怀化市"});
            regionMap.put("广东省", new String[]{"广州市", "韶关市", "深圳市", "珠海市", "汕头市", "佛山市", "江门市", "湛江市", "茂名市", "肇庆市", "惠州市", "梅州市", "汕尾市", "河源市", "阳江市", "清远市"});
            regionMap.put("江苏省", new String[]{"南京市", "无锡市", "徐州市", "常州市", "苏州市", "南通市", "连云港市", "淮安市", "盐城市", "扬州市", "镇江市", "泰州市", "宿迁市"});
            regionMap.put("浙江省", new String[]{"杭州市", "宁波市", "温州市", "嘉兴市", "湖州市", "绍兴市", "金华市", "衢州市", "舟山市", "台州市", "丽水市"});
            regionMap.put("武汉市", new String[]{"江岸镇", "江汉镇", "江夏镇", "硚口镇", "武昌镇", "江夏镇"});
            regionMap.put("黄石市", new String[]{"黄石港镇", "西塞山镇", "下陆镇", "大冶镇", "大冶镇"});
    
            String path = "/Users/shangwei/Desktop/example" + System.currentTimeMillis() + ".xlsx";
            createExcel(path, provinceList, regionMap);
    
        }
    
    
    }
    
    

相关 Maven 依赖


        <dependency>
            <groupId>org.apache.poi</groupId>
            <artifactId>poi-ooxml</artifactId>
            <version>5.2.3</version>
        </dependency>
        <dependency>
            <groupId>commons-io</groupId>
            <artifactId>commons-io</artifactId>
            <version>2.11.0</version>
        </dependency>

运行截图:

image

  • POI
    23 引用 • 21 回帖

相关帖子

欢迎来到这里!

我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。

注册 关于
请输入回帖内容 ...

推荐标签 标签

  • React

    React 是 Facebook 开源的一个用于构建 UI 的 JavaScript 库。

    192 引用 • 291 回帖 • 402 关注
  • Pipe

    Pipe 是一款小而美的开源博客平台。Pipe 有着非常活跃的社区,可将文章作为帖子推送到社区,来自社区的回帖将作为博客评论进行联动(具体细节请浏览 B3log 构思 - 分布式社区网络)。

    这是一种全新的网络社区体验,让热爱记录和分享的你不再感到孤单!

    131 引用 • 1114 回帖 • 131 关注
  • 前端

    前端技术一般分为前端设计和前端开发,前端设计可以理解为网站的视觉设计,前端开发则是网站的前台代码实现,包括 HTML、CSS 以及 JavaScript 等。

    247 引用 • 1347 回帖
  • 小薇

    小薇是一个用 Java 写的 QQ 聊天机器人 Web 服务,可以用于社群互动。

    由于 Smart QQ 从 2019 年 1 月 1 日起停止服务,所以该项目也已经停止维护了!

    34 引用 • 467 回帖 • 740 关注
  • 正则表达式

    正则表达式(Regular Expression)使用单个字符串来描述、匹配一系列遵循某个句法规则的字符串。

    31 引用 • 94 回帖 • 1 关注
  • 招聘

    哪里都缺人,哪里都不缺人。

    190 引用 • 1057 回帖 • 1 关注
  • Spark

    Spark 是 UC Berkeley AMP lab 所开源的类 Hadoop MapReduce 的通用并行框架。Spark 拥有 Hadoop MapReduce 所具有的优点;但不同于 MapReduce 的是 Job 中间输出结果可以保存在内存中,从而不再需要读写 HDFS,因此 Spark 能更好地适用于数据挖掘与机器学习等需要迭代的 MapReduce 的算法。

    74 引用 • 46 回帖 • 561 关注
  • 面试

    面试造航母,上班拧螺丝。多面试,少加班。

    325 引用 • 1395 回帖
  • MyBatis

    MyBatis 本是 Apache 软件基金会 的一个开源项目 iBatis,2010 年这个项目由 Apache 软件基金会迁移到了 google code,并且改名为 MyBatis ,2013 年 11 月再次迁移到了 GitHub。

    170 引用 • 414 回帖 • 383 关注
  • Postman

    Postman 是一款简单好用的 HTTP API 调试工具。

    4 引用 • 3 回帖 • 2 关注
  • 知乎

    知乎是网络问答社区,连接各行各业的用户。用户分享着彼此的知识、经验和见解,为中文互联网源源不断地提供多种多样的信息。

    10 引用 • 66 回帖
  • 互联网

    互联网(Internet),又称网际网络,或音译因特网、英特网。互联网始于 1969 年美国的阿帕网,是网络与网络之间所串连成的庞大网络,这些网络以一组通用的协议相连,形成逻辑上的单一巨大国际网络。

    98 引用 • 344 回帖
  • JetBrains

    JetBrains 是一家捷克的软件开发公司,该公司位于捷克的布拉格,并在俄国的圣彼得堡及美国麻州波士顿都设有办公室,该公司最为人所熟知的产品是 Java 编程语言开发撰写时所用的集成开发环境:IntelliJ IDEA

    18 引用 • 54 回帖
  • SendCloud

    SendCloud 由搜狐武汉研发中心孵化的项目,是致力于为开发者提供高质量的触发邮件服务的云端邮件发送平台,为开发者提供便利的 API 接口来调用服务,让邮件准确迅速到达用户收件箱并获得强大的追踪数据。

    2 引用 • 8 回帖 • 478 关注
  • SEO

    发布对别人有帮助的原创内容是最好的 SEO 方式。

    35 引用 • 200 回帖 • 15 关注
  • Lute

    Lute 是一款结构化的 Markdown 引擎,支持 Go 和 JavaScript。

    25 引用 • 191 回帖 • 17 关注
  • DNSPod

    DNSPod 建立于 2006 年 3 月份,是一款免费智能 DNS 产品。 DNSPod 可以为同时有电信、网通、教育网服务器的网站提供智能的解析,让电信用户访问电信的服务器,网通的用户访问网通的服务器,教育网的用户访问教育网的服务器,达到互联互通的效果。

    6 引用 • 26 回帖 • 505 关注
  • OnlyOffice
    4 引用 • 1 关注
  • SOHO

    为成为自由职业者在家办公而努力吧!

    7 引用 • 55 回帖 • 18 关注
  • 996
    13 引用 • 200 回帖 • 2 关注
  • JavaScript

    JavaScript 一种动态类型、弱类型、基于原型的直译式脚本语言,内置支持类型。它的解释器被称为 JavaScript 引擎,为浏览器的一部分,广泛用于客户端的脚本语言,最早是在 HTML 网页上使用,用来给 HTML 网页增加动态功能。

    728 引用 • 1326 回帖
  • GitBook

    GitBook 使您的团队可以轻松编写和维护高质量的文档。 分享知识,提高团队的工作效率,让用户满意。

    3 引用 • 8 回帖 • 4 关注
  • V2EX

    V2EX 是创意工作者们的社区。这里目前汇聚了超过 400,000 名主要来自互联网行业、游戏行业和媒体行业的创意工作者。V2EX 希望能够成为创意工作者们的生活和事业的一部分。

    17 引用 • 236 回帖 • 335 关注
  • 友情链接

    确认过眼神后的灵魂连接,站在链在!

    24 引用 • 373 回帖
  • 音乐

    你听到信仰的声音了么?

    60 引用 • 511 回帖 • 1 关注
  • Ruby

    Ruby 是一种开源的面向对象程序设计的服务器端脚本语言,在 20 世纪 90 年代中期由日本的松本行弘(まつもとゆきひろ/Yukihiro Matsumoto)设计并开发。在 Ruby 社区,松本也被称为马茨(Matz)。

    7 引用 • 31 回帖 • 212 关注
  • Rust

    Rust 是一门赋予每个人构建可靠且高效软件能力的语言。Rust 由 Mozilla 开发,最早发布于 2014 年 9 月。

    58 引用 • 22 回帖 • 4 关注