使用Java填充Word模板的方法详解

From: https://www.jb51.net/program/324679hhw.htm

Java填充Word模板是一种将动态数据插入到Word文档模板中生成最终文档的过程,通常用于批量创建包含个人信息、报告结果或其他动态内容的文档,本文给大家介绍了使用Java填充Word模板的方法,需要的朋友可以参考下

 

概述

在Java中填充Word模板的需求通常涉及以下几个步骤：

  1. 准备一个Word模板文件，包含占位符。
  2. 使用Java代码读取模板文件。
  3. 根据实际数据替换模板中的占位符。
  4. 生成最终的Word文档并保存或输出。

为了实现这一过程，我们可以选择不同的Java库，每种库有其独特的优势和使用场景。本文将介绍三种常见的Java Word处理库：Apache POI、Aspose.Words for Java和Docx4j。

常见的Java Word处理库

Apache POI

Apache POI是一个开源的Java API，用于读取和写入Microsoft Office文档。POI支持Word、Excel和PowerPoint文件格式。它是处理Word文档的一个常用选择，尤其是在需要处理较简单的文档操作时。

优点：

  • 开源免费
  • 社区支持活跃
  • 适用于简单的文档操作

缺点：

  • 对复杂文档操作支持有限
  • API较为底层，使用复杂

Aspose.Words for Java

Aspose.Words for Java是一个功能强大的商业库，用于创建、修改、转换和渲染Word文档。它支持各种复杂的Word文档操作，包括填充模板、插入图片、设置样式等。

优点：

  • 功能强大，支持复杂的文档操作
  • API简洁易用
  • 优秀的文档和示例支持

缺点：

  • 商业库，需要购买许可证
  • 较高的学习成本

Docx4j

Docx4j是一个开源的Java库，用于创建和操作Office Open XML（OOXML）文件。它特别适用于处理Word（.docx）文档，支持较复杂的文档操作和格式。

优点：

  • 开源免费
  • 支持复杂的文档操作
  • 良好的文档和社区支持

缺点：

  • 学习曲线较陡
  • 对某些高级特性支持有限

使用Apache POI填充Word模板

创建和读取Word文档

首先，我们需要创建一个Word模板文档，并在Java代码中读取它。以下是如何使用Apache POI创建和读取Word文档的示例：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
import org.apache.poi.xwpf.usermodel.XWPFDocument;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
 
public class PoiExample {
    public static void main(String[] args) throws IOException {
        // 创建Word文档
        XWPFDocument document = new XWPFDocument();
         
        // 创建文件输出流
        FileOutputStream out = new FileOutputStream("template.docx");
        document.write(out);
        out.close();
         
        // 读取Word文档
        FileInputStream fis = new FileInputStream("template.docx");
        XWPFDocument doc = new XWPFDocument(fis);
        fis.close();
    }
}

填充文本

在模板中，使用占位符（如${placeholder}）来表示需要填充的数据。以下示例展示了如何使用Apache POI替换占位符：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
import org.apache.poi.xwpf.usermodel.XWPFParagraph;
import org.apache.poi.xwpf.usermodel.XWPFRun;
import java.util.List;
 
public class PoiTextFiller {
    public static void fillText(XWPFDocument document, String placeholder, String value) {
        List<XWPFParagraph> paragraphs = document.getParagraphs();
        for (XWPFParagraph paragraph : paragraphs) {
            List<XWPFRun> runs = paragraph.getRuns();
            for (XWPFRun run : runs) {
                String text = run.getText(0);
                if (text != null && text.contains(placeholder)) {
                    text = text.replace(placeholder, value);
                    run.setText(text, 0);
                }
            }
        }
    }
}

填充表格

对于表格数据，可以使用类似的方法遍历表格并替换占位符：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
import org.apache.poi.xwpf.usermodel.XWPFTable;
import org.apache.poi.xwpf.usermodel.XWPFTableCell;
import org.apache.poi.xwpf.usermodel.XWPFTableRow;
 
public class PoiTableFiller {
    public static void fillTable(XWPFDocument document, String placeholder, String value) {
        List<XWPFTable> tables = document.getTables();
        for (XWPFTable table : tables) {
            for (XWPFTableRow row : table.getRows()) {
                for (XWPFTableCell cell : row.getTableCells()) {
                    String text = cell.getText();
                    if (text != null && text.contains(placeholder)) {
                        text = text.replace(placeholder, value);
                        cell.removeParagraph(0);
                        cell.setText(text);
                    }
                }
            }
        }
    }
}

