springboot 基于自定义注解poi导入导出excel

最新推荐文章于 2024-03-08 01:24:01 发布
最新推荐文章于 2024-03-08 01:24:01 发布
阅读量1.1k 收藏 8
点赞数 1
分类专栏： POI 文章标签： spring boot
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_40974235/article/details/107149967
版权

注意：本文用到了java8新特性，要jdk1.8以上

1.导入poi 依赖

<!-- poi导入导出 -->
		<dependency>
			<groupId>org.apache.poi</groupId>
			<artifactId>poi</artifactId>
			<version>3.13</version>
		</dependency>
		<dependency>
			<groupId>org.apache.poi</groupId>
			<artifactId>poi-ooxml</artifactId>
			<version>3.13</version>
		</dependency>

2.添加ExcelUtils工具类

package com.iflytek.edu.hnezzhxy.util;
import com.iflytek.edu.hnezzhxy.common.config.Constants;
import com.iflytek.edu.hnezzhxy.common.config.ExcelColumn;
import org.apache.poi.hssf.usermodel.HSSFDateUtil;
import org.apache.poi.hssf.usermodel.HSSFWorkbook;
import org.apache.poi.ss.usermodel.*;
import org.apache.poi.xssf.usermodel.XSSFWorkbook;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.MediaType;
import org.springframework.util.CollectionUtils;
import org.springframework.web.multipart.MultipartFile;

import javax.servlet.http.HttpServletResponse;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.math.BigDecimal;
import java.net.URLEncoder;
import java.util.*;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.stream.Collectors;
import java.util.stream.Stream;

/**
 * @version 1.0
 * @description 导入Execel
 * @create 2020/06/24 16:09
 */
public class ExcelUtils {

    private final static Logger log = LoggerFactory.getLogger(ExcelUtils.class);

    public static <T> List<T> readExcel(String path, Class<T> cls, MultipartFile file){

        String fileName = file.getOriginalFilename();
        if (!fileName.matches("^.+\\.(?i)(xls)$") && !fileName.matches("^.+\\.(?i)(xlsx)$")) {
            log.error("上传文件格式不正确");
        }
        List<T> dataList = new ArrayList<>();
        Workbook workbook = null;
        try {
            InputStream is = file.getInputStream();
            if (fileName.endsWith(Constants.EXCEL2007)) {
                workbook = new XSSFWorkbook(is);
            }
            if (fileName.endsWith(Constants.EXCEL2003)) {
                workbook = new HSSFWorkbook(is);
            }
            if (workbook != null) {
                //类映射  注解 value-->bean columns
                Map<String, List<Field>> classMap = new HashMap<>();
                List<Field> fields = Stream.of(cls.getDeclaredFields()).collect(Collectors.toList());
                fields.forEach(
                        field -> {
                            ExcelColumn annotation = field.getAnnotation(ExcelColumn.class);
                            if (annotation != null) {
                                String value = annotation.value();
                                if (StringUtils.isBlank(value)) {
                                    return;//return起到的作用和continue是相同的 语法
                                }
                                if (!classMap.containsKey(value)) {
                                    classMap.put(value, new ArrayList<>());
                                }
                                field.setAccessible(true);
                                classMap.get(value).add(field);
                            }
                        }
                );
                //索引-->columns
                Map<Integer, List<Field>> reflectionMap = new HashMap<>(16);
                //默认读取第一个sheet
                Sheet sheet = workbook.getSheetAt(0);

                boolean firstRow = true;
                for (int i = sheet.getFirstRowNum(); i <= sheet.getLastRowNum(); i++) {
                    Row row = sheet.getRow(i);
                    //首行  提取注解
                    if (firstRow) {
                        for (int j = row.getFirstCellNum(); j <= row.getLastCellNum(); j++) {
                            Cell cell = row.getCell(j);
                            String cellValue = getCellValue(cell);
                            if (classMap.containsKey(cellValue)) {
                                reflectionMap.put(j, classMap.get(cellValue));
                            }
                        }
                        firstRow = false;
                    } else {
                        //忽略空白行
                        if (row == null) {
                            continue;
                        }
                        try {
                            T t = cls.newInstance();
                            //判断是否为空白行
                            boolean allBlank = true;
                            for (int j = row.getFirstCellNum(); j <= row.getLastCellNum(); j++) {
                                if (reflectionMap.containsKey(j)) {
                                    Cell cell = row.getCell(j);
                                    String cellValue = getCellValue(cell);
                                    if (StringUtils.isNotBlank(cellValue)) {
                                        allBlank = false;
                                    }
                                    List<Field> fieldList = reflectionMap.get(j);
                                    fieldList.forEach(
                                            x -> {
                                                try {
                                                    handleField(t, cellValue, x);
                                                } catch (Exception e) {
                                                    log.error(String.format("第:%row行 field:%s value:%s exception!", x.getName(), cellValue), e);
                                                }
                                            }
                                    );
                                }
                            }
                            if (!allBlank) {
                                dataList.add(t);
                            } else {
                                log.warn(String.format("row:%s is blank ignore!", i));
                            }
                        } catch (Exception e) {
                            log.error(String.format("parse row:%s exception!", i), e);
                        }
                    }
                }
            }
        } catch (Exception e) {
            log.error(String.format("parse excel exception!"), e);
        } finally {
            if (workbook != null) {
                try {
                    workbook.close();
                } catch (Exception e) {
                    log.error(String.format("parse excel exception!"), e);
                }
            }
        }
        return dataList;
    }

