在SpringBoot: SpringBoot里面创建导出Excel的接口教程

 更新时间:2020年10月26日 12:50:41   投稿:jingxian  
这篇文章主要介绍了在SpringBoot: SpringBoot里面创建导出Excel的接口教程,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧

在Web项目中,难免需要导出Excel这样的功能,后端接口怎么实现呢,Controller代码在下面,复制到项目的Controller中即可使用:

首先加入Excel的依赖,本例中我们用apache的poi:

<dependency>
 <groupId>org.apache.poi</groupId>
 <artifactId>poi</artifactId>
 <version>3.17</version>
</dependency>

后台导出Excel的Controller接口代码:

import org.apache.poi.hssf.usermodel.*;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

@Controller
public class ExcelController {

 /**
 * Excel表格导出接口
 * http://localhost:8080/ExcelDownload
 * @param response response对象
 * @throws IOException 抛IO异常
 */
 @RequestMapping("/ExcelDownload")
 public void excelDownload(HttpServletResponse response) throws IOException {
 //表头数据
 String[] header = {"ID", "姓名", "性别", "年龄", "地址", "分数"};

 //数据内容
 String[] student1 = {"1", "小红", "女", "23", "成都青羊区", "96"};
 String[] student2 = {"2", "小强", "男", "26", "成都金牛区", "91"};
 String[] student3 = {"3", "小明", "男", "28", "成都武侯区", "90"};

 //声明一个工作簿
 HSSFWorkbook workbook = new HSSFWorkbook();

 //生成一个表格,设置表格名称为"学生表"
 HSSFSheet sheet = workbook.createSheet("学生表");

 //设置表格列宽度为10个字节
 sheet.setDefaultColumnWidth(10);

 //创建第一行表头
 HSSFRow headrow = sheet.createRow(0);

 //遍历添加表头(下面模拟遍历学生,也是同样的操作过程)
 for (int i = 0; i < header.length; i++) {
  //创建一个单元格
  HSSFCell cell = headrow.createCell(i);

  //创建一个内容对象
  HSSFRichTextString text = new HSSFRichTextString(header[i]);

  //将内容对象的文字内容写入到单元格中
  cell.setCellValue(text);
 }

 //模拟遍历结果集,把内容加入表格
 //模拟遍历第一个学生
 HSSFRow row1 = sheet.createRow(1);
 for (int i = 0; i < student1.length; i++) {
  HSSFCell cell = row1.createCell(i);
  HSSFRichTextString text = new HSSFRichTextString(student1[i]);
  cell.setCellValue(text);
 }

 //模拟遍历第二个学生
 HSSFRow row2 = sheet.createRow(2);
 for (int i = 0; i < student2.length; i++) {
  HSSFCell cell = row2.createCell(i);
  HSSFRichTextString text = new HSSFRichTextString(student2[i]);
  cell.setCellValue(text);
 }

 //模拟遍历第三个学生
 HSSFRow row3 = sheet.createRow(3);
 for (int i = 0; i < student3.length; i++) {
  HSSFCell cell = row3.createCell(i);
  HSSFRichTextString text = new HSSFRichTextString(student3[i]);
  cell.setCellValue(text);
 }

 //准备将Excel的输出流通过response输出到页面下载
 //八进制输出流
 response.setContentType("application/octet-stream");

 //这后面可以设置导出Excel的名称,此例中名为student.xls
 response.setHeader("Content-disposition", "attachment;filename=student.xls");

 //刷新缓冲
 response.flushBuffer();

 //workbook将Excel写入到response的输出流中,供页面下载
 workbook.write(response.getOutputStream());
 }
}

然后访问接口,弹出页面:

下载该Excel,打开后如下图:

至此为止,SpringBoot的后台Controller接口导出Excel数据表,已成功实现!

后来我封装了一个静态方法,可以在项目中作为工具类使用:

import org.apache.poi.hssf.usermodel.*;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.util.List;

/**
 * Excel工具类
 */
public class ExcelUtil {

 /**
 * Excel表格导出
 * @param response HttpServletResponse对象
 * @param excelData Excel表格的数据,封装为List<List<String>>
 * @param sheetName sheet的名字
 * @param fileName 导出Excel的文件名
 * @param columnWidth Excel表格的宽度,建议为15
 * @throws IOException 抛IO异常
 */
 public static void exportExcel(HttpServletResponse response,
     List<List<String>> excelData, 
     String sheetName, 
     String fileName, 
     int columnWidth) throws IOException {

 //声明一个工作簿
 HSSFWorkbook workbook = new HSSFWorkbook();

 //生成一个表格,设置表格名称
 HSSFSheet sheet = workbook.createSheet(sheetName);

 //设置表格列宽度
 sheet.setDefaultColumnWidth(columnWidth);

 //写入List<List<String>>中的数据
 int rowIndex = 0;
 for(List<String> data : excelData){
  //创建一个row行,然后自增1
  HSSFRow row = sheet.createRow(rowIndex++);

  //遍历添加本行数据
  for (int i = 0; i < data.size(); i++) {
  //创建一个单元格
  HSSFCell cell = row.createCell(i);

  //创建一个内容对象
  HSSFRichTextString text = new HSSFRichTextString(data.get(i));

  //将内容对象的文字内容写入到单元格中
  cell.setCellValue(text);
  }
 }

 //准备将Excel的输出流通过response输出到页面下载
 //八进制输出流
 response.setContentType("application/octet-stream");

 //设置导出Excel的名称
 response.setHeader("Content-disposition", "attachment;filename=" + fileName);

 //刷新缓冲
 response.flushBuffer();

 //workbook将Excel写入到response的输出流中,供页面下载该Excel文件
 workbook.write(response.getOutputStream());

 //关闭workbook
 workbook.close();
 }
}

