- 对 excel 的生成 的读取，一直都是一个很花时间的问题，现对excel的生成和读取，封装成一个工具，将加快excel 在 java中的处理。
- Excel 是对 poi 的封装，建立一个通用的excel模板，再通过 set,add,create等简单的操作方法生成 excel。同时也能指定起始度坐标，对标准的 Excel进行读取。
- 最新版本只发布在 github 的私库
<dependency>
<groupId>com.wkclz.util</groupId>
<artifactId>excel</artifactId>
<version>${latest}</version>
</dependency>
<repositories>
<repository>
<id>github-mvn</id>
<url>https://github.com/wkclz/mvn-repository/raw/master</url>
</repository>
</repositories>
- 稳定版本发布中央仓库
<dependency>
<groupId>com.wkclz.util</groupId>
<artifactId>excel</artifactId>
<version>${stable}</version>
</dependency>
- JDK 1.8
- poi-4.0.1.jar
- poi-ooxml-4.0.1.jar
- poi-ooxml-schemas-4.0.1.jar
- xmlbeans-3.0.2.jar
- commons-collections4-4.2.jar
- 以上依赖已经在 pom.xml 中描述，只支持 poi3.15及以上版本
对象化操作
- 通过 new Excel() 创建excel对象
- 通过set 方法设置文档基本信息。
- 提供以下set方法：
- setTitle(String title)
- setCreateBy(String createBy)
- setCreateBy(Object createBy)【会将object转换为String】
- setDateFrom(String dateFrom) [null]
- setDateTo(String dateTo) [null]
- setSavePath(String savePath) [null]
- setHeader(List header)
- setHeader(String[] header)
- setWidth(Integer width)【在有设置 header的时候，会自动取其长度，不需要header的需要设置 width】
- setCacheRowsInMemory(Integer rows) [10240] 【设置内存缓存的数据行数。内存小的服务器请调小。如果不理解，请不要设置。】
- setParams:
- titleOff [default null] 是否关闭 title 显示
- createInfoOff [default dull] 是否关闭创建信息显示，创建时间和创建人
- 提供的get方法：
- 以上的set方法均有对应的无参get方法。
- add方法：
- addRow(ExcelRow row) 添加行对象【protected】【保护的方法。createXlsx过程会自动添加】
- addRowFromCache(ExcelRow row) 【将缓存对象加入到excel。会将上一个createRow得到的对象立即添加到excel】
- addNewSheet() 添加一个 Sheet。默认的 Sheet 不需要手动添加。【注意，Sheet 分离时，不能有row合并，否则排版会异常】
- 提供的create方法：
- createRow() 创建行对象【创建row对象，创建前会将上一个行对象添加到excel】
- createRowBeforeHeader() 创建行对象【创建在 header 之前的 row】
- createRowInCache()创建行对象【不直接添加到excel中，需要调用addRowFromCache(ExcelRow row) 对会被加入到excel】
- CreateXlsx() 创建最终的excel，无返回.
- CreateXlsxByFile() 创建最终的excel在临时目录，并返回 File.
- 通过 createRow方法创建了行对象row后，可以对行对象进行操作。
addCell(Object cellContent, boolean border, short align, int col, int row) cellContent：cell 文本内容。必需，将自动设置 cell 宽度。超过一定长度后自动定义为富文本框
border：cell的边框，默认为true。边框大小不提供自定义
align：对齐方式，需要从 ExcelUtil里面取static值。仅提货左，中两种常用取值
col：合并行，需要与row结合使用。
row：合并列，需要与col结合使用。
col和row需成对出现或不设置。默认为1。当有行合并时，将不自动设置行宽。 \
java.lang.Integer. java.lang.String【默认类型】 java.util.Date【年月日时分秒】 java.sql.Date【年月日】 java.lang.Double【默认保留两位小数】 按上述类型传入的值，将会自动设置到cell中，其他类型的值通不过上述类型判断，将用默认类型处理。
了解了excel的写入操作，将更便于此工具的使用。
- 对 excel对象得到的参数进行验证，如果有错误，将返回错误结果。
- 使用 header 的长度，或者 width 的值，进行标题的合并和设置。
- 写入文档创建时间。如果创建人有设置，加入创建人。
- 如果时间范围存在，设置时间范围。
- 如果存在 header，写入excel的列名
- 依次对行和进行循环。
- 如果有行列合并，对所在区域进行合并，并设置空字符串值。如果已经有值，说明已经被合并，找到下一个空值的cell
- 对cell的内容进行类型判断。不同的类型，将给不同的样式。
- 将内容写入到cell
- 内容完全写入到cell后，将excel通过文件流的方式写入到磁盘。完成 excel生成
public class ExcelHelper {
private static final Logger log = LoggerFactory.getLogger(ExcelHelper.class);
public static void excelStreamResopnse(HttpServletResponse response, Excel excel) {
OutputStream fops = null;
InputStream in = null;
int len = 0;
byte[] bytes = new byte[1024];
try {
File file = excel.createXlsxByFile();
String fileName = file.getName();
String suffix = fileName.substring(fileName.lastIndexOf(".") + 1);
log.info("the excel file is in {}", file.getPath());
in = new FileInputStream(file);
response.setContentType("application/x-excel");
response.setCharacterEncoding("UTF-8");
response.setHeader("Content-Disposition", "attachment; filename=" + new String(excel.getTitle().getBytes("utf-8"), "ISO8859-1") + "." + suffix);
response.setHeader("Content-Length", String.valueOf(file.length()));
fops = response.getOutputStream();
while ((len = in.read(bytes)) != -1) {
fops.write(bytes, 0, len);
}
fops.flush();
response.flushBuffer();
response.getOutputStream().flush();
response.getOutputStream().close();
} catch (Exception e) {
e.printStackTrace();
log.error("文件有误!");
} finally {
try {
if (fops != null) {
fops.close();
}
if (in != null) {
in.close();
}
} catch (IOException e) {
e.printStackTrace();
}
}
}
}
- new ExcelRd()提供以下方法进行实例化
- new ExcelRd(String xlsxPath)
- new ExcelRd(File file)
- new ExcelRd(InputStream ins, ExcelRdVersionEnum version)
- new ExcelRd(FileInputStream fins, ExcelRdVersionEnum version)
- new ExcelRdSheet()新增一个 sheet 识别配置
- setStartRow(int rowNum)
- setStartCol(int colNum)
- setTypes(ExcelRdTypeEnum[] types) excelRd.addSheets(sheet)
- 最后通过 analysis() 方法，得到所有行数据。
@RestController
public class ExcelHelper {
@PostMapping("/excel/inport")
public Result excelRd(@RequestParam("file") MultipartFile file) throws IOException {
Result result = new Result();
if (file.isEmpty()) {
return result.setError("the file is empty");
}
ExcelRd excelRd = new ExcelRd(file.getInputStream(), ExcelRdVersionEnum.XLSX);
// 后续过程请参照 ExcelRdTest
return null;
}
}最后，此工具类共享出来给大家使用，希望大家能够帮助一起完善，通过开源的方式互助。发现有什么bug，或者有什么想法欢迎 PR.
2019-05-12 23:56:30
- Excel 识别支持多 sheet
- Excel 生成，添加日志打印
- Excel 生成，header 上可加 rows
2019-02-21 23:22:16
- Excel 读取返回二维数组
- 升级 poi 版本 至 4.0.1
2019-02-15 06:41:17
- 引入lombpk
- 添加 params控制参数
- 标题可选关闭显示
- 创建时间，创建人 可选关闭显示
- 文字靠右
2019-02-12 01:47:35
- 使用gitee 发布jar 包
- 修正空白 header 时的判断错误
2018-07-31 18:4:20
- Excel 读取，支持（类似）手机的长型识别
2018-06-12 11:44:12
- Excel 读取，支持文件流方式，适应文件上传直接读取的应用场景
2018-04-02 00:45:15
- 标准化代码
- 优化Excel生成过程中的内存占用
- 多 Sheet 支持
2018-01-26 11:41:22
- 还原旧方法，对旧版本的兼容
- 减小生成 excel生成时内存缓存的量，减小服务器压力。同时此参数支持设置。
2017-12-09 10:15:52
- Excel 生成去除结果返回，换成 throws 的方式抛出错误。
- 将 excel 生成过程独立，加入方法 CreateXlsxByFile()，写入到临时目录，返回File
- 结构优化
2017-11-15 22:58:33
- Excel读取工具 ExcelRd 定义枚举类型ExcelRdTypeEnum：INTEGER("整形"),DOUBLE("双精浮点型"),DATE("日期型"),DATETIME("日期时间型"),STRING("字符型");读取时需要初始化字段类型。