    private static <T> void handleField(T t, String value, Field field) throws Exception {
        Class<?> type = field.getType();
        if (type == null || type == void.class || StringUtils.isBlank(value)) {
            return;
        }
        if (type == Object.class) {
            field.set(t, value);
            //数字类型
        } else if (type.getSuperclass() == null || type.getSuperclass() == Number.class) {
            if (type == int.class || type == Integer.class) {
                field.set(t, Integer.parseInt(value));
            } else if (type == long.class || type == Long.class) {
                field.set(t, Long.parseLong(value));
            } else if (type == byte.class || type == Byte.class) {
                field.set(t, Byte.parseByte(value));
            } else if (type == short.class || type == Short.class) {
                field.set(t, Short.parseShort(value));
            } else if (type == double.class || type == Double.class) {
                field.set(t, Double.parseDouble(value));
            } else if (type == float.class || type == Float.class) {
                field.set(t, Float.parseFloat(value));
            } else if (type == char.class || type == Character.class) {
                field.set(t, String.valueOf(value));
            } else if (type == boolean.class) {
                field.set(t, Boolean.valueOf(value));
            } else if (type == BigDecimal.class) {
                field.set(t, new BigDecimal(value));
            }
        } else if (type == Boolean.class) {
            field.set(t, Boolean.valueOf(value));
        } else if (type == Date.class) {
            //
            field.set(t, value);
        } else if (type == String.class) {
            field.set(t, value);
        } else {
            Constructor<?> constructor = type.getConstructor(String.class);
            field.set(t, constructor.newInstance(value));
        }
    }

    private static String getCellValue(Cell cell) {
        if (cell == null) {
            return "";
        }
        if (cell.getCellType() == Cell.CELL_TYPE_NUMERIC) {
            if (HSSFDateUtil.isCellDateFormatted(cell)) {
                return HSSFDateUtil.getJavaDate(cell.getNumericCellValue()).toString();
            } else {
                return new BigDecimal(cell.getNumericCellValue()).toString();
            }
        } else if (cell.getCellType() == Cell.CELL_TYPE_STRING) {
            return StringUtils.trimToEmpty(cell.getStringCellValue());
        } else if (cell.getCellType() == Cell.CELL_TYPE_FORMULA) {
            return StringUtils.trimToEmpty(cell.getCellFormula());
        } else if (cell.getCellType() == Cell.CELL_TYPE_BLANK) {
            return "";
        } else if (cell.getCellType() == Cell.CELL_TYPE_BOOLEAN) {
            return String.valueOf(cell.getBooleanCellValue());
        } else if (cell.getCellType() == Cell.CELL_TYPE_ERROR) {
            return "ERROR";
        } else {
            return cell.toString().trim();
        }

    }

