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 回帖

相关帖子

欢迎来到这里!

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

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

推荐标签 标签

  • 又拍云

    又拍云是国内领先的 CDN 服务提供商,国家工信部认证通过的“可信云”,乌云众测平台认证的“安全云”,为移动时代的创业者提供新一代的 CDN 加速服务。

    21 引用 • 37 回帖 • 547 关注
  • Maven

    Maven 是基于项目对象模型(POM)、通过一小段描述信息来管理项目的构建、报告和文档的软件项目管理工具。

    186 引用 • 318 回帖 • 303 关注
  • RESTful

    一种软件架构设计风格而不是标准,提供了一组设计原则和约束条件,主要用于客户端和服务器交互类的软件。基于这个风格设计的软件可以更简洁,更有层次,更易于实现缓存等机制。

    30 引用 • 114 回帖
  • Angular

    AngularAngularJS 的新版本。

    26 引用 • 66 回帖 • 536 关注
  • NetBeans

    NetBeans 是一个始于 1997 年的 Xelfi 计划,本身是捷克布拉格查理大学的数学及物理学院的学生计划。此计划延伸而成立了一家公司进而发展这个商用版本的 NetBeans IDE,直到 1999 年 Sun 买下此公司。Sun 于次年(2000 年)六月将 NetBeans IDE 开源,直到现在 NetBeans 的社群依然持续增长。

    78 引用 • 102 回帖 • 681 关注
  • OpenResty

    OpenResty 是一个基于 NGINX 与 Lua 的高性能 Web 平台,其内部集成了大量精良的 Lua 库、第三方模块以及大多数的依赖项。用于方便地搭建能够处理超高并发、扩展性极高的动态 Web 应用、Web 服务和动态网关。

    17 引用 • 40 关注
  • 七牛云

    七牛云是国内领先的企业级公有云服务商,致力于打造以数据为核心的场景化 PaaS 服务。围绕富媒体场景,七牛先后推出了对象存储,融合 CDN 加速,数据通用处理,内容反垃圾服务,以及直播云服务等。

    27 引用 • 225 回帖 • 169 关注
  • 阿里云

    阿里云是阿里巴巴集团旗下公司,是全球领先的云计算及人工智能科技公司。提供云服务器、云数据库、云安全等云计算服务,以及大数据、人工智能服务、精准定制基于场景的行业解决方案。

    89 引用 • 345 回帖
  • 学习

    “梦想从学习开始,事业从实践起步” —— 习近平

    169 引用 • 506 回帖
  • OpenShift

    红帽提供的 PaaS 云,支持多种编程语言,为开发人员提供了更为灵活的框架、存储选择。

    14 引用 • 20 回帖 • 633 关注
  • Jenkins

    Jenkins 是一套开源的持续集成工具。它提供了非常丰富的插件,让构建、部署、自动化集成项目变得简单易用。

    53 引用 • 37 回帖 • 2 关注
  • Sublime

    Sublime Text 是一款可以用来写代码、写文章的文本编辑器。支持代码高亮、自动完成,还支持通过插件进行扩展。

    10 引用 • 5 回帖 • 1 关注
  • webpack

    webpack 是一个用于前端开发的模块加载器和打包工具,它能把各种资源,例如 JS、CSS(less/sass)、图片等都作为模块来使用和处理。

    41 引用 • 130 回帖 • 261 关注
  • 笔记

    好记性不如烂笔头。

    308 引用 • 793 回帖
  • RIP

    愿逝者安息!

    8 引用 • 92 回帖 • 351 关注
  • 安装

    你若安好,便是晴天。

    132 引用 • 1184 回帖 • 1 关注
  • JetBrains

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

    18 引用 • 54 回帖
  • MongoDB

    MongoDB(来自于英文单词“Humongous”,中文含义为“庞大”)是一个基于分布式文件存储的数据库,由 C++ 语言编写。旨在为应用提供可扩展的高性能数据存储解决方案。MongoDB 是一个介于关系数据库和非关系数据库之间的产品,是非关系数据库当中功能最丰富,最像关系数据库的。它支持的数据结构非常松散,是类似 JSON 的 BSON 格式,因此可以存储比较复杂的数据类型。

    90 引用 • 59 回帖 • 1 关注
  • WebClipper

    Web Clipper 是一款浏览器剪藏扩展,它可以帮助你把网页内容剪藏到本地。

    3 引用 • 9 回帖 • 1 关注
  • JavaScript

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

    729 引用 • 1327 回帖 • 1 关注
  • Kubernetes

    Kubernetes 是 Google 开源的一个容器编排引擎,它支持自动化部署、大规模可伸缩、应用容器化管理。

    110 引用 • 54 回帖 • 1 关注
  • ZooKeeper

    ZooKeeper 是一个分布式的,开放源码的分布式应用程序协调服务,是 Google 的 Chubby 一个开源的实现,是 Hadoop 和 HBase 的重要组件。它是一个为分布式应用提供一致性服务的软件,提供的功能包括:配置维护、域名服务、分布式同步、组服务等。

    59 引用 • 29 回帖 • 6 关注
  • Love2D

    Love2D 是一个开源的, 跨平台的 2D 游戏引擎。使用纯 Lua 脚本来进行游戏开发。目前支持的平台有 Windows, Mac OS X, Linux, Android 和 iOS。

    14 引用 • 53 回帖 • 530 关注
  • SpaceVim

    SpaceVim 是一个社区驱动的模块化 vim/neovim 配置集合,以模块的方式组织管理插件以
    及相关配置,为不同的语言开发量身定制了相关的开发模块,该模块提供代码自动补全,
    语法检查、格式化、调试、REPL 等特性。用户仅需载入相关语言的模块即可得到一个开箱
    即用的 Vim-IDE。

    3 引用 • 31 回帖 • 99 关注
  • Telegram

    Telegram 是一个非盈利性、基于云端的即时消息服务。它提供了支持各大操作系统平台的开源的客户端,也提供了很多强大的 APIs 给开发者创建自己的客户端和机器人。

    5 引用 • 35 回帖 • 2 关注
  • H2

    H2 是一个开源的嵌入式数据库引擎,采用 Java 语言编写,不受平台的限制,同时 H2 提供了一个十分方便的 web 控制台用于操作和管理数据库内容。H2 还提供兼容模式,可以兼容一些主流的数据库,因此采用 H2 作为开发期的数据库非常方便。

    11 引用 • 54 回帖 • 653 关注
  • Swagger

    Swagger 是一款非常流行的 API 开发工具,它遵循 OpenAPI Specification(这是一种通用的、和编程语言无关的 API 描述规范)。Swagger 贯穿整个 API 生命周期,如 API 的设计、编写文档、测试和部署。

    26 引用 • 35 回帖