注解+反射优雅的实现Excel导入导出(通用版),飘了!

2023-10-13 20:30

本文主要是介绍注解+反射优雅的实现Excel导入导出(通用版),飘了!,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

大家好,我是老赵

来源:blog.csdn.net/youzi1394046585/article/details/86670203

日常在做后台系统的时候会很频繁的遇到Excel导入导出的问题,正好这次在做一个后台系统,就想着写一个公用工具来进行Excel的导入导出。

一般我们在导出的时候都是导出的前端表格,而前端表格同时也会对应的在后台有一个映射类。

所以在写这个工具时我们先理一下需要实现的效果:

  • 导出方法接收一个list集合,和一个Class类型,和HttpServletResponse 对象

  • 导出是可能会有下拉列表,所以需要一个map存储下拉列表数据源,传入参数后只需一行代码即可导出

  • 导入方法需要传入file文件,以及一个Class类型,导入之后将会返回一个list集合,里面的对象就是传入类型的对象,传入参数后只需一行代码即可导入

实现过程:

首先需要创建三个注解

一个是EnableExport ,必须有这个注解才能导出

/*** 设置允许导出*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface EnableExport {String fileName();}

然后就是EnableExportField,有这个注解的字段才会导出到Excel里面,并且可以设置列宽

/*** 设置该字段允许导出* 并且可以设置宽度*/
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface EnableExportField {int colWidth() default  100;String colName();
}

再就是ImportIndex,导入的时候设置Excel中的列对应的序号

/*** 导入时索引*/
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ImportIndex {int index() ;}

注解使用示例

e3258d4439e593b23f0f2b4f67a9e1ac.png

三个注解创建好之后就需要开始操作Excel了

首先,导入方法。在后台接收到前端上传的Excel文件之后,使用poi来读取Excel文件

我们根据传入的类型上面的字段注解的顺序来分别为不同的字段赋值,然后存入集合中,再返回

代码如下:

/*** 将Excel转换为对象集合* @param excel Excel 文件* @param clazz pojo类型* @return*/
public static List<Object> parseExcelToList(File excel,Class clazz){List<Object> res = new ArrayList<>();// 创建输入流,读取ExcelInputStream is = null;Sheet sheet = null;try {is = new FileInputStream(excel.getAbsolutePath());if (is != null) {Workbook workbook = WorkbookFactory.create(is);//默认只获取第一个工作表sheet = workbook.getSheetAt(0);if (sheet != null) {//前两行是标题int i = 2;String values[] ;Row row = sheet.getRow(i);while (row != null) {//获取单元格数目int cellNum = row.getPhysicalNumberOfCells();values = new String[cellNum];for (int j = 0; j <= cellNum; j++) {Cell cell =   row.getCell(j);if (cell != null) {//设置单元格内容类型cell.setCellType(Cell.CELL_TYPE_STRING );//获取单元格值String value = cell.getStringCellValue() == null ? null : cell.getStringCellValue();values[j]=value;}}Field[] fields = clazz.getDeclaredFields();Object obj = clazz.newInstance();for(Field f : fields){if(f.isAnnotationPresent(ImportIndex.class)){ImportIndex annotation = f.getDeclaredAnnotation(ImportIndex.class);int index = annotation.index();f.setAccessible(true);//此处使用了阿里巴巴的fastjson包里面的一个类型转换工具类Object val =TypeUtils.cast(values[index],f.getType(),null);f.set(obj,val);}}res.add(obj);i++;row=sheet.getRow(i);}}}} catch (Exception e) {e.printStackTrace();}return res;
}

接下来就是导出方法。

导出分为几个步骤:

  1. 建立一个工作簿,也就是类型新建一个Excel文件

2fb5d41956f9fedc014aff0bda758bb3.png
  1. 建立一张sheet表

fdffbda4c661d59e0c0596ea06fc244a.png
  1. 设置标的行高和列宽

6ad9e5ad0eb94c46de6ba2bda5c261f8.png
  1. 绘制标题和表头

c4c8f600916636cab2b923317d9f291e.png

这两个方法是自定义方法,代码会贴在后面

  1. 写入数据到Excel

59d3d16de15b5904903ba76003559424.png
  1. 创建下拉列表

b95743312ace709ce934a5adc80ad6bb.png
  1. 写入文件到response

99011101c00d096c217449bb79071fb6.png

到这里导出工作就完成了

下面是一些自定义方法的代码

