通过maven引入jar
1.8 UTF-8 1.8 1.8 4.1.0 3.5 18.0 org.springframework.boot spring-boot-starter-web org.apache.poi poi ${poi.version} org.apache.poi poi-ooxml ${poi.version} org.projectlombok lombok true org.apache.commons commons-lang3 ${commons-lang3.version} 自定义注解@ExcelField
package cn.lisongyu.common.annotation; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** * @author lisongyu * @date 2019/09/23 */ @Target({ElementType.FIELD, ElementType.METHOD, ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) public @interface ExcelField { /** * 导出字段名(默认调用当前字段的“get”方法,如指定导出字段为对象,请填写“对象名.对象属性”,例:“area.name”、“office.name”) */ String value() default ""; /** * 导出字段标题(需要添加批注请用“**”分隔,标题**批注,仅对导出模板有效) */ String title(); /** * 导出字段对齐方式(0:自动;1:靠左;2:居中;3:靠右) */ int align() default 0; /** * 导出字段字段排序(升序) */ int sort() default 0; }
工具类
- 导出
package cn.lisongyu.common.util; import cn.lisongyu.common.annotation.ExcelField; import lombok.extern.slf4j.Slf4j; import org.apache.commons.lang3.StringUtils; import org.apache.poi.ss.usermodel.*; import org.apache.poi.ss.util.CellRangeAddress; import org.apache.poi.xssf.streaming.SXSSFSheet; import org.apache.poi.xssf.streaming.SXSSFWorkbook; import org.apache.poi.xssf.usermodel.XSSFClientAnchor; import org.apache.poi.xssf.usermodel.XSSFRichTextString; import javax.servlet.http.HttpServletResponse; import java.io.FileOutputStream; import java.io.IOException; import java.io.OutputStream; import java.lang.reflect.Field; import java.lang.reflect.Method; import java.math.BigDecimal; import java.net.URLEncoder; import java.util.*; /** * @author lisongyu * @date 2019/09/23 */ @Slf4j public class ExportExcel { /** * 工作薄对象 */ private SXSSFWorkbook wb; /** * 工作表对象 */ private Sheet sheet; /** * 样式列表 */ private Map
styles; /** * 当前行号 */ private int rownum; /** * 注解列表(Object[]{ ExcelField, Field/Method }) */ private List - 导入
package cn.lisongyu.common.util; import cn.lisongyu.common.annotation.ExcelField; import org.apache.commons.lang3.StringUtils; import org.apache.poi.hssf.usermodel.HSSFDateUtil; import org.apache.poi.hssf.usermodel.HSSFWorkbook; import org.apache.poi.openxml4j.exceptions.InvalidFormatException; import org.apache.poi.ss.usermodel.*; import org.apache.poi.xssf.usermodel.XSSFWorkbook; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.web.multipart.MultipartFile; import java.io.File; import java.io.FileInputStream; import java.io.IOException; import java.io.InputStream; import java.lang.reflect.Field; import java.lang.reflect.Method; import java.text.NumberFormat; import java.text.SimpleDateFormat; import java.util.ArrayList; import java.util.Comparator; import java.util.Date; import java.util.List; /** * 导入Excel文件(支持“XLS”和“XLSX”格式) * * @author */ public class ImportExcel { private static Logger log = LoggerFactory.getLogger(ImportExcel.class); /** * 工作薄对象 */ private Workbook wb; /** * 工作表对象 */ private Sheet sheet; /** * 标题行号 */ private int headerNum; /** * 构造函数 * * @param fileName 导入文件,读取第一个工作表 * @param headerNum 标题行号,数据行号=标题行号+1 * @throws InvalidFormatException * @throws IOException */ public ImportExcel(String fileName, int headerNum) throws InvalidFormatException, IOException { this(new File(fileName), headerNum); } /** * 构造函数 * * @param file 导入文件对象,读取第一个工作表 * @param headerNum 标题行号,数据行号=标题行号+1 * @throws InvalidFormatException * @throws IOException */ public ImportExcel(File file, int headerNum) throws InvalidFormatException, IOException { this(file, headerNum, 0); } /** * 构造函数 * * @param fileName 导入文件 * @param headerNum 标题行号,数据行号=标题行号+1 * @param sheetIndex 工作表编号 * @throws InvalidFormatException * @throws IOException */ public ImportExcel(String fileName, int headerNum, int sheetIndex) throws InvalidFormatException, IOException { this(new File(fileName), headerNum, sheetIndex); } /** * 构造函数 * * @param file 导入文件对象 * @param headerNum 标题行号,数据行号=标题行号+1 * @param sheetIndex 工作表编号 * @throws InvalidFormatException * @throws IOException */ public ImportExcel(File file, int headerNum, int sheetIndex) throws InvalidFormatException, IOException { this(file.getName(), new FileInputStream(file), headerNum, sheetIndex); } /** * 构造函数 * * @param multipartFile 导入文件对象 * @param headerNum 标题行号,数据行号=标题行号+1 * @param sheetIndex 工作表编号 * @throws InvalidFormatException * @throws IOException */ public ImportExcel(MultipartFile multipartFile, int headerNum, int sheetIndex) throws InvalidFormatException, IOException { this(multipartFile.getOriginalFilename(), multipartFile.getInputStream(), headerNum, sheetIndex); } /** * 构造函数 * * @param fileName 导入文件对象 * @param headerNum 标题行号,数据行号=标题行号+1 * @param sheetIndex 工作表编号 * @throws InvalidFormatException * @throws IOException */ public ImportExcel(String fileName, InputStream is, int headerNum, int sheetIndex) throws InvalidFormatException, IOException { if (StringUtils.isBlank(fileName)) { throw new RuntimeException("导入文档为空!"); } else if (fileName.toLowerCase().endsWith("xls")) { this.wb = new HSSFWorkbook(is); } else if (fileName.toLowerCase().endsWith("xlsx")) { this.wb = new XSSFWorkbook(is); } else { throw new RuntimeException("文档格式不正确!"); } if (this.wb.getNumberOfSheets() < sheetIndex) { throw new RuntimeException("文档中没有工作表!"); } this.sheet = this.wb.getSheetAt(sheetIndex); this.headerNum = headerNum; } /** * 获取行对象 * * @param rownum * @return */ public Row getRow(int rownum) { return this.sheet.getRow(rownum); } /** * 获取数据行号 * * @return */ public int getDataRowNum() { return headerNum + 1; } /** * 获取最后一个数据行号 * * @return */ public int getLastDataRowNum() { return this.sheet.getLastRowNum() + headerNum; } /** * 获取最后一个列号 * * @return */ public int getLastCellNum() { return this.getRow(headerNum).getLastCellNum(); } /** * 获取单元格值 * * @param row 获取的行 * @param column 获取单元格列号 * @return 单元格值 */ public Object getCellValue(Row row, int column) { Object val = ""; try { Cell cell = row.getCell(column); if (cell != null) { if (cell.getCellType() == CellType.NUMERIC) { // val = cell.getNumericCellValue(); // 当excel 中的数据为数值或日期是需要特殊处理 if (HSSFDateUtil.isCellDateFormatted(cell)) { double d = cell.getNumericCellValue(); Date date = HSSFDateUtil.getJavaDate(d); SimpleDateFormat dformat = new SimpleDateFormat( "yyyy-MM-dd"); val = dformat.format(date); } else { NumberFormat nf = NumberFormat.getInstance(); // true时的格式:1,234,567,890 nf.setGroupingUsed(false); // 数值类型的数据为double,所以需要转换一下 val = nf.format(cell.getNumericCellValue()); } } else if (cell.getCellType() == CellType.STRING) { val = cell.getStringCellValue(); } else if (cell.getCellType() == CellType.FORMULA) { val = cell.getCellFormula(); } else if (cell.getCellType() == CellType.BOOLEAN) { val = cell.getBooleanCellValue(); } else if (cell.getCellType() == CellType.ERROR) { val = cell.getErrorCellValue(); } } } catch (Exception e) { return val; } return val; } /** * 获取导入数据列表 * * @param cls 导入对象类型 */ public
List getDataList(Class cls) throws InstantiationException, IllegalAccessException { List - 反射
package cn.lisongyu.common.util; import java.lang.reflect.Field; import java.lang.reflect.InvocationTargetException; import java.lang.reflect.Method; import java.lang.reflect.Modifier; import java.lang.reflect.ParameterizedType; import java.lang.reflect.Type; import org.apache.commons.lang3.StringUtils; import org.apache.commons.lang3.Validate; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.util.Assert; /** * 反射工具类. * 提供调用getter/setter方法, 访问私有变量, 调用私有方法, 获取泛型类型Class, 被AOP过的真实类等工具函数. * * @author lisongyu * @date 2019/09/23 */ @SuppressWarnings("rawtypes") public class Reflections { private static final String SETTER_PREFIX = "set"; private static final String GETTER_PREFIX = "get"; private static final String CGLIB_CLASS_SEPARATOR = "$$"; private static final String POINT = "."; private static Logger logger = LoggerFactory.getLogger(Reflections.class); /** * 调用Getter方法. * 支持多级,如:对象名.对象名.方法 */ static Object invokeGetter(Object obj, String propertyName) { Object object = obj; for (String name : StringUtils.split(propertyName, POINT)) { String getterMethodName = GETTER_PREFIX + StringUtils.capitalize(name); object = invokeMethod(object, getterMethodName, new Class[]{}, new Object[]{}); } return object; } /** * 调用Setter方法, 仅匹配方法名。 * 支持多级,如:对象名.对象名.方法 */ static void invokeSetter(Object obj, String propertyName, Object value) { Object object = obj; String[] names = StringUtils.split(propertyName, "."); for (int i = 0; i < names.length; i++) { if (i < names.length - 1) { String getterMethodName = GETTER_PREFIX + StringUtils.capitalize(names[i]); object = invokeMethod(object, getterMethodName, new Class[]{}, new Object[]{}); } else { String setterMethodName = SETTER_PREFIX + StringUtils.capitalize(names[i]); invokeMethodByName(object, setterMethodName, new Object[]{value}); } } } /** * 直接读取对象属性值, 无视private/protected修饰符, 不经过getter函数. */ public static Object getFieldValue(final Object obj, final String fieldName) { Field field = getAccessibleField(obj, fieldName); if (field == null) { throw new IllegalArgumentException("Could not find field [" + fieldName + "] on target [" + obj + "]"); } Object result = null; try { result = field.get(obj); } catch (IllegalAccessException e) { logger.error("不可能抛出的异常{}", e.getMessage()); } return result; } /** * 直接设置对象属性值, 无视private/protected修饰符, 不经过setter函数. */ public static void setFieldValue(final Object obj, final String fieldName, final Object value) { Field field = getAccessibleField(obj, fieldName); if (field == null) { throw new IllegalArgumentException("Could not find field [" + fieldName + "] on target [" + obj + "]"); } try { field.set(obj, value); } catch (IllegalAccessException e) { logger.error("不可能抛出的异常:{}", e.getMessage()); } } /** * 直接调用对象方法, 无视private/protected修饰符. * 用于一次性调用的情况,否则应使用getAccessibleMethod()函数获得Method后反复调用. * 同时匹配方法名+参数类型, */ static Object invokeMethod(final Object obj, final String methodName, final Class>[] parameterTypes, final Object[] args) { Method method = getAccessibleMethod(obj, methodName, parameterTypes); if (method == null) { throw new IllegalArgumentException("Could not find method [" + methodName + "] on target [" + obj + "]"); } try { return method.invoke(obj, args); } catch (Exception e) { throw convertReflectionExceptionToUnchecked(e); } } /** * 直接调用对象方法, 无视private/protected修饰符, * 用于一次性调用的情况,否则应使用getAccessibleMethodByName()函数获得Method后反复调用. * 只匹配函数名,如果有多个同名函数调用第一个。 */ public static Object invokeMethodByName(final Object obj, final String methodName, final Object[] args) { Method method = getAccessibleMethodByName(obj, methodName); if (method == null) { throw new IllegalArgumentException("Could not find method [" + methodName + "] on target [" + obj + "]"); } try { return method.invoke(obj, args); } catch (Exception e) { throw convertReflectionExceptionToUnchecked(e); } } /** * 循环向上转型, 获取对象的DeclaredField, 并强制设置为可访问. *
* 如向上转型到Object仍无法找到, 返回null. */ private static Field getAccessibleField(final Object obj, final String fieldName) { Validate.notNull(obj, "object can't be null"); Validate.notBlank(fieldName, "fieldName can't be blank"); for (Class> superClass = obj.getClass(); superClass != Object.class; superClass = superClass.getSuperclass()) { try { Field field = superClass.getDeclaredField(fieldName); makeAccessible(field); return field; } catch (NoSuchFieldException e) {//NOSONAR // Field不在当前类定义,继续向上转型 } } return null; } /** * 循环向上转型, 获取对象的DeclaredMethod,并强制设置为可访问. * 如向上转型到Object仍无法找到, 返回null. * 匹配函数名+参数类型。 *
* 用于方法需要被多次调用的情况. 先使用本函数先取得Method,然后调用Method.invoke(Object obj, Object... args) */ private static Method getAccessibleMethod(final Object obj, final String methodName, final Class>... parameterTypes) { Validate.notNull(obj, "object can't be null"); Validate.notBlank(methodName, "methodName can't be blank"); for (Class> searchType = obj.getClass(); searchType != Object.class; searchType = searchType.getSuperclass()) { try { Method method = searchType.getDeclaredMethod(methodName, parameterTypes); makeAccessible(method); return method; } catch (NoSuchMethodException e) { // Method不在当前类定义,继续向上转型 } } return null; } /** * 循环向上转型, 获取对象的DeclaredMethod,并强制设置为可访问. * 如向上转型到Object仍无法找到, 返回null. * 只匹配函数名。 *
* 用于方法需要被多次调用的情况. 先使用本函数先取得Method,然后调用Method.invoke(Object obj, Object... args) */ private static Method getAccessibleMethodByName(final Object obj, final String methodName) { Validate.notNull(obj, "object can't be null"); Validate.notBlank(methodName, "methodName can't be blank"); for (Class> searchType = obj.getClass(); searchType != Object.class; searchType = searchType.getSuperclass()) { Method[] methods = searchType.getDeclaredMethods(); for (Method method : methods) { if (method.getName().equals(methodName)) { makeAccessible(method); return method; } } } return null; } /** * 改变private/protected的方法为public,尽量不调用实际改动的语句,避免JDK的SecurityManager抱怨。 */ private static void makeAccessible(Method method) { if ((!Modifier.isPublic(method.getModifiers()) || !Modifier.isPublic(method.getDeclaringClass().getModifiers())) && !method.isAccessible()) { method.setAccessible(true); } } /** * 改变private/protected的成员变量为public,尽量不调用实际改动的语句,避免JDK的SecurityManager抱怨。 */ private static void makeAccessible(Field field) { if ((!Modifier.isPublic(field.getModifiers()) || !Modifier.isPublic(field.getDeclaringClass().getModifiers()) || Modifier .isFinal(field.getModifiers())) && !field.isAccessible()) { field.setAccessible(true); } } /** * 通过反射, 获得Class定义中声明的泛型参数的类型, 注意泛型必须定义在父类处 * 如无法找到, 返回Object.class. * eg. * public UserDao extends HibernateDao
* * @param clazz The class to introspect * @return the first generic declaration, or Object.class if cannot be determined */ @SuppressWarnings("unchecked") public static Class getClassGenricType(final Class clazz) { return getClassGenricType(clazz, 0); } /** * 通过反射, 获得Class定义中声明的父类的泛型参数的类型. * 如无法找到, 返回Object.class. * * 如public UserDao extends HibernateDao
* * @param clazz clazz The class to introspect * @param index the Index of the generic ddeclaration,start from 0. * @return the index generic declaration, or Object.class if cannot be determined */ private static Class getClassGenricType(final Class clazz, final int index) { Type genType = clazz.getGenericSuperclass(); if (!(genType instanceof ParameterizedType)) { logger.warn(clazz.getSimpleName() + "'s superclass not ParameterizedType"); return Object.class; } Type[] params = ((ParameterizedType) genType).getActualTypeArguments(); if (index >= params.length || index < 0) { logger.warn("Index: " + index + ", Size of " + clazz.getSimpleName() + "'s Parameterized Type: " + params.length); return Object.class; } if (!(params[index] instanceof Class)) { logger.warn(clazz.getSimpleName() + " not set the actual class on superclass generic parameter"); return Object.class; } return (Class) params[index]; } public static Class> getUserClass(Object instance) { Assert.notNull(instance, "Instance must not be null"); Class clazz = instance.getClass(); if (clazz != null && clazz.getName().contains(CGLIB_CLASS_SEPARATOR)) { Class> superClass = clazz.getSuperclass(); if (superClass != null && !Object.class.equals(superClass)) { return superClass; } } return clazz; } /** * 将反射时的checked exception转换为unchecked exception. */ private static RuntimeException convertReflectionExceptionToUnchecked(Exception e) { if (e instanceof IllegalAccessException || e instanceof IllegalArgumentException || e instanceof NoSuchMethodException) { return new IllegalArgumentException(e); } else if (e instanceof InvocationTargetException) { return new RuntimeException(((InvocationTargetException) e).getTargetException()); } else if (e instanceof RuntimeException) { return (RuntimeException) e; } return new RuntimeException("Unexpected Checked Exception.", e); } } 测试
package cn.lisongyu.common.base; import cn.lisongyu.common.annotation.ExcelField; import cn.lisongyu.common.util.ExportExcel; import cn.lisongyu.common.util.ImportExcel; import lombok.*; import lombok.extern.slf4j.Slf4j; import java.text.SimpleDateFormat; import java.util.ArrayList; import java.util.Date; import java.util.List; import java.util.Random; /** * @author lisongyu * @date 2019/09/23 */ @Data @Builder @AllArgsConstructor(access = AccessLevel.PRIVATE) @NoArgsConstructor public class TestClass { @ExcelField(title = "编号", align = 2) private Integer id; @ExcelField(title = "姓名", align = 2, sort = 1) private String name; @ExcelField(title = "年龄", align = 2, sort = 2) private Integer age; @ExcelField(title = "薪水", align = 2, sort = 3) private Double salary; @ExcelField(title = "出生日期", align = 2, sort = 4) private String birthday; } @Slf4j class Test { public static void main(String[] args) throws Exception { List
testClasses = new ArrayList<>(); for (int i = 1; i <= 10; i++) { TestClass testClass = TestClass.builder() .id(i) .name("测试" + i) .age(new Random().nextInt(100)) .salary(10000d) .birthday(new SimpleDateFormat("yyyy-MM-dd").format(new Date())) .build(); testClasses.add(testClass); } ExportExcel exportExcel = new ExportExcel("测试导出", TestClass.class).setDataList(testClasses); exportExcel.writeFile("E:\\1.xlsx"); exportExcel.dispose(); ImportExcel importExcel = new ImportExcel("E:\\1.xlsx", 1, 0); List list = importExcel.getDataList(TestClass.class); for (int i = 0; i < list.size(); i++) { TestClass excelModelTest = list.get(i); log.info(excelModelTest.toString()); } } } 结果
19:46:59.423 [main] DEBUG cn.lisongyu.common.util.ExportExcel - Initialize success. 19:46:59.813 [main] INFO cn.lisongyu.common.util.ImportExcel - Read success: [1, 测试1, 0, 10000.0, 2019-09-24, ] 19:46:59.814 [main] INFO cn.lisongyu.common.util.ImportExcel - Read success: [2, 测试2, 63, 10000.0, 2019-09-24, ] 19:46:59.815 [main] INFO cn.lisongyu.common.util.ImportExcel - Read success: [3, 测试3, 18, 10000.0, 2019-09-24, ] 19:46:59.815 [main] INFO cn.lisongyu.common.util.ImportExcel - Read success: [4, 测试4, 91, 10000.0, 2019-09-24, ] 19:46:59.816 [main] INFO cn.lisongyu.common.util.ImportExcel - Read success: [5, 测试5, 1, 10000.0, 2019-09-24, ] 19:46:59.816 [main] INFO cn.lisongyu.common.util.ImportExcel - Read success: [6, 测试6, 47, 10000.0, 2019-09-24, ] 19:46:59.817 [main] INFO cn.lisongyu.common.util.ImportExcel - Read success: [7, 测试7, 19, 10000.0, 2019-09-24, ] 19:46:59.818 [main] INFO cn.lisongyu.common.util.ImportExcel - Read success: [8, 测试8, 40, 10000.0, 2019-09-24, ] 19:46:59.818 [main] INFO cn.lisongyu.common.util.ImportExcel - Read success: [9, 测试9, 72, 10000.0, 2019-09-24, ] 19:46:59.819 [main] INFO cn.lisongyu.common.util.ImportExcel - Read success: [10, 测试10, 51, 10000.0, 2019-09-24, ] 19:46:59.819 [main] INFO cn.lisongyu.common.base.Test - TestClass(id=1, name=测试1, age=0, salary=10000.0, birthday=2019-09-24) 19:46:59.819 [main] INFO cn.lisongyu.common.base.Test - TestClass(id=2, name=测试2, age=63, salary=10000.0, birthday=2019-09-24) 19:46:59.819 [main] INFO cn.lisongyu.common.base.Test - TestClass(id=3, name=测试3, age=18, salary=10000.0, birthday=2019-09-24) 19:46:59.819 [main] INFO cn.lisongyu.common.base.Test - TestClass(id=4, name=测试4, age=91, salary=10000.0, birthday=2019-09-24) 19:46:59.819 [main] INFO cn.lisongyu.common.base.Test - TestClass(id=5, name=测试5, age=1, salary=10000.0, birthday=2019-09-24) 19:46:59.819 [main] INFO cn.lisongyu.common.base.Test - TestClass(id=6, name=测试6, age=47, salary=10000.0, birthday=2019-09-24) 19:46:59.819 [main] INFO cn.lisongyu.common.base.Test - TestClass(id=7, name=测试7, age=19, salary=10000.0, birthday=2019-09-24) 19:46:59.819 [main] INFO cn.lisongyu.common.base.Test - TestClass(id=8, name=测试8, age=40, salary=10000.0, birthday=2019-09-24) 19:46:59.819 [main] INFO cn.lisongyu.common.base.Test - TestClass(id=9, name=测试9, age=72, salary=10000.0, birthday=2019-09-24) 19:46:59.819 [main] INFO cn.lisongyu.common.base.Test - TestClass(id=10, name=测试10, age=51, salary=10000.0, birthday=2019-09-24)