当前位置: 首页 > news >正文

EasyExcel自定义下拉注解的三种实现方式

在这里插入图片描述

文章目录

  • 一、简介
  • 二、关键组件
    • 1、ExcelSelected注解
    • 2、ExcelDynamicSelect接口(仅用于方式二)
    • 3、ExcelSelectedResolve类
    • 4、SelectedSheetWriteHandler类
  • 三、实际应用
  • 总结

一、简介

  在使用EasyExcel设置下拉数据时,每次都要创建一个SheetWriteHandler组件确实比较繁琐。为了优化这个过程,我们可以通过自定义注解来简化操作,使得只需要在需要添加下拉数据的字段上添加注解即可。

注解实现三种方式可供选择

  • 方式一:固定值
  • 方式二:动态获取复杂数据
  • 方式三:通过码值获取码值表的数据列表

二、关键组件

1、ExcelSelected注解

  • 用于在数据模型类中标注需要添加下拉列表的字段及其属性
  • 三种方式都是通过此注解实现
/*** 定义Excel列下拉列表属性的注解。*/
@Documented
@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface ExcelSelected {/*** 方式一:固定的下拉选项*/String[] source() default {};/*** 方式二:提供动态下拉选项的类*/Class<? extends ExcelDynamicSelect>[] sourceClass() default {};/*** 方式三:基于码值从数据库查询数据*/String codeField() default "";/*** 下拉列表的起始行(默认从第二行开始)。*/int firstRow() default 1;/*** 下拉列表的结束行(默认到第65536行)。*/int lastRow() default 65536;
}

2、ExcelDynamicSelect接口(仅用于方式二)

  • 方式二定义动态获取下拉列表数据的规范
  • 实现该接口的类可以从数据库、外部服务或其他动态来源获取数据

/*** 动态下拉列表数据提供者接口。*/
public interface ExcelDynamicSelect {/*** 获取动态生成的下拉列表选项。* * @return 下拉选项数组。*/String[] getSource();
}

3、ExcelSelectedResolve类

  • 负责解析ExcelSelected注解,获取下拉列表的具体数据
/*** 根据 ExcelSelected 注解解析下拉列表数据源。*/
@Data
@Slf4j
public class ExcelSelectedResolve {/*** 下拉选项数组。*/private String[] source;/*** 下拉列表的起始行。*/private int firstRow;/*** 下拉列表的结束行。*/private int lastRow;/*** 解析下拉列表数据来源** @param excelSelected 下拉框注解对象* @return 下拉框选项数组*/public String[] resolveSelectedSource(ExcelSelected excelSelected) {if (excelSelected == null) {return null;}// 方式一:获取固定下拉框的内容String[] source = excelSelected.source();if (source.length > 0) {return source;}// 方式二:获取动态下拉框的内容Class<? extends ExcelDynamicSelect>[] classes = excelSelected.sourceClass();if (classes.length > 0) {try {ExcelDynamicSelect excelDynamicSelect = classes[0].newInstance();String[] dynamicSelectSource = excelDynamicSelect.getSource();if (dynamicSelectSource != null && dynamicSelectSource.length > 0) {return dynamicSelectSource;}} catch (InstantiationException | IllegalAccessException e) {log.error("解析动态下拉框数据异常", e);}}// 方式三:获取码值下拉数据(动态下拉)String codeField = excelSelected.codeField();if (ObjectUtils.isNotEmpty(codeField)) {try {// 这里就是通过码值查询码值表,写死了,每次传码值查询即可String[] codeFieldSource = SpringUtil.getBean(xxxService.class).selectByCode(codeField);if (ObjectUtils.isNotEmpty(codeFieldSource)) {return codeFieldSource;}} catch (Exception e) {log.error("解析动态下拉框(码值)数据异常", e);}}return null;}
}

4、SelectedSheetWriteHandler类