/*** 获取一个基本的带边框的单元格* @param workbook* @return*/
private static HSSFCellStyle getBasicCellStyle(HSSFWorkbook workbook){HSSFCellStyle hssfcellstyle = workbook.createCellStyle();hssfcellstyle.setBorderLeft(HSSFCellStyle.BORDER_THIN);hssfcellstyle.setBorderBottom(HSSFCellStyle.BORDER_THIN);hssfcellstyle.setBorderRight(HSSFCellStyle.BORDER_THIN);hssfcellstyle.setBorderTop(HSSFCellStyle.BORDER_THIN);hssfcellstyle.setAlignment(HSSFCellStyle.ALIGN_CENTER);hssfcellstyle.setVerticalAlignment(HSSFCellStyle.VERTICAL_CENTER);hssfcellstyle.setWrapText(true);return hssfcellstyle;
}/*** 获取带有背景色的标题单元格* @param workbook* @return*/
private static HSSFCellStyle getTitleCellStyle(HSSFWorkbook workbook){HSSFCellStyle hssfcellstyle =  getBasicCellStyle(workbook);hssfcellstyle.setFillForegroundColor((short) HSSFColor.CORNFLOWER_BLUE.index); // 设置背景色hssfcellstyle.setFillPattern(HSSFCellStyle.SOLID_FOREGROUND);return hssfcellstyle;
}/*** 创建一个跨列的标题行* @param workbook* @param hssfRow* @param hssfcell* @param hssfsheet* @param allColNum* @param title*/
private static void createTitle(HSSFWorkbook workbook, HSSFRow hssfRow , HSSFCell hssfcell, HSSFSheet hssfsheet,int allColNum,String title){//在sheet里增加合并单元格CellRangeAddress cra = new CellRangeAddress(0, 0, 0, allColNum);hssfsheet.addMergedRegion(cra);// 使用RegionUtil类为合并后的单元格添加边框RegionUtil.setBorderBottom(1, cra, hssfsheet, workbook); // 下边框RegionUtil.setBorderLeft(1, cra, hssfsheet, workbook); // 左边框RegionUtil.setBorderRight(1, cra, hssfsheet, workbook); // 有边框RegionUtil.setBorderTop(1, cra, hssfsheet, workbook); // 上边框//设置表头hssfRow = hssfsheet.getRow(0);hssfcell = hssfRow.getCell(0);hssfcell.setCellStyle( getTitleCellStyle(workbook));hssfcell.setCellType(HSSFCell.CELL_TYPE_STRING);hssfcell.setCellValue(title);
}/*** 设置表头标题栏以及表格高度* @param workbook* @param hssfRow* @param hssfcell* @param hssfsheet* @param colNames*/
private static void createHeadRow(HSSFWorkbook workbook,HSSFRow hssfRow , HSSFCell hssfcell,HSSFSheet hssfsheet,List<String> colNames){//插入标题行hssfRow = hssfsheet.createRow(1);for (int i = 0; i < colNames.size(); i++) {hssfcell = hssfRow.createCell(i);hssfcell.setCellStyle(getTitleCellStyle(workbook));hssfcell.setCellType(HSSFCell.CELL_TYPE_STRING);hssfcell.setCellValue(colNames.get(i));}
}
/*** excel添加下拉数据校验* @param sheet 哪个 sheet 页添加校验* @return*/
public static void createDataValidation(Sheet sheet,Map<Integer,String[]> selectListMap) {if(selectListMap!=null) {selectListMap.forEach(// 第几列校验(0开始)key 数据源数组value(key, value) -> {if(value.length>0) {CellRangeAddressList cellRangeAddressList = new CellRangeAddressList(2, 65535, key, key);DataValidationHelper helper = sheet.getDataValidationHelper();DataValidationConstraint constraint = helper.createExplicitListConstraint(value);DataValidation dataValidation = helper.createValidation(constraint, cellRangeAddressList);//处理Excel兼容性问题if (dataValidation instanceof XSSFDataValidation) {dataValidation.setSuppressDropDownArrow(true);dataValidation.setShowErrorBox(true);} else {dataValidation.setSuppressDropDownArrow(false);}dataValidation.setEmptyCellAllowed(true);dataValidation.setShowPromptBox(true);dataValidation.createPromptBox("提示", "只能选择下拉框里面的数据");sheet.addValidationData(dataValidation);}});}
}

使用实例

导出数据

a757bfa021796ebab5a24cb4b390a6c0.png

导入数据(返回对象List)

ee7eb23857c159bd0b5fb747f792249a.png

源码地址:

https://github.com/xyz0101/excelutils

 

精彩推荐

1.45 个 Git 经典操作场景,专治不会合代码
2.华为Java开发编程最新军规,谁违反谁滚蛋!
3.还在使用TIMESTAMP 作为日期字段?你们的服务器没崩?
4.这几行代码,真的骚!
5.尽快卸载这两款恶意浏览器插件!已有近 50 万用户安装
6.这款IDEA插件刷爆了技术群,群友:这用起来真酸爽~
7.14家互联网公司裁员(1-2月裁员清单)
8.Redis 官方推出可视化工具,颜值爆表,功能真心强大!这是不给其他工具活路啊!

efbfcd7d7a231ee9c2c35216353fe8c5.png

这篇关于注解+反射优雅的实现Excel导入导出(通用版),飘了!的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/205700

相关文章

使用Java解析JSON数据并提取特定字段的实现步骤(以提取mailNo为例)

《使用Java解析JSON数据并提取特定字段的实现步骤(以提取mailNo为例)》在现代软件开发中,处理JSON数据是一项非常常见的任务,无论是从API接口获取数据,还是将数据存储为JSON格式,解析... 目录1. 背景介绍1.1 jsON简介1.2 实际案例2. 准备工作2.1 环境搭建2.1.1 添加

Java实现任务管理器性能网络监控数据的方法详解

《Java实现任务管理器性能网络监控数据的方法详解》在现代操作系统中,任务管理器是一个非常重要的工具,用于监控和管理计算机的运行状态,包括CPU使用率、内存占用等,对于开发者和系统管理员来说,了解这些... 目录引言一、背景知识二、准备工作1. Maven依赖2. Gradle依赖三、代码实现四、代码详解五

java如何分布式锁实现和选型

《java如何分布式锁实现和选型》文章介绍了分布式锁的重要性以及在分布式系统中常见的问题和需求,它详细阐述了如何使用分布式锁来确保数据的一致性和系统的高可用性,文章还提供了基于数据库、Redis和Zo... 目录引言:分布式锁的重要性与分布式系统中的常见问题和需求分布式锁的重要性分布式系统中常见的问题和需求

SpringBoot基于MyBatis-Plus实现Lambda Query查询的示例代码

《SpringBoot基于MyBatis-Plus实现LambdaQuery查询的示例代码》MyBatis-Plus是MyBatis的增强工具,简化了数据库操作,并提高了开发效率,它提供了多种查询方... 目录引言基础环境配置依赖配置(Maven)application.yml 配置表结构设计demo_st

python使用watchdog实现文件资源监控

《python使用watchdog实现文件资源监控》watchdog支持跨平台文件资源监控,可以检测指定文件夹下文件及文件夹变动,下面我们来看看Python如何使用watchdog实现文件资源监控吧... python文件监控库watchdogs简介随着Python在各种应用领域中的广泛使用,其生态环境也

el-select下拉选择缓存的实现

《el-select下拉选择缓存的实现》本文主要介绍了在使用el-select实现下拉选择缓存时遇到的问题及解决方案,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的... 目录项目场景:问题描述解决方案:项目场景:从左侧列表中选取字段填入右侧下拉多选框,用户可以对右侧

Python pyinstaller实现图形化打包工具

《Pythonpyinstaller实现图形化打包工具》:本文主要介绍一个使用PythonPYQT5制作的关于pyinstaller打包工具,代替传统的cmd黑窗口模式打包页面,实现更快捷方便的... 目录1.简介2.运行效果3.相关源码1.简介一个使用python PYQT5制作的关于pyinstall

使用Python实现大文件切片上传及断点续传的方法

《使用Python实现大文件切片上传及断点续传的方法》本文介绍了使用Python实现大文件切片上传及断点续传的方法,包括功能模块划分(获取上传文件接口状态、临时文件夹状态信息、切片上传、切片合并)、整... 目录概要整体架构流程技术细节获取上传文件状态接口获取临时文件夹状态信息接口切片上传功能文件合并功能小

python实现自动登录12306自动抢票功能

《python实现自动登录12306自动抢票功能》随着互联网技术的发展,越来越多的人选择通过网络平台购票,特别是在中国,12306作为官方火车票预订平台,承担了巨大的访问量,对于热门线路或者节假日出行... 目录一、遇到的问题?二、改进三、进阶–展望总结一、遇到的问题?1.url-正确的表头:就是首先ur

C#实现文件读写到SQLite数据库

《C#实现文件读写到SQLite数据库》这篇文章主要为大家详细介绍了使用C#将文件读写到SQLite数据库的几种方法,文中的示例代码讲解详细,感兴趣的小伙伴可以参考一下... 目录1. 使用 BLOB 存储文件2. 存储文件路径3. 分块存储文件《文件读写到SQLite数据库China编程的方法》博客中,介绍了文