利用注解+反射优雅的实现通用Excel导入导出

最新推荐文章于 2024-06-05 17:20:25 发布
最新推荐文章于 2024-06-05 17:20:25 发布
阅读量1.8k 收藏 1
点赞数
文章标签： java mybatis 前端 spring 开发语言
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/china_coding/article/details/126924243
版权

2019/3/12更新

日常在做后台系统的时候会很频繁的遇到Excel导入导出的问题，正好这次在做一个后台系统，就想着写一个公用工具来进行Excel的导入导出。
一般我们在导出的时候都是导出的前端表格，而前端表格同时也会对应的在后台有一个映射类。
所以在写这个工具的时候我们先理一下我们需要实现的效果：

  1. 导出方法接收一个list集合，和一个Class类型，和HttpServletResponse 对象
  2. 导出是可能会有下拉列表，所以需要一个map存储下拉列表数据源，传入参数后只需一行代码即可导出
  3. 导入方法需要传入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() ;


}

注解使用示例在这里插入图片描述

三个注解创建好之后就需要开始操作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<>();
        // 创建输入流，读取Excel
        InputStream 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文件在这里插入图片描述
  2. 建立一张sheet表在这里插入图片描述
  3. 设置标的行高和列宽在这里插入图片描述
  4. 绘制标题和表头在这里插入图片描述
    这两个方法是自定义方法，代码会贴在后面
  5. 写入数据到Excel在这里插入图片描述
  6. 创建下拉列表在这里插入图片描述
  7. 写入文件到response在这里插入图片描述
    到这里导出工作就完成了
    下面是一些自定义方法的代码