  • SheetWriteHandler实现类,在Sheet创建后设置下拉列表
  • 在隐藏的sheet中存储下拉选项,然后设置数据验证以实现下拉功能
  • 最后这里添加了阻止输入非下拉选项的值的校验
/*** 处理Excel下拉列表的SheetWriteHandler实现类。*/
@Slf4j
@Data
public class SelectedSheetWriteHandler implements SheetWriteHandler {// 存储列索引与对应下拉列表解析器的映射private Map<Integer, ExcelSelectedResolve> selectedMap = new HashMap<>();/*** 构造方法,解析表头类中的下拉列表注解信息。** @param head 表头类。*/public SelectedSheetWriteHandler(Class<?> head) {// 获取所有声明的字段Field[] fields = head.getDeclaredFields();for (int i = 0; i < fields.length; i++) {Field field = fields[i];// 获取 ExcelSelected 注解ExcelSelected selected = field.getAnnotation(ExcelSelected.class);ExcelProperty property = field.getAnnotation(ExcelProperty.class);if (selected != null) {ExcelSelectedResolve resolve = new ExcelSelectedResolve();// 解析下拉列表数据源String[] source = resolve.resolveSelectedSource(selected);if (source != null && source.length > 0) {resolve.setSource(source);resolve.setFirstRow(selected.firstRow());resolve.setLastRow(selected.lastRow());// 使用注解中的索引或字段顺序作为列索引if (property != null && property.index() >= 0) {selectedMap.put(property.index(), resolve);} else {selectedMap.put(i, resolve);}}}}}/*** 在创建Sheet之前调用的方法。*/@Overridepublic void beforeSheetCreate(WriteWorkbookHolder writeWorkbookHolder, WriteSheetHolder writeSheetHolder) {// 此处无需操作,保持空实现}/*** 在Sheet创建后调用的方法,用于设置Excel下拉列表。** @param writeWorkbookHolder 写入的工作簿持有者。* @param writeSheetHolder    写入的Sheet持有者。*/@Overridepublic void afterSheetCreate(WriteWorkbookHolder writeWorkbookHolder, WriteSheetHolder writeSheetHolder) {Sheet sheet = writeSheetHolder.getSheet();Workbook workbook = sheet.getWorkbook();// SXSSFWorkbook 是 Apache POI 库中用于处理大文件的一种特殊工作簿类型SXSSFWorkbook sw = (SXSSFWorkbook) workbook;// 1.创建一个隐藏的sheet,名称为hidden,用于存储下拉列表选项String hiddenName = "hidden";XSSFSheet hiddenSheet = sw.getXSSFWorkbook().createSheet(hiddenName);// 将隐藏的sheet设置为不可见workbook.setSheetHidden(workbook.getSheetIndex(hiddenName), true);// 创建数据验证辅助器DataValidationHelper helper = sheet.getDataValidationHelper();// 为每个需要下拉列表的列创建数据验证selectedMap.forEach((index, selectedResolve) -> {// 设置下拉列表的范围:起始行,结束行,起始列,结束列CellRangeAddressList rangeList = new CellRangeAddressList(selectedResolve.getFirstRow(),selectedResolve.getLastRow(),index,index);// 在隐藏的sheet中生成下拉列表选项值String[] values = selectedResolve.getSource();generateSelectValue(hiddenSheet, index, values);// 获取Excel列标,例如A, B, AAString excelLine = getExcelLine(index);// 引用隐藏sheet中的单元格区域,例如hidden!$H$1:$H$50String refers = hiddenName + "!$" + excelLine + "$1:$" + excelLine + "$" + values.length;// 使用引用的内容作为下拉列表的值DataValidationConstraint constraint = helper.createFormulaListConstraint(refers);DataValidation validation = helper.createValidation(constraint, rangeList);// 设置验证属性,阻止输入非下拉选项的值validation.setErrorStyle(DataValidation.ErrorStyle.STOP);validation.setShowErrorBox(true);validation.setSuppressDropDownArrow(true);validation.createErrorBox("提示", "请输入下拉选项中的内容");// 将验证添加到当前的sheet中sheet.addValidationData(validation);});}/*** 获取Excel列标(例如:A-Z, AA-ZZ)。** @param num 列索引,从0开始。* @return Excel列标字符串。*/public static String getExcelLine(int num) {StringBuilder line = new StringBuilder();// 计算列标,使用字母表示,例如 A, B, ..., Z, AA, AB, ...int first = num / 26;int second = num % 26;if (first > 0) {line.append((char) ('A' + first - 1));}line.append((char) ('A' + second));return line.toString();}/*** 在隐藏的sheet中生成下拉列表选项值。** @param sheet  隐藏的sheet对象。* @param col    列索引。* @param values 下拉列表选项值数组。*/private void generateSelectValue(Sheet sheet, int col, String[] values) {// 将下拉列表选项值写入隐藏的sheet中,每个选项值占用一行for (int i = 0, length = values.length; i < length; i++) {Row row = sheet.getRow(i);if (row == null) {row = sheet.createRow(i);}// 在指定列中创建单元格并设置下拉列表选项值row.createCell(col).setCellValue(values[i]);}}
}

三、实际应用

