From fe74f26f6f037fc42fa04570a9a24079f3efde35 Mon Sep 17 00:00:00 2001 From: Looly Date: Sat, 21 Dec 2024 13:09:03 +0800 Subject: [PATCH] =?UTF-8?q?=E6=B7=BB=E5=8A=A0StopReadException=EF=BC=8C?= =?UTF-8?q?=E5=AE=9A=E4=B9=89sax=E8=AF=BB=E5=8F=96=E6=97=B6=E7=94=A8?= =?UTF-8?q?=E6=88=B7=E5=8F=AF=E6=89=8B=E5=8A=A8=E7=BB=88=E6=AD=A2=EF=BC=88?= =?UTF-8?q?issue#3820@Github=EF=BC=89?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CHANGELOG.md | 1 + .../poi/excel/sax/Excel03SaxReader.java | 2 ++ .../cn/hutool/poi/excel/sax/ExcelSaxUtil.java | 8 +++-- .../poi/excel/sax/StopReadException.java | 33 +++++++++++++++++++ .../cn/hutool/poi/excel/ExcelSaxReadTest.java | 19 +++++++++++ 5 files changed, 60 insertions(+), 3 deletions(-) create mode 100644 hutool-poi/src/main/java/cn/hutool/poi/excel/sax/StopReadException.java diff --git a/CHANGELOG.md b/CHANGELOG.md index f48002790..bccaa41f9 100755 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,6 +12,7 @@ * 【core 】 DateUtil.parseUTC方法标记废弃，改名为parseISO8601（issue#IBB6I5@Gitee） * 【core 】 添加EnumUtil#getBy(Class, Func1, Object)方法（pr#1283@Gitee） * 【db 】 添加Entity.addCondition方法（issue#IBCDL2@Gitee） +* 【poi 】 添加StopReadException，定义sax读取时用户可手动终止（issue#3820@Github） ### 🐞Bug修复 * 【crypto 】 修复JWTSignerUtil.createSigner中algorithmId未转换问题（issue#3806@Github） diff --git a/hutool-poi/src/main/java/cn/hutool/poi/excel/sax/Excel03SaxReader.java b/hutool-poi/src/main/java/cn/hutool/poi/excel/sax/Excel03SaxReader.java index a24882c9d..72c10ee7e 100644 --- a/hutool-poi/src/main/java/cn/hutool/poi/excel/sax/Excel03SaxReader.java +++ b/hutool-poi/src/main/java/cn/hutool/poi/excel/sax/Excel03SaxReader.java @@ -147,6 +147,8 @@ public class Excel03SaxReader implements HSSFListener, ExcelSaxReader createSaxReader(boolean isXlsx, RowHandler rowHandler) { return isXlsx - ? new Excel07SaxReader(rowHandler) - : new Excel03SaxReader(rowHandler); + ? new Excel07SaxReader(rowHandler) + : new Excel03SaxReader(rowHandler); } /** @@ -184,6 +184,8 @@ public class ExcelSaxUtil { throw new IORuntimeException(e); } catch (SAXException e) { throw new POIException(e); + } catch (final StopReadException e) { + // issue#3820 跳过，用户抛出此异常，表示强制结束读取 } } @@ -268,7 +270,7 @@ public class ExcelSaxUtil { // issue#IB0EJ9 可能精度丢失，对含有小数的value判断并转为BigDecimal final double number = Double.parseDouble(value); - if(StrUtil.contains(value, CharUtil.DOT) && !value.equals(Double.toString(number))){ + if (StrUtil.contains(value, CharUtil.DOT) && !value.equals(Double.toString(number))) { // 精度丢失 return NumberUtil.toBigDecimal(value); } diff --git a/hutool-poi/src/main/java/cn/hutool/poi/excel/sax/StopReadException.java b/hutool-poi/src/main/java/cn/hutool/poi/excel/sax/StopReadException.java new file mode 100644 index 000000000..22d56c4b9 --- /dev/null +++ b/hutool-poi/src/main/java/cn/hutool/poi/excel/sax/StopReadException.java @@ -0,0 +1,33 @@ +package cn.hutool.poi.excel.sax; + +import cn.hutool.poi.exceptions.POIException; + +/** + * 读取结束异常，用于标记读取结束
+ * Sax方式读取时，如果用户在RowHandler中抛出此异常，表示读取结束，此时不再读取其他数据 + * + * @author Looly + * @since 5.8.35 + */ +public class StopReadException extends POIException { + private static final long serialVersionUID = 1L; + + /** + * 构造 + * + */ + public StopReadException() { + this("Stop read by user."); + } + + /** + * 构造 + * + * @param message 消息 + */ + public StopReadException(final String message) { + super(message); + // 去除堆栈 + setStackTrace(new StackTraceElement[0]); + } +} diff --git a/hutool-poi/src/test/java/cn/hutool/poi/excel/ExcelSaxReadTest.java b/hutool-poi/src/test/java/cn/hutool/poi/excel/ExcelSaxReadTest.java index b54379de2..2f52c1a0e 100644 --- a/hutool-poi/src/test/java/cn/hutool/poi/excel/ExcelSaxReadTest.java +++ b/hutool-poi/src/test/java/cn/hutool/poi/excel/ExcelSaxReadTest.java @@ -8,6 +8,7 @@ import cn.hutool.core.lang.Console; import cn.hutool.core.util.StrUtil; import cn.hutool.poi.excel.cell.FormulaCellValue; import cn.hutool.poi.excel.sax.Excel03SaxReader; +import cn.hutool.poi.excel.sax.StopReadException; import cn.hutool.poi.excel.sax.handler.RowHandler; import cn.hutool.poi.exceptions.POIException; import org.apache.poi.ss.usermodel.CellStyle; @@ -33,6 +34,24 @@ public class ExcelSaxReadTest { ExcelUtil.readBySax("aaa.xlsx", 0, createRowHandler()); } + @Test + void readEndByExceptionTest(){ + ExcelUtil.readBySax("aaa.xlsx", 0, (sheetIndex, rowIndex, rowList) -> { + if (rowIndex == 1) { + throw new StopReadException(); + } + }); + } + + @Test + void readEndByException03Test(){ + ExcelUtil.readBySax("aaa.xls", 0, (sheetIndex, rowIndex, rowList) -> { + if (rowIndex == 1) { + throw new StopReadException(); + } + }); + } + @Test public void excel07ByNameTest() { // 工具化快速读取