    public static <T> void writeExcel(HttpServletResponse response, List<T> dataList, Class<T> cls) {
        Field[] fields = cls.getDeclaredFields();
        List<Field> fieldList = Arrays.stream(fields)
                .filter(field -> {
                //ExcelColumn.class注解的字段必须中测value值要和excel中的表头文字要保持一模一样，不然不能将excel读取的内容存到相对应的字段上
                    ExcelColumn annotation = field.getAnnotation(ExcelColumn.class);
                    if (annotation != null && annotation.col() > 0) {
                        field.setAccessible(true);
                        return true;
                    }
                    return false;
                }).sorted(Comparator.comparing(field -> {
                    int col = 0;
                    ExcelColumn annotation = field.getAnnotation(ExcelColumn.class);
                    if (annotation != null) {
                        col = annotation.col();
                    }
                    return col;
                })).collect(Collectors.toList());

        Workbook wb = new XSSFWorkbook();
        Sheet sheet = wb.createSheet("Sheet1");
        AtomicInteger ai = new AtomicInteger();
        {
            Row row = sheet.createRow(ai.getAndIncrement());
            AtomicInteger aj = new AtomicInteger();
            //写入头部
            fieldList.forEach(field -> {
                ExcelColumn annotation = field.getAnnotation(ExcelColumn.class);
                String columnName = "";
                if (annotation != null) {
                    columnName = annotation.value();
                }
                Cell cell = row.createCell(aj.getAndIncrement());

                CellStyle cellStyle = wb.createCellStyle();
                cellStyle.setFillForegroundColor(IndexedColors.WHITE.getIndex());
                cellStyle.setFillPattern(CellStyle.SOLID_FOREGROUND);
                cellStyle.setAlignment(CellStyle.ALIGN_CENTER);

                Font font = wb.createFont();
                font.setBoldweight(Font.BOLDWEIGHT_NORMAL);
                cellStyle.setFont(font);
                cell.setCellStyle(cellStyle);
                cell.setCellValue(columnName);
            });
        }
        if (!CollectionUtils.isEmpty(dataList)) {
            dataList.forEach(t -> {
                Row row1 = sheet.createRow(ai.getAndIncrement());
                AtomicInteger aj = new AtomicInteger();
                fieldList.forEach(field -> {
                    Class<?> type = field.getType();
                    Object value = "";
                    try {
                        value = field.get(t);
                    } catch (Exception e) {
                        e.printStackTrace();
                    }
                    Cell cell = row1.createCell(aj.getAndIncrement());
                    if (value != null) {
                        if (type == Date.class) {
                            cell.setCellValue(value.toString());
                        } else {
                            cell.setCellValue(value.toString());
                        }
                        cell.setCellValue(value.toString());
                    }
                });
            });
        }
        //冻结窗格
        wb.getSheet("Sheet1").createFreezePane(0, 1, 0, 1);
        //浏览器下载excel
        buildExcelDocument("abbot.xlsx", wb, response);
        //生成excel文件
        // buildExcelFile(".\\default.xlsx",wb);
    }

    /**
     * 浏览器下载excel
     * @param fileName
     * @param wb
     * @param response
     */

