SpringBoot | 第十三章：springboot集成easypoi实现Excel导入导出

最新推荐文章于 2024-06-10 16:27:56 发布
最新推荐文章于 2024-06-10 16:27:56 发布
阅读量651 收藏 1
点赞数
分类专栏： java

https://blog.csdn.net/Thinkingcao/article/details/85005930

easypoi官方文档：http://easypoi.mydoc.io/

 借鉴博客：https://blog.csdn.net/qq_37598011/article/details/80918565

1. 前传
  1.1 前言

  easypoi功能如同名字easy,主打的功能就是容易,让一个没见接触过poi的人员 就可以方便的写出Excel导出,Excel模板导出,Excel导    入,Word模板导出,通过简单的注解和模板 语言(熟悉的表达式语法),完成以前复杂的写法

2. 功能
Excel自适应xls和xlsx两种格式,word只支持docx模式

1.Excel导入

注解导入
Map导入
大数据量导入sax模式
导入文件保存
文件校验
字段校验
2.Excel导出

注解导出
模板导出
html导出
3.Excel转html

4.word导出

5.pdf导出

 

3. Easypoi介绍
    Easypoi 为谁而开发

不太熟悉poi的
不想写太多重复太多的
只是简单的导入导出的
喜欢使用模板的
4. 新建SpringBoot项目，引入pom依赖

<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.0.RELEASE</version>
        <relativePath />
    </parent>
 
    <!-- 设jdk版本1.8和项目编码格式UTF-8 -->
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>
 
    <dependencies>
        <!-- 集成easypoi组件 .导出excel http://easypoi.mydoc.io/ -->
        <dependency>
            <groupId>cn.afterturn</groupId>
            <artifactId>easypoi-base</artifactId>
            <version>3.2.0</version>
        </dependency>
        <dependency>
            <groupId>cn.afterturn</groupId>
            <artifactId>easypoi-web</artifactId>
            <version>3.2.0</version>
        </dependency>
        <dependency>
            <groupId>cn.afterturn</groupId>
            <artifactId>easypoi-annotation</artifactId>
            <version>3.2.0</version>
        </dependency>
        
        <!-- 这个依赖相当于上面 easypoi-base、easypoi-web、easypoi-annotation这3个依赖,可以引入上面3个依赖，也可以引入下面这一个，两个方案二选一-->
    <!--     <dependency>
            <groupId>cn.afterturn</groupId>
            <artifactId>easypoi-spring-boot-starter</artifactId>
            <version>3.2.0</version>
        </dependency> -->
 
 
        <!-- 集成springboot web组件 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!-- 集成springboot test组件 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <!-- 集成lombok 框架 -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <!-- 文件上传组件 -->
        <dependency>
            <groupId>commons-fileupload</groupId>
            <artifactId>commons-fileupload</artifactId>
            <version>1.3.1</version>
        </dependency>
        <!--阿里巴巴 fastjson -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.30</version>
        </dependency>
    </dependencies>
 
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
5. 定义需要导出的实体对象User

    补充@Setter、@Getter、@ToString这三个注解是使用Lombok插件，不知道的另行百度即可；

import java.util.Date;
 
import javax.validation.constraints.NotBlank;
 
import cn.afterturn.easypoi.excel.annotation.Excel;
import cn.afterturn.easypoi.excel.annotation.ExcelTarget;
import lombok.Getter;
import lombok.Setter;
import lombok.ToString;
 
/**
 * <pre>
 * &#64;author cao_wencao
 * &#64;date 2018年12月13日 下午4:50:18
 * </pre>
 */
@ExcelTarget("20")
@Setter
@Getter
@ToString
public class User implements java.io.Serializable{
    @Excel(name = "id", width=15)
    @NotBlank(message = "该字段不能为空")
    private Integer id;
 
    @Excel(name = "姓名", orderNum = "0", width=30)
    private String name;
 
    @Excel(name = "性别", replace = { "男_1", "女_2" }, orderNum = "1", width=30)
    private String sex;
 
    @Excel(name = "生日", exportFormat = "yyyy-MM-dd",  orderNum = "2", width=30)
    private String birthday;
 
 
 
}
5. Excel导入导出工具类

import cn.afterturn.easypoi.excel.ExcelExportUtil;
import cn.afterturn.easypoi.excel.ExcelImportUtil;
import cn.afterturn.easypoi.excel.entity.ExportParams;
import cn.afterturn.easypoi.excel.entity.ImportParams;
import cn.afterturn.easypoi.excel.entity.enmus.ExcelType;
import org.apache.commons.lang3.StringUtils;
import org.apache.poi.ss.usermodel.Workbook;
import org.springframework.web.multipart.MultipartFile;
 
