Java中利用POI优雅的导出Excel文件详解

前言

故事是这样开始的: 公司给排了几天的工期,让完成 2 个功能模块的开发。其中有一个场景是这样的,从 Excel 导入数据,要求数据不能重复。用户可以下载导入失败的 Excel 文件。

这样就有 2 种实现

  • 将失败数据存储数据库,需要下载时生成 Excel 下载即可
  • 将失败数据生成 Excel 文件存储文件服务器,然后返回下载链接。

老大要求按方案二进行。好吧,导出 Excel 是再常见不过的功能了,然而总是觉得以前写的不够优雅,所以决定进行简单的封装,以适应简单场景的 Excel 导出。

实现

Excel 导出的数据源一般是数据库中查询的数据。在 Java 开发这种面向对象的设计中,数据一般都是以对象为载体,填充在集合中的。所以入参之一便设计为 Collection 集合类。

导出的 Excel 一般需要表头说明每列数据的含义,这里计划用注解+反射来进行定义。Excel 无论是通过 HttpServletResponse 还是 File 存储,本质上都是 IO 流操作。

具体实现如下:

pom.xml

  <dependency>
   <groupId>org.apache.poi</groupId>
   <artifactId>poi-ooxml</artifactId>
   <version>4.1.2</version>
  </dependency>

注解定义

该注解添加在字段上,标识哪些字段需要导出到 Excel,并且添加表头说明。

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ExcelHeader {

 /**
  * 表头
  * @return
  */
 String value() default "";

 /**
  * 列索引
  * @return
  */
 int columnIndex() default 0;
}

实体类

以下实体类中根据注解可知,age 字段不需要导出到 Excel。

@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {

 @ExcelHeader(value = "账号")
 private String username;

 @ExcelHeader(value = "密码")
 private String password;

 @ExcelHeader(value = "生日")
 @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
 @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
 private LocalDateTime birthday;

 // 该字段没有添加注解, Excel不导出
 private Integer age;

 public User(String username, String password, LocalDateTime birthday) {
  this.username = username;
  this.password = password;
  this.birthday = birthday;
 }
}

单元测试

注释已经足够清晰,这里不再过多复述。

@Slf4j
class IdcPoiApplicationTests {

 @Test
 void contextLoads() throws NoSuchFieldException, IllegalAccessException, IOException {
  // 创建模拟数据
  User user1 = new User("admin", "123456", LocalDateTime.now());
  User user2 = new User("test", "123456", LocalDateTime.now());
  List<User> users = Arrays.asList(user1, user2);

  // 文件路径
  String basePath = "/Users/cuishiying/Documents/spring-cloud-learning/idc-poi/oss/";
  String fileName = new SimpleDateFormat("yyyyMMddHHmmss").format(new Date()).toString() +".xls";

  // 将Excel写入文件
  HSSFWorkbook workbook = exportExcel(users, User.class);
  workbook.setSheetName(0,"sheetName");//设置sheet的Name

  // 无论是通过HttpServletResponse导出还是导出到本地磁盘,本质都是IO操作,所以这里将IO操作提取到外层。
  workbook.write(new File(basePath + File.separator + fileName));
 }

 /**
  *
  * @param data 需要导出的数据
  * @param clz 数据对应的实体类
  * @param <T> 泛型
  * @return Excel文件
  * @throws NoSuchFieldException
  * @throws IllegalAccessException
  */
 public <T> HSSFWorkbook exportExcel(List<T> data, Class<T> clz) throws NoSuchFieldException, IllegalAccessException {

  Field[] fields = clz.getDeclaredFields();
  List<String> headers = new LinkedList<>();
  List<String> variables = new LinkedList<>();

  // 创建工作薄对象
  HSSFWorkbook workbook=new HSSFWorkbook();//这里也可以设置sheet的Name
  // 创建工作表对象
  HSSFSheet sheet = workbook.createSheet();
  // 创建表头
  Row rowHeader = sheet.createRow(0);

  // 表头处理
  for (int h = 0; h < fields.length; h++) {
   Field field = fields[h];
   if (field.isAnnotationPresent(ExcelHeader.class)) {
    // 表头
    ExcelHeader annotation = field.getAnnotation(ExcelHeader.class);
    headers.add(annotation.value());
    rowHeader.createCell(h).setCellValue(annotation.value());

    // 字段
    variables.add(field.getName());
   }
  }

  // 数据处理
  for (int i = 0; i < data.size() ; i++) {

   //创建工作表的行(表头占用1行, 这里从第二行开始)
   HSSFRow row = sheet.createRow(i + 1);
   // 获取一行数据
   T t = data.get(i);
   Class<?> aClass = t.getClass();
   // 填充列数据
   for (int j = 0; j < variables.size(); j++) {

    Field declaredField = aClass.getDeclaredField(variables.get(j));
    declaredField.setAccessible(true);

    String key = declaredField.getName();
    Object value = declaredField.get(t);

    row.createCell(j).setCellValue(value.toString());
   }
  }
  log.info("Excel文件创建成功");
  return workbook;
 }
}