以上方法调用示例:

/**
 * Excel表格导出接口
 * http://localhost:8080/ExcelDownload
 * @param response response对象
 * @throws IOException 抛IO异常
 */
@RequestMapping("/ExcelDownload")
public void excelDownload(HttpServletResponse response) throws IOException {

 List<List<String>> excelData = new ArrayList<>();

 List<String> head = new ArrayList<>();
 head.add("第一列");
 head.add("第二列");
 head.add("第三列");

 List<String> data1 = new ArrayList<>();
 data1.add("123");
 data1.add("234");
 data1.add("345");

 List<String> data2 = new ArrayList<>();
 data2.add("abc");
 data2.add("bcd");
 data2.add("cde");

 excelData.add(head);
 excelData.add(data1);
 excelData.add(data2);

 String sheetName = "测试";
 String fileName = "ExcelTest.xls";

 ExcelUtil.exportExcel(response, excelData, sheetName, fileName, 15);
}

以上这篇在SpringBoot: SpringBoot里面创建导出Excel的接口教程就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • 浅谈Java序列化和反序列化为何要实现Serializable接口

    浅谈Java序列化和反序列化为何要实现Serializable接口

    这篇文章主要介绍了浅谈Java序列化和反序列化为何要实现Serializable接口,序列化最重要的作用是在传递和保存对象时.保证对象的完整性和可传递性,对象转换为有序字节流,以便在网络上传输或者保存在本地文件中,需要的朋友可以参考下
    2023-12-12
  • 深入聊聊Java内存泄露问题

    深入聊聊Java内存泄露问题

    所谓内存泄露就是指一个不再被程序使用的对象或变量一直被占据在内存中,下面这篇文章主要给大家介绍了关于Java内存泄露问题的相关资料,文中通过示例代码介绍的非常详细,需要的朋友可以参考下
    2022-04-04
  • Java实现图像分割功能

    Java实现图像分割功能

    这篇文章主要为大家详细介绍了Java实现图像分割功能,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-06-06
  • 透彻理解Java中Synchronized(对象锁)和Static Synchronized(类锁)的区别

    透彻理解Java中Synchronized(对象锁)和Static Synchronized(类锁)的区别

    这篇文章主要介绍了Java中Synchronized(对象锁)和Static Synchronized(类锁)的区别,希望对大家有所帮助,一起跟随小编过来看看吧
    2018-05-05
  • RabbitMQ中的延迟队列机制详解

    RabbitMQ中的延迟队列机制详解

    这篇文章主要介绍了RabbitMQ中的延迟队列机制详解,延时队列内部是有序的,最重要的特性就体现在它的延时属性上,延时队列中的元素是希望,在指定时间到了以后或之前取出和处理,简单来说,延时队列就是用来存放需要在指定时间被处理的元素的队列,需要的朋友可以参考下
    2023-09-09
  • 详解Java利用实现对称加密(DES、3DES、AES)

    详解Java利用实现对称加密(DES、3DES、AES)

    本篇文章主要介绍了Java利用实现对称加密(DES、3DES、AES),具有一定的参考价值,有兴趣的可以了解一下。
    2017-01-01
  • java 枚举enum的用法(与在switch中的用法)

    java 枚举enum的用法(与在switch中的用法)

    这篇文章主要介绍了java 枚举enum的用法(与在switch中的用法),具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-10-10
  • 关于java命令的本质逻辑揭秘过程

    关于java命令的本质逻辑揭秘过程

    Java是通过java虚拟机来装载和执行编译文件(class文件)的,java虚拟机通过命令java  option 来启动,这篇文章主要给大家介绍了关于java命令的本质逻辑揭秘的相关资料,文中通过示例代码介绍的非常详细,需要的朋友可以参考下
    2021-05-05
  • springboot3请求参数种类及接口测试案例小结

    springboot3请求参数种类及接口测试案例小结

    这篇文章主要介绍了springboot3请求参数种类及接口测试案例小结,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧
    2023-10-10
  • Java OOM原因以及解决方案

    Java OOM原因以及解决方案

    这篇文章主要介绍了Java OOM原因以及解决方案,本篇文章通过简要的案例,讲解了该项技术的了解与使用,以下就是详细内容,需要的朋友可以参考下
    2021-09-09

最新评论