import javax.servlet.http.HttpServletResponse;
import java.io.File;
import java.io.IOException;
import java.net.URLEncoder;
import java.util.List;
import java.util.Map;
import java.util.NoSuchElementException;
 
//Excel导入导出工具类
public class ExcelUtils {
    public static void exportExcel(List<?> list, String title, String sheetName, Class<?> pojoClass, String fileName,
            boolean isCreateHeader, HttpServletResponse response) {
        ExportParams exportParams = new ExportParams(title, sheetName);
        exportParams.setCreateHeadRows(isCreateHeader);
        defaultExport(list, pojoClass, fileName, response, exportParams);
    }
 
    public static void exportExcel(List<?> list, String title, String sheetName, Class<?> pojoClass, String fileName,
            HttpServletResponse response) {
        defaultExport(list, pojoClass, fileName, response, new ExportParams(title, sheetName));
    }
 
    public static void exportExcel(List<Map<String, Object>> list, String fileName, HttpServletResponse response) {
        defaultExport(list, fileName, response);
    }
 
    private static void defaultExport(List<?> list, Class<?> pojoClass, String fileName, HttpServletResponse response,
            ExportParams exportParams) {
        Workbook workbook = ExcelExportUtil.exportExcel(exportParams, pojoClass, list);
        if (workbook != null)
            ;
        downLoadExcel(fileName, response, workbook);
    }
 
    private static void downLoadExcel(String fileName, HttpServletResponse response, Workbook workbook) {
        try {
            response.setCharacterEncoding("UTF-8");
            response.setHeader("content-Type", "application/vnd.ms-excel");
            response.setHeader("Content-Disposition", "attachment;filename=" + URLEncoder.encode(fileName, "UTF-8"));
            workbook.write(response.getOutputStream());
        } catch (IOException e) {
            // throw new NormalException(e.getMessage());
        }
    }
 
    private static void defaultExport(List<Map<String, Object>> list, String fileName, HttpServletResponse response) {
        Workbook workbook = ExcelExportUtil.exportExcel(list, ExcelType.HSSF);
        if (workbook != null)
            ;
        downLoadExcel(fileName, response, workbook);
    }
 
    public static <T> List<T> importExcel(String filePath, Integer titleRows, Integer headerRows, Class<T> pojoClass) {
        if (StringUtils.isBlank(filePath)) {
            return null;
        }
        ImportParams params = new ImportParams();
        params.setTitleRows(titleRows);
        params.setHeadRows(headerRows);
        List<T> list = null;
        try {
            list = ExcelImportUtil.importExcel(new File(filePath), pojoClass, params);
        } catch (NoSuchElementException e) {
            // throw new NormalException("模板不能为空");
        } catch (Exception e) {
            e.printStackTrace();
            // throw new NormalException(e.getMessage());
        }
        return list;
    }
 
    public static <T> List<T> importExcel(MultipartFile file, Integer titleRows, Integer headerRows,
            Class<T> pojoClass) {
        if (file == null) {
            return null;
        }
        ImportParams params = new ImportParams();
        params.setTitleRows(titleRows);
        params.setHeadRows(headerRows);
        List<T> list = null;
        try {
            list = ExcelImportUtil.importExcel(file.getInputStream(), pojoClass, params);
        } catch (NoSuchElementException e) {
            // throw new NormalException("excel文件不能为空");
        } catch (Exception e) {
            // throw new NormalException(e.getMessage());
            System.out.println(e.getMessage());
        }
        return list;
    }
 
}
6. 封装接口，定义Service，分别定义查询导出数据和保存导入数据的方法，我这个demo中就写假接口，不操作数据库，自己用的时候自行开发接口从数据库存取

import java.util.Date;
import java.util.List;
 
import org.springframework.stereotype.Service;
 
import com.google.common.collect.Lists;
import com.thinkingcao.demo.easypoi.entity.User;
 
/**
 * <pre>
 * &#64;author cao_wencao
 * &#64;date 2018年12月13日 下午5:37:17
 * </pre>
 */
@Service
public class UserService {
    
    public List<User> findAll() {
        List<User> listAll = Lists.newArrayList();
        List<User> list = Lists.newArrayList();
        User user = new User();
        user.setId(10);
        user.setName("张三");
        user.setSex("男");
        user.setBirthday(new Date().toString());
        User user1 = new User();
        user1.setId(20);
        user1.setName("李四");
        user1.setSex("男");
        user1.setBirthday(new Date().toString());
        user.setBirthday(new Date().toString());
        User user2 = new User();
        user2.setId(20);
        user2.setName("王五");
        user2.setSex("男");
        user2.setBirthday(new Date().toString());
        list.add(user);
        list.add(user1);
        list.add(user2);
        listAll.addAll(list);
        return listAll;
    }
}
7. 导出方法的Controller。ExcelExportController

import java.util.List;
 