/**
     * 获取一个基本的带边框的单元格
     * @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);
                        }
                    }
            );
        }
    }

使用实例
导出数据在这里插入图片描述

导入数据(返回对象List)在这里插入图片描述

最近更新了代码并上传到了github：https://github.com/xyz0101/excelutils

来源：https://blog.csdn.net/youzi1394046585/article/details/86670203
小明的学习圈子
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
分分钟搞定 Excel 数据导出
wenxinzizhu的博客
08-13 2163
数据导出是日常开发的常见功能，及将数据导出为Excel并提供下载。 Java 生态存在大量的 Excel 操作类库，基于这些类库便可完成相关功能。这样，大量繁杂、无意义的代码耗费着宝贵的人力资源，大家距离 996 又近了几分，那有没有更优解呢？...
springboot+mybatis+poi 实现excel导入导出
09-04
本篇文章将详细介绍如何利用SpringBoot和MyBatis结合Apache POI实现Excel的导入导出功能。 首先，SpringBoot是一个基于Spring框架的轻量级开发工具，它简化了新Spring应用的初始搭建以及开发过程。SpringBoot通过...
基于注解实现Excel导入导出（兼容2003、2007版本）
09-01
测试、验证、导入导出都已经亲测，导出即可用，需要的下载
Java高级特性——注解：注解实现Excel导出功能
2401_84046635的博客
05-16 368
自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。深知大多数Java工程师，想要提升技能，往往是自己摸索成长，自己不成体系的自学效果低效漫长且无助。因此收集整理了一份《2024年Java开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。
基于注解导出excel
08-03
基于注解，java反射，通用导出excel工具，demo
java导入、导出Excel自动工具【基于注解，不用关心代码逻辑】
08-08
java导入、导出Excel自动工具【基于注解，不用关心代码逻辑】
ssh注解方式+poi实现Excel导入导出
11-01
本人实际项目功能简化出来的小功能，由三大框架ssh构成，使用的是注解方式。项目中去除了连接数据库那一块，如需数据库操作，请进行相应修改。使用方式：直接用eclipse把项目导入进去，配置Tomcat7.0运行即可
easyexcel+validation excel导入导出下载
01-19
本文将深入探讨如何结合EasyExcel和Validation实现高效且准确的Excel导入导出与数据校验。 EasyExcel的优势在于其简洁的API设计和对内存的高效利用。它无需预先加载整个Excel文件到内存，而是采用流式读写，降低了...
spring boot+mybatis plus+easy poi实现数据库导出成excel和excel导入到数据库.zip
11-22
在本项目中，"spring boot+mybatis plus+easy poi实现数据库导出成excel和excel导入到数据库"，开发者利用了Spring Boot、MyBatis Plus和EasyPoi库来实现了一个功能强大的数据交互系统，允许用户将数据库中的数据...
Springboot+Poi实现Excel的导入导出
10-22
综上所述，"Springboot+Poi实现Excel的导入导出"是一个实用的功能，它结合了Spring Boot的便捷性、MyBatis的数据库操作以及POI的Excel处理能力，为企业级应用提供了高效的数据交换手段。在实际开发中，还需要根据...
springboot注解实现excel下载
08-24
利用注解实现excel导出。PubCloudFrmAgrmController是controller层，ResponseEntity是返回给前端的excel下载流。调用下载只需new ExportExcel("框架协议数据", FrmAgrmExcelOutVo.class).setDataList(list).getResponseEntity()。 ExcelField.java是注解类，ExportExcel.java是注解解释类。
基于注解实现的 Excel 万能导出工具，附源码
Java笔记虾
04-05 692
前言上次给大家分享了一个自己开发的基于注解Excel导出的小工具，不知道有没有人用，是针对复杂数据导出多个Sheet页的，那也是第一个版本。后来小编发现了很多问题：无法满足多复杂数据多行表头有那种一对一的数据也没有办法显示，而且得需要去做连表查询。开发太费劲。无法设置自己的样式或者企业规定的样式或字体。列宽无法自适应。遇到数据库里面 类似：type 字段的值一般都是 1,2,3,4：1：未支付，2...
利用注解反射生成导出excel文件
sinat_27581653的专栏
04-21 780
利用注解和反射生成excel
基于注解的Excel导出工具
刘先森的博客
08-07 518
前言 大家工作中，往往会遇到Excel导出的问题，但是写导出数据的时候，需要构造很多不需要的参数，如Title，列明，还有数据列表。不知道小伙伴们有没有感觉很繁琐，小编自己觉得很繁琐，所以想有一个能够不用 构造这么多东西去写Excel导出，能不能直接给我传递一个集合，我就能直接给导出呢？ 针对这个小编也是想了很久终于找到了一套方案，最近也是写了一个初级版本。这里分享给大家，希望能够对那些觉得Exc...
自定注解,导出Excel
单人影的博客
04-21 659
poi的依赖 <dependencies> <dependency> <groupId>org.apache.poi</groupId> <artifactId>poi</artifactId> ...
Java SSM注解实现POI导入导出Excel
Jason_zhang666的博客
03-12 452
POI生成Excel设置单元格格式：HSSFWorkbook demoWorkBook = new HSSFWorkbook();   HSSFSheet demoSheet = demoWorkBook.createSheet("The World's 500 Enterprises");   HSSFCell cell = demoSheet.createRow(0).createCell(0...
基于注解的Excel 导入导出
weixin_43762303的博客
07-30 141
https://blog.csdn.net/qq_34087560/article/details/79352448
【Java】使用注解实现Excel导出功能
最新发布
Buer_D的博客
06-05 157
因为在开发过程中，有大量的Excel导出需求，重复性代码很多，故有了利用注解实现Excel导出的想法，经过拼凑和结合我的使用场景，写了一个利用注解实现Excel导出的工具类代码。该工具类将添加了注解的实体类属性填入sheet页中，可根据自己的需求灵活改动，降低开发中的工作量。以上代码部分实现借鉴于博客，送还于博客。下面是使用该注解的工具类。
Java注解生成Excel_Java：自定义注解+反射实现导入导出Excel文档
05-14
Java注解是一种元数据，它可以为类、方法、字段等元素添加额外的信息。在Java中，可以使用自定义注解和反射来实现导入导出Excel文档。 首先，定义一个自定义注解，用于标记需要导出的实体类的字段： ```java @Target(ElementType.FIELD) @Retention(RetentionPolicy.RUNTIME) public @interface ExcelField { /** * 列名 */ public String name(); /** * 顺序 */ public int order(); } ``` 然后，在实体类的字段上添加该注解： ```java public class User { @ExcelField(name = "姓名", order = 1) private String name; @ExcelField(name = "年龄", order = 2) private int age; // 省略其他字段和方法 } ``` 接着，定义一个工具类，用于读取和写入Excel文档： ```java public class ExcelUtil { /** * 从Excel中读取数据 */ public static <T> List<T> readFromExcel(InputStream is, Class<T> clazz) { List<T> list = new ArrayList<>(); try { Workbook workbook = WorkbookFactory.create(is); Sheet sheet = workbook.getSheetAt(0); Map<Integer, String> headers = getHeaders(sheet.getRow(0)); for (int i = 1; i <= sheet.getLastRowNum(); i++) { Row row = sheet.getRow(i); T obj = clazz.newInstance(); for (int j = 0; j < row.getLastCellNum(); j++) { Cell cell = row.getCell(j); String value = getValue(cell); String fieldName = headers.get(j); Field field = clazz.getDeclaredField(fieldName); field.setAccessible(true); setValue(obj, field, value); } list.add(obj); } } catch (Exception e) { e.printStackTrace(); } return list; } /** * 写入数据到Excel中 */ public static <T> void writeToExcel(List<T> list, OutputStream os) { try { Workbook workbook = new XSSFWorkbook(); Sheet sheet = workbook.createSheet(); Row header = sheet.createRow(0); Map<String, Integer> fields = getFields(list.get(0).getClass()); List<String> fieldNames = new ArrayList<>(fields.keySet()); Collections.sort(fieldNames); for (int i = 0; i < fieldNames.size(); i++) { String fieldName = fieldNames.get(i); Cell cell = header.createCell(i); cell.setCellValue(fields.get(fieldName)); } for (int i = 0; i < list.size(); i++) { Row row = sheet.createRow(i + 1); T obj = list.get(i); for (int j = 0; j < fieldNames.size(); j++) { String fieldName = fieldNames.get(j); Field field = obj.getClass().getDeclaredField(fieldName); field.setAccessible(true); Object value = field.get(obj); Cell cell = row.createCell(j); cell.setCellValue(value.toString()); } } workbook.write(os); } catch (Exception e) { e.printStackTrace(); } } /** * 获取Excel中的列名 */ private static Map<Integer, String> getHeaders(Row row) { Map<Integer, String> headers = new HashMap<>(); for (int i = 0; i < row.getLastCellNum(); i++) { Cell cell = row.getCell(i); String value = getValue(cell); headers.put(i, value); } return headers; } /** * 获取实体类中的字段名和顺序 */ private static <T> Map<String, Integer> getFields(Class<T> clazz) { Map<String, Integer> fields = new HashMap<>(); Field[] declaredFields = clazz.getDeclaredFields(); for (Field field : declaredFields) { if (field.isAnnotationPresent(ExcelField.class)) { ExcelField excelField = field.getAnnotation(ExcelField.class); fields.put(field.getName(), excelField.order()); } } return fields; } /** * 设置实体类中的字段值 */ private static <T> void setValue(T obj, Field field, String value) throws Exception { String typeName = field.getType().getName(); if ("int".equals(typeName)) { field.set(obj, Integer.parseInt(value)); } else if ("java.lang.String".equals(typeName)) { field.set(obj, value); } // 省略其他类型的判断 } /** * 获取单元格中的值 */ private static String getValue(Cell cell) { String value = ""; if (cell != null) { switch (cell.getCellType()) { case STRING: value = cell.getStringCellValue(); break; case NUMERIC: if (DateUtil.isCellDateFormatted(cell)) { Date date = cell.getDateCellValue(); value = new SimpleDateFormat("yyyy-MM-dd").format(date); } else { value = String.valueOf(cell.getNumericCellValue()); } break; case BOOLEAN: value = String.valueOf(cell.getBooleanCellValue()); break; case FORMULA: value = String.valueOf(cell.getCellFormula()); break; default: value = ""; } } return value; } } ``` 最后，可以使用该工具类来读取和写入Excel文档： ```java public class Main { public static void main(String[] args) { // 从Excel中读取数据 try (InputStream is = new FileInputStream("users.xlsx")) { List<User> list = ExcelUtil.readFromExcel(is, User.class); for (User user : list) { System.out.println(user.getName() + ", " + user.getAge()); } } catch (Exception e) { e.printStackTrace(); } // 写入数据到Excel中 List<User> list = new ArrayList<>(); list.add(new User("张三", 20)); list.add(new User("李四", 30)); list.add(new User("王五", 40)); try (OutputStream os = new FileOutputStream("users.xlsx")) { ExcelUtil.writeToExcel(list, os); } catch (Exception e) { e.printStackTrace(); } } } ```
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值