使用EasyExcel动态合并单元格和对指定列添加超链接

Excel数据处理与美化:合并单元格与添加超链接示例
本文介绍了如何使用EasyExcel API实现动态单元格合并和超链接功能。处理器分别针对特定列进行操作,适用于标题行后的数据处理。

处理器一定要实现CellWriteHandler接口
动态合并单元格的处理器:

import com.alibaba.excel.metadata.Head;
import com.alibaba.excel.metadata.data.WriteCellData;
import com.alibaba.excel.write.handler.CellWriteHandler;
import com.alibaba.excel.write.metadata.holder.WriteSheetHolder;
import com.alibaba.excel.write.metadata.holder.WriteTableHolder;
import org.apache.poi.ss.usermodel.Cell;
import org.apache.poi.ss.usermodel.CellType;
import org.apache.poi.ss.usermodel.Row;
import org.apache.poi.ss.usermodel.Sheet;
import org.apache.poi.ss.util.CellRangeAddress;

import java.util.List;

//动态合并单元格
public class ExcelFillCellMergeHandler implements CellWriteHandler{

    /**
     * 合并字段的下标
     */
    private int[] mergeColumnIndex;
    /**
     * 从第几行开始合并,0代表标题行
     */
    private int mergeRowIndex;

    public ExcelFillCellMergeHandler() {
    }

    public ExcelFillCellMergeHandler(int mergeRowIndex, int[] mergeColumnIndex) {
        this.mergeRowIndex = mergeRowIndex;
        this.mergeColumnIndex = mergeColumnIndex;
    }

    @Override
    public void beforeCellCreate(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, Row row,
                                 Head head, Integer integer, Integer integer1, Boolean aBoolean) {

    }

    @Override
    public void afterCellCreate(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, Cell cell,
                                Head head, Integer integer, Boolean aBoolean) {

    }

    @Override
    public void afterCellDataConverted(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, WriteCellData<?> cellData, Cell cell, Head head, Integer relativeRowIndex, Boolean isHead) {

    }

    @Override
    public void afterCellDispose(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, List<WriteCellData<?>> cellDataList, Cell cell, Head head, Integer relativeRowIndex, Boolean isHead) {
        // 当前行
        int curRowIndex = cell.getRowIndex();
        // 当前列
        int curColIndex = cell.getColumnIndex();
        // 判断当前行是否大于等于指定的开始行
        if (curRowIndex >= mergeRowIndex) {
            for (int i = 0; i < mergeColumnIndex.length; i++) {
                // 判断当前列是否等于指定的列
                if (curColIndex == mergeColumnIndex[i]) {
                    mergeWithPrevRow(writeSheetHolder, cell, curRowIndex, curColIndex);
                    break;
                }
            }
        }
    }

    // curRowIndex 当前行 curColIndex当前列
    private void mergeWithPrevRow(WriteSheetHolder writeSheetHolder, Cell cell, int curRowIndex, int curColIndex) {

        //获取当前行的第一列的数据和上一行的第一列的数据,比较上一行数据是否相同进行合并
        Cell curFirstCell = cell.getSheet().getRow(curRowIndex).getCell(0);
        Cell preFirstCell = cell.getSheet().getRow(curRowIndex-1).getCell(0);
        Object curId = curFirstCell.getCellType() == CellType.NUMERIC ? curFirstCell.getNumericCellValue() : curFirstCell.getStringCellValue();
        Object perId = preFirstCell.getCellType() == CellType.NUMERIC ? preFirstCell.getNumericCellValue() : preFirstCell.getStringCellValue();
        // 比较当前行的第一列的单元格与上一行是否相同,相同合并当前单元格与上一行
        // 之所以比较第一列,是因为第一列导出的是数据的id,具有唯一性,如果想比较其他单元格只需要指定不同的行和列的位置即可
        if (curId.equals(perId)) {
            Sheet sheet = writeSheetHolder.getSheet();
            List<CellRangeAddress> mergeRegions = sheet.getMergedRegions();
            boolean isMerged = false;
            for (int i = 0; i < mergeRegions.size() && !isMerged; i++) {
                CellRangeAddress cellRangeAddr = mergeRegions.get(i);
                // 若上一个单元格已经被合并,则先移出原有的合并单元,再重新添加合并单元
                if (cellRangeAddr.isInRange(curRowIndex - 1, curColIndex)) {
                    sheet.removeMergedRegion(i);
                    cellRangeAddr.setLastRow(curRowIndex);
                    sheet.addMergedRegion(cellRangeAddr);
                    isMerged = true;
                }
            }
            // 若上一个单元格未被合并,则新增合并单元
            if (!isMerged) {
                CellRangeAddress cellRangeAddress = new CellRangeAddress(curRowIndex - 1, curRowIndex, curColIndex,
                        curColIndex);
                sheet.addMergedRegion(cellRangeAddress);
            }
        }
    }
}