import javax.servlet.http.HttpServletResponse;
 
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
 
import com.thinkingcao.demo.easypoi.entity.User;
import com.thinkingcao.demo.easypoi.service.UserService;
import com.thinkingcao.demo.easypoi.utils.ExcelUtils;
 
/**
 * <pre>
 * &#64;author cao_wencao
 * &#64;date 2018年12月13日 下午6:16:59
 * </pre>
 */
@RestController
@RequestMapping("/excel/export")
public class ExcelExportController {
    @Autowired
    private UserService userService;
 
    @GetMapping("/exportExcel")
    public void export(HttpServletResponse response) {
        System.out.println(1);
        // 模拟从数据库获取需要导出的数据
        List<User> personList = userService.findAll();
        // 导出操作
        ExcelUtils.exportExcel(personList, "easypoi导出功能", "导出sheet1", User.class, "测试user.xls", response);
 
    }
}
8. 导入方法的Controller。ExcelImportController 

import java.io.IOException;
import java.util.List;
 
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;
 
import com.alibaba.fastjson.JSONObject;
import com.fasterxml.jackson.databind.util.JSONPObject;
import com.thinkingcao.demo.easypoi.entity.User;
 
import cn.afterturn.easypoi.excel.ExcelImportUtil;
import cn.afterturn.easypoi.excel.entity.ImportParams;
import cn.afterturn.easypoi.excel.entity.result.ExcelImportResult;
import lombok.extern.slf4j.Slf4j;
 
/**
 * <pre>
 * &#64;author cao_wencao
 * &#64;date 2018年12月13日 下午6:17:10
 * </pre>
 */
@RestController
@RequestMapping("/excel/import")
@Slf4j
public class ExcelImportController {
 
    @PostMapping("/importExcel")
    public String importExcel2(@RequestParam("file") MultipartFile file) {
        ImportParams importParams = new ImportParams();
        // 数据处理
        importParams.setHeadRows(1);
        importParams.setTitleRows(1);
        // 需要验证
        importParams.setNeedVerfiy(false);       
        
        try {
            ExcelImportResult<User> result = ExcelImportUtil.importExcelMore(file.getInputStream(), User.class,
                    importParams);
            List<User> userList = result.getList();
            for (User User : userList) {
                // System.out.println(User);
                log.info("从Excel导入数据到数据库的详细为 ：{}", JSONObject.toJSONString(User));
                //TODO 将导入的数据做保存数据库操作
            }
            log.info("从Excel导入数据一共 {} 行 ", userList.size());
        } catch (IOException e) {
            log.error("导入失败：{}", e.getMessage());
        } catch (Exception e1) {
            log.error("导入失败：{}", e1.getMessage());
        }
        return "导入成功";
    }
}
9.创建启动类SpringBootEasyPoiApp

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
 
/**
 * <pre>
 * @author cao_wencao
 * @date 2018年12月13日 下午4:38:24
 * </pre>
 */
@SpringBootApplication
public class SpringBootEasyPoiApp {
 
    /**
     * <pre>  
     * @author cao_wencao
     * @param args
     * </pre>  
     */
    public static void main(String[] args) {
        SpringApplication.run(SpringBootEasyPoiApp.class, args);
    }
 
}
10.创建aplication.yml文件，定义端口

server:
  port: 8998
11.结果

Excel导入接口
     接口地址：http://127.0.0.1:8998/excel/import/importExcel

     

Excel导出接口
     接口地址：http://127.0.0.1:8998/excel/export/exportExcel

     

 

简单的导入导出就这样，很简单，有其他更加丰富的功能，可以阅读作者文档：http://easypoi.mydoc.io/

 
--------------------- 
作者：自由不过一种漂泊 
来源：CSDN 
原文：https://blog.csdn.net/Thinkingcao/article/details/85005930 
版权声明：本文为博主原创文章，转载请附上博文链接！

