在平时做项目的时候，经常在项目中有遇到excel导入、导出的功能，起初做在网上找了一些类似的demo，功能是实现了，但是总感觉代码量太大，而且不能够灵活的调用，每块功能需要调用的时候，都需要重新写一遍自己相关的字段信息，感觉非常不爽，于是结合网上和自己的理解写了基于注解进行Excel的导入、导出。
本次实现使用第三方jar包是poi
首先在maven项目中的pom文件中加入这个依赖包。
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi</artifactId>
<version>3.9</version>
</dependency>
1、实现控制excel导入、导出的注解@Excel
package com.test.annotation;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* @ClassName Excel
* @Description: Excel配置注解自定义接口
* @Author: myc
* @Date: 2021/9/23 10:43
* @Version: 1.0
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({java.lang.annotation.ElementType.FIELD})
public @interface Excel {
/**
* Excel中的列名
*
* @return
*/
public abstract String name();
/**
* 列名对应的A,B,C,D...,不指定按照默认顺序排序
*
* @return
*/
public abstract String column() default "";
/**
* 提示信息
*
* @return
*/
public abstract String prompt() default "";
/**
* 设置只能选择不能输入的列内容
*
* @return
*/
public abstract String[] combo() default {};
/**
* 是否导出数据
*
* @return
*/
public abstract boolean isExport() default true;
/**
* 是否为重要字段（整列标红,着重显示）
*
* @return
*/
public abstract boolean isMark() default false;
/**
* 是否合计当前列
*
* @return
*/
public abstract boolean isSum() default false;
}
2、实现解析Excel文件的工具类ExcelUtil
package com.test.utils;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.Serializable;
import java.lang.reflect.Field;
import java.math.BigDecimal;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import com.test.annotation.Excel;
import org.apache.commons.lang.StringUtils;
import org.apache.poi.hssf.usermodel.DVConstraint;
import org.apache.poi.hssf.usermodel.HSSFCell;
import org.apache.poi.hssf.usermodel.HSSFCellStyle;
import org.apache.poi.hssf.usermodel.HSSFDataValidation;
import org.apache.poi.hssf.usermodel.HSSFFont;
import org.apache.poi.hssf.usermodel.HSSFRichTextString;
import org.apache.poi.hssf.usermodel.HSSFRow;
import org.apache.poi.hssf.usermodel.HSSFSheet;
import org.apache.poi.hssf.usermodel.HSSFWorkbook;
import org.apache.poi.ss.usermodel.Cell;
import org.apache.poi.ss.util.CellRangeAddressList;
/**
* @ClassName ExcelUtil
* @Description: excel导入导出工具类
* @Author: myc
* @Date: 2021/9/23 14:48
* @Version: 1.0
*/
public class ExcelUtil<T> implements Serializable {
private static final long serialVersionUID = 551970754610248636L;
private Class<T> clazz;
public ExcelUtil(Class<T> clazz) {
this.clazz = clazz;
}
/**
* 将excel表单数据源的数据导入到list
*
* @param sheetName 工作表的名称
* @param input java输入流
*/
public List<T> getExcelToList(String sheetName, InputStream input) throws Exception {
List<T> list = new ArrayList<T>();
SimpleDateFormat sdf = new SimpleDateFormat("YYYY-MM-dd");
try {
HSSFWorkbook book = new HSSFWorkbook(input);
HSSFSheet sheet = null;
// 如果指定sheet名,则取指定sheet中的内容.
if (StringUtils.isNotBlank(sheetName)) {
sheet = book.getSheet(sheetName);
}
// 如果传入的sheet名不存在则默认指向第1个sheet.
if (sheet == null) {
sheet = book.getSheetAt(0);
}
// 得到数据的行数
int rows = sheet.getLastRowNum();
// 有数据时才处理
if (rows > 0) {
// 得到类的所有field
Field[] allFields = clazz.getDeclaredFields();
// 定义一个map用于存放列的序号和field
Map<Integer, Field> fieldsMap = new HashMap<Integer, Field>();
for (int i = 0, index = 0; i < allFields.length; i++) {
Field field = allFields[i];
// 将有注解的field存放到map中
if (field.isAnnotationPresent(Excel.class)) {
// 设置类的私有字段属性可访问
field.setAccessible(true);
fieldsMap.put(index, field);
index++;
}
}
// 从第2行开始取数据,默认第一行是表头
for (int i = 1, len = rows; i < len; i++) {
// 得到一行中的所有单元格对象.
HSSFRow row = sheet.getRow(i);
Iterator<Cell> cells = row.cellIterator();
T entity = null;
int index = 0;
while (cells.hasNext()) {
// 单元格中的内容.
String c = cells.next().getStringCellValue();
if (!StringUtils.isNotBlank(c)) {
continue;
}
if (c.indexOf("合计：") != -1) {
continue;
}
// 如果不存在实例则新建
entity = (entity == null ? clazz.newInstance() : entity);
// 从map中得到对应列的field
Field field = fieldsMap.get(index);
if (field == null) {
continue;
}
// 取得类型,并根据对象类型设置值.
Class<?> fieldType = field.getType();
if (fieldType == null) {
continue;
}
if (String.class == fieldType) {
field.set(entity, String.valueOf(c));
} else if (BigDecimal.class == fieldType) {
c = c.indexOf("%") != -1 ? c.replace("%", "") : c;
field.set(entity, BigDecimal.valueOf(Double.valueOf(c)));
} else if (Date.class == fieldType) {
field.set(entity, sdf.parse(c));
} else if ((Integer.TYPE == fieldType) || (Integer.class == fieldType)) {
field.set(entity, Integer.parseInt(c));
} else if ((Long.TYPE == fieldType) || (Long.class == fieldType)) {
field.set(entity, Long.valueOf(c));
} else if ((Float.TYPE == fieldType) || (Float.class == fieldType)) {
field.set(entity, Float.valueOf(c));
} else if ((Short.TYPE == fieldType) || (Short.class == fieldType)) {
field.set(entity, Short.valueOf(c));
} else if ((Double.TYPE == fieldType) || (Double.class == fieldType)) {
field.set(entity, Double.valueOf(c));
} else if (Character.TYPE == fieldType) {
if ((c != null) && (c.length() > 0)) {
field.set(entity, Character.valueOf(c.charAt(0)));
}
}
index++;
}
if (entity != null) {
list.add(entity);
}
}
}
} catch (Exception e) {
throw new Exception("将excel表单数据源的数据导入到list异常!", e);
}
return list;
}
/**
* 将list数据源的数据导入到excel表单
*
* @param list 数据源
* @param sheetName 工作表的名称
* @param output java输出流
*/
public boolean getListToExcel(List<T> list, String sheetName, OutputStream output) throws Exception {
try {
// excel中每个sheet中最多有65536行
int sheetSize = 65536;
// 得到所有定义字段
Field[] allFields = clazz.getDeclaredFields();
List<Field> fields = new ArrayList<Field>();
// 得到所有field并存放到一个list中
for (Field field : allFields) {
if (field.isAnnotationPresent(Excel.class)) {
fields.add(field);
}
}
// 产生工作薄对象
HSSFWorkbook workbook = new HSSFWorkbook();
// 取出一共有多少个sheet
int listSize = 0;
if (list != null && list.size() >= 0) {
listSize = list.size();
}
double sheetNo = Math.ceil(listSize / sheetSize);
for (int index = 0; index <= sheetNo; index++) {
// 产生工作表对象
HSSFSheet sheet = workbook.createSheet();
// 设置工作表的名称.
workbook.setSheetName(index, sheetName + index);
HSSFRow row;
HSSFCell cell;// 产生单元格
row = sheet.createRow(0);// 产生一行
/* *********普通列样式********* */
HSSFFont font = workbook.createFont();
HSSFCellStyle cellStyle = workbook.createCellStyle();
font.setFontName("Arail narrow"); // 字体
font.setBoldweight(HSSFFont.BOLDWEIGHT_BOLD); // 字体宽度
/* *********标红列样式********* */
HSSFFont newFont = workbook.createFont();
HSSFCellStyle newCellStyle = workbook.createCellStyle();
newFont.setFontName("Arail narrow"); // 字体
newFont.setBoldweight(HSSFFont.BOLDWEIGHT_BOLD); // 字体宽度
/* *************创建列头名称*************** */
for (int i = 0; i < fields.size(); i++) {
Field field = fields.get(i);
Excel attr = field.getAnnotation(Excel.class);
int col = i;
// 根据指定的顺序获得列号
if (StringUtils.isNotBlank(attr.column())) {
col = getExcelCol(attr.column());
}
// 创建列
cell = row.createCell(col);
if (attr.isMark()) {
newFont.setColor(HSSFFont.COLOR_RED); // 字体颜色
newCellStyle.setFont(newFont);
cell.setCellStyle(newCellStyle);
} else {
font.setColor(HSSFFont.COLOR_NORMAL); // 字体颜色
cellStyle.setFont(font);
cell.setCellStyle(cellStyle);
}
sheet.setColumnWidth(i, (int) ((attr.name().getBytes().length <= 4 ? 6 : attr.name().getBytes().length) * 1.5 * 256));
// 设置列中写入内容为String类型
cell.setCellType(HSSFCell.CELL_TYPE_STRING);
// 写入列名
cell.setCellValue(attr.name());
// 如果设置了提示信息则鼠标放上去提示.
if (StringUtils.isNotBlank(attr.prompt())) {
setHSSFPrompt(sheet, "", attr.prompt(), 1, 100, col, col);
}
// 如果设置了combo属性则本列只能选择不能输入
if (attr.combo().length > 0) {
setHSSFValidation(sheet, attr.combo(), 1, 100, col, col);
}
}
/* *************创建内容列*************** */
font = workbook.createFont();
cellStyle = workbook.createCellStyle();
int startNo = index * sheetSize;
int endNo = Math.min(startNo + sheetSize, listSize);
// 写入各条记录,每条记录对应excel表中的一行
for (int i = startNo; i < endNo; i++) {
row = sheet.createRow(i + 1 - startNo);
T vo = (T) list.get(i); // 得到导出对象.
for (int j = 0; j < fields.size(); j++) {
// 获得field
Field field = fields.get(j);
// 设置实体类私有属性可访问
field.setAccessible(true);
Excel attr = field.getAnnotation(Excel.class);
int col = j;
// 根据指定的顺序获得列号
if (StringUtils.isNotBlank(attr.column())) {
col = getExcelCol(attr.column());
}
// 根据ExcelVOAttribute中设置情况决定是否导出,有些情况需要保持为空,希望用户填写这一列.
if (attr.isExport()) {
// 创建cell
cell = row.createCell(col);
if (attr.isMark()) {
newFont.setColor(HSSFFont.COLOR_RED); // 字体颜色
newCellStyle.setFont(newFont);
cell.setCellStyle(newCellStyle);
} else {
font.setColor(HSSFFont.COLOR_NORMAL); // 字体颜色
cellStyle.setFont(font);
cell.setCellStyle(cellStyle);
}
// 如果数据存在就填入,不存在填入空格
Class<?> classType = (Class<?>) field.getType();
String value = null;
if (field.get(vo) != null && classType.isAssignableFrom(Date.class)) {
SimpleDateFormat sdf = new SimpleDateFormat("EEE MMM dd HH:mm:ss zzz yyyy", Locale.US);
value = sdf.format(sdf.parse(String.valueOf(field.get(vo))));
}
cell.setCellValue(field.get(vo) == null ? "" : value == null ? String.valueOf(field.get(vo)) : value);
}
}
}
/* *************创建合计列*************** */
HSSFRow lastRow = sheet.createRow((short) (sheet.getLastRowNum() + 1));
for (int i = 0; i < fields.size(); i++) {
Field field = fields.get(i);
Excel attr = field.getAnnotation(Excel.class);
if (attr.isSum()) {
int col = i;
// 根据指定的顺序获得列号
if (StringUtils.isNotBlank(attr.column())) {
col = getExcelCol(attr.column());
}
BigDecimal totalNumber = BigDecimal.ZERO;
for (int j = 1, len = (sheet.getLastRowNum() - 1); j < len; j++) {
HSSFRow hssfRow = sheet.getRow(j);
if (hssfRow != null) {
HSSFCell hssfCell = hssfRow.getCell(col);
if (hssfCell != null && hssfCell.getCellType() == HSSFCell.CELL_TYPE_STRING
&& hssfCell.getStringCellValue().indexOf(String.valueOf("\\.")) == -1) {
totalNumber = totalNumber.add(BigDecimal.valueOf(Double.valueOf(hssfCell.getStringCellValue())));
}
}
}
HSSFCell sumCell = lastRow.createCell(col);
sumCell.setCellValue(new HSSFRichTextString("合计：" + totalNumber));
}
}
}
output.flush();
workbook.write(output);
output.close();
return Boolean.TRUE;
} catch (Exception e) {
throw new Exception("将list数据源的数据导入到excel表单异常!", e);
}
}
/**
* 将EXCEL中A,B,C,D,E列映射成0,1,2,3
*
* @param col
*/
public static int getExcelCol(String col) {
col = col.toUpperCase();
// 从-1开始计算,字母重1开始运算。这种总数下来算数正好相同。
int count = -1;
char[] cs = col.toCharArray();
for (int i = 0; i < cs.length; i++) {
count += (cs[i] - 64) * Math.pow(26, cs.length - 1 - i);
}
return count;
}
/**
* 设置单元格上提示
*
* @param sheet 要设置的sheet.
* @param promptTitle 标题
* @param promptContent 内容
* @param firstRow 开始行
* @param endRow 结束行
* @param firstCol 开始列
* @param endCol 结束列
* @return 设置好的sheet.
*/
public static HSSFSheet setHSSFPrompt(HSSFSheet sheet, String promptTitle, String promptContent, int firstRow, int endRow,
int firstCol, int endCol) {
// 构造constraint对象
DVConstraint constraint = DVConstraint.createCustomFormulaConstraint("DD1");
// 四个参数分别是：起始行、终止行、起始列、终止列
CellRangeAddressList regions = new CellRangeAddressList(firstRow, endRow, firstCol, endCol);
// 数据有效性对象
HSSFDataValidation data_validation_view = new HSSFDataValidation(regions, constraint);
data_validation_view.createPromptBox(promptTitle, promptContent);
sheet.addValidationData(data_validation_view);
return sheet;
}
/**
* 设置某些列的值只能输入预制的数据,显示下拉框.
*
* @param sheet 要设置的sheet.
* @param textlist 下拉框显示的内容
* @param firstRow 开始行
* @param endRow 结束行
* @param firstCol 开始列
* @param endCol 结束列
* @return 设置好的sheet.
*/
public static HSSFSheet setHSSFValidation(HSSFSheet sheet, String[] textlist, int firstRow, int endRow, int firstCol, int endCol) {
// 加载下拉列表内容
DVConstraint constraint = DVConstraint.createExplicitListConstraint(textlist);
// 设置数据有效性加载在哪个单元格上,四个参数分别是：起始行、终止行、起始列、终止列
CellRangeAddressList regions = new CellRangeAddressList(firstRow, endRow, firstCol, endCol);
// 数据有效性对象
HSSFDataValidation data_validation_list = new HSSFDataValidation(regions, constraint);
sheet.addValidationData(data_validation_list);
return sheet;
}
}
以上@Excel注解类和ExcelUtil工具类已经编写完成了，下面我们看看如何使用
首先我们创建一个需要进行导入、导出进行映射的java文件
package com.test.entity;
import java.text.SimpleDateFormat;
import java.util.Date;
import com.test.annotation.Excel;
public class Student {
@Excel(name = "ID")
private Long id;
@Excel(name = "姓名")
private String name;
@Excel(name = "年龄")
private Integer age;
@Excel(name = "生日")
private Date birthday;
}
需要进行导入、导出的属性字段我加上了@Excel这个注解类进行配置。然后我们进行测试一下。
测试类：TestExcel.java
package com.test.controller;
import java.io.FileOutputStream;
import org.springframework.web.multipart.MultipartFile;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import java.util.Random;
import org.junit.Test;
import com.test.utils.ExcelUtil;
public class TestExcel{
@GetMapping("/export")
@ApiOperation(value = "Excel导出")
public void export() throws Exception {
List<Student> list = new ArrayList<Student>();
for (int i = 0; i < 20; i++) {
Student student= new Student();
student.setId(Long.valueOf(i + 1));
student.setName("张三" + (i + 1));
list.add(student);
}
FileOutputStream out = new FileOutputStream("D:\\student.xls");
ExcelUtil<Student> util1 = new ExcelUtil<Student>(Student .class);
util1.getListToExcel(list, "student信息", out);
}
@PostMapping("/import")
@ApiOperation(value = "Excel文件信息导入")
public void import(@RequestParam MultipartFile file) throws Exception {
InputStream inputStream = null;
inputStream = file.getInputStream();
ExcelUtil<Student> util1 = new ExcelUtil<Student>(Student.class);
List<Student> students = util1.getExcelToList("student", inputStream );
for (Student student : students) {
System.out.println(student.toString());
}
}
}
1000
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
