feat: Supports obtaining current row data object during writing #598 #619
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * 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.apache.fesod.excel.demo.write; | ||
|
|
||
| import lombok.extern.slf4j.Slf4j; | ||
| import org.apache.fesod.excel.util.BooleanUtils; | ||
| import org.apache.fesod.excel.write.handler.CellWriteHandler; | ||
| import org.apache.fesod.excel.write.handler.context.CellWriteHandlerContext; | ||
| import org.apache.poi.ss.usermodel.Cell; | ||
|
|
||
| /** | ||
| * 拦截器中单元格上下文可以获取到行数据 | ||
| */ | ||
| @Slf4j | ||
| public class RecordCellWriteHandler implements CellWriteHandler { | ||
|
|
||
| @Override | ||
| public void afterCellDispose(CellWriteHandlerContext context) { | ||
| Cell cell = context.getCell(); | ||
|
|
||
| if (BooleanUtils.isFalse(context.getHead()) && cell.getColumnIndex() != 0) { | ||
| RecordData record = context.getOriginalRecord(); | ||
| log.info("写入数据：{}", record); | ||
|
||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,63 @@ | ||||||
| /* | ||||||
| * Licensed to the Apache Software Foundation (ASF) under one | ||||||
| * or more contributor license agreements. See the NOTICE file | ||||||
| * distributed with this work for additional information | ||||||
| * regarding copyright ownership. The ASF licenses this file | ||||||
| * to you under the Apache License, Version 2.0 (the | ||||||
| * "License"); you may not use this file except in compliance | ||||||
| * with the License. You may obtain a copy of the License at | ||||||
| * | ||||||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||||||
| * | ||||||
| * 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.apache.fesod.excel.demo.write; | ||||||
|
|
||||||
| import lombok.EqualsAndHashCode; | ||||||
| import lombok.Getter; | ||||||
| import lombok.Setter; | ||||||
| import lombok.ToString; | ||||||
| import org.apache.fesod.excel.annotation.ExcelProperty; | ||||||
|
|
||||||
| import java.util.Date; | ||||||
|
|
||||||
| /** | ||||||
| * Basic data class | ||||||
| * | ||||||
| * | ||||||
| **/ | ||||||
| @Getter | ||||||
| @Setter | ||||||
| @ToString | ||||||
| @EqualsAndHashCode | ||||||
| public class RecordData { | ||||||
| /** | ||||||
| * String Title | ||||||
| */ | ||||||
| @ExcelProperty("String Title") | ||||||
| private String string; | ||||||
|
|
||||||
| /** | ||||||
| * Date Title | ||||||
| */ | ||||||
| @ExcelProperty("Date Title") | ||||||
| private Date date; | ||||||
|
|
||||||
| /** | ||||||
| * Number Title | ||||||
| */ | ||||||
| @ExcelProperty("Number Title") | ||||||
| private Double doubleData; | ||||||
|
|
||||||
| /** | ||||||
| * 通过自定义转换器转换 | ||||||
|
There was a problem hiding this comment. The comment is written in Chinese. For consistency with the rest of the codebase, documentation should be in English.
Suggested change
|
||||||
| */ | ||||||
| @ExcelProperty(converter = RecordStringStringConverter.class) | ||||||
| private String text; | ||||||
| } | ||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,59 @@ | ||||||
| /* | ||||||
| * Licensed to the Apache Software Foundation (ASF) under one | ||||||
| * or more contributor license agreements. See the NOTICE file | ||||||
| * distributed with this work for additional information | ||||||
| * regarding copyright ownership. The ASF licenses this file | ||||||
| * to you under the Apache License, Version 2.0 (the | ||||||
| * "License"); you may not use this file except in compliance | ||||||
| * with the License. You may obtain a copy of the License at | ||||||
| * | ||||||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||||||
| * | ||||||
| * 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.apache.fesod.excel.demo.write; | ||||||
|
|
||||||
| import lombok.extern.slf4j.Slf4j; | ||||||
| import org.apache.fesod.excel.converters.Converter; | ||||||
| import org.apache.fesod.excel.converters.ReadConverterContext; | ||||||
| import org.apache.fesod.excel.converters.WriteConverterContext; | ||||||
| import org.apache.fesod.excel.enums.CellDataTypeEnum; | ||||||
| import org.apache.fesod.excel.metadata.data.WriteCellData; | ||||||
|
|
||||||
| /** | ||||||
| * converter to the original data record | ||||||
| */ | ||||||
| @Slf4j | ||||||
| public class RecordStringStringConverter implements Converter<String> { | ||||||
| @Override | ||||||
| public Class<?> supportJavaTypeKey() { | ||||||
| return String.class; | ||||||
| } | ||||||
|
|
||||||
| @Override | ||||||
| public CellDataTypeEnum supportExcelTypeKey() { | ||||||
| return CellDataTypeEnum.STRING; | ||||||
| } | ||||||
|
|
||||||
| @Override | ||||||
| public String convertToJavaData(ReadConverterContext<?> context) { | ||||||
| return context.getReadCellData().getStringValue(); | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * 这里是写的时候会可以访问到原始数据，你可以进行其他业务处理，然后进行转换 | ||||||
|
There was a problem hiding this comment. The comment is written in Chinese. For consistency with the rest of the codebase, documentation should be in English.
Suggested change
|
||||||
| */ | ||||||
| @Override | ||||||
| public WriteCellData<?> convertToExcelData(WriteConverterContext<String> context) { | ||||||
| // 获取原始数据 | ||||||
| RecordData record = context.getRecord(); | ||||||
| log.info("原始数据：{}", record); | ||||||
| return new WriteCellData<>("自定义：" + context.getValue() + "-" + record.getDoubleData()); | ||||||
| } | ||||||
| } | ||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -19,14 +19,6 @@ | |||||||||||
|
|
||||||||||||
| package org.apache.fesod.excel.demo.write; | ||||||||||||
|
|
||||||||||||
| import org.apache.fesod.excel.ExcelWriter; | ||||||||||||
| import org.apache.fesod.excel.FastExcel; | ||||||||||||
| import org.apache.fesod.excel.annotation.ExcelProperty; | ||||||||||||
|
|
@@ -36,12 +28,7 @@ | |||||||||||
| import org.apache.fesod.excel.annotation.write.style.ContentRowHeight; | ||||||||||||
| import org.apache.fesod.excel.annotation.write.style.HeadRowHeight; | ||||||||||||
| import org.apache.fesod.excel.enums.CellDataTypeEnum; | ||||||||||||
| import org.apache.fesod.excel.metadata.data.*; | ||||||||||||
|
There was a problem hiding this comment. Using wildcard imports reduces code readability and can lead to naming conflicts. Consider using explicit imports instead.
Suggested change
|
||||||||||||
| import org.apache.fesod.excel.util.BooleanUtils; | ||||||||||||
| import org.apache.fesod.excel.util.FileUtils; | ||||||||||||
| import org.apache.fesod.excel.util.ListUtils; | ||||||||||||
|
|
@@ -58,16 +45,16 @@ | |||||||||||
| import org.apache.fesod.excel.write.metadata.style.WriteFont; | ||||||||||||
| import org.apache.fesod.excel.write.style.HorizontalCellStyleStrategy; | ||||||||||||
| import org.apache.fesod.excel.write.style.column.LongestMatchColumnWidthStyleStrategy; | ||||||||||||
| import org.apache.poi.ss.usermodel.*; | ||||||||||||
| import org.apache.poi.ss.util.CellRangeAddress; | ||||||||||||
| import org.apache.poi.xssf.streaming.SXSSFSheet; | ||||||||||||
| import org.junit.jupiter.api.Test; | ||||||||||||
|
|
||||||||||||
| import java.io.File; | ||||||||||||
| import java.io.InputStream; | ||||||||||||
| import java.net.URL; | ||||||||||||
| import java.util.*; | ||||||||||||
|
|
||||||||||||
| /** | ||||||||||||
| * 写的常见写法 | ||||||||||||
| * | ||||||||||||
|
|
@@ -711,6 +698,15 @@ public void customHandlerWrite() { | |||||||||||
| .doWrite(data()); | ||||||||||||
| } | ||||||||||||
|
|
||||||||||||
| @Test | ||||||||||||
| public void recordWrite() { | ||||||||||||
| String fileName = TestFileUtil.getPath() + "recordWrite" + System.currentTimeMillis() + ".xlsx"; | ||||||||||||
| FastExcel.write(fileName, RecordData.class) | ||||||||||||
| .registerWriteHandler(new RecordCellWriteHandler()) | ||||||||||||
| .sheet("模板") | ||||||||||||
| .doWrite(records()); | ||||||||||||
| } | ||||||||||||
|
|
||||||||||||
| /** | ||||||||||||
| * 插入批注 | ||||||||||||
| * <p> | ||||||||||||
|
|
@@ -844,6 +840,19 @@ private List<DemoData> data() { | |||||||||||
| return list; | ||||||||||||
| } | ||||||||||||
|
|
||||||||||||
| private List<RecordData> records() { | ||||||||||||
| List<RecordData> list = ListUtils.newArrayList(); | ||||||||||||
| for (int i = 0; i < 10; i++) { | ||||||||||||
| RecordData data = new RecordData(); | ||||||||||||
| data.setString("STRING" + i); | ||||||||||||
| data.setDate(new Date()); | ||||||||||||
| data.setDoubleData(0.56); | ||||||||||||
| data.setText("record-" + i); | ||||||||||||
| list.add(data); | ||||||||||||
| } | ||||||||||||
| return list; | ||||||||||||
| } | ||||||||||||
|
|
||||||||||||
| private List<DemoData> dataHex() { | ||||||||||||
| List<DemoData> list = ListUtils.newArrayList(); | ||||||||||||
| for (int i = 0; i < 10; i++) { | ||||||||||||
|
|
||||||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -19,7 +19,6 @@ | |||||||||
|
|
||||||||||
| package org.apache.fesod.excel.write.executor; | ||||||||||
|
|
||||||||||
| import org.apache.commons.collections4.CollectionUtils; | ||||||||||
| import org.apache.fesod.excel.context.WriteContext; | ||||||||||
| import org.apache.fesod.excel.converters.Converter; | ||||||||||
|
|
@@ -28,31 +27,17 @@ | |||||||||
| import org.apache.fesod.excel.converters.WriteConverterContext; | ||||||||||
| import org.apache.fesod.excel.enums.CellDataTypeEnum; | ||||||||||
| import org.apache.fesod.excel.exception.ExcelWriteDataConvertException; | ||||||||||
| import org.apache.fesod.excel.metadata.data.*; | ||||||||||
| import org.apache.fesod.excel.metadata.property.ExcelContentProperty; | ||||||||||
| import org.apache.fesod.excel.support.ExcelTypeEnum; | ||||||||||
| import org.apache.fesod.excel.util.*; | ||||||||||
|
There was a problem hiding this comment. Using wildcard imports reduces code readability and can lead to naming conflicts. Consider using explicit imports instead.
Suggested change
|
||||||||||
| import org.apache.fesod.excel.write.handler.context.CellWriteHandlerContext; | ||||||||||
| import org.apache.poi.hssf.usermodel.HSSFClientAnchor; | ||||||||||
| import org.apache.poi.ss.usermodel.*; | ||||||||||
| import org.apache.poi.xssf.usermodel.XSSFClientAnchor; | ||||||||||
|
|
||||||||||
| import java.util.List; | ||||||||||
|
|
||||||||||
| /** | ||||||||||
| * Excel write Executor | ||||||||||
| * | ||||||||||
|
|
@@ -361,7 +346,7 @@ private WriteCellData<?> doConvert(CellWriteHandlerContext cellWriteHandlerConte | |||||||||
| try { | ||||||||||
| cellData = ((Converter<Object>) converter) | ||||||||||
| .convertToExcelData(new WriteConverterContext<>( | ||||||||||
| cellWriteHandlerContext.getOriginalValue(), cellWriteHandlerContext.getOriginalRecord(), excelContentProperty, writeContext)); | ||||||||||
| } catch (Exception e) { | ||||||||||
| throw new ExcelWriteDataConvertException( | ||||||||||
| cellWriteHandlerContext, | ||||||||||
|
|
||||||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The comment is written in Chinese. For consistency with the rest of the codebase, documentation should be in English.