之前在项目中有遇到excel导入、导出的功能,起初做的时候在网上找了一些类似的例子,功能是实现了,但是总感觉代码太过于臃肿,不够灵活,每次进行导入导出的需要写一长串代码感觉非常不爽,于是结合网上和自己的理解写了以下博客!
使用的第三方jar包是poi
首先在maven项目中的pom文件中加入这个依赖包
<dependency> <groupId>org.apache.poi</groupId> <artifactId>poi</artifactId> <version>3.9</version> </dependency>
然后编写控制excel导入、导出的注解
ExcelAttribute.java
package com.mango.insure.common.annotation; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** * Excel配置注解自定义接口 * * @author jiaxingHuang * @version 1.0 2014-08-20 * @since 1.0 */ @Retention(RetentionPolicy.RUNTIME) @Target({ java.lang.annotation.ElementType.FIELD }) public @interface ExcelAttribute { /** * 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; }
然后再编写excel导入、导入所需要到的工具类
ExcelUtil.java
package com.mango.insure.common.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 org.apache.commons.lang3.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; import com.mango.core.common.util.BigDecimalUtils; import com.mango.core.common.util.DateUtils; import com.mango.core.enums.CalculateType; import com.mango.insure.common.annotation.ExcelAttribute; import com.mango.insure.common.exception.ExcelException; /** * excel导入导出工具类 * * @author jiaxingHuang * @version 1.0 2014-08-20 * @since 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 output * java输入流 */ public List<T> getExcelToList(String sheetName, InputStream input) { List<T> list = new ArrayList<T>(); 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(ExcelAttribute.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, DateUtils.parseDate(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 ExcelException("将excel表单数据源的数据导入到list异常!", e); } return list; } /** * 将list数据源的数据导入到excel表单 * * @param list * 数据源 * @param sheetName * 工作表的名称 * @param output * java输出流 */ public boolean getListToExcel(List<T> list, String sheetName, OutputStream output) { 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(ExcelAttribute.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); ExcelAttribute attr = field.getAnnotation(ExcelAttribute.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); ExcelAttribute attr = field.getAnnotation(ExcelAttribute.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 = DateUtils.formatDate(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); ExcelAttribute attr = field.getAnnotation(ExcelAttribute.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 && ValidateUtil.isFloat(hssfCell.getStringCellValue())) { totalNumber = BigDecimalUtils.getValue(totalNumber, BigDecimal.valueOf(Double.valueOf(hssfCell.getStringCellValue())), CalculateType.Add); } } } 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 ExcelException("将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; } }
以上注解类和工具类已经编写完成了,接下来我们看看如何使用
首先我们创建一个需要进行导入、导出进行映射的java文件
TestModel.java
package com.mango.insure.test; import java.text.SimpleDateFormat; import java.util.Date; import com.mango.insure.common.annotation.ExcelAttribute; public class TestModel { @ExcelAttribute(name = "ID") private Long id; @ExcelAttribute(name = "姓名", isMark = true) private String name; @ExcelAttribute(name = "年龄", isMark = true) private Integer age; @ExcelAttribute(name = "生日") private Date birthday; @ExcelAttribute(name = "备注") private String mark; public TestModel() { } public Long getId() { return id; } public void setId(Long id) { this.id = id; } public String getName() { return name; } public void setName(String name) { this.name = name; } public Integer getAge() { return age; } public void setAge(Integer age) { this.age = age; } public Date getBirthday() { return birthday; } public void setBirthday(Date birthday) { this.birthday = birthday; } public String getMark() { return mark; } public void setMark(String mark) { this.mark = mark; } @Override public String toString() { return "TestModel [id=" + id + ", name=" + name + ", age=" + age + ", birthday=" + new SimpleDateFormat("yyyy-MM-dd").format(birthday) + ", mark=" + mark + "]"; } }需要进行导入、导出的属性字段我加上了@ExcelAttribute这个注解类进行配置
相关推荐
Java中的Excel导入导出是开发过程中常见的需求,特别是在数据处理、...以上就是Java中使用Apache POI和注解进行Excel导入导出的基本教程。通过实践和扩展,你可以创建一个强大的Excel工具包,满足各种复杂的业务需求。
总结,Java注解在Excel导入导出中的应用极大地提高了代码的可读性和维护性,减少了硬编码,使得数据的映射变得更加直观。通过结合Apache POI库,我们可以高效地处理Excel文件,满足各种业务需求。在实际开发中,还...
"基于注解实现Excel导入导出(兼容2003、2007版本)"的主题涉及了如何利用编程技术高效地与Excel文件进行交互,特别是在Java环境中。这个主题通常涉及到Apache POI库,这是一个强大的API,允许开发者创建、修改和...
该项目是一款基于注解的Java Excel导入导出工具设计源码,包含44个文件,涵盖30个Java源文件、5个XML配置文件、5个PNG图片文件、2个Markdown文档文件、1个Git忽略文件、1个Idea项目文件。该工具支持丰富的导出和导入...
在Java开发中,处理Excel数据的导入导出是一项常见的任务,尤其在企业级应用中,如数据批量处理、报表生成等。SpringBoot框架以其轻量级、便捷的特性深受开发者喜爱,而easypoi则是Java领域处理Excel的一个强大工具...
首先,Excel的注解方式导入导出是一种高效且灵活的数据处理手段,它通过Java编程语言,利用Apache POI库或其他类似的库,如JExcelAPI,对Excel文件进行操作。这种方式通常涉及创建数据模型类,并在模型类的字段上...
Java实现Excel导入导出是Java开发中常见的任务,主要用于数据的批量处理和分析,尤其在数据分析、报表生成和数据备份等方面具有广泛应用。要熟练掌握这一技术,开发者需要了解Excel文件的结构,熟悉Java的文件操作,...
使用EasyExcel进行Excel导入导出,主要涉及以下几个步骤: 1. **定义实体类**:首先,我们需要创建一个Java实体类,该类的属性对应Excel文件中的列,通过注解可以设置对应的Excel列名和格式。 2. **编写监听器**:...
本文将详细探讨"Excel导入动态校验,自定义注解动态校验"这一主题,旨在帮助你理解和掌握如何在处理Excel数据时进行有效的验证和校验。 首先,Excel导入动态校验是指在将Excel数据导入到系统或数据库时,对数据进行...
在Java开发中,处理Excel数据是一项常见的任务,尤其是在数据导入导出、数据分析或者报表生成等场景。Apache POI是一个流行的库,它允许开发者使用Java来读取、写入和修改Microsoft Office格式的文件,包括Excel(....
在这个"通用excel导入/导出 (poi)"的示例中,我们主要关注的是Excel文件的处理,特别是如何利用POI库进行数据的导入和导出。下面将详细介绍这个过程中的关键知识点。 首先,让我们了解一下Apache POI。它是Apache...
在Java开发中,处理Excel和XML文件是一项常见的任务,特别是在数据导入导出、报表生成以及数据交换等场景。本文将详细讲解如何使用Java进行Excel和XML文件的解析及操作。 一、Excel文件处理 1. **Apache POI库**:...
本资源提供了一个基于Java实现的Excel导入导出工具类,结合注解的使用,使得这一功能更加便捷和通用。这个工具适用于构建公共的Excel处理模块,能够有效地提高开发效率。 首先,我们来看一下导入导出的基本原理。在...
2. **Excel导入**: - 读取Excel文件:使用POI库,打开本地文件,获取工作簿和工作表。 - 数据解析:遍历每一行,读取每个单元格的数据,根据业务需求进行类型转换。 - 数据验证:对导入的数据进行校验,确保符合...
Java使用EasyExcel进行Excel的导入导出是一种高效且便捷的方式,尤其对于大数据量的处理,EasyExcel能够很好地解决内存溢出的问题。以下是关于EasyExcel在Java中应用的详细讲解: 一、准备工作 在使用EasyExcel之前...
在使用easypoi库进行Java项目的Excel表格导入导出时,开发者需要重视其依赖的引入,理解各注解的用途,以及能够解决使用过程中可能出现的类找不到或者依赖冲突等错误。另外,合理使用文档资源,跟进库的版本更新,也...
本篇将详细介绍如何使用注解与反射技术来构建一个通用的Excel导出工具。 首先,我们需要理解注解(Annotation)在Java中的作用。注解是一种元数据,它提供了在源代码中嵌入信息的方式,这些信息可以被编译器或者...
本主题将深入探讨“java导入导出通用模板”,特别是使用自定义注解和反射技术来实现这一目标。这些技术是Java POI库在Excel处理中的常见应用,可以帮助开发者更高效地管理数据的输入和输出。 首先,我们来看...
对于J2EE项目导入导出Excel是最普通和实用功能,本工具类使用步骤简单,功能强大,只需要对实体类进行简单的注解就能实现导入导出功能,导入导出操作的都是实体对象. 请看一下这个类都有哪些功能: * 1.实体属性配置了...