竹林幽深
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Spring Boot进阶(07)：如何使用EasyPoi实现Java中Excel的导入导出？完整教程请收藏，让你的Excel操作更高效！
**My Coding Family**
09-02 2875
集成EasyPoi，实现Excel的导入导出，一文教你学会。
Spring Boot进阶(09)：用EasyPoi实现Excel多sheet导入导出，轻松管理海量数据！
**My Coding Family**
09-05 6540
集成EasyPoi，实现Excel文件多sheet的导入导出，一文教会大家。
【Java+EasyExcel】使用 SpringBoot 实现 Excel 文件的导入（含示例代码）
热门推荐
06-10 1万+
【Java+EasyExcel】使用 SpringBoot 实现 Excel 文件的导入（含示例代码）
Spring Boot进阶(08)：使用EasyPoi实现Excel/Word携带图片导出，打造精美的报表
**My Coding Family**
09-07 3239
如何快速学会SpringBoot项目中图片导出到Excel/Word中？一文教你搞定
Spring Boot进阶(10)：「从Excel到PDF，EasyPoi助你一键完美转换！」
**My Coding Family**
09-11 7379
集成EasyPoi，如何实现Excel模板导出成PDF文件？一文教会你。
Spring Boot进阶(55)：高效无缝集成MongoDB！SpringBoot开发从容应对大数据存储挑战。
**My Coding Family**
07-19 3602
SpringBoot如何集成MongoDB及实战使用？一文教你搞定。
Spring Boot进阶(48)：【实战教程】SpringBoot集成WebSocket轻松实现实时消息推送
**My Coding Family**
06-15 2048
一文教你如何在Spring Boot项目中集成WebSocket及使用说明，非常详细具体。
Springboot导出Excel表格
余生一个帆的博客
07-17 927
controller @ApiOperation("后台管理-导出开奖信息") @IgnoreAuth @GetMapping("exportPrizeExchangeInfo") public void exportPrizeExchangeInfo(BevActivitySettingIdReq req){ response.setCharacterEncoding("utf-8"); response.setContentType("mu
SpringBoot第1讲：SpringBoot 知识体系详解+原理+应用+面试(P6精通)
Jet_qi的博客
08-10 358
面试时常常被面试官问到这个问题，Spring Boot包含实际业务开发中的方方面面。本篇文章作为SpringBoot第1讲，开篇会站在知识体系的视角，介绍基于SpringBoot总体知识点，包括入门、开发过程、项目实战、源码解析等。
SpringBoot图文教程9—SpringBoot 导入导出 Excel 「Apache Poi」
Java杂记
03-04 1125
有天上飞的概念，就要有落地的实现 - 概念十遍不如代码一遍，朋友，希望你把文中所有的代码案例都敲一遍 - 先赞后看，养成习惯 SpringBoot 图文教程系列文章目录 SpringBoot图文教程1「概念+案例 思维导图」「基础篇上」 SpringBoot图文教程2—日志的使用「logback」「log4j」 SpringBoot图文教程3—「‘初恋’情结」集成Jsp Spring...
springboot整合easypoi实现文件导入导出OSS文件上传和下载。OSS图片导出
01-07
在本项目中，我们主要探讨如何使用SpringBoot框架与阿里云OSS（Object Storage Service）服务相结合，通过Easypoi库实现文件的导入、导出功能，以及OSS上的文件上传和下载。Easypoi是一个强大的Java操作Excel的工具...
使用Springboot实现excel的导入导出
04-02
在Spring Boot中实现Excel的导入导出可以通过POI库来实现，POI是一个开源的Java库，用于处理Microsoft Office格式文件，包括Excel。一个简单的示例，演示如何在Spring Boot项目中使用POI来实现Excel的导入导出功能。...
SpringBoot整合poi实现Excel文件的导入和导出.pdf
10-08
下面我们将详细介绍如何在SpringBoot中整合POI来实现Excel的导入和导出，以及如何利用ExcelFormatUtil工具类进行单元格数据格式的判断。 首先，我们需要在项目的pom.xml文件中引入Apache POI的相关依赖，具体如下：...
Springboot+Poi实现Excel的导入导出
01-28
总之，"Springboot+Poi实现Excel的导入导出"项目结合了多种强大的工具，提供了一种高效、灵活的数据处理解决方案。无论是开发数据管理应用，还是进行数据分析任务，这样的功能都极具价值。通过深入了解和实践这些...
springboot实现Excel文件导入与导出功能
12-19
springboot实现Excel文件导入与导出功能, 本次任务主要实现两个功能，一是如何将Excel文件导入后台服务器，解析文件中的内容，并且存入数据库中。二是如何将后台数据库中的数据导出为Excel表格。经过调研，实现此...
Java面试整理，涵盖基础、JVM、线程并发、框架、MySQL、微服务、Redis、中间件、数据结构与算法等。陆续完善中.zip
07-31
Java面试整理，涵盖基础、JVM、线程并发、框架、MySQL、微服务、Redis、中间件、数据结构与算法等。陆续完善中
chromedriver-mac-x64_121.0.6167.184.zip
最新发布
07-31
chromedriver-mac-x64_121.0.6167.184.zip
【Java面试+Java技术文章汇总】 涵盖大部分Java程序员所需要掌握的核心知识。.zip
07-31
【Java面试+Java技术文章汇总】 涵盖大部分Java程序员所需要掌握的核心知识。
easypoi导入导出 springboot
09-30
您可以使用easypoi-spring-boot-starter来实现springboot项目中的Excel导入导出功能。可以通过在项目的pom.xml文件中添加以下依赖来导入eas＊＊＊;/groupId> <artifactId>easypoi-spring-boot-starter<...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值