使用Aspose.Words for Java填充Word模板

创建和读取Word文档

使用Aspose.Words for Java创建和读取Word文档相对简单，以下是示例代码：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
import com.aspose.words.Document;
import com.aspose.words.DocumentBuilder;
 
public class AsposeExample {
    public static void main(String[] args) throws Exception {
        // 创建Word文档
        Document document = new Document();
        DocumentBuilder builder = new DocumentBuilder(document);
         
        // 添加内容到文档
        builder.write("Hello World!");
         
        // 保存文档
        document.save("template.docx");
         
        // 读取Word文档
        Document doc = new Document("template.docx");
    }
}

填充文本

Aspose.Words提供了更高级的API来替换文本占位符，例如使用DocumentBuilder类：

1
2
3
4
5
public class AsposeTextFiller {
    public static void fillText(Document document, String placeholder, String value) throws Exception {
        document.getRange().replace(placeholder, value, new FindReplaceOptions());
    }
}

填充表格

使用Aspose.Words填充表格也非常简单，以下是示例代码：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
import com.aspose.words.Cell;
import com.aspose.words.Row;
import com.aspose.words.Table;
 
public class AsposeTableFiller {
    public static void fillTable(Document document, String placeholder, String value) throws Exception {
        Table table = (Table) document.getChild(NodeType.TABLE, 0, true);
        for (Row row : table.getRows()) {
            for (Cell cell : row.getCells()) {
                if (cell.getText().contains(placeholder)) {
                    cell.getFirstParagraph().getRuns().clear();
                    cell.getFirstParagraph().appendChild(new Run(document, value));
                }
            }
        }
    }
}

使用Docx4j填充Word模板

创建和读取Word文档

使用Docx4j创建和读取Word文档如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
import org.docx4j.openpackaging.packages.WordprocessingMLPackage;
import org.docx4
 
j.openpackaging.parts.WordprocessingML.MainDocumentPart;
 
public class Docx4jExample {
    public static void main(String[] args) throws Exception {
        // 创建Word文档
        WordprocessingMLPackage wordMLPackage = WordprocessingMLPackage.createPackage();
        MainDocumentPart mainDocumentPart = wordMLPackage.getMainDocumentPart();
         
        // 添加内容到文档
        mainDocumentPart.addParagraphOfText("Hello World!");
         
        // 保存文档
        wordMLPackage.save(new java.io.File("template.docx"));
         
        // 读取Word文档
        WordprocessingMLPackage wordMLPackageRead = WordprocessingMLPackage.load(new java.io.File("template.docx"));
    }
}

填充文本

使用Docx4j替换文本占位符的示例如下：

1
2
3
4
5
6
7
8
9
10
11
import org.docx4j.wml.Text;
import org.docx4j.XmlUtils;
 
public class Docx4jTextFiller {
    public static void fillText(WordprocessingMLPackage wordMLPackage, String placeholder, String value) throws Exception {
        String xml = XmlUtils.marshaltoString(wordMLPackage.getMainDocumentPart().getJaxbElement(), true, true);
        xml = xml.replaceAll(placeholder, value);
        wordMLPackage.getMainDocumentPart().setJaxbElement(
                (org.docx4j.wml.Document) XmlUtils.unmarshalString(xml));
    }
}

填充表格

使用Docx4j填充表格数据的示例代码如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
import org.docx4j.wml.Tc;
import org.docx4j.wml.Tr;
import org.docx4j.wml.Tbl;
 
public class Docx4jTableFiller {
    public static void fillTable(WordprocessingMLPackage wordMLPackage, String placeholder, String value) throws Exception {
        List<Object> tables = getAllElementsFromObject(wordMLPackage.getMainDocumentPart(), Tbl.class);
        if (tables.size() > 0) {
            Tbl table = (Tbl) tables.get(0);
            List<Object> rows = getAllElementsFromObject(table, Tr.class);
            for (Object row : rows) {
                List<Object> cells = getAllElementsFromObject(row, Tc.class);
                for (Object cell : cells) {
                    Tc tableCell = (Tc) cell;
                    if (tableCell.toString().contains(placeholder)) {
                        tableCell.getContent().clear();
                        tableCell.getContent().add(wordMLPackage.getMainDocumentPart().createParagraphOfText(value));
                    }
                }
            }
        }
    }
 