总结

上边的案例只是表达基本设计思路,并不严谨。大家项目中使用的话还请斟酌。

到此这篇关于Java中利用POI优雅的导出Excel文件的文章就介绍到这了,更多相关Java用POI导出Excel文件内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们!

时间: 2020-05-19

Java 使用poi把数据库中数据导入Excel的解决方法

Java 利用poi把数据库中数据导入Excel 效果: 使用时先把poi包导入工程的path,注意只需要导入poi包即可,下载后有三个jar包 核心代码: 连接数据库:DBConnection.java 复制代码 代码如下: package org.xg.db;import java.sql.Connection;import java.sql.DriverManager;import java.sql.PreparedStatement;import java.sql.ResultSet;i

java poi读取excel操作示例(2个代码)

项目中要求读取excel文件内容,并将其转化为xml格式.常见读取excel文档一般使用POI和JExcelAPI这两个工具.这里我们介绍使用POI实现读取excel文档. 复制代码 代码如下: /* * 使用POI读取EXCEL文件 */import java.io.File;import java.io.FileInputStream;import java.util.ArrayList; import org.apache.poi.hssf.usermodel.HSSFCell;impor

Java 使用POI生成带联动下拉框的excel表格实例代码

废话不多说了,直接给大家贴代码了,具体代码如下所示: import java.io.File; import java.io.FileNotFoundException; import java.io.FileOutputStream; import java.io.IOException; import java.util.ArrayList; import java.util.Arrays; import java.util.List; import org.apache.poi.hssf.

在java poi导入Excel通用工具类示例详解

前言 本文主要给大家介绍了关于java poi导入Excel通用工具类的相关内容,分享出来供大家参考学习,下面话不多说了,来一起看看详细的介绍吧. 问题引入和分析 提示:如果不想看罗嗦的文章,可以直接到最后点击源码下载运行即可 最近在做一个导入Excel的功能,在做之前在百度上面查找"java通用导入Excel工具类",没有查到,大多数都是java通用导出Excel.后来仔细想想,导出可以利用java的反射,做成通用的,放进相应的实体成员变量中,导入为什么不可以呢?也是可以的,不过在做

java的poi技术读取和导入Excel实例

报表输出是Java应用开发中经常涉及的内容,而一般的报表往往缺乏通用性,不方便用户进行个性化编辑.Java程序由于其跨平台特性,不能直接操纵Excel.因此,本文探讨一下POI视线Java程序进行Excel的读取和导入. 项目结构: java_poi_excel 用到的Excel文件: xls XlsMain .java 类 //该类有main方法,主要负责运行程序,同时该类中也包含了用poi读取Excel(2003版) import java.io.FileInputStream; impor

JAVA使用POI获取Excel的列数与行数

前言 报表输出是Java应用开发中经常涉及的内容,而一般的报表往往缺乏通用性,不方便用户进行个性化编辑.Java程序由于其跨平台特性,不能直接操纵Excel.因此,本文探讨一下POI视线Java程序进行Excel中列数和行数的读取. 方法如下 //获取指定行,索引从0开始 hssfRow=hssfSheet.getRow(1); //获取指定列,索引从0开始 hssfCell=hssfRow.getCell((short)6); //获取总行数 //int rowNum=hssfSheet.ge

Java利用POI读取、写入Excel的方法指南

前言 Apache POI [1] 是用Java编写的免费开源的跨平台的 Java API,Apache POI提供API给Java程式对Microsoft Office格式档案读和写的功能.POI为"Poor Obfuscation Implementation"的首字母缩写,意为"简洁版的模糊实现". 做项目时经常有通过程序读取Excel数据,或是创建新的Excel并写入数据的需求: 网上很多经验教程里使用的POI版本都比较老了,一些API在新版里已经废弃,这里

java使用poi读取excel内容方法实例

复制代码 代码如下: import java.io.BufferedInputStream;import java.io.File;import java.io.FileInputStream;import java.io.FileOutputStream;import java.io.IOException;import java.nio.channels.FileChannel;import java.text.DecimalFormat;import java.text.SimpleDat

java使用poi读取ppt文件和poi读取excel、word示例

