mirror of
https://gitee.com/smallc/blade-tool.git
synced 2026-07-10 18:39:44 +08:00
🎉 新增excel封装，将easyexcel切换为fastexcel
This commit is contained in:
smallchill
parent
5e93ae11b5
commit
a40f354f33
47
blade-starter-excel/pom.xml
Normal file
47
blade-starter-excel/pom.xml
Normal file
|
|
@ -0,0 +1,47 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project xmlns="http://maven.apache.org/POM/4.0.0"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
<parent>
|
||||
<groupId>org.springblade</groupId>
|
||||
<artifactId>blade-tool</artifactId>
|
||||
<version>${revision}</version>
|
||||
</parent>
|
||||
|
||||
<artifactId>blade-starter-excel</artifactId>
|
||||
<name>${project.artifactId}</name>
|
||||
<packaging>jar</packaging>
|
||||
|
||||
<properties>
|
||||
<module.name>org.springblade.blade.starter.excel</module.name>
|
||||
</properties>
|
||||
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>org.springblade</groupId>
|
||||
<artifactId>blade-core-launch</artifactId>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>cn.idev.excel</groupId>
|
||||
<artifactId>fastexcel</artifactId>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.apache.poi</groupId>
|
||||
<artifactId>poi</artifactId>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.apache.poi</groupId>
|
||||
<artifactId>poi-ooxml</artifactId>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.apache.poi</groupId>
|
||||
<artifactId>poi-scratchpad</artifactId>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.apache.poi</groupId>
|
||||
<artifactId>ooxml-schemas</artifactId>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
|
||||
</project>
|
||||
|
|
@ -0,0 +1,50 @@
|
|||
/**
|
||||
* Copyright (c) 2018-2099, Chill Zhuang 庄骞 (bladejava@qq.com).
|
||||
* <p>
|
||||
* Licensed under the GNU LESSER GENERAL PUBLIC LICENSE 3.0;
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
* <p>
|
||||
* http://www.gnu.org/licenses/lgpl.html
|
||||
* <p>
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package org.springblade.core.excel.listener;
|
||||
|
||||
import cn.idev.excel.context.AnalysisContext;
|
||||
import cn.idev.excel.event.AnalysisEventListener;
|
||||
import lombok.EqualsAndHashCode;
|
||||
import lombok.Getter;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
|
||||
/**
|
||||
* Excel监听器
|
||||
*
|
||||
* @author Chill
|
||||
*/
|
||||
@Getter
|
||||
@EqualsAndHashCode(callSuper = true)
|
||||
public class DataListener<T> extends AnalysisEventListener<T> {
|
||||
|
||||
/**
|
||||
* 缓存的数据列表
|
||||
*/
|
||||
private final List<T> dataList = new ArrayList<>();
|
||||
|
||||
@Override
|
||||
public void invoke(T data, AnalysisContext analysisContext) {
|
||||
dataList.add(data);
|
||||
}
|
||||
|
||||
@Override
|
||||
public void doAfterAllAnalysed(AnalysisContext analysisContext) {
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,71 @@
|
|||
/**
|
||||
* Copyright (c) 2018-2099, Chill Zhuang 庄骞 (bladejava@qq.com).
|
||||
* <p>
|
||||
* Licensed under the GNU LESSER GENERAL PUBLIC LICENSE 3.0;
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
* <p>
|
||||
* http://www.gnu.org/licenses/lgpl.html
|
||||
* <p>
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package org.springblade.core.excel.listener;
|
||||
|
||||
import cn.idev.excel.context.AnalysisContext;
|
||||
import cn.idev.excel.event.AnalysisEventListener;
|
||||
import lombok.Data;
|
||||
import lombok.EqualsAndHashCode;
|
||||
import lombok.RequiredArgsConstructor;
|
||||
import org.springblade.core.excel.support.ExcelImporter;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
|
||||
/**
|
||||
* Excel监听器
|
||||
*
|
||||
* @author Chill
|
||||
*/
|
||||
@Data
|
||||
@RequiredArgsConstructor
|
||||
@EqualsAndHashCode(callSuper = true)
|
||||
public class ImportListener<T> extends AnalysisEventListener<T> {
|
||||
|
||||
/**
|
||||
* 默认每隔3000条存储数据库
|
||||
*/
|
||||
private int batchCount = 3000;
|
||||
/**
|
||||
* 缓存的数据列表
|
||||
*/
|
||||
private List<T> list = new ArrayList<>();
|
||||
/**
|
||||
* 数据导入类
|
||||
*/
|
||||
private final ExcelImporter<T> importer;
|
||||
|
||||
@Override
|
||||
public void invoke(T data, AnalysisContext analysisContext) {
|
||||
list.add(data);
|
||||
// 达到BATCH_COUNT，则调用importer方法入库，防止数据几万条数据在内存，容易OOM
|
||||
if (list.size() >= batchCount) {
|
||||
// 调用importer方法
|
||||
importer.save(list);
|
||||
// 存储完成清理list
|
||||
list.clear();
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public void doAfterAllAnalysed(AnalysisContext analysisContext) {
|
||||
// 调用importer方法
|
||||
importer.save(list);
|
||||
// 存储完成清理list
|
||||
list.clear();
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,36 @@
|
|||
/**
|
||||
* Copyright (c) 2018-2099, Chill Zhuang 庄骞 (bladejava@qq.com).
|
||||
* <p>
|
||||
* Licensed under the GNU LESSER GENERAL PUBLIC LICENSE 3.0;
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
* <p>
|
||||
* http://www.gnu.org/licenses/lgpl.html
|
||||
* <p>
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package org.springblade.core.excel.support;
|
||||
|
||||
import java.io.Serial;
|
||||
|
||||
/**
|
||||
* Excel异常处理类
|
||||
*
|
||||
* @author Chill
|
||||
*/
|
||||
public class ExcelException extends RuntimeException {
|
||||
@Serial
|
||||
private static final long serialVersionUID = 1L;
|
||||
|
||||
/**
|
||||
* 默认构造函数
|
||||
* @param message 异常信息
|
||||
*/
|
||||
public ExcelException(String message) {
|
||||
super(message);
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,34 @@
|
|||
/**
|
||||
* Copyright (c) 2018-2099, Chill Zhuang 庄骞 (bladejava@qq.com).
|
||||
* <p>
|
||||
* Licensed under the GNU LESSER GENERAL PUBLIC LICENSE 3.0;
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
* <p>
|
||||
* http://www.gnu.org/licenses/lgpl.html
|
||||
* <p>
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package org.springblade.core.excel.support;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
/**
|
||||
* Excel统一导入接口
|
||||
*
|
||||
* @author Chill
|
||||
*/
|
||||
public interface ExcelImporter<T> {
|
||||
|
||||
/**
|
||||
* 导入数据逻辑
|
||||
*
|
||||
* @param data 数据集合
|
||||
*/
|
||||
void save(List<T> data);
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,199 @@
|
|||
/**
|
||||
* Copyright (c) 2018-2099, Chill Zhuang 庄骞 (bladejava@qq.com).
|
||||
* <p>
|
||||
* Licensed under the GNU LESSER GENERAL PUBLIC LICENSE 3.0;
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
* <p>
|
||||
* http://www.gnu.org/licenses/lgpl.html
|
||||
* <p>
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package org.springblade.core.excel.util;
|
||||
|
||||
|
||||
import cn.idev.excel.FastExcel;
|
||||
import cn.idev.excel.read.builder.ExcelReaderBuilder;
|
||||
import cn.idev.excel.read.listener.ReadListener;
|
||||
import cn.idev.excel.util.DateUtils;
|
||||
import cn.idev.excel.write.builder.ExcelWriterBuilder;
|
||||
import cn.idev.excel.write.handler.WriteHandler;
|
||||
import jakarta.servlet.http.HttpServletResponse;
|
||||
import lombok.SneakyThrows;
|
||||
import org.springblade.core.excel.listener.DataListener;
|
||||
import org.springblade.core.excel.listener.ImportListener;
|
||||
import org.springblade.core.excel.support.ExcelException;
|
||||
import org.springblade.core.excel.support.ExcelImporter;
|
||||
import org.springframework.util.StringUtils;
|
||||
import org.springframework.web.multipart.MultipartFile;
|
||||
|
||||
import java.io.BufferedInputStream;
|
||||
import java.io.IOException;
|
||||
import java.io.InputStream;
|
||||
import java.net.URLEncoder;
|
||||
import java.nio.charset.StandardCharsets;
|
||||
import java.util.Date;
|
||||
import java.util.List;
|
||||
|
||||
/**
|
||||
* Excel 工具类
|
||||
*
|
||||
* @author Chill
|
||||
*/
|
||||
public class ExcelUtil {
|
||||
|
||||
/**
|
||||
* 读取 Excel 的所有 sheet 数据。
|
||||
*
|
||||
* @param <T> 数据模型类型
|
||||
* @param excel Excel 文件
|
||||
* @param clazz 实体类 `Class` 对象
|
||||
* @return 读取到的数据列表
|
||||
*/
|
||||
public static <T> List<T> read(MultipartFile excel, Class<T> clazz) {
|
||||
DataListener<T> dataListener = new DataListener<>();
|
||||
ExcelReaderBuilder builder = getReaderBuilder(excel, dataListener, clazz);
|
||||
if (builder == null) {
|
||||
return null;
|
||||
}
|
||||
builder.doReadAll();
|
||||
return dataListener.getDataList();
|
||||
}
|
||||
|
||||
/**
|
||||
* 读取 Excel 指定 sheet 的数据。
|
||||
*
|
||||
* @param <T> 数据模型类型
|
||||
* @param excel Excel 文件
|
||||
* @param sheetNo sheet 序号（从 0 开始）
|
||||
* @param clazz 实体类 `Class` 对象
|
||||
* @return 读取到的数据列表
|
||||
*/
|
||||
public static <T> List<T> read(MultipartFile excel, int sheetNo, Class<T> clazz) {
|
||||
return read(excel, sheetNo, 1, clazz);
|
||||
}
|
||||
|
||||
/**
|
||||
* 读取 Excel 指定 sheet 的数据。
|
||||
*
|
||||
* @param <T> 数据模型类型
|
||||
* @param excel Excel 文件
|
||||
* @param sheetNo sheet 序号（从 0 开始）
|
||||
* @param headRowNumber 表头占用的行数
|
||||
* @param clazz 实体类 `Class` 对象
|
||||
* @return 读取到的数据列表
|
||||
*/
|
||||
public static <T> List<T> read(MultipartFile excel, int sheetNo, int headRowNumber, Class<T> clazz) {
|
||||
DataListener<T> dataListener = new DataListener<>();
|
||||
ExcelReaderBuilder builder = getReaderBuilder(excel, dataListener, clazz);
|
||||
if (builder == null) {
|
||||
return null;
|
||||
}
|
||||
builder.sheet(sheetNo).headRowNumber(headRowNumber).doRead();
|
||||
return dataListener.getDataList();
|
||||
}
|
||||
|
||||
/**
|
||||
* 读取数据并使用指定的导入器进行数据导入。
|
||||
*
|
||||
* @param <T> 数据模型类型
|
||||
* @param excel Excel 文件
|
||||
* @param importer 导入逻辑处理器
|
||||
* @param clazz 实体类 `Class` 对象
|
||||
*/
|
||||
public static <T> void save(MultipartFile excel, ExcelImporter<T> importer, Class<T> clazz) {
|
||||
ImportListener<T> importListener = new ImportListener<>(importer);
|
||||
ExcelReaderBuilder builder = getReaderBuilder(excel, importListener, clazz);
|
||||
if (builder != null) {
|
||||
builder.doReadAll();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 导出 Excel。
|
||||
* <p>
|
||||
* 默认使用当前时间戳作为文件名，"导出数据" 作为 sheet 名。
|
||||
*
|
||||
* @param <T> 数据模型类型
|
||||
* @param response `HttpServletResponse` 对象
|
||||
* @param dataList 要导出的数据列表
|
||||
* @param clazz 实体类 `Class` 对象
|
||||
*/
|
||||
@SneakyThrows
|
||||
public static <T> void export(HttpServletResponse response, List<T> dataList, Class<T> clazz) {
|
||||
export(response, DateUtils.format(new Date(), DateUtils.DATE_FORMAT_14), "导出数据", dataList, clazz);
|
||||
}
|
||||
|
||||
/**
|
||||
* 导出 Excel。
|
||||
*
|
||||
* @param <T> 数据模型类型
|
||||
* @param response `HttpServletResponse` 对象
|
||||
* @param fileName 文件名（不含扩展名）
|
||||
* @param sheetName sheet 名称
|
||||
* @param dataList 要导出的数据列表
|
||||
* @param clazz 实体类 `Class` 对象
|
||||
*/
|
||||
@SneakyThrows
|
||||
public static <T> void export(HttpServletResponse response, String fileName, String sheetName, List<T> dataList, Class<T> clazz) {
|
||||
export(response, fileName, sheetName, dataList, null, clazz);
|
||||
}
|
||||
|
||||
/**
|
||||
* 导出 Excel。
|
||||
*
|
||||
* @param <T> 数据模型类型
|
||||
* @param response `HttpServletResponse` 对象
|
||||
* @param fileName 文件名（不含扩展名）
|
||||
* @param sheetName sheet 名称
|
||||
* @param dataList 要导出的数据列表
|
||||
* @param writeHandler 自定义 `WriteHandler` 处理器
|
||||
* @param clazz 实体类 `Class` 对象
|
||||
*/
|
||||
@SneakyThrows
|
||||
public static <T> void export(HttpServletResponse response, String fileName, String sheetName, List<T> dataList, WriteHandler writeHandler, Class<T> clazz) {
|
||||
response.setContentType("application/vnd.ms-excel");
|
||||
response.setCharacterEncoding(StandardCharsets.UTF_8.name());
|
||||
fileName = URLEncoder.encode(fileName, StandardCharsets.UTF_8);
|
||||
response.setHeader("Content-disposition", "attachment;filename=" + fileName + ".xlsx");
|
||||
|
||||
ExcelWriterBuilder write = FastExcel.write(response.getOutputStream(), clazz);
|
||||
if (writeHandler != null) {
|
||||
write.registerWriteHandler(writeHandler);
|
||||
}
|
||||
write.sheet(sheetName).doWrite(dataList);
|
||||
}
|
||||
|
||||
/**
|
||||
* 获取 Excel 读取构建器 `ExcelReaderBuilder`。
|
||||
*
|
||||
* @param <T> 数据模型类型
|
||||
* @param excel Excel 文件
|
||||
* @param readListener Excel 读取监听器
|
||||
* @param clazz 实体类 `Class` 对象
|
||||
* @return `ExcelReaderBuilder` 构建器实例，若发生 `IOException` 则返回 `null`
|
||||
* @throws ExcelException 如果文件为空或文件类型不正确
|
||||
*/
|
||||
public static <T> ExcelReaderBuilder getReaderBuilder(MultipartFile excel, ReadListener<T> readListener, Class<T> clazz) {
|
||||
String filename = excel.getOriginalFilename();
|
||||
if (!StringUtils.hasText(filename)) {
|
||||
throw new ExcelException("请上传文件!");
|
||||
}
|
||||
if ((!StringUtils.endsWithIgnoreCase(filename, ".xls") && !StringUtils.endsWithIgnoreCase(filename, ".xlsx"))) {
|
||||
throw new ExcelException("请上传正确的excel文件!");
|
||||
}
|
||||
InputStream inputStream;
|
||||
try {
|
||||
inputStream = new BufferedInputStream(excel.getInputStream());
|
||||
return FastExcel.read(inputStream, clazz, readListener);
|
||||
} catch (IOException e) {
|
||||
e.printStackTrace();
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
}
|
||||
20
pom.xml
20
pom.xml
|
|
@ -71,6 +71,7 @@
|
|||
<alibaba.nacos.version>3.0.1</alibaba.nacos.version>
|
||||
<fastexcel.version>1.2.0</fastexcel.version>
|
||||
<poi.version>5.4.1</poi.version>
|
||||
<poi.ooxl.version>1.4</poi.ooxl.version>
|
||||
</properties>
|
||||
|
||||
<modules>
|
||||
|
|
@ -84,6 +85,7 @@
|
|||
<module>blade-starter-api-crypto</module>
|
||||
<module>blade-starter-datascope</module>
|
||||
<module>blade-starter-develop</module>
|
||||
<module>blade-starter-excel</module>
|
||||
<module>blade-starter-loadbalancer</module>
|
||||
<module>blade-starter-log</module>
|
||||
<module>blade-starter-mybatis</module>
|
||||
|
|
@ -166,6 +168,11 @@
|
|||
<artifactId>blade-starter-develop</artifactId>
|
||||
<version>${revision}</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springblade</groupId>
|
||||
<artifactId>blade-starter-excel</artifactId>
|
||||
<version>${revision}</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springblade</groupId>
|
||||
<artifactId>blade-core-secure</artifactId>
|
||||
|
|
@ -433,12 +440,6 @@
|
|||
<artifactId>easy-captcha</artifactId>
|
||||
<version>1.6.2</version>
|
||||
</dependency>
|
||||
<!-- easyexcel -->
|
||||
<dependency>
|
||||
<groupId>com.alibaba</groupId>
|
||||
<artifactId>easyexcel</artifactId>
|
||||
<version>4.0.3</version>
|
||||
</dependency>
|
||||
<!-- fastexcel -->
|
||||
<dependency>
|
||||
<groupId>cn.idev.excel</groupId>
|
||||
|
|
@ -465,6 +466,11 @@
|
|||
<artifactId>poi-scratchpad</artifactId>
|
||||
<version>${poi.version}</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.apache.poi</groupId>
|
||||
<artifactId>ooxml-schemas</artifactId>
|
||||
<version>${poi.ooxl.version}</version>
|
||||
</dependency>
|
||||
<!-- sm2 -->
|
||||
<dependency>
|
||||
<groupId>org.bouncycastle</groupId>
|
||||
|
|
@ -687,6 +693,8 @@
|
|||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-javadoc-plugin</artifactId>
|
||||
<version>3.11.2</version>
|
||||
<!-- 若模块化编译报错可切换此版本 -->
|
||||
<!--<version>2.10.1</version>-->
|
||||
<executions>
|
||||
<execution>
|
||||
<phase>package</phase>
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user