    private static List<Object> getAllElementsFromObject(Object obj, Class<?> toSearch) {
        List<Object> result = new ArrayList<>();
        if (obj instanceof JAXBElement) obj = ((JAXBElement<?>) obj).getValue();
 
        if (obj.getClass().equals(toSearch)) result.add(obj);
        else if (obj instanceof ContentAccessor) {
            List<?> children = ((ContentAccessor) obj).getContent();
            for (Object child : children) result.addAll(getAllElementsFromObject(child, toSearch));
        }
        return result;
    }
}

实际应用示例

生成合同文档

合同文档通常包含多个部分和表格，需要填充客户信息、合同条款等。以下是一个使用Apache POI生成合同文档的示例：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
import org.apache.poi.xwpf.usermodel.XWPFDocument;
import java.io.FileOutputStream;
import java.io.IOException;
 
public class ContractGenerator {
    public static void main(String[] args) throws IOException {
        XWPFDocument document = new XWPFDocument();
         
        // 填充合同内容
        PoiTextFiller.fillText(document, "${customerName}", "张三");
        PoiTextFiller.fillText(document, "${contractDate}", "2024-07-05");
        PoiTableFiller.fillTable(document, "${itemDescription}", "服务项目");
         
        // 保存合同文档
        FileOutputStream out = new FileOutputStream("contract.docx");
        document.write(out);
        out.close();
    }
}

生成发票文档

发票文档需要填充客户信息、商品明细和金额等。以下是一个使用Aspose.Words for Java生成发票文档的示例：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
import com.aspose.words.Document;
import com.aspose.words.DocumentBuilder;
import java.util.List;
 
public class InvoiceGenerator {
    public static void main(String[] args) throws Exception {
        Document document = new Document("invoice_template.docx");
         
        // 填充发票内容
        AsposeTextFiller.fillText(document, "${customerName}", "李四");
        AsposeTextFiller.fillText(document, "${invoiceDate}", "2024-07-05");
        AsposeTableFiller.fillTable(document, "${itemDescription}", "商品明细");
         
        // 保存发票文档
        document.save("invoice.docx");
    }
}

生成报告文档

报告文档通常包含多个章节和数据图表，需要填充数据分析结果和图表。以下是一个使用Docx4j生成报告文档的示例：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
import org.docx4j.openpackaging.packages.WordprocessingMLPackage;
import java.io.File;
 
public class ReportGenerator {
    public static void main(String[] args) throws Exception {
        WordprocessingMLPackage wordMLPackage = WordprocessingMLPackage.load(new File("report_template.docx"));
         
        // 填充报告内容
        Docx4jTextFiller.fillText(wordMLPackage, "${reportTitle}", "2024年度报告");
        Docx4jTextFiller.fillText(wordMLPackage, "${reportDate}", "2024-07-05");
        Docx4jTableFiller.fillTable(wordMLPackage, "${dataDescription}", "数据分析结果");
         
        // 保存报告文档
        wordMLPackage.save(new File("report.docx"));
    }
}

最佳实践

模板设计

  • 使用清晰的占位符：选择易于识别和替换的占位符，如${placeholder}。
  • 保持模板简洁：尽量减少复杂的格式和样式，确保模板易于维护。
  • 分段设计：将模板分为多个独立的部分，便于单独替换和填充。

性能优化

  • 批量处理：对于大量文档生成任务，使用批量处理方法，减少单次操作的开销。
  • 缓存数据：将常用的数据缓存到内存中，减少重复读取的开销。
  • 异步处理：对于耗时的文档生成任务，使用异步处理方式，提高系统的响应速度。

错误处理

  • 捕获异常：在文档操作过程中，捕获可能出现的异常，并记录错误日志。
  • 数据验证：在填充模板之前，验证数据的完整性和准确性，避免生成错误的文档。
  • 回滚机制：在批量生成文档过程中，出现错误时，支持回滚机制，避免部分数据的生成失败。

总结

本文详细介绍了如何使用Java填充Word模板，包括常见的Java Word处理库（Apache POI、Aspose.Words for Java和Docx4j）的使用方法和实际应用示例。通过理解和应用这些技术，可以高效地生成符合特定格式的Word文档，满足各种业务需求。

posted on 2024-11-12 21:31  清清飞扬  阅读(78)  评论(0)  编辑  收藏  举报

Powered by: 博客园 Copyright © 2024 清清飞扬
Powered by .NET 9.0 on Kubernetes