对指定列添加超链接的处理器

import cn.hutool.core.util.StrUtil;
import com.alibaba.excel.metadata.Head;
import com.alibaba.excel.metadata.data.WriteCellData;
import com.alibaba.excel.write.handler.CellWriteHandler;
import com.alibaba.excel.write.metadata.holder.WriteSheetHolder;
import com.alibaba.excel.write.metadata.holder.WriteTableHolder;
import org.apache.poi.common.usermodel.HyperlinkType;
import org.apache.poi.ss.usermodel.*;

import java.util.List;

//动态添加超链接
public class ExcelHyperlinkHandler implements CellWriteHandler {
    /**
     * 添加超链接的字段的下标
     */
    private int[] mergeColumnIndex;
    /**
     * 从第几行开始添加,0代表标题行
     */
    private int mergeRowIndex;

    public ExcelHyperlinkHandler() {
    }

    public ExcelHyperlinkHandler(int mergeRowIndex, int[] mergeColumnIndex) {
        this.mergeRowIndex = mergeRowIndex;
        this.mergeColumnIndex = mergeColumnIndex;
    }

    @Override
    public void beforeCellCreate(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, Row row,
                                 Head head, Integer integer, Integer integer1, Boolean aBoolean) {

    }

    @Override
    public void afterCellCreate(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, Cell cell,
                                Head head, Integer integer, Boolean aBoolean) {

    }

    @Override
    public void afterCellDataConverted(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, WriteCellData<?> cellData, Cell cell, Head head, Integer relativeRowIndex, Boolean isHead) {

    }

    @Override
    public void afterCellDispose(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, List<WriteCellData<?>> cellDataList, Cell cell, Head head, Integer relativeRowIndex, Boolean isHead) {
        //当前行
        int curRowIndex = cell.getRowIndex();
        //当前列
        int curColIndex = cell.getColumnIndex();

        if (curRowIndex >= mergeRowIndex) {
            for (int i = 0; i < mergeColumnIndex.length; i++) {
                if (curColIndex == mergeColumnIndex[i]) {
                    mergeWithPrevRow(writeSheetHolder, cell, curRowIndex, curColIndex);
                    break;
                }
            }
        }
    }

    private void mergeWithPrevRow(WriteSheetHolder writeSheetHolder, Cell cell, int curRowIndex, int curColIndex) {

        //获得超链接,当前单元格的内容就是一个超链接
        String stringCellValue = cell.getCellType()==CellType.STRING ? cell.getStringCellValue():null;
        if (StrUtil.isNotBlank(stringCellValue)) {
            CreationHelper creationHelper = writeSheetHolder.getSheet().getWorkbook().getCreationHelper();
            Hyperlink hyperlink = creationHelper.createHyperlink(HyperlinkType.URL);
            hyperlink.setAddress(stringCellValue);
            cell.setHyperlink(hyperlink);//添加超链接
        }
    }
}

调用方法,使用 registerWriteHandler 指定,然后在 new 处理器的时候,传入指定的行和列即可

EasyExcel.write(response.getOutputStream(), Entity.class)
            .head(Entity.class)
                .registerWriteHandler(new ExcelFillCellMergeHandler(1, new int[]{0,1,2,3,4,5,6,7}))//从第一行开始,对第0到7列的单元格进行判断是否进行合并
                .registerWriteHandler(new ExcelHyperlinkHandler(1, new int[]{8}))//从第一行开始,对第8列的单元格添加超链接
            .excelType(ExcelTypeEnum.XLSX)
            .sheet("文件名")
            .doWrite(list);

<think> 我们参考了用户提供的引用内容,特别是引用[1]引用[3]。 根据引用[1],我们可以使用`registerWriteHandler`方法注册一个处理器,其中`ExcelHyperlinkHandler`就是用来添加超链接的处理器。其使用方式为: .registerWriteHandler(new ExcelHyperlinkHandler(1, new int[]{8})) 这表示从第一行(索引从0开始,这里1表示第二行?注意:这里的行索引参数可能是起始行索引,即从第几行开始处理)开始,对第8列(索引为8,即第9列)的单元添加超链接。 但是,我们注意到引用[1]中的代码示例并没有给出`ExcelHyperlinkHandler`的具体实现,因此我们需要自己实现这个处理器。而引用[3]提到了EasyExcel中创建超链接需要使用`CreationHelper`,这与Apache POI的接口一致。 因此,我们可以推断,我们需要自定义一个`CellWriteHandler`,在单元写入时,对指定列的单元设置超链接。 步骤: 1. 创建一个类实现`com.alibaba.excel.write.handler.CellWriteHandler`接口。 2. 在`afterCellCreate`方法中(或者`afterCellDataConverted`方法,根据需求),我们可以为单元设置超链接。 3. 使用`Hyperlink`对象,并通过`CreationHelper`来创建超链接,然后设置到单元上。 注意:我们需要指定哪些行哪些列需要设置超链接。我们可以通过构造器传入需要处理的列索引数组起始行索引(或者行列的条件)。 下面是一个自定义处理器的示例代码: ```java import com.alibaba.excel.metadata.Head; import com.alibaba.excel.write.handler.CellWriteHandler; import com.alibaba.excel.write.metadata.holder.WriteSheetHolder; import com.alibaba.excel.write.metadata.holder.WriteTableHolder; import org.apache.poi.common.usermodel.HyperlinkType; import org.apache.poi.ss.usermodel.*; import org.apache.poi.xssf.usermodel.XSSFHyperlink; import java.util.List; public class ExcelHyperlinkHandler implements CellWriteHandler { // 起始行索引(从0开始),这里我们假设从第headerRow+1行开始(即数据行)添加超链接 private int startRowIndex; // 需要添加超链接的列索引数组 private int[] columnIndexes; public ExcelHyperlinkHandler(int startRowIndex, int[] columnIndexes) { this.startRowIndex = startRowIndex; this.columnIndexes = columnIndexes; } @Override public void afterCellCreate(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, Cell cell, Head head, Integer relativeRowIndex, Boolean isHead) { // 如果是表头行,则跳过 if (isHead) { return; } // 获取当前行索引(相对于整个sheet的索引) int rowIndex = cell.getRowIndex(); int colIndex = cell.getColumnIndex(); // 如果当前行小于起始行索引,则跳过 if (rowIndex < startRowIndex) { return; } // 判断当前列是否在需要设置的列索引数组中 boolean isTargetColumn = false; for (int col : columnIndexes) { if (col == colIndex) { isTargetColumn = true; break; } } if (!isTargetColumn) { return; } // 获取单元的值,作为超链接的地址(或者可以根据业务规则生成链接) String cellValue = cell.getStringCellValue(); if (cellValue != null && !cellValue.isEmpty()) { // 创建超链接 CreationHelper createHelper = writeSheetHolder.getSheet().getWorkbook().getCreationHelper(); Hyperlink hyperlink = createHelper.createHyperlink(HyperlinkType.URL); hyperlink.setAddress(cellValue); // 这里假设单元的值就是链接地址,也可以根据业务自定义 cell.setHyperlink(hyperlink); // 设置单元样式为超链接样式(蓝色带下划线) CellStyle cellStyle = cell.getSheet().getWorkbook().createCellStyle(); Font font = cell.getSheet().getWorkbook().createFont(); font.setUnderline(Font.U_SINGLE); font.setColor(IndexedColors.BLUE.getIndex()); cellStyle.setFont(font); cell.setCellStyle(cellStyle); } } } ``` 然后,在写入Excel的时候,注册这个处理器: ```java EasyExcel.write("your_path.xlsx", Entity.class) .registerWriteHandler(new ExcelHyperlinkHandler(1, new int[]{8})) // 从第1行(即第二行,索引1)开始,第8列(索引8)设置超链接 .sheet("Sheet1") .doWrite(dataList); ``` 注意: 1. 上述示例中,我们假设单元的值就是超链接的地址。实际业务中,可能超链接地址需要根据其他字段生成,此时可以在处理器中通过行数据(如使用`Cell`的行索引获取整行数据)来构建超链接地址。但是,在`afterCellCreate`方法中,我们只能拿到当前单元的值,无法直接拿到同一行的其他单元值。因此,如果超链接地址依赖于同一行的其他列,我们需要调整实现方式,比如在`afterCellCreate`中通过行索引列索引去获取其他列的值,或者使用`afterRowDispose`方法并在此时设置超链接(但要注意,此时单元可能已经创建了样式,设置超链接可能会覆盖样式)。 2. 另外,上面设置了超链接样式(蓝色下划线),如果不想要样式,可以不设置。 3. 由于EasyExcel的处理器机制,我们也可以考虑在`afterCellDataConverted`方法中处理,但该方法在`afterCellCreate`之后,且主要用于数据转换后,同样可以设置超链接。 4. 如果数据量很大,注意样式创建过多可能导致内存溢出,可以考虑将样式对象提前创建并复用。 5. 上述处理器中,我们只处理了非表头行(`isHead`为false),并且行索引大于等于指定的起始行索引,列索引在指定数组中的单元。 因此,用户可以根据上述示例代码来实现EasyExcel设置单元超链接的功能。 </think> ### EasyExcel 单元设置超链接的方法 在 EasyExcel 中为单元设置超链接,主要通过**自定义单元处理器**实现。以下是详细步骤示例代码: #### 核心实现步骤 1. **创建超链接处理器**:继承 `AbstractCellWriteHandler` 并重写 `afterCellCreate()` 方法 2. **配置超链接属性**: - 使用 `HyperlinkType.URL` 指定链接类型 - 通过 `CreationHelper` 创建超链接对象 - 设置链接地址(URL/邮件/文件路径等) 3. **注册处理器**:在写入 Excel 时使用 `.registerWriteHandler()` #### 完整代码示例 ```java import com.alibaba.excel.write.handler.AbstractCellWriteHandler; import com.alibaba.excel.write.metadata.holder.WriteSheetHolder; import com.alibaba.excel.write.metadata.holder.WriteTableHolder; import org.apache.poi.common.usermodel.HyperlinkType; import org.apache.poi.ss.usermodel.*; import org.apache.poi.ss.util.CellRangeAddress; public class ExcelHyperlinkHandler extends AbstractCellWriteHandler { private final int startRow; // 起始行索引(0-based) private final int[] targetColumns; // 目标列索引数组 public ExcelHyperlinkHandler(int startRow, int[] targetColumns) { this.startRow = startRow; this.targetColumns = targetColumns; } @Override public void afterCellCreate(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, Cell cell, Head head, Integer relativeRowIndex, Boolean isHead) { if (isHead || cell.getRowIndex() < startRow) return; Sheet sheet = writeSheetHolder.getSheet(); Workbook workbook = sheet.getWorkbook(); // 检查当前列是否需要添加超链接 for (int colIndex : targetColumns) { if (cell.getColumnIndex() == colIndex) { CreationHelper createHelper = workbook.getCreationHelper(); // 创建超链接(此处示例使用URL类型) Hyperlink hyperlink = createHelper.createHyperlink(HyperlinkType.URL); hyperlink.setAddress("https://www.example.com/details?id=" + cell.getRowIndex()); cell.setHyperlink(hyperlink); // 可选:设置超链接样式 CellStyle linkStyle = workbook.createCellStyle(); Font linkFont = workbook.createFont(); linkFont.setUnderline(Font.U_SINGLE); linkFont.setColor(IndexedColors.BLUE.getIndex()); linkStyle.setFont(linkFont); cell.setCellStyle(linkStyle); break; } } } } ``` #### 使用方法 ```java // 写入Excel时注册处理器 EasyExcel.write("output.xlsx", YourDataClass.class) .registerWriteHandler(new ExcelHyperlinkHandler( 1, // 从第2行开始(索引0为标题行) new int[]{2, 5} // 为第3列第6列添加超链接 )) .sheet("数据页") .doWrite(dataList); ``` #### 关键配置说明 1. **超链接类型**(通过 `HyperlinkType` 指定): - `URL`:网页链接 - `EMAIL`:邮件链接(式:`mailto:address@example.com`) - `FILE`:本地文件路径 - `DOCUMENT`:跳转工作表 2. **地址动态生成技巧**: ```java // 示例:根据行数据动态生成链接 String id = dataList.get(cell.getRowIndex() - 1).getId(); hyperlink.setAddress("https://api.com/query?id=" + id); ``` 3. **样式优化建议**: - 默认蓝色下划线符合用户认知 - 可使用 `linkFont.setColor(IndexedColors.PURPLE.getIndex())` 修改颜色 - 添加悬浮提示:`hyperlink.setLabel("查看详情")` > **注意事项**: > 1. 超链接仅在 `.xlsx` 式有效(`ExcelTypeEnum.XLSX`) > 2. 合并单元需先处理合并逻辑再添加超链接[^1] > 3. 避免在表头行设置超链接(通过 `isHead` 参数过滤) [^1]: 动态合并单元参考 `ExcelFillCellMergeHandler` 实现逻辑 [^2]: 文件路径处理注意跨平台兼容性 [^3]: POI 的 `CreationHelper` 是超链接创建的关键接口
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值