缘起
最近写一个程序,需要操作excel,遂稍微深入了解下poi从操作,
在需要复制一个sheet的时候,找到三份资料
问题
如果在copy一个cell的时候,需要把样式也copy过去,怎么办,会怎样呢?
如果像第三份资料中所做,会创建太多的style,而这些style又是重复的 ,毫无意义,数据多了还报错
如果像第二份资料中所做,前提是同一个workbook,也不存在copy style 的问题,只不过是不同的cell引用相同的style而已
如果像第一份资料所做,他自己都注释掉了,因为报错
如何解决
思路
- 相同的book中,不需要copy
- 不同的book中,styleTable应该不一致,copy的时候,在目标book中创建,最后返回两个book中的style index的映射关系
代码
暂时没测试过,写出来就迫不及待要分享了。
import org.apache.poi.ss.usermodel.CellStyle;import org.apache.poi.ss.usermodel.Workbook;import org.slf4j.Logger;import org.slf4j.LoggerFactory;/** * 提供常用excel操作 *
*/public class ExcelOperationUtil { private static Logger logger = LoggerFactory.getLogger(ExcelOperationUtil.class); /** * 把一个excel中的styleTable复制到另一个excel中 * @return StyleMapping 两个文件中styleTable的映射关系 * @see StyleMapping */ public static StyleMapping copyCellStyle(Workbook srcBook, Workbook desBook){ if (null == srcBook || null == desBook) { throw new ExcelExecption("源excel 或 目标excel 不存在"); } if (srcBook.equals(desBook)) { throw new ExcelExecption("不要使用此方法在同一个文件中copy style"); } logger.debug("src中style number:{}, des中style number:{}", srcBook.getNumCellStyles(), desBook.getNumCellStyles()); short[] src2des = new short[srcBook.getNumCellStyles()]; short[] des2src = new short[desBook.getNumCellStyles() + srcBook.getNumCellStyles()]; for(short i=0;i
= this.des2srcIndexMapping.length) { throw new ExcelExecption("索引越界:源文件styleNum=" + this.des2srcIndexMapping.length + " 访问位置=" + desIndex); } return this.des2srcIndexMapping[desIndex]; } /** * 根据源文件的style的index,获取目标文件的style的index * @param srcIndex 源excel中style的index * @return desIndex 目标excel中style的index */ public short desIndex(short srcIndex) { if (srcIndex < 0 || srcIndex >= this.src2desIndexMapping.length) { throw new ExcelExecption("索引越界:源文件styleNum=" + this.src2desIndexMapping.length + " 访问位置=" + srcIndex); } return this.src2desIndexMapping[srcIndex]; } }} 完善代码
工作忙了几天,终于可以回头把这件事结束掉了
org.apache.poi poi 3.17 org.apache.poi poi-ooxml 3.17 org.apache.poi poi-scratchpad 3.17
为啥贴出依赖?因为我一开始用3.8版本,如果是xls就可以,如果是xlsx死活不行,最后,换掉版本就可以了。
import org.apache.poi.hssf.usermodel.HSSFWorkbook;import org.apache.poi.ss.usermodel.*;import org.apache.poi.ss.util.CellRangeAddress;import org.apache.poi.xssf.usermodel.XSSFWorkbook;import org.slf4j.Logger;import org.slf4j.LoggerFactory;import java.util.Iterator;/** * 提供常用excel操作 *
*/public class ExcelOperationUtil { private static Logger logger = LoggerFactory.getLogger(ExcelOperationUtil.class); /** * sheet 复制,复制数据、如果同一个文件,复制样式,不同文件则只复制数据
* 如果是同book中复制,建议使用workbook中的cloneSheet()方法
* *
建议用于 不同book间只复制数据 * */ public static void copySheet(Sheet srcSheet, Sheet desSheet) { copySheet(srcSheet, desSheet, true, true, null); } /** * sheet 复制,如果同一个文件,复制样式,不同文件则不复制
* *
建议用于 同book中,只复制样式,不复制数据
* eg: copySheet(srcSheet, desSheet, false) * * @param copyValueFlag 控制是否复制数据 */ public static void copySheet(Sheet srcSheet, Sheet desSheet, boolean copyValueFlag) { copySheet(srcSheet, desSheet, copyValueFlag, true, null); } /** * sheet 复制,复制数据、样式
* *
建议用于 不同book间复制,同时复制数据和样式
* eg: copySheet(srcSheet, desSheet, mapping) * * @param mapping 不同文件间复制时,如果要复制样式,必传,否则不复制样式 */ public static void copySheet(Sheet srcSheet, Sheet desSheet, StyleMapping mapping) { copySheet(srcSheet, desSheet, true, true, mapping); } /** * sheet 复制,复制数据
* *
建议用于 同book中,只复制数据,不复制样式
* eg: copySheet(srcSheet, desSheet, false, null) * * @param srcSheet * @param desSheet * @param copyStyleFlag * @param mapping */ public static void copySheet(Sheet srcSheet, Sheet desSheet, boolean copyStyleFlag, StyleMapping mapping) { copySheet(srcSheet, desSheet, true, copyStyleFlag, mapping); } /** * sheet 复制, 灵活控制是否控制数据、样式
* *
不建议直接使用 * * @param copyValueFlag 控制是否复制数据 * @param copyStyleFlag 控制是否复制样式 * @param mapping 不同book中复制样式时,必传 */ public static void copySheet(Sheet srcSheet, Sheet desSheet, boolean copyValueFlag, boolean copyStyleFlag, StyleMapping mapping) { if (srcSheet.getWorkbook() == desSheet.getWorkbook()) { logger.warn("统一workbook内复制sheet建议使用 workbook的cloneSheet方法"); } //合并区域处理 copyMergedRegion(srcSheet, desSheet); //行复制 Iterator
rowIterator = srcSheet.rowIterator(); int areadlyColunm = 0; while (rowIterator.hasNext()) { Row srcRow = rowIterator.next(); Row desRow = desSheet.createRow(srcRow.getRowNum()); copyRow(srcRow, desRow, copyValueFlag, copyStyleFlag, mapping); //调整列宽(增量调整) if (srcRow.getPhysicalNumberOfCells() > areadlyColunm) { for (int i = areadlyColunm; i < srcRow.getPhysicalNumberOfCells(); i++) { desSheet.setColumnWidth(i, srcSheet.getColumnWidth(i)); } areadlyColunm = srcRow.getPhysicalNumberOfCells(); } } } /** * 复制行 */ public static void copyRow(Row srcRow, Row desRow) { copyRow(srcRow, desRow, true, true, null); } /** * 复制行 */ public static void copyRow(Row srcRow, Row desRow, boolean copyValueFlag) { copyRow(srcRow, desRow, copyValueFlag, true, null); } /** * 复制行 */ public static void copyRow(Row srcRow, Row desRow, StyleMapping mapping) { copyRow(srcRow, desRow, true, true, mapping); } /** * 复制行 */ public static void copyRow(Row srcRow, Row desRow, boolean copyStyleFlag, StyleMapping mapping) { copyRow(srcRow, desRow, true, copyStyleFlag, mapping); } /** * 复制行 */ public static void copyRow(Row srcRow, Row desRow,boolean copyValueFlag, boolean copyStyleFlag, StyleMapping mapping) { Iterator it = srcRow.cellIterator(); while (it.hasNext()) { Cell srcCell = it.next(); Cell desCell = desRow.createCell(srcCell.getColumnIndex()); copyCell(srcCell, desCell, copyValueFlag, copyStyleFlag, mapping); } } /** * 复制区域(合并单元格) */ public static void copyMergedRegion(Sheet srcSheet, Sheet desSheet) { int sheetMergerCount = srcSheet.getNumMergedRegions(); for (int i = 0; i < sheetMergerCount; i++) { desSheet.addMergedRegion(srcSheet.getMergedRegion(i)); CellRangeAddress cellRangeAddress = srcSheet.getMergedRegion(i); } } /** * 复制单元格,复制数据,如果同文件,复制样式,不同文件则不复制样式 */ public static void copyCell(Cell srcCell, Cell desCell) { copyCell(srcCell, desCell, true, true,null); } /** * 复制单元格, 如果同文件,复制样式,不同文件则不复制样式 * @param copyValueFlag 控制是否复制数据 */ public static void copyCell(Cell srcCell, Cell desCell, boolean copyValueFlag) { copyCell(srcCell, desCell, copyValueFlag, true, null); } /** * 复制单元格,复制数据,复制样式 * @param mapping 不同文件间复制时,如果要复制样式,必传,否则不复制样式 */ public static void copyCell(Cell srcCell, Cell desCell, StyleMapping mapping) { copyCell(srcCell, desCell, true, true, mapping); } /** * 复制单元格,复制数据 * @param copyStyleFlag 控制是否复制样式 * @param mapping 不同文件间复制时,如果要复制样式,必传,否则不复制样式 */ public static void copyCell(Cell srcCell, Cell desCell, boolean copyStyleFlag, StyleMapping mapping) { copyCell(srcCell, desCell, true, copyStyleFlag, mapping); } /** * 复制单元格 * @param copyValueFlag 控制是否复制单元格的内容 * @param copyStyleFlag 控制是否复制样式 * @param mapping 不同文件间复制时,如果需要连带样式复制,必传,否则不复制样式 */ public static void copyCell(Cell srcCell, Cell desCell, boolean copyValueFlag, boolean copyStyleFlag, StyleMapping mapping) { Workbook srcBook = srcCell.getSheet().getWorkbook(); Workbook desBook = desCell.getSheet().getWorkbook(); //复制样式 //如果是同一个excel文件内,连带样式一起复制 if (srcBook == desBook && copyStyleFlag) { //同文件,复制引用 desCell.setCellStyle(srcCell.getCellStyle()); } else if (copyStyleFlag) { //不同文件,通过映射关系复制 if (null != mapping) { short desIndex = mapping.desIndex(srcCell.getCellStyle().getIndex()); desCell.setCellStyle(desBook.getCellStyleAt(desIndex)); } } //复制评论 if (srcCell.getCellComment() != null) { desCell.setCellComment(srcCell.getCellComment()); } //复制内容 desCell.setCellType(srcCell.getCellTypeEnum()); if (copyValueFlag) { switch (srcCell.getCellTypeEnum()) { case STRING: desCell.setCellValue(srcCell.getStringCellValue()); break; case NUMERIC: desCell.setCellValue(srcCell.getNumericCellValue()); break; case FORMULA: desCell.setCellFormula(srcCell.getCellFormula()); break; case BOOLEAN: desCell.setCellValue(srcCell.getBooleanCellValue()); break; case ERROR: desCell.setCellValue(srcCell.getErrorCellValue()); break; case BLANK: //nothing to do break; default: break; } } } /** * 把一个excel中的styleTable复制到另一个excel中 * 如果是同一个excel文件,就不用复制styleTable了 * @return StyleMapping 两个文件中styleTable的映射关系 * @see StyleMapping */ public static StyleMapping copyCellStyle(Workbook srcBook, Workbook desBook){ if (null == srcBook || null == desBook) { throw new ExcelException("源excel 或 目标excel 不存在"); } if (srcBook.equals(desBook)) { throw new ExcelException("不要使用此方法在同一个文件中copy style,同一个excel中复制sheet不需要copy Style"); } if ((srcBook instanceof HSSFWorkbook && desBook instanceof XSSFWorkbook) || (srcBook instanceof XSSFWorkbook && desBook instanceof HSSFWorkbook)) { throw new ExcelException("不支持在不同的版本的excel中复制样式)"); } logger.debug("src中style number:{}, des中style number:{}", srcBook.getNumCellStyles(), desBook.getNumCellStyles()); short[] src2des = new short[srcBook.getNumCellStyles()]; short[] des2src = new short[desBook.getNumCellStyles() + srcBook.getNumCellStyles()]; for(short i=0;i = this.des2srcIndexMapping.length) { throw new ExcelException("索引越界:源文件styleNum=" + this.des2srcIndexMapping.length + " 访问位置=" + desIndex); } return this.des2srcIndexMapping[desIndex]; } /** * 根据源文件的style的index,获取目标文件的style的index * @param srcIndex 源excel中style的index * @return desIndex 目标excel中style的index */ public short desIndex(short srcIndex) { if (srcIndex < 0 || srcIndex >= this.src2desIndexMapping.length) { throw new ExcelException("索引越界:源文件styleNum=" + this.src2desIndexMapping.length + " 访问位置=" + srcIndex); } return this.src2desIndexMapping[srcIndex]; } }} |
一个自定义异常类
public class ExcelException extends RuntimeException { public ExcelException() { } public ExcelException(String message) { super(message); } public ExcelException(String message, Throwable cause) { super(message, cause); } public ExcelException(Throwable cause) { super(cause); } public ExcelException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) { super(message, cause, enableSuppression, writableStackTrace); }}