【原创】POI操作Excel导入导出工具类ExcelUtil
关于本类线程安全性的解释：
多数工具方法不涉及共享变量问题，至于添加合并单元格方法addMergeArea，使用ThreadLocal变量存储合并数据，ThreadLocal内部借用Thread.ThreadLocalMap以当前ThreadLocal为key进行存储，设置一次变量，则其他线程也会有上次数据的残留，因此在addMergeArea方法中进行清空的操作。为了保证原子性, 采用ReentrantLock确保一次只有一个线程可以进行添加合并数据的操作。
线程安全性从以上两个方面保证。
水平有限，难免会有疏漏，敬请谅解。
主要使用Apache POI进行Excel的导入、导出
使用
读取Excel中的数据
原始数据如下：
方法：public static List<List<String>> readFile(InputStream ins, int headRowNum) throws Exception
使用方式：
String filePath = "excel文件路径";
File file = new File(filePath);
InputStream ins = new FileInputStream(file);
List<List<String>> lists = ExcelUtil.readFile(ins, 2);
System.out.println(lists);
返回结果：
[[序号, 部门, 姓名, 上岗证号, 岗职, 入职时间], [, , , , , ], [1, 财务部, 赵六, 001, 出纳, 1540915200000], [1, 财务部, 张三, 002, 会计, 1517328000000]]
注：对于Date类型，读取时读的是long类型参数
将Excel中的数据转换为对应的实体Entity
public static <T> List<T> getListFromExcel(InputStream ins, int headRowNum, Class<T> cls, int parseIndex, String... excludeAttr) throws Exceptionpublic static <T> List<T> getListFromExcel(MultipartFile file, int headRowNum, Class<T> cls, int parseIndex, String... excludeAttr) throws Exception
两种方法本质上没有什么区别，可变参数excludeAttr配置实体不匹配的属性，例如：id
注：转换的时候，需要保证excel中属性的顺序与实体中属性的顺序对应，例如excel中部门-姓名-上岗证号...这样，则实体也应该按照这样的顺序定义属性。
此方法通常用于获取对应的excel数据，并批量插入数据库中。
导出Excel
根据List数据导出excel
public static void exportExcel(String title, String[] headers, List<?> list, HttpServletResponse response, boolean useXSSF, String sheetName, List<String> includeAttr)
title:导出名字
headers：表头数组，list:数据， useXSSF：是否使用2007Excel, sheetName：创建sheet名字，includeAttr：展示实体的哪些属性public static void exportExcel(String title, String[] headers, List<?> list, HttpServletResponse response, boolean useXSSF, String sheetName, String... excludeAttr)主要差别在最后一个，不展示哪些属性如果在导出时需要合并单元格，先调用`public static void setMergeAreaList(List list)`
例如：
List<ExcelUtil.RectangleArea> list = new ArrayList<>();
ExcelUtil.RectangleArea area = new ExcelUtil.RectangleArea(2,2,0,4);
list.add(area);
ExcelUtil.setMergeAreaList(list);
根据字符串列表导出excel
public static void exportExcel(String title, List<List<String>> list, boolean useXSSF, HttpServletResponse response)
根据字符串列表自定义导出实现
调用
public static Workbook getExcelWorkBook(List<List<String>> list, boolean useXSSF)获取workbook，
public static void addMergeArea(Workbook workbook, int sheetIndex, List<RectangleArea> areas)添加合并单元格数据，然后workboo.write(输出流)即可。
其余依赖工具类，请参见github地址：
https://github.com/studentytj/sth_useful
package com.test.sth_useful.common.util;
import com.test.sth_useful.common.util.ReflectionUtils;
import com.test.sth_useful.common.util.StreamUtil;
import org.apache.commons.lang3.StringUtils;
import org.apache.poi.hssf.usermodel.HSSFCellStyle;
import org.apache.poi.hssf.usermodel.HSSFRichTextString;
import org.apache.poi.hssf.usermodel.HSSFWorkbook;
import org.apache.poi.ss.formula.functions.T;
import org.apache.poi.ss.usermodel.*;
import org.apache.poi.ss.util.CellRangeAddress;
import org.apache.poi.xssf.usermodel.XSSFCell;
import org.apache.poi.xssf.usermodel.XSSFRichTextString;
import org.apache.poi.xssf.usermodel.XSSFWorkbook;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.multipart.MultipartFile;
import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletResponse;
import java.io.InputStream;
import java.lang.reflect.Field;
import java.net.URLEncoder;
import java.text.DateFormat;
import java.text.DecimalFormat;
import java.text.NumberFormat;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import java.util.Locale;
import java.util.concurrent.locks.ReentrantLock;
import static org.apache.poi.ss.usermodel.Cell.*;
/**
* 关于本类线程安全性的解释：
* 多数工具方法不涉及共享变量问题，至于添加合并单元格方法addMergeArea，使用ThreadLocal变量存储合并数据，ThreadLocal
* 内部借用Thread.ThreadLocalMap以当前ThreadLocal为key进行存储，设置一次变量，则其他线程也会有上次数据的残留，因此在
* addMergeArea方法中进行清空的操作。为了保证原子性, 采用ReentrantLock确保一次只有一个线程可以进行添加合并数据的操作。
* 线程安全性从以上两个方面保证。
* 水平有限，难免会有疏漏，敬请谅解。
*
*
* @date 2018/10/15
*/
public class ExcelUtil {
/**
* logger
*/
private static final Logger LOGGER = LoggerFactory.getLogger(ExcelUtil.class);
private static ThreadLocal<List<RectangleArea>> mergeAreaList = new ThreadLocal<>();
public static List<RectangleArea> getMergeAreaList() {
return mergeAreaList.get();
}
public static void setMergeAreaList(List<RectangleArea> list) {
mergeAreaList.set(list);
}
/**
* 获取单元格的值
*
* @param cell
* @return
*/
public static String getCellValue(Cell cell) {
String cellValue = "";
int cellType = cell.getCellType();
if (cellType == CELL_TYPE_STRING) {
cellValue = cell.getStringCellValue();
} else if (cellType == CELL_TYPE_NUMERIC) {
if (org.apache.poi.ss.usermodel.DateUtil.isCellDateFormatted(cell)) {
LOGGER.info("date: {}", cell.getDateCellValue());
cellValue = String.valueOf(cell.getDateCellValue().getTime());
} else {
if (cell instanceof XSSFCell) {
cellValue = ((XSSFCell) cell).getRawValue();
} else {
cellValue = String.valueOf(cell.getNumericCellValue());
}
// cellValue = String.valueOf(df.format(cell.getNumericCellValue()));
}
} else if (cellType == CELL_TYPE_FORMULA) {
switch (cell.getCachedFormulaResultType()) {
case Cell.CELL_TYPE_NUMERIC:
// 保留两位小数
cellValue = String.valueOf(new DecimalFormat("#.00").format(cell.getNumericCellValue()));
break;
case Cell.CELL_TYPE_STRING:
cellValue = String.valueOf(cell.getRichStringCellValue());
break;
}
} else if (cellType == CELL_TYPE_BLANK) {
cellValue = cell.getStringCellValue();
}
return cellValue;
}
/**
* 读取excel
* 注意： 默认读取的数据是在第一个sheet中的，暂不支持多个sheet的读取
*
* @param ins 输入流
* @param headRowNum 表头所在行数
* @return 返回excel中的字符串数据
* @throws Exception
*/
public static List<List<String>> readFile(InputStream ins, int headRowNum) throws Exception {
Workbook workbook = WorkbookFactory.create(ins);
Sheet sheet = workbook.getSheetAt(0);
// 获取excel总行数
int rownum = sheet.getLastRowNum();
List<List<String>> result = new ArrayList<>();
LOGGER.info("excel 总行数：{}", rownum);
// 获取表头那一行的数据长度
short allColumnNum = sheet.getRow(headRowNum).getLastCellNum();
for (int i = 0; i <= rownum; i++) {
Row row = sheet.getRow(i);
if (row == null || row.getPhysicalNumberOfCells() == 0) {
LOGGER.info("第{}行数据为空.", i);
continue;
}
List<String> oneRecord = new ArrayList<>();
for (int j = 0; j < allColumnNum; j++) {
Cell cell = row.getCell(j);
// cell.setCellStyle(cellStyle);
if (cell == null) {
oneRecord.add("");
continue;
}
String cellValue = getCellValue(cell);
oneRecord.add(cellValue);
}
result.add(oneRecord);
}
LOGGER.info("读取文件完成!");
return result;
}
/**
* 将读取到的excel数据存入List<cls>列表中
*
* @param list 字符串
* @param cls 解析的类对象
* @param parseIndex 开始解析的行数
* @param excludeAttr 哪些属性不解析
* @return 对应的对象列表
* @throws Exception
*/
public static <T> List<T> getEntityList(List<List<String>> list, Class<T> cls, int parseIndex, String... excludeAttr) throws Exception {
List<T> result = new ArrayList<>();
for (int i = parseIndex; i < list.size(); i++) {
List<String> oneRecord = list.get(i);
T instance = cls.newInstance();
for (int j = 0, tmp = 0; j < oneRecord.size(); j++) {
String cellValue = oneRecord.get(j);
if (StringUtils.isEmpty(cellValue)) continue;
Field[] fields = cls.getDeclaredFields();
Field field = fields[j];
for (String s : excludeAttr) {
if (field.getName().equals(s)) {
tmp++;
break;
}
}
field = fields[j + tmp];
Object cellVal = field.getType().equals(Date.class) ? new Date(Long.parseLong(cellValue)) : cellValue;
ReflectionUtils.setFieldValue(instance, field.getName(), cellVal);
}
result.add(instance);
}
return result;
}
/**
* 获取excel表中对应的实体数据
*
* @param ins
* @param headRowNum
* @param cls
* @param parseIndex
* @param excludeAttr
* @param <T>
* @return
* @throws Exception
*/
public static <T> List<T> getListFromExcel(InputStream ins, int headRowNum, Class<T> cls, int parseIndex, String... excludeAttr) throws Exception {
List<List<String>> strLists = readFile(ins, headRowNum);
return getEntityList(strLists, cls, parseIndex, excludeAttr);
}
/**
* 获取excel对应的实体列表
*
* @param file 导入的excel文件
* @param headRowNum 表头行数，记住：从0开始
* @param cls 实体类
* @param parseIndex 从哪一行开始解析
* @param excludeAttr 哪些属性不映射
* @param <T>
* @return
* @throws Exception
*/
public static <T> List<T> getListFromExcel(MultipartFile file, int headRowNum, Class<T> cls, int parseIndex, String... excludeAttr) throws Exception {
// try(流)是Java7中的try-with-resource语法。当try语句块运行结束时，InputStream 会被自动关闭，只要实现了AutoCloseable接口的类都可以写在try括号里
try (InputStream ins = file.getInputStream()) {
List<List<String>> strLists = readFile(ins, headRowNum);
return getEntityList(strLists, cls, parseIndex, excludeAttr);
}
}
/**
* 展示某些属性的方法
*
* @param headers
* @param list
* @param useXSSF 是否使用2007
* @param sheetName
* @param includeAttr
* @param isInclude
* @return
*/
private static <T> Workbook getExcelWorkBook(String[] headers, List<T> list, boolean useXSSF, String sheetName, List<String> includeAttr, boolean isInclude) {
Workbook workbook = getWorkbook(useXSSF);
// 创建sheet
Sheet sheet = workbook.createSheet(sheetName);
CellStyle cellStyle = getCellStyle(workbook);
// 创建表头
createHeader(headers, sheet, useXSSF, cellStyle);
Field[] fields = null;
// 确定行数
for (int i = 0; i < list.size(); i++) {
// 创建一行
Row dataRow = sheet.createRow(i + 1);
T t = list.get(i);
if (isInclude) {
// 为每个单元格设值
for (int j = 0; j < includeAttr.size(); j++) {
String fieldName = includeAttr.get(j);
formatCell(sheet, cellStyle, dataRow, t, j, fieldName);
}
} else {
fields = fields == null ? t.getClass().getDeclaredFields() : fields;
// k用来解决某些字段并不在excel中展示带来的数据和列名不匹配问题
for (int j = 0, k = 0; j < fields.length - 1; j++) {
Field field = fields[j];
String fieldName = field.getName();
// flag标志代表是否不展示该项的值
boolean flag = false;
if (includeAttr.contains(fieldName)) {
// 解决生成数据不匹配问题
k++;
flag = true;
break;
}
if (flag) continue;
formatCell(sheet, cellStyle, dataRow, t, j - k, fieldName);
}
}
}
return workbook;
}
/**
* 格式化单元格
* @param sheet
* @param cellStyle
* @param dataRow
* @param t
* @param j
* @param fieldName
* @param <T>
*/
private static <T> void formatCell(Sheet sheet, CellStyle cellStyle, Row dataRow, T t, int j, String fieldName) {
Cell dataCell = dataRow.createCell(j);
dataCell.setCellStyle(cellStyle);
// 设置固定宽度, 每个单元格可存放16个字符
sheet.setColumnWidth(j, 16 * 256);
setCellValue(dataCell, ReflectionUtils.getFieldValue(t, fieldName));
}
/**
* 获取通用style
*
* @param workbook
* @return
*/
private static CellStyle getCellStyle(Workbook workbook) {
CellStyle cellStyle = workbook.createCellStyle();
cellStyle.setBorderLeft(CellStyle.BORDER_THIN);
cellStyle.setLeftBorderColor(IndexedColors.BLACK.getIndex());
cellStyle.setBorderRight(CellStyle.BORDER_THIN);
cellStyle.setRightBorderColor(IndexedColors.BLACK.getIndex());
cellStyle.setBorderBottom(CellStyle.BORDER_THIN);
cellStyle.setBottomBorderColor(IndexedColors.BLACK.getIndex());
cellStyle.setBorderTop(CellStyle.BORDER_THIN);
cellStyle.setTopBorderColor(IndexedColors.BLACK.getIndex());
return cellStyle;
}
private static Workbook getWorkbook(boolean useXSSF) {
return useXSSF ? new XSSFWorkbook() : new HSSFWorkbook();
}
/**
* 给出字符串的情况下获取WorkBook
*
* @param list
* @return
*/
public static Workbook getExcelWorkBook(List<List<String>> list, boolean useXSSF) {
Workbook workbook = getWorkbook(useXSSF);
// 创建sheet, 名字默认为sheet0
Sheet sheet = workbook.createSheet("sheet0");
// 确定行数
for (int i = 0; i < list.size(); i++) {
// 创建一行
Row dataRow = sheet.createRow(i);
List<String> t = list.get(i);
// 为每个单元格设值
for (int j = 0; j < t.size(); j++) {
Cell dataCell = dataRow.createCell(j);
// 设置固定宽度, 每个单元格可存放16个字符
setCellValue(dataCell, t.get(j));
}
}
return workbook;
}
/**
* 创建表头
*
* @param headers
* @param sheet
*/
private static void createHeader(String[] headers, Sheet sheet, boolean useXSSF, CellStyle commonStyle) {
Row headerRow = sheet.createRow(0);
for (int i = 0; i < headers.length; i++) {
Cell headerRowCell = headerRow.createCell(i);
headerRowCell.setCellStyle(commonStyle);
RichTextString text = useXSSF ? new XSSFRichTextString(headers[i]) : new HSSFRichTextString(headers[i]);
headerRowCell.setCellValue(text);
}
}
/**
* 为单元格设置值
*
* @param dataCell
* @param value
*/
public static void setCellValue(Cell dataCell, Object value) {
if (value instanceof Date) {
DateFormat sdf = DateUtil.secondFormat.get();
String zero = "00:00:00";
if (zero.equals(sdf.format(value).split(" ")[1])) {
sdf = DateUtil.dayFormat.get();
}
dataCell.setCellValue(sdf.format(value));
} else if (value instanceof Number) {
dataCell.setCellValue(Double.parseDouble(String.valueOf(value)));
} else if (value == null) {
dataCell.setCellValue("");
} else {
dataCell.setCellValue(value.toString());
}
}
/**
* 导出excel ——展示某些属性
*
* @param title
* @param headers
* @param list
* @param response
* @param useXSSF
* @param sheetName
* @param includeAttr
*/
public static void exportExcel(String title, String[] headers, List<?> list, HttpServletResponse response, boolean useXSSF, String sheetName, List<String> includeAttr, boolean isInclude) {
try {
Workbook workbook = getExcelWorkBook(headers, list, useXSSF, sheetName, includeAttr, isInclude);
addMergeArea(workbook, 0, getMergeAreaList());
writeToResp(title, workbook, response, useXSSF);
} catch (Exception e) {
e.printStackTrace();
}
}
/**
* 给出导出字符串的情况下的导出方法
*
* @param title
* @param list
* @param response
*/
public static void exportExcel(String title, List<List<String>> list, boolean useXSSF, HttpServletResponse response) {
try {
Workbook workbook = getExcelWorkBook(list, useXSSF);
writeToResp(title, workbook, response, useXSSF);
} catch (Exception e) {
e.printStackTrace();
}
}
/**
* 将excel流写入response
*
* @param title
* @param workbook
* @param response
* @param useXSSF
*/
private static void writeToResp(String title, Workbook workbook, HttpServletResponse response, boolean useXSSF) {
ServletOutputStream outputStream = null;
try {
LOGGER.info("" + workbook);
outputStream = response.getOutputStream();
// 解决浏览器及中文乱码问题https://tools.ietf.org/html/rfc2231
response.setHeader("Content-Disposition", "attachment;filename*=utf-8'zh_cn'" + URLEncoder.encode(title, "UTF-8") + (useXSSF ? ".xlsx" : ".xls"));
response.setContentType("application/msexcel");
workbook.write(outputStream);
} catch (Exception e) {
e.printStackTrace();
} finally {
// 关闭流资源
StreamUtil.close(outputStream, workbook);
}
}
/**
* 合并单元格并水平垂直居中实现
*
* @param areas
*/
public static void addMergeArea(Workbook workbook, int sheetIndex, List<RectangleArea> areas) {
ReentrantLock lock = new ReentrantLock();
try {
lock.lock();
LOGGER.info("Thread: {}, threadLocal is: {}.", Thread.currentThread().getName(), String.valueOf(getMergeAreaList()));
if (areas != null && areas.size() > 0) {
for (RectangleArea area : areas) {
workbook.getSheetAt(sheetIndex)
.addMergedRegion(new CellRangeAddress(area.getFirstRow(), area.getLastRow(), area.getFirstCol(), area.getLastCol()));
// 合并单元格时默认居中（水平、垂直居中）
CellStyle cellStyle = getCellStyle(workbook);
cellStyle.setAlignment(CellStyle.ALIGN_CENTER);
cellStyle.setVerticalAlignment(CellStyle.VERTICAL_CENTER);
workbook.getSheetAt(sheetIndex).getRow(area.getFirstRow()).getCell(area.getFirstCol()).setCellStyle(cellStyle);
}
mergeAreaList.set(null);
}
} finally {
lock.unlock();
}
}
public static class RectangleArea {
private int firstRow, lastRow, firstCol, lastCol;
public RectangleArea(int firstRow, int lastRow, int firstCol, int lastCol) {
this.firstRow = firstRow;
this.lastRow = lastRow;
this.firstCol = firstCol;
this.lastCol = lastCol;
}
public int getFirstRow() {
return firstRow;
}
public int getLastRow() {
return lastRow;
}
public int getFirstCol() {
return firstCol;
}
public int getLastCol() {
return lastCol;
}
}
}
【原创】POI操作Excel导入导出工具类ExcelUtil的更多相关文章
- 一个基于POI的通用excel导入导出工具类的简单实现及使用方法
前言: 最近PM来了一个需求,简单来说就是在录入数据时一条一条插入到系统显得非常麻烦,让我实现一个直接通过excel导入的方法一次性录入所有数据.网上关于excel导入导出的例子很多,但大多相互借鉴. ...
- Java基础学习总结(49)——Excel导入导出工具类
在项目的pom文件中引入 <dependency> <groupId>net.sourceforge.jexcelapi</groupId> <artifac ...
- apache POI 操作excel<导入导出>
1.首先导入maven依赖 <!-- POI核心依赖 --> <dependency> <groupId>org.apache.poi</groupId> ...
- java中excel导入\导出工具类
1.导入工具 package com.linrain.jcs.test; import jxl.Cell; import jxl.Sheet; import jxl.Workbook; import ...
- java Excel导入导出工具类
本文章,导入导出依赖提前定义好的模板 package com.shareworx.yjwy.utils; import java.io.File; import java.io.FileInputSt ...
- java简易excel导入导出工具（封装POI）
Octopus 如何导入excel 如何导出excel github项目地址 Octopus Octopus 是一个简单的java excel导入导出工具. 如何导入excel 下面是一个excel文 ...
- Excel导入导出工具（简单、好用且轻量级的海量Excel文件导入导出解决方案.）
Excel导入导出工具(简单.好用且轻量级的海量Excel文件导入导出解决方案.) 置顶 2019-09-07 16:47:10 $9420 阅读数 261更多 分类专栏: java 版权声明:本 ...
- Octopus——excel导入导出工具
Octopus Octopus是一个简易的Excel导入导出工具.目前主要就两个功能: 导入:将excel中一行数据转换为指定的java对象,并通过指定的正则表达式检查合法性. 导出:按照给定的xml ...
- SpringBoot集成文件 - 集成POI之Excel导入导出
Apache POI 是用Java编写的免费开源的跨平台的 Java API,Apache POI提供API给Java程序对Microsoft Office格式档案读和写的功能.本文主要介绍通过Spr ...
随机推荐
- 《深入浅出RxJS》读书笔记
rxjs的引入 // 如果以这种方式导入rxjs,那么整个库都会导入,我们一般不可能在项目中运用到rxjs的所有功能 const Rx = require('rxjs'); 解决这个问题,可以使用深链 ...
- redux和react-redux做简单组件控制
这次我们用两种方式实现以下要求 1.三个组件 2.第一个组件有两个按钮 分别控制第二和第三个组件年龄和姓名的改变 3第二个组件展示姓名,第三个组件展示年龄 用到哪些插件 store redux 一 ...
- vue的基本用法和指令
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8&quo ...
- AD域和LDAP协议
随着我们的习大大上台后,国家在网络信息安全方面就有了很明显的改变!所以现在好多做网络信息安全产品的公司和需要网络信息安全的公司都会提到用AD域服务器来验证,这里就简单的研究了一下! 先简单的讲讲AD域 ...
- APM系统SkyWalking介绍
公司最近在构建服务化平台,需要上线APM系统,本篇文章简单的介绍SkyWalking APM APM全称Application Performance Management应用性能管理,目的是通过各种 ...
- 自定义HashSet判重标准
HashSet在执行add时会首先根据目标类的hashcode判断是否有与其hashcode相同的对象,若有则使用equals该对象判断是否与其相同. HashSet保证了元素的唯一性, 我们可以通过 ...
- python的@修饰符
‘@’引用已有的函数,对下面的函数进行修饰.引用函数必须放在修饰函数的上面,引用函数的返回值,返回给被修饰的函数 一个简单的栗子: def funA(fn): print('A') # 输出A fn( ...
- 【题解】导游-C++
Description 宁波市的中小学生们在镇海中学参加程序设计比赛之余,热情的主办方邀请同学们参观镇海中学内的各处景点,已 知镇海中学内共有n处景点.现在有n位该校的学生志愿承担导游和讲解任务.每个 ...
- [原创]lvs+ospf+nginx实现高可用大流量web架构
lvs+ospf+nginx实现高可用大流量web架构配置总概述 架构图: 配置如下: .quagga之zebra配置: # cat /etc/quagga/zebra.conf ! ! Zebra ...
- 【CYH-02】NOIp考砸后虐题赛:函数：题解
这道题貌似只有@AKEE 大佬A掉,恭喜! 还有因为c++中支持两个参数数量不同的相同名称的函数调用,所以当时就没改成两个函数,这里表示抱歉. 这道题可直接用指针+hash一下,然后就模拟即可. 代码 ...