  • 包含三种方式,固定值、动态获取、码值数据库获取
@Data
public class Employee {@ExcelProperty(value = "用户编号")private Integer id;@ExcelProperty(value = "姓名")private String name;@ExcelProperty(value = "性别")@ExcelSelected(source = {"男", "女"})private String gender;@ExcelProperty(value = "职位")@ExcelSelected(sourceClass = {PositionDynamicSelect.class})private String position;@ExcelProperty(value = "国家")@ExcelSelected(codeField = "country_code")private String country;
}
  • 方式二的动态获取数据
public class PositionDynamicSelect implements ExcelDynamicSelect {@Overridepublic String[] getSource() {// 动态生成职位列表return new String[]{"软件工程师", "项目经理", "人事专员", "财务分析师"};}
}
  • 测试类
public class EmployeeExcelTest {public static void main(String[] args) {String fileName = "/Users/xuchang/Documents/employee.xlsx";EasyExcel.write(fileName, Employee.class).registerWriteHandler(new SelectedSheetWriteHandler(Employee.class)).sheet().doWrite((Collection<?>) null);}
}
  • 下拉效果

在这里插入图片描述

  • 输入非下拉框数据效果

在这里插入图片描述

总结

  • 方式一只需要添加注解@ExcelSelected(source = {"x1", "x2"})即可
  • 方式二在查询复杂的情况下使用,每个下拉都需要创建一个ExcelDynamicSelect的实现类,并添加注解@ExcelSelected(sourceClass = {xxx.class})
  • 方式三只需要添加注解@ExcelSelected(codeField = "xxx_code"),所有系统应该都有码值表,在ExcelSelectedResolve类中已写好通过码值查询数据的方法
  • 同样也支持@ExcelSelected注解的扩展,添加属性,然后在ExcelSelectedResolve类中去添加获取下拉数据的方法。

相关文章:

EasyExcel自定义下拉注解的三种实现方式

文章目录 一、简介二、关键组件1、ExcelSelected注解2、ExcelDynamicSelect接口&#xff08;仅用于方式二&#xff09;3、ExcelSelectedResolve类4、SelectedSheetWriteHandler类 三、实际应用总结 一、简介 在使用EasyExcel设置下拉数据时&#xff0c;每次都要创建一个SheetWr…...

Burp Suite Professional 2024.9 for macOS x64 ARM64 - 领先的 Web 渗透测试软件

Burp Suite Professional 2024.9 for macOS x64 & ARM64 - 领先的 Web 渗透测试软件 世界排名第一的 Web 渗透测试工具包 请访问原文链接&#xff1a;https://sysin.org/blog/burp-suite-pro-mac/ 查看最新版。原创作品&#xff0c;转载请保留出处。 作者主页&#xff1…...

使用Mock库进行依赖注入的实用指南

使用Mock库进行依赖注入的实用指南 在现代软件开发中,测试是确保代码质量的重要环节。尤其是在进行单元测试时,依赖注入(Dependency Injection, DI)是一种常用的设计模式,它可以帮助我们更好地管理依赖关系,提高代码的可测试性。本文将深入探讨如何使用Python的unittest…...

nosql课本习题

nosql题目 1. 文档数据库相比其他 NoSQL 的突出优势和特点是什么&#xff1f; 答案&#xff1a; 文档数据库的突出优势在于它的灵活性和可扩展性。不同于传统的关系型数据库&#xff0c;文档数据库允许存储半结构化和非结构化数据&#xff0c;每个文档可以有不同的字段&#x…...

springboot 3.2.5集成spring security 只放行get请求,其他请求403

环境配置 jdk 17 <parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>3.2.5</version><relativePath/> <!-- lookup parent from repository --></…...

【linux】麒麟v10安装ELKB(ARM架构)

安装elasticsearch 创建目录 #放安装软件的位置 mkdir -pv /software#安装elasticsearch目录 mkdir -pv /usr/local/elasticsearch#安装kibana目录 mkdir -pv /usr/local/kibana 解压elasticsearch tar -zxvf elasticsearch-8.8.1-linux-aarch64.tar.gz -C /usr/local/elast…...

帝国CMS – AutoTitlePic 自动生成文章标题图片插件

帝国CMS – AutoTitlePic 自动生成文章标题图片插件 AutoTitlePic&#xff0c;自动生成文章标题图片插件。功能特点&#xff1a; 1、安装方便、使用简单。老站、新站都能使用。 2、自动生成图片&#xff0c;安装后静默运行。所以本插件也没有预览图片。 3、扩展性强&#x…...

Docker安装Mysql5.7,解决无法访问DockerHub问题

Docker安装Mysql5.7&#xff0c;解决无法访问DockerHub问题 简介 Docker Hub 无法访问&#xff0c;应用安装失败&#xff0c;镜像拉取超时的解决方案。 摘要 &#xff1a; 当 Docker Hub 无法访问时&#xff0c;可以通过配置国内镜像加速来解决应用安装失败和镜像拉取超时的…...

React中使用Antd开源组件Popover等部分组件原生样式改变问题

1.如果发现某个组件的样式在单独的样式文件中更改不了&#xff0c;得在全局中更改时&#xff0c;我们可以使用一下方法&#xff1a; <Popoverplacement"bottomLeft"title{null}trigger"click"content{contentopic}overlayClassName{pinsInputLess.nop…...

Linux 配置 ssh —— ubuntu

Linux 配置 ssh —— ubuntu 设置 ip 这里我们选择使用系统 DHCP 自动分配的 IP&#xff0c;有些教程推荐使用自定义 IP&#xff0c;但是这样我们就没法上网&#xff0c;所有这里采用自定义 IP 即可 安装并启动 ssh 首先需要安装 ssh&#xff1a; sudo apt-get install op…...

eCAP超声波测距-ePWM电机调速

目录 eCAP超声波测距 整体框架 关键模块 实验效果 PWM电机调速 DRV8833基本介绍 整体框架 eCAP超声波测距 本实验所用的超声波HC-SR04模块如下图所示&#xff0c;左边为正面图&#xff0c;右边为反面图。 HC-SR04基本工作原理&#xff1a; &#xff08;1&#xff09;采…...

【K8s】Kubernetes 词汇表

微思网络 厦门微思网络 K8S认证工程师&#xff08;CKA&#xff09;备考与学习指南https://mp.weixin.qq.com/s/XsEVpU7dKnJDBopynWW3GQ K8S-CKA课程试听:Container 概述 词汇表 此术语表旨在提供 Kubernetes 术语的完整、标准列表。其中包含特定于 Kubernetes 的技术术语以及…...

高级java每日一道面试题-2024年10月20日-数据库篇[Redis篇]-Redis为什么是单线程的?

如果有遗漏,评论区告诉我进行补充 面试官: Redis为什么是单线程的? 我回答: Redis的单线程模型 Redis在6.0版本之前的设计是基于单线程模型的&#xff0c;这意味着Redis的网络IO和键值对数据的读写操作是由单个主线程来完成的。这种设计选择主要是出于以下几个原因&#x…...

SW-LIMS在化妆品行业稳定性试验中的应用

化妆品的稳定性是提供产品相关质量安全和潜在安全风险评价的一个重要数据来源,能为产品的安全性评估以及安全性预期提供佐证,通过设置产品保质期的边界和相关内容也能为化妆品上市后的监管提供依据。 通过稳定性试验,可以发现化妆品中可能存在的有害物质,避免这些物质在使用过…...

vue 项目i18n国际化,快速抽离中文,快速翻译

国际化大家都知道vue-i18n 实现的&#xff0c;但是有个问题&#xff0c;就是繁杂的抽离中文字符的过程&#xff0c;以及翻译中文字符的过程&#xff0c;关于这个有些小工具可以希望可以帮到大家 1.安装vue-i18n npm i vue-i18n8.22.22.ElementUI多语言配置 在src目录下创建…...

java--多态(详解)

目录 一、概念二、多态实现的条件三、向上转型和向下转型3.1 向上转型3.2 向下转型 四、重写和重载五、理解多态5.1练习&#xff1a;5.2避免在构造方法中调用重写的方法&#xff1a; 欢迎来到权权的博客~欢迎大家对我的博客提出指导这是我的博客主页&#xff1a;点击 一、概念…...

windows DLL技术-DLL概述

动态链接库 (DLL) 是一个模块&#xff0c;其中包含可由另一个模块 (应用程序或 DLL) 使用的函数和数据。 DLL 可以定义两种类型的函数&#xff1a;导出函数和内部函数。 导出的函数旨在由其他模块调用&#xff0c;以及从定义它们的 DLL 中调用。 内部函数通常只能从定义内部函…...

C++ —— 实现一个日期类

目录 一. 对日期类的介绍 二. 实现日期类 1. 运算符重载 2.日期类实现代码 一. 对日期类的介绍 通过对类和对象&#xff08;这里链接是类和对象的介绍&#xff09;的学习&#xff0c;类就是一种模型一样的东西&#xff0c;是对象一种抽象的描述。所以实现日期类&#xff0…...

Java全栈经典面试题剖析5】JavaSE高级 -- 集合

目录 面试题3.18 Java中有多少种数据结构&#xff0c;分别是什么&#xff1f; 面试题3.19 List、Set和Map的区别&#xff1f; 面试题3.20 List遍历方式有多少种 面试题3.21 Arraylist&#xff0c;Vector和Linkedlist 的区别 面试题3.22 Collection和Collections的区别 面试…...

python中如何获取对象信息

目录 一、获取对象类型 二、使用isinstance()函数 三、使用dir()函数 四、使用对象的__dict__属性&#xff08;适用于大多数自定义对象&#xff09; 五、使用文档字符串&#xff08;__doc__属性&#xff09;获取对象的文档信息 一、获取对象类型 使用type()函数&#xff…...

OkHttp 中实现断点续传 demo

在 OkHttp 中实现断点续传主要通过以下步骤完成&#xff0c;核心是利用 HTTP 协议的 Range 请求头指定下载范围&#xff1a; 实现原理 Range 请求头&#xff1a;向服务器请求文件的特定字节范围&#xff08;如 Range: bytes1024-&#xff09; 本地文件记录&#xff1a;保存已…...

SpringCloudGateway 自定义局部过滤器

场景&#xff1a; 将所有请求转化为同一路径请求&#xff08;方便穿网配置&#xff09;在请求头内标识原来路径&#xff0c;然后在将请求分发给不同服务 AllToOneGatewayFilterFactory import lombok.Getter; import lombok.Setter; import lombok.extern.slf4j.Slf4j; impor…...

JAVA后端开发——多租户

数据隔离是多租户系统中的核心概念&#xff0c;确保一个租户&#xff08;在这个系统中可能是一个公司或一个独立的客户&#xff09;的数据对其他租户是不可见的。在 RuoYi 框架&#xff08;您当前项目所使用的基础框架&#xff09;中&#xff0c;这通常是通过在数据表中增加一个…...

es6+和css3新增的特性有哪些

一&#xff1a;ECMAScript 新特性&#xff08;ES6&#xff09; ES6 (2015) - 革命性更新 1&#xff0c;记住的方法&#xff0c;从一个方法里面用到了哪些技术 1&#xff0c;let /const块级作用域声明2&#xff0c;**默认参数**&#xff1a;函数参数可以设置默认值。3&#x…...

倒装芯片凸点成型工艺

UBM&#xff08;Under Bump Metallization&#xff09;与Bump&#xff08;焊球&#xff09;形成工艺流程。我们可以将整张流程图分为三大阶段来理解&#xff1a; &#x1f527; 一、UBM&#xff08;Under Bump Metallization&#xff09;工艺流程&#xff08;黄色区域&#xff…...

【实施指南】Android客户端HTTPS双向认证实施指南

&#x1f510; 一、所需准备材料 证书文件&#xff08;6类核心文件&#xff09; 类型 格式 作用 Android端要求 CA根证书 .crt/.pem 验证服务器/客户端证书合法性 需预置到Android信任库 服务器证书 .crt 服务器身份证明 客户端需持有以验证服务器 客户端证书 .crt 客户端身份…...

Python学习(8) ----- Python的类与对象

Python 中的类&#xff08;Class&#xff09;与对象&#xff08;Object&#xff09;是面向对象编程&#xff08;OOP&#xff09;的核心。我们可以通过“类是模板&#xff0c;对象是实例”来理解它们的关系。 &#x1f9f1; 一句话理解&#xff1a; 类就像“图纸”&#xff0c;对…...

数据分析六部曲?

引言 上一章我们说到了数据分析六部曲&#xff0c;何谓六部曲呢&#xff1f; 其实啊&#xff0c;数据分析没那么难&#xff0c;只要掌握了下面这六个步骤&#xff0c;也就是数据分析六部曲&#xff0c;就算你是个啥都不懂的小白&#xff0c;也能慢慢上手做数据分析啦。 第一…...

第22节 Node.js JXcore 打包

Node.js是一个开放源代码、跨平台的、用于服务器端和网络应用的运行环境。 JXcore是一个支持多线程的 Node.js 发行版本&#xff0c;基本不需要对你现有的代码做任何改动就可以直接线程安全地以多线程运行。 本文主要介绍JXcore的打包功能。 JXcore 安装 下载JXcore安装包&a…...

C/Python/Go示例 | Socket Programing与RPC

Socket Programming介绍 Computer networking这个领域围绕着两台电脑或者同一台电脑内的不同进程之间的数据传输和信息交流&#xff0c;会涉及到许多有意思的话题&#xff0c;诸如怎么确保对方能收到信息&#xff0c;怎么应对数据丢失、被污染或者顺序混乱&#xff0c;怎么提高…...