Apache的POI项目可以用来处理MS Office文档,codeplex上还有一个它的.net版本.POI项目可创建和维护操作各种基于OOXML和OLE2文件格式的Java API.大多数MS Office都是OLE2格式的.POI通HSMF子项目来支持Outlook,通过HDGF子项目来支持Visio,通过HPBF子项目来支持Publisher. 使用POI抽取Word简单示例: 要引入poi-3.7.jat和poi-scratchpad-3.7.ajr这两个包. 复制代码 代码如下: p

Java利用POI实现导入导出Excel表格示例代码

介绍 Jakarta POI 是一套用于访问微软格式文档的Java API.Jakarta POI有很多组件组成,其中有用于操作Excel格式文件的HSSF和用于操作Word的HWPF,在各种组件中目前只有用于操作Excel的HSSF相对成熟.官方主页http://poi.apache.org/index.html,API文档http://poi.apache.org/apidocs/index.html 实现 已经在代码中加入了完整的注释. import java.io.FileInputSt

django admin后台添加导出excel功能示例代码

Django功能强大不单在于他先进的编程理念,很多现有的功能模块更是可以直接拿来使用,比如这个牛掰的admin模块,可以作为一个很好的信息登记管理系统. admin模块中的actioin是可以自定义添加的,比如这次要介绍的导出excel功能,就可以在action中触发. 本文将详细介绍如何导出admin中录入的数据为excel,可以直接提交给你的leader观看. 首先我们要安装 xlwt 这个工具模块: pip install xlwt import的准备 修改admin.py: #-*-co

C#导入导出EXCEL文件的代码实例

复制代码 代码如下: using System;using System.Data;using System.Data.OleDb; namespace ZFSoft.Joint{    public class ExcelIO    {        private int _ReturnStatus;        private string _ReturnMessage; /// <summary>        /// 执行返回状态        /// </summary&g

js导出Excel表格超出26位英文字符的解决方法ES6

这个需要对Excel表格的表头编码规则有所了解,目前示例代码只扩展到52个字段 /** *json数据导入导出Excel表格示例代码 * / var array_utils = require('./utils-array') var XLSX = require("xlsx"); module.exports = { writeExcel : function (headers,data,file,callback) { if(data.length ==0){ var obj =

JAVA导出EXCEL表格的实例教学

小伙伴们,最近比较忙,没什么时间写,今天给大家分享的是JAVA如何导出EXCEL表格,因为最近有做这样一个功能,所以分享出来,如有不对之处,敬请指正. 在许多企业办公系统中,经常会有用户要求,需要对数据进行统计并且可以直接下载Excel文件,这样子的话,既然客户提出了要求,我们就应该去满足吖,毕竟客户是上帝嘛,那么我们如何去实现呢?且看我为你一一道来. POI简介:Jakarta POI 是一套用于访问微软格式文档的Java API.Jakarta POI有很多组件组成,其中有用于操作Excel

java基于poi导出excel透视表代码实例

这篇文章主要介绍了java基于poi导出excel透视表代码实例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下 从前,我是一个前端程序猿,怀着对打通任(前)督(后)二(开)脉(发)的梦想转了后端,自学两礼拜java+spring全家桶,直接上项目实战.最近接到一需求:将业务数据导出一张透视表. 需求开发完成已近有一段时间了,甲方的大爷大妈,爷爷奶奶们也都用的很开心,我也很开心,于是就心想咱学了也不能白学,所以写下这篇随笔. 先看下用easypo

详解poi+springmvc+springjdbc导入导出excel实例

工作中常遇到导入导出excel的需求,本獂有一简答实例与大家分享. 废话不多说, 1.所需jar包: 2.前端代码: ieport.jsp: <%@page import="java.util.Date"%> <%@ page language="java" contentType="text/html; charset=utf-" pageEncoding="utf-"%> <!DOCTYPE

PHP导入导出Excel代码

一.导入 导入需要使用能读取Excel的组件,网上也有比较好的组件,这里分享我使用的:下载  提取码:vxyn.(注意两个文件有引用关系) <?php //传入要导入的Excel的文件名 function import_to_DB($filename) { require_once'reader.php'; $data = new Spreadsheet_Excel_Reader(); //创建读取Excel的对象 $data->setOutputEncoding('utf-8'); //设置

JSP 导出Excel表格的实例

java 后台返回一个ModelAndView 对象,然后加入这2行设置 response.setContentType("application/vnd.ms-excel"); response.setHeader("Content-disposition","attachment;filename=" + URLEncoder.encode("会员列表.xls", "UTF-8")); 也可以把这二行设