java实现导出excel三级联动+下拉框(poi)
最终效果
java 导入导出excel的几种方式
常见有2种方式,一种是jxl,一种是poi.
他们之间的区别:
jxl只能支持后缀名为xls的文件。
poi不仅支持xls还支持xlsx格式;提供API对Microsoft Office格式档案读和写的功能。
数据较小时两者没有明显差别;数据量过大时,jxl相对poi来说对jvm虚拟机内存的消耗不高,如果只 是简单的单个excel的读写操作用jxl,对于复杂的建议使用poi。
代码实现
// 使用的jar包
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi</artifactId>
<version>3.14</version>
</dependency>
Controller类
package com.mycompany.myapp.web.rest;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.mycompany.myapp.service.test.ExcelService;
import com.mycompany.myapp.service.test.impl.ExcelPoiServiceImpl;
import io.swagger.annotations.ApiOperation;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
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.multipart.MultipartFile;
import javax.annotation.Resource;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;
/**
* @description:
* @author: alan
* @time: 2021/7/26 14:11
*/
@Controller
@RequestMapping("/api/poi")
public class TestPoi {
private final Logger log = LoggerFactory.getLogger(TestPoi.class);
@Resource(type = ExcelPoiServiceImpl.class)
private ExcelService excelService;
@Autowired
private ObjectMapper objectMapper;
@GetMapping("/test/exportExcel")
@ApiOperation(value = "导出Excel")
public void exportExcel(HttpServletResponse response, HttpServletRequest request) {
excelService.export(response, request);
}
@PostMapping("/test/importExcel")
@ApiOperation(value = "导入Excel")
public ResponseEntity importFile(@RequestParam("file") MultipartFile multipartFile) {
try {
InputStream inputStream = multipartFile.getInputStream();
List<String> fileContents = new ArrayList<String>();
fileContents = excelService.importExcel("", inputStream);
String json = objectMapper.writeValueAsString(fileContents);
log.info("导入的数据:{}", json);
} catch (Throwable t) {
t.printStackTrace();
}
return new ResponseEntity<>(null, null, HttpStatus.OK);
}
}
接口类
package com.mycompany.myapp.service.test;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.InputStream;
import java.util.List;
/**
* @description:
* @author: alan
* @time: 2021/7/25 21:33
*/
public interface ExcelService {
void export(HttpServletResponse response, HttpServletRequest request);
List importExcel(String type, InputStream inputStream);
}
接口实现类
package com.mycompany.myapp.service.test.impl;
import com.mycompany.myapp.service.test.ExcelService;
import com.mycompany.myapp.util.DownloadFileUtil;
import com.mycompany.myapp.util.PoiUtil;
import org.springframework.stereotype.Service;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.InputStream;
import java.text.SimpleDateFormat;
import java.util.*;
/**
* @description:
* @author: alan
* @time: 2021/7/26 17:41
*/
@Service
public class ExcelPoiServiceImpl implements ExcelService {
//可以转成你想要的格式 yyyy/MM/dd HH:mm:ss 等等
private final SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd-HH-mm-ss");
@Override
public void export(HttpServletResponse response, HttpServletRequest request) {
String dateString = format.format(new Date());
//文件地址名称
String filePath = "D:/usr/address"+dateString+".xls";
//excel 表头
List<String> headers = Arrays.asList("序号","省","市", "区", "无", "属性");
//所有一级
List<String> mapOneList = new ArrayList<String>();
mapOneList.add("广东省");
mapOneList.add("湖北省");
//关系map
Map<String, List<String>> map = new HashMap<String, List<String>>();
map.put("广东省", Arrays.asList("广州市", "佛山市"));
map.put("湖北省", Arrays.asList("武汉市", "荆州市"));
map.put("广州市", Arrays.asList("白云区", "越秀区"));
map.put("佛山市", Arrays.asList("顺德区", "南海区"));
//需要显示在excel的信息
List list = new ArrayList();
PoiUtil.export(filePath,headers,mapOneList,map,list);
//获取文件流返回给客户端
DownloadFileUtil.downloadFile(response, request, filePath);
}
@Override
public List importExcel(String type, InputStream inputStream) {
List list = new ArrayList();
try {
list = PoiUtil.importExcel(inputStream);
}catch(Throwable t){
t.printStackTrace();
}
return list;
}
}
poi工具类
package com.mycompany.myapp.util;
import org.apache.log4j.Logger;
import org.apache.poi.hssf.usermodel.*;
import org.apache.poi.ss.usermodel.*;
import org.apache.poi.ss.util.CellRangeAddressList;
import org.apache.poi.util.IOUtils;
import java.io.File;
import java.io.FileOutputStream;
import java.io.InputStream;
import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
/**
* @description:
* @author: alan
* @time: 2020/10/12 9:36
*/
public class PoiUtil {
private static final Logger LOG = Logger.getLogger(PoiUtil.class);
private static final String MAIN_SHEET = "信息";
private static final String SHEET_MAP = "map";
private static final String ATTRIBUTE_STATUS = "attribute";
/**
* 计算formula
*
* @param offset 偏移量,如果给0,表示从A列开始,1,就是从B列
* @param rowId 第几行
* @param colCount 一共多少列
* @return 如果给入参 1,1,10. 表示从B1-K1。最终返回 $B$1:$K$1
*/
private static String getRange(int offset, int rowId, int colCount) {
char start = (char) ('A' + offset);
if (colCount <= 25) {
char end = (char) (start + colCount - 1);
return "$" + start + "$" + rowId + ":$" + end + "$" + rowId;
} else {
char endPrefix = 'A';
char endSuffix = 'A';
if ((colCount - 25) / 26 == 0 || colCount == 51) {// 26-51之间,包括边界(仅两次字母表计算)
if ((colCount - 25) % 26 == 0) {// 边界值
endSuffix = (char) ('A' + 25);
} else {
endSuffix = (char) ('A' + (colCount - 25) % 26 - 1);
}
} else {// 51以上
if ((colCount - 25) % 26 == 0) {
endSuffix = (char) ('A' + 25);
endPrefix = (char) (endPrefix + (colCount - 25) / 26 - 1);
} else {
endSuffix = (char) ('A' + (colCount - 25) % 26 - 1);
endPrefix = (char) (endPrefix + (colCount - 25) / 26);
}
}
return "$" + start + "$" + rowId + ":$" + endPrefix + endSuffix + "$" + rowId;
}
}
//-----------------------------------------------------------
/**
* 导出三级联动and单个下拉框的excel
*
* @param filePath 文件输出地址
* @param headers 表头
* @param mapOneList 一级所有内容
* @param map 三级联动对应内容
* @param list 导出数据
*/
public static void export(String filePath, List<String> headers, List<String> mapOneList, Map<String, List<String>> map, List list) {
// 属性单个下拉数据
List<String> attributeList = new ArrayList<String>();
attributeList.add("是");
attributeList.add("否");
// 2.创建Excel
// 1)创建workbook
HSSFWorkbook hssfWorkBook = new HSSFWorkbook();
// 2)创建sheet
HSSFSheet mainSheet = hssfWorkBook.createSheet(MAIN_SHEET);// 主sheet
// 用于展示
//2.1 创建表头,供用户输入
initHeaders(hssfWorkBook, mainSheet, headers);
//导出数据到主sheet
setMainSheet(mainSheet, list);
// attribute 下拉框 sheet
HSSFSheet attributeSheet = hssfWorkBook.createSheet(ATTRIBUTE_STATUS);
//三级联动 sheet
HSSFSheet mapSheet = hssfWorkBook.createSheet(SHEET_MAP);
// true:隐藏/false:显示
//省市区关系sheet
hssfWorkBook.setSheetHidden(hssfWorkBook.getSheetIndex(mapSheet), false);// 设置sheet是否隐藏
//单个下拉框sheet
hssfWorkBook.setSheetHidden(hssfWorkBook.getSheetIndex(attributeSheet), false);// 设置sheet是否隐藏
// 3.写入数据
writeData(hssfWorkBook, mapSheet, mapOneList, map);// 将数据写入隐藏的sheet中并做好关联关系
//3.1 写入单个下拉数据
writeDropDownData(hssfWorkBook, attributeSheet, attributeList, ATTRIBUTE_STATUS);
// 4.设置数据有效性
setDataValid(hssfWorkBook, mainSheet, mapOneList, map);
FileOutputStream os = null;
try {
String exisname = filePath.substring(0, filePath.lastIndexOf("/"));
File f = new File(exisname);
if (!f.exists()) {
f.mkdirs();//创建目录
}
// 创建可写入的Excel工作簿
File file = new File(filePath);
if (!file.exists()) {
boolean bool = file.createNewFile();
System.out.println(bool);
} else {
file.delete();
file.createNewFile();
}
os = new FileOutputStream(filePath);
hssfWorkBook.write(os);
} catch (Exception e) {
e.printStackTrace();
} finally {
IOUtils.closeQuietly(os);
}
}
/**
* 生成主页面表头
*
* @param wb
* @param mainSheet
* @param headers
*/
private static void initHeaders(HSSFWorkbook wb, HSSFSheet mainSheet, List<String> headers) {
//表头样式
HSSFCellStyle style = wb.createCellStyle();
style.setAlignment(HSSFCellStyle.ALIGN_CENTER); // 创建一个居中格式
//字体样式
HSSFFont fontStyle = wb.createFont();
fontStyle.setFontName("微软雅黑");
fontStyle.setFontHeightInPoints((short) 12);
fontStyle.setBoldweight(HSSFFont.BOLDWEIGHT_BOLD);
style.setFont(fontStyle);
//生成主内容
HSSFRow rowFirst = mainSheet.createRow(0);//第一个sheet的第一行为标题
mainSheet.createFreezePane(0, 1, 0, 1); //冻结第一行
//写标题
for (int i = 0; i < headers.size(); i++) {
HSSFCell cell = rowFirst.createCell(i); //获取第一行的每个单元格
mainSheet.setColumnWidth(i, 4000); //设置每列的列宽
cell.setCellStyle(style); //加样式
cell.setCellValue(headers.get(i)); //往单元格里写数据
}
}
private static void setMainSheet(HSSFSheet mainSheet, List list) {
for (int j = 0; j < list.size(); j++) {
//行
Row row = mainSheet.createRow(j + 1);
Object obj = list.get(j);
if (obj != null) {
Field[] fields = obj.getClass().getDeclaredFields();
try {
for (int i = 0; i < fields.length; i++) {
if (i == 0) {
//excel 第一列 为序号
Cell cell = row.createCell(i);
cell.setCellValue(j + 1);
} else {
Field f = fields[i];
f.setAccessible(true);
String name = f.getName();
Object value = f.get(obj);
if (value == null) {
value = "";
}
//列
Cell cell = row.createCell(i);
cell.setCellValue(value.toString());
}
}
} catch (IllegalAccessException e) {
e.printStackTrace();
}
}
}
}
private static void setDataValid(HSSFWorkbook HSSFWorkBook, HSSFSheet mainSheet, List<String> provinceList, Map<String, List<String>> siteMap) {
//设置省份下拉
HSSFDataValidationHelper dvHelper = new HSSFDataValidationHelper((HSSFSheet) mainSheet);
String[] dataArray = provinceList.toArray(new String[0]);
HSSFSheet hidden = HSSFWorkBook.createSheet("hidden");
HSSFCell cell = null;
for (int i = 0, length = dataArray.length; i < length; i++) {
String name = dataArray[i];
HSSFRow row = hidden.createRow(i);
cell = row.createCell(0);
cell.setCellValue(name);
}
Name namedCell = HSSFWorkBook.createName();
namedCell.setNameName("hidden");
namedCell.setRefersToFormula("hidden!$A$1:$A$" + dataArray.length);
//加载数据,将名称为hidden的
DVConstraint constraint = DVConstraint.createFormulaListConstraint("hidden");
// 四个参数分别是:起始行、终止行、起始列、终止列.
// 1 (省份下拉框代表从excel第1+1行开始) 10(省份下拉框代表从excel第1+10行结束) 1(代表第几列开始,0是第一列,1是第二列) 1(代表第几列结束,0是第一列,1是第二列)
CellRangeAddressList provinceRangeAddressList = new CellRangeAddressList(1, 10, 1, 1);
DataValidation provinceDataValidation = dvHelper.createValidation(constraint, provinceRangeAddressList);
provinceDataValidation.createErrorBox("error", "请选择正确");
provinceDataValidation.setShowErrorBox(true);
// provinceDataValidation.setSuppressDropDownArrow(true);
//将第二个sheet设置为隐藏
// true:隐藏/false:显示
HSSFWorkBook.setSheetHidden(HSSFWorkBook.getSheetIndex(hidden), true);// 设置sheet是否隐藏
// HSSFWorkBook.setSheetHidden(1, true);
mainSheet.addValidationData(provinceDataValidation);
//设置属性下拉
DataValidationConstraint attributeConstraint = dvHelper.createFormulaListConstraint(ATTRIBUTE_STATUS);
// 四个参数分别是:起始行、终止行、起始列、终止列
// 1 (下拉框代表从excel第1+1行开始) 10(下拉框代表从excel第1+10行结束) 5(代表第几列开始,0是第一列,1是第二列) 5(代表第几列结束,0是第一列,1是第二列)
CellRangeAddressList attributeRangeAddressList = new CellRangeAddressList(1, 10, 5, 5);
HSSFDataValidation attributeDataValidation = (HSSFDataValidation) dvHelper.createValidation(attributeConstraint, attributeRangeAddressList);
attributeDataValidation.createErrorBox("Error", "请选择或输入有效的选项,或下载最新重试!");
// genderDataValidation.setSuppressDropDownArrow(true);
mainSheet.addValidationData(attributeDataValidation);
// 设置市、区下拉
// i <= 10 ,10代表市、区下拉框到10+1行结束
for (int i = 0; i <= 10; i++) {
setDataValidation('B', mainSheet, i + 1, 2);// "B"是指父类所在的列,i+1初始值为1代表从第2行开始,2要与“B”对应,为B的列号加1,假如第一个参数为“C”,那么最后一个参数就3
}
}
/**
* 设置有效性
*
* @param offset 主影响单元格所在列,即此单元格由哪个单元格影响联动
* @param sheet
* @param rowNum 行数
* @param colNum 列数
*/
private static void setDataValidation(char offset, HSSFSheet sheet, int rowNum, int colNum) {
HSSFDataValidationHelper dvHelper = new HSSFDataValidationHelper(sheet);
DataValidation dataValidationList1;
DataValidation dataValidationList2;
dataValidationList1 = getDataValidationByFormula("INDIRECT($" + offset + (rowNum) + ")", rowNum, colNum, dvHelper);
dataValidationList2 = getDataValidationByFormula("INDIRECT($" + (char) (offset + 1) + (rowNum) + ")", rowNum, colNum + 1, dvHelper);
sheet.addValidationData(dataValidationList1);
sheet.addValidationData(dataValidationList2);
}
private static DataValidation getDataValidationByFormula(String formulaString, int naturalRowIndex, int naturalColumnIndex, HSSFDataValidationHelper dvHelper) {
DataValidationConstraint dvConstraint = dvHelper.createFormulaListConstraint(formulaString);
CellRangeAddressList regions = new CellRangeAddressList(naturalRowIndex, 65535, naturalColumnIndex, naturalColumnIndex);
HSSFDataValidation data_validation_list = (HSSFDataValidation) dvHelper.createValidation(dvConstraint, regions);
data_validation_list.setEmptyCellAllowed(false);
if (data_validation_list instanceof HSSFDataValidation) {
// data_validation_list.setSuppressDropDownArrow(true);
data_validation_list.setShowErrorBox(true);
} else {
// data_validation_list.setSuppressDropDownArrow(false);
}
// 设置输入信息提示信息
data_validation_list.createPromptBox("下拉选择提示", "请使用下拉方式选择合适的值!");
return data_validation_list;
}
/**
* 循环单个下拉框的数据写入genderSheet的第A列中
*
* @param hssfWorkBook
* @param sheet
* @param list
* @param name sheet名称
*/
private static void writeDropDownData(HSSFWorkbook hssfWorkBook, HSSFSheet sheet, List<String> list, String name) {
//循环单个下拉框的数据写入genderSheet的第A列中
for (int i = 0; i < list.size(); i++) {
HSSFRow genderRow = sheet.createRow(i);
genderRow.createCell(0).setCellValue(list.get(i));
}
initGenderMapping(hssfWorkBook, sheet.getSheetName(), list.size(), name);// 创建数据规则
}
private static void writeData(HSSFWorkbook hssfWorkBook, HSSFSheet mapSheet, List<String> provinceList, Map<String, List<String>> siteMap) {
//循环将父数据写入siteSheet的第1行中
int siteRowId = 0;
HSSFRow provinceRow = mapSheet.createRow(siteRowId++);
provinceRow.createCell(0).setCellValue("父列表");
for (int i = 0; i < provinceList.size(); i++) {
provinceRow.createCell(i + 1).setCellValue(provinceList.get(i));
}
// 将具体的数据写入到每一行中,行开头为父级区域,后面是子区域。
Iterator<String> keyIterator = siteMap.keySet().iterator();
while (keyIterator.hasNext()) {
String key = keyIterator.next();
List<String> son = siteMap.get(key);
HSSFRow siteRow = mapSheet.createRow(siteRowId++);
siteRow.createCell(0).setCellValue(key);
for (int i = 0; i < son.size(); i++) {
siteRow.createCell(i + 1).setCellValue(son.get(i));
}
// 添加名称管理器
String range = getRange(1, siteRowId, son.size());
Name name = hssfWorkBook.createName();
name.setNameName(key);
String formula = mapSheet.getSheetName() + "!" + range;
name.setRefersToFormula(formula);
}
}
/**
* 创建下拉数据规则
*
* @param workbook
* @param genderSheetName
* @param genderQuantity
* @param name
*/
private static void initGenderMapping(HSSFWorkbook workbook, String genderSheetName, int genderQuantity, String name) {
Name genderName = workbook.createName();
genderName.setNameName(name);
genderName.setRefersToFormula(genderSheetName + "!$A$1:$A$" + genderQuantity);
}
/**
* 导入文件
*
* @param inputStream
* @return
* @throws Exception
*/
public static List importExcel(InputStream inputStream) throws Exception {
List returnList = new ArrayList();
//根据指定的文件输入流导入Excel从而产生Workbook对象
Workbook wb0 = new HSSFWorkbook(inputStream);
//获取Excel文档中的第一个表单
Sheet sht0 = wb0.getSheetAt(0);
//对Sheet中的每一行进行迭代
List rowList = null;
for (Row r : sht0) {
//如果当前行的行号(从0开始)未达到2(第三行)则从新循环
if (r.getRowNum() < 1) {
continue;
}
rowList = new ArrayList();
//非空判断
Cell c0 = r.getCell(0, Row.RETURN_BLANK_AS_NULL);
if (c0 != null) {
// 将区域编号的cell中的内容当做字符串处理
r.getCell(0).setCellType(HSSFCell.CELL_TYPE_STRING);
rowList.add(r.getCell(0).getStringCellValue());
}
Cell c1 = r.getCell(1, Row.RETURN_BLANK_AS_NULL);
if (c1 != null) {
r.getCell(1).setCellType(HSSFCell.CELL_TYPE_STRING);
rowList.add(r.getCell(1).getStringCellValue());
} else {
break;
}
Cell c2 = r.getCell(2, Row.RETURN_BLANK_AS_NULL);
if (c2 != null) {
r.getCell(2).setCellType(HSSFCell.CELL_TYPE_STRING);
rowList.add(r.getCell(2).getStringCellValue());
}
Cell c3 = r.getCell(3, Row.RETURN_BLANK_AS_NULL);
if (c3 != null) {
r.getCell(3).setCellType(HSSFCell.CELL_TYPE_STRING);
rowList.add(r.getCell(3).getStringCellValue());
}
Cell c4 = r.getCell(4, Row.RETURN_BLANK_AS_NULL);
if (c4 != null) {
r.getCell(4).setCellType(HSSFCell.CELL_TYPE_STRING);
rowList.add(r.getCell(4).getStringCellValue());
}
Cell c5 = r.getCell(5, Row.RETURN_BLANK_AS_NULL);
if (c5 != null) {
r.getCell(5).setCellType(HSSFCell.CELL_TYPE_STRING);
rowList.add(r.getCell(5).getStringCellValue());
}
returnList.add(rowList);
}
return returnList;
}
}
下载工具类
package com.mycompany.myapp.util;
import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.*;
/**
* @description:
* @author: alan
* @time: 2020/9/27 18:01
*/
public class DownloadFileUtil {
/**
* 下载文件
*
* @param response
* @param request
* @param filePath 文件地址
* @throws Exception
*/
public static void downloadFile(HttpServletResponse response, HttpServletRequest request, String filePath) {
try {
//获取文件
File file = new File(filePath);
String fileName = file.getName();
response.reset();
ServletOutputStream out = response.getOutputStream();
request.setCharacterEncoding("UTF-8");
int BUFFER = 1024 * 10;
byte data[] = new byte[BUFFER];
BufferedInputStream bis = null;
//获取文件输入流
InputStream inputStream = new BufferedInputStream(new FileInputStream(filePath));
// 以流的形式下载文件。
DataInputStream fis = new DataInputStream(inputStream);
int read;
bis = new BufferedInputStream(fis, BUFFER);
response.setContentType("application/OCTET-STREAM");
response.setHeader("Content-Disposition", "attachment; filename=" + fileName);
while ((read = bis.read(data)) != -1) {
out.write(data, 0, read);
}
fis.close();
bis.close();
} catch (Exception e) {
e.printStackTrace();
} finally {
File file = new File(filePath);
//删除临时文件
if (file.exists()) {
file.delete();
}
}
}
}
运行结果
调用导出,直接调用浏览器下载
导出的文件
导入刚刚导出的文件
导入结果
解析
1.map页对应的是省市区三级联动下拉框的数据
// 设为 false 才显示map
//省市区关系sheet
hssfWorkBook.setSheetHidden(hssfWorkBook.getSheetIndex(mapSheet), false);
// 设置sheet是否隐藏
2.attrbute页对应的是属性单个下拉框的数据
// 设为 false 才显示attribute
//单个下拉框sheet
hssfWorkBook.setSheetHidden(hssfWorkBook.getSheetIndex(attributeSheet), false);
//设置sheet是否隐藏