    private static  void  buildExcelDocument(String fileName, Workbook wb, HttpServletResponse response){
        try {
            response.setContentType(MediaType.APPLICATION_OCTET_STREAM_VALUE);
            response.setHeader("Content-Disposition", "attachment;filename="+ URLEncoder.encode(fileName, "utf-8"));
            response.flushBuffer();
            wb.write(response.getOutputStream());
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    /**
     * 生成excel文件
     * @param path 生成excel路径
     * @param wb
     */
    private static  void  buildExcelFile(String path, Workbook wb){

        File file = new File(path);
        if (file.exists()) {
            file.delete();
        }
        try {
            wb.write(new FileOutputStream(file));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

}

3.控制类代码

package com.iflytek.edu.hnezzhxy.controller;

import com.alibaba.fastjson.JSON;
import com.iflytek.edu.hnezzhxy.model.ExcelZsbmStudentResultImport;
import com.iflytek.edu.hnezzhxy.service.ImportExcelService;
import com.iflytek.edu.hnezzhxy.util.ExcelUtils;
import com.iflytek.edu.hnezzhxy.vo.ResultVO;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;

import java.util.List;

/**
 * @version 1.0
 * @description
 * @create 2020/06/24 15:54
 */
@RestController
@RequestMapping("/excel")
public class ImportExcelController {

    @Autowired
    private ImportExcelService importExcelService;

    /**
     *  导入座位号
     * @param file excel文件
     */
    @RequestMapping(value = "/readExcel", method = RequestMethod.POST)
    public void readExcel(@RequestParam(value="uploadFile", required = false) MultipartFile file){
        long t1 = System.currentTimeMillis();
        List<ExcelZsbmStudentResultImport> list = ExcelUtils.readExcel("", ExcelZsbmStudentResultImport.class, file);
        long t2 = System.currentTimeMillis();
        System.out.println(String.format("read over! cost:%sms", (t2 - t1)));
        list.forEach(
                b -> System.out.println(JSON.toJSONString(b))
        );
    }
}

4.自定义导入excel的字段的注解

package com.iflytek.edu.hnezzhxy.common.config;

import java.lang.annotation.*;

@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ExcelColumn {
    /**
     * Excel标题
     *
     * @return
     * @author Lynch
     */
    String value() default "";

    /**
     * Excel从左往右排列位置
     *
     * @return
     * @author Lynch
     */
    int col() default 0;

    /**
     * 字典表
     * @return
     * @author Lynch
     */
    String dicTable() default "";

    /**
     * 字典编码
     * @return
     * @author Lynch
     */
    String dicCode() default "";
    /**
     * 字典名称
     * @return
     * @author Lynch
     */
    String dicName() default "";
}

5.定义要导入的字段模型

package com.iflytek.edu.hnezzhxy.model;

import com.iflytek.edu.hnezzhxy.common.config.ExcelColumn;
import lombok.Data;

/**
 * @version 1.0
 * @description
 * @create 2020/06/24 17:30
 */
@Data
public class ExcelZsbmStudentResultImport {

    @ExcelColumn(value = "学生id", col = 1)
    private String sid;

    @ExcelColumn(value = "考场号", col = 2)
    private String examinationRoomNum;

    @ExcelColumn(value = "座位号", col = 3)
    private String num;

    @ExcelColumn(value = "考试成绩", col = 4)
    private Double score;

}

6.准备的excel
在这里插入图片描述
7.postman导入测试
在这里插入图片描述
8.控制台打印
在这里插入图片描述
然后执行insert方法就可以导入数据库了

9.对比传统的excel导入的优缺点：

1.优点:自定义注解导入比较通用，其他模块也需要导入功能，只需要重新定义一个导入excel的字段模型就好了

2.缺点:excel填写错误时，用户提示不太友好，因为可以通用,所以不太好控制每个模块每个字段的excel填写的错误提示

长路漫漫，与键作伴
关注
专栏目录
【SpringBoot】37、SpringBoot整合EasyPoi自定义字典导出Excel
Asurplus
11-06 22万+
前面我们介绍了 SpringBoot 中使用 JeecgBoot 的 Autopoi 导出 Excel，其实 Autopoi 的底层也是 EasyPoi，对于 Excel 的导入/导出也是非常方便的。那 EasyPoi 也是基于 POI 的，如果对这方面想要深究的，可以先看看原生 POI 的导入/导出方式，你会回来选择 EasyPoi 的 一、简介 EasyPoi 功能如同名字 easy，主打的功能就是容易，让一个没见接触过poi的人员就可以方便的写出 Excel 导出，Excel 模板导出，Excel 导
springboot使用hutool实现EXCEL导入导出
这里是Mae。
04-08 3662
手把手教你 springboot导入导出。
spring-excel-demo--poi 封装对象注解式导入导出--springboot--注释非常完整，适合初学者研究！！！
09-23
只实现了简单的excel导入导出，不支持特殊模版的定义。 里面包含的知识点（适合初学者学习的demo）： 1、poi-excel 基本操作（工具） 2、自定义注解的使用 3、全局异常捕获的定义 4、jkd1.8新特性：Lambda 表达式 、函数式接口 等等 5、统一出参包装类 6、lombok
Java SpringBoot实现注解方式Excel导出
Programmer__Chen的博客
02-03 1489
Java SpringBoot实现注解方式Excel导出
Springboot+Poi实现Excel的导入导出
10-22
主要是springboot+myBatis+poi+mysql的使用，从数据库查询到结果集导出excel到本地，从本地中的excel文件导入到数据库中。
POI 自定义导入Excel
ghb5371548的专栏
04-24 391
Controller代码： @ApiOperation("批量导入排课计划") @PostMapping("/excelBatchImportCourse") public Wrapper excelBatchImportCourse(@RequestHeader("token") String token, @ApiParam(value = "公司ID",required = false) @Req
springboot + poi 解析 excel
悟世君子的博客
10-31 2637
Apache POI 是用 Java 编写的免费开源的跨平台的 Java API，Apache POI提供API给Java程式对 Microsoft Office 格式档案读和写的功能。   本文使用 springboot + mybatis + poi ，来介绍如何解析 excel 、并将 excel 内的数据添加到数据库   一、编写代码  1、添加依赖 因为 excel 分 20...
springboot整合easyPoi的注解方式导出excel文件
weixin_45865428的博客
05-27 1178
一、导入依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>cn.afterturn</groupId> <artifact.
Springboot整合Poi导出excel
weixin_46026528的博客
03-30 392
1.导入依赖 <dependency> <groupId>org.apache.poi</groupId> <artifactId>poi</artifactId> <version>3.14</version> </dependency> <dependency> &lt
java springboot注解通用导入导出Excel
weixin_37304688的博客
09-09 579
springboot 通用的导入和导出 代码简单方便 1.先写个ExcelResources 类 package com.pengtu.utils.ExcelUtils; import java.lang.annotation.*; @Target({ElementType.FIELD}) @Documented @Retention(RetentionPolicy.RUNTIME) public @interface ExcelResources { int order() defau..
springboot注解实现excel下载
08-24
利用注解实现excel导出。PubCloudFrmAgrmController是controller层，ResponseEntity是返回给前端的excel下载流。调用下载只需new ExportExcel("框架协议数据", FrmAgrmExcelOutVo.class).setDataList(list).getResponseEntity()。 ExcelField.java是注解类，ExportExcel.java是注解解释类。
基于Poi的自编导入工具类
weixin_44718708的博客
12-02 4073
利用业余时间基于Poi的自编导入工具类。 1.省去大篇幅的数据处理代码，节约重复编码工作，业务层更干净易维护。 2.实体类做数据模板，实体字段注解处理数据防呆与格式约束，在遍历获取sheet数据时顺便进行相应防呆处理，节约数据二次遍历的开销。
springboot - Excel 导出
y_index的博客
08-14 354
1、maven引入 <dependency> <groupId>org.apache.poi</groupId> <artifactId>poi</artifactId> <version>3.13</version> </dependency...
Springboot excel导入 EasyPOI 双表头的excel 导入数据
memory_cood的博客
02-24 4328
在工作中难免会遇到excel的数据导入。但是有些时间Excel的表头却不那么友好的。直接看图 这里就出现双表头的头的导入 第一步 ：导包 maven <dependency> <groupId>cn.afterturn</groupId> <artifactId>easypoi-base</ar...
POI技术实现文件的导入导出
weixin_47162914的博客
03-11 7072
POI常用工具类的使用
SpringBoot最简单好用的导出导入功能，拿来即用
weixin_51604181的博客
08-09 6263
惊不惊喜，意不意外！！！！ SpringBoot 最简单好用的导出到入功能，已经简单封装好了，拿来即用，提示：觉得🐂B的扣个 666
【Springboot】导入导出
Rex的博客
05-19 1035
导入导出Excel 参考 添加poi的maven依赖 <dependency> <groupId>org.apache.poi</groupId> <artifactId>poi</artifactId> <version>3.13</version> </dependency> <dependency> <groupId>org.apache.poi&lt
Spring Boot中Excel数据导入导出的高效实现
最新发布
interest_ing_的博客
03-08 2966
在企业级应用中，Excel文件的导入导出是一个常见的需求。本文将介绍如何在Spring Boot项目中使用EasyExcel库实现Excel文件的导入导出功能。我们将通过实际的代码示例，展示如何读取和写入Excel文件，以及如何通过自定义监听器来增强数据处理的灵活性。
java导入功能，直接复制使用，有详细注释
虽千万人,吾往矣
11-25 2303
本文基于poi、注解类加反射实现自定义文件表头的导入功能、只需要将表头名写入到实体类的注解类上，就可以实现自定义文件的万能导入功能工具类；有详细的演示和对应的注释
Springboot实战：POI深度解析Excel导出
"Springboot利用POI技术实现Excel文件导出功能的详细教程" 在Springboot项目中，利用Apache POI库进行Excel文件的导出是一项常见的需求，尤其是在处理数据报表或者需要将数据持久化到Excel文档的情况。本文将深入...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值