Primefaces p:dataTable多列PDF导出分页实现咨询

针对你遇到的40+列DataTable导出PDF时挤在一起的问题，完全可以通过扩展自定义PDF导出器来实现按列分页（比如每页7列），替代用大尺寸纸张的临时方案。下面是具体的实现思路和代码示例：

问题根源 #

PrimeFaces默认的PDFExporter是把所有列渲染到同一个PDF表格中，没有内置横向拆分列的逻辑；而Excel的结构天然支持横向分页，所以你之前能轻松实现。要实现PDF的列分页，我们需要手动拆分列集合，逐页渲染独立的表格。

具体实现步骤 #

假设你已经有了PDFCustomExporter，我们可以重写核心的导出逻辑，添加列分组和分页处理：

1. 核心逻辑改造 #

在自定义导出器中，我们需要：

• 定义每页显示的列数（比如PAGE_COL_COUNT = 7）
• 将原始列列表拆分为多个子列组
• 对每个列组，单独渲染PDF表格（包含表头+数据行）
• 每渲染完一个列组后，添加分页符

2. 代码示例 #

public class PDFColumnPagedExporter extends PDFExporter {
    // 每页显示的列数
    private static final int PAGE_COL_COUNT = 7;

    @Override
    protected void exportPDF(FacesContext context, DataTable table, Document document, PdfWriter writer, String title, boolean pageOnly, boolean selectionOnly) throws IOException, DocumentException {
        // 获取所有列（注意处理p:columns动态生成的列）
        List<UIColumn> columns = getColumnsToExport(table, pageOnly, selectionOnly);
        int totalColumns = columns.size();
        int totalPages = (int) Math.ceil((double) totalColumns / PAGE_COL_COUNT);

        // 循环处理每个列页
        for (int page = 0; page < totalPages; page++) {
            int startCol = page * PAGE_COL_COUNT;
            int endCol = Math.min(startCol + PAGE_COL_COUNT, totalColumns);
            List<UIColumn> currentPageColumns = columns.subList(startCol, endCol);

            // 创建当前页的PDF表格，设置列宽
            PdfPTable pdfTable = new PdfPTable(currentPageColumns.size());
            // 可以设置固定宽度，或按比例分配
            float[] columnWidths = new float[currentPageColumns.size()];
            Arrays.fill(columnWidths, 100f); // 每个列固定100单位宽度，可根据需求调整
            pdfTable.setWidths(columnWidths);
            pdfTable.setWidthPercentage(100); // 占满页面宽度

            // 渲染表头
            renderHeader(table, currentPageColumns, pdfTable);

            // 渲染数据行
            renderRows(context, table, currentPageColumns, pdfTable, pageOnly, selectionOnly);

            // 将表格添加到文档
            document.add(pdfTable);

            // 不是最后一页的话，添加分页符
            if (page < totalPages - 1) {
                document.newPage();
            }
        }
    }

    // 重写表头渲染方法，只处理当前页的列
    private void renderHeader(DataTable table, List<UIColumn> columns, PdfPTable pdfTable) {
        for (UIColumn column : columns) {
            String headerText = column.getHeaderText();
            // 处理表头组件（比如h:outputText）
            if (column.getHeader() != null) {
                headerText = exportValue(FacesContext.getCurrentInstance(), column.getHeader());
            }
            PdfPCell cell = new PdfPCell(new Phrase(headerText, getFont(FONT_HEADER)));
            cell.setBackgroundColor(HEADER_BACKGROUND);
            pdfTable.addCell(cell);
        }
    }

    // 重写数据行渲染方法，只处理当前页的列
    private void renderRows(FacesContext context, DataTable table, List<UIColumn> columns, PdfPTable pdfTable, boolean pageOnly, boolean selectionOnly) {
        List<?> datasource = getDataSource(table);
        int first = pageOnly ? table.getFirst() : 0;
        int rows = pageOnly ? table.getRows() : datasource.size();

        for (int i = first; i < first + rows; i++) {
            if (i >= datasource.size()) {
                break;
            }
            Object rowData = datasource.get(i);
            table.setRowIndex(i);

            if (selectionOnly && !table.isRowSelected()) {
                continue;
            }

            for (UIColumn column : columns) {
                Object value = exportValue(context, column);
                PdfPCell cell = new PdfPCell(new Phrase(value != null ? value.toString() : "", getFont(FONT_DATA)));
                pdfTable.addCell(cell);
            }
        }
        table.setRowIndex(-1);
    }
}

3. 关键注意事项 #

• 列宽设置：可以根据需求调整columnWidths数组，比如按内容比例分配，或者设置不同列的不同宽度，避免内容挤压。
• 动态列处理：getColumnsToExport方法要正确获取p:columns生成的动态列，确保所有列都被纳入拆分逻辑。
• 表头重复：如果需要每页都显示表头，上面的代码已经处理，每个列组的表格都会渲染自己的表头。
• 分页符控制：通过document.newPage()确保每个列组单独占一页。

使用方式 #

在你的页面导出按钮中，指定使用自定义的导出器：

<p:commandButton value="导出PDF" ajax="false">
    <p:fileDownload value="#{yourBean.exportPdf}" />
</p:commandButton>

在Bean中：

public StreamedContent exportPdf() {
    FacesContext context = FacesContext.getCurrentInstance();
    DataTable table = (DataTable) context.getViewRoot().findComponent("yourDataTableId");
    PDFColumnPagedExporter exporter = new PDFColumnPagedExporter();
    
    ByteArrayOutputStream baos = new ByteArrayOutputStream();
    try {
        Document document = new Document(PageSize.A4); // 用默认A4即可，不用大纸张
        PdfWriter writer = PdfWriter.getInstance(document, baos);
        document.open();
        exporter.export(context, table, document, writer, "导出标题", false, false);
        document.close();
    } catch (Exception e) {
        e.printStackTrace();
    }
    return new DefaultStreamedContent(new ByteArrayInputStream(baos.toByteArray()), "application/pdf", "data.pdf");
}

这样导出的PDF就会自动按每页7列拆分，每一页都是清晰可读的表格，不用依赖大尺寸纸张了。

内容的提问来源于stack exchange，提问作者Tifred