如何使用Java SpringBoot集成POI實現Word文檔導出

如何使用Java SpringBoot集成POI實現Word文檔導出

目錄

1. 引言
2. POI簡介
3. SpringBoot項目搭建
4. POI依賴引入
5. Word文檔導出基礎
6. 創建Word文檔
7. 添加文本內容
8. 設置文本樣式
9. 插入表格
10. 插入圖片
11. 處理復雜文檔
12. 導出Word文檔
13. 完整代碼示例
14. 總結

引言

在現代企業應用中，文檔導出功能是一個非常常見的需求。無論是生成報告、合同還是其他類型的文檔，能夠將數據導出為Word文檔是非常有用的。Java SpringBoot流行的Java開發框架，結合Apache POI庫，可以輕松實現Word文檔的導出功能。本文將詳細介紹如何使用Java SpringBoot集成POI實現Word文檔導出。

POI簡介

Apache POI是一個開源的Java庫，用于處理Microsoft Office文檔，包括Word、Excel和PowerPoint等。POI提供了豐富的API，可以創建、修改和讀取Office文檔。在本文中，我們將主要使用POI的XWPF模塊來處理Word文檔。

SpringBoot項目搭建

首先，我們需要創建一個SpringBoot項目?？梢允褂肧pring Initializr來快速生成項目骨架。

1. 打開Spring Initializr。
2. 選擇項目類型為Maven Project。
3. 選擇Spring Boot版本（建議使用最新穩定版）。
4. 填寫項目元數據（Group、Artifact等）。
5. 添加依賴：Spring Web。
6. 點擊“Generate”按鈕下載項目。

下載完成后，解壓項目并導入到IDE中（如IntelliJ IDEA或Eclipse）。

POI依賴引入

在pom.xml文件中添加POI的依賴：

<dependencies>
    <!-- Spring Boot Starter Web -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <!-- Apache POI for Word -->
    <dependency>
        <groupId>org.apache.poi</groupId>
        <artifactId>poi-ooxml</artifactId>
        <version>5.2.3</version>
    </dependency>

    <!-- Apache POI OOXML Schemas -->
    <dependency>
        <groupId>org.apache.poi</groupId>
        <artifactId>poi-ooxml-schemas</artifactId>
        <version>4.1.2</version>
    </dependency>

    <!-- XMLBeans for POI -->
    <dependency>
        <groupId>org.apache.xmlbeans</groupId>
        <artifactId>xmlbeans</artifactId>
        <version>5.1.1</version>
    </dependency>
</dependencies>

Word文檔導出基礎

在開始編寫代碼之前，我們需要了解一些POI的基本概念和API。

• XWPFDocument: 代表一個Word文檔。
• XWPFParagraph: 代表文檔中的一個段落。
• XWPFRun: 代表段落中的一段文本。
• XWPFTable: 代表文檔中的一個表格。
• XWPFTableRow: 代表表格中的一行。
• XWPFTableCell: 代表表格中的一個單元格。

創建Word文檔

首先，我們需要創建一個XWPFDocument對象，它代表一個空白的Word文檔。

import org.apache.poi.xwpf.usermodel.XWPFDocument;

public class WordExportService {

    public XWPFDocument createDocument() {
        return new XWPFDocument();
    }
}

添加文本內容

接下來，我們可以在文檔中添加文本內容。文本內容是通過XWPFParagraph和XWPFRun來添加的。

import org.apache.poi.xwpf.usermodel.XWPFDocument;
import org.apache.poi.xwpf.usermodel.XWPFParagraph;
import org.apache.poi.xwpf.usermodel.XWPFRun;

public class WordExportService {

    public XWPFDocument createDocument() {
        XWPFDocument document = new XWPFDocument();
        XWPFParagraph paragraph = document.createParagraph();
        XWPFRun run = paragraph.createRun();
        run.setText("Hello, World!");
        return document;
    }
}

設置文本樣式

我們可以通過XWPFRun來設置文本的樣式，如字體、字號、顏色等。

import org.apache.poi.xwpf.usermodel.XWPFDocument;
import org.apache.poi.xwpf.usermodel.XWPFParagraph;
import org.apache.poi.xwpf.usermodel.XWPFRun;

public class WordExportService {

    public XWPFDocument createDocument() {
        XWPFDocument document = new XWPFDocument();
        XWPFParagraph paragraph = document.createParagraph();
        XWPFRun run = paragraph.createRun();
        run.setText("Hello, World!");
        run.setBold(true);
        run.setFontSize(16);
        run.setColor("FF0000");
        return document;
    }
}

插入表格

在Word文檔中插入表格也非常簡單。我們可以使用XWPFTable來創建表格，并通過XWPFTableRow和XWPFTableCell來添加行和單元格。

import org.apache.poi.xwpf.usermodel.*;

public class WordExportService {

    public XWPFDocument createDocument() {
        XWPFDocument document = new XWPFDocument();
        XWPFParagraph paragraph = document.createParagraph();
        XWPFRun run = paragraph.createRun();
        run.setText("Hello, World!");
        run.setBold(true);
        run.setFontSize(16);
        run.setColor("FF0000");

        // 創建表格
        XWPFTable table = document.createTable(3, 3);

        // 填充表格內容
        for (int row = 0; row < 3; row++) {
            XWPFTableRow tableRow = table.getRow(row);
            for (int col = 0; col < 3; col++) {
                XWPFTableCell cell = tableRow.getCell(col);
                cell.setText("Row " + row + ", Col " + col);
            }
        }

        return document;
    }
}

插入圖片

在Word文檔中插入圖片需要使用XWPFRun的addPicture方法。首先，我們需要將圖片轉換為字節數組。

import org.apache.poi.xwpf.usermodel.*;
import org.apache.poi.util.IOUtils;

import java.io.FileInputStream;
import java.io.IOException;

public class WordExportService {

    public XWPFDocument createDocument() throws IOException {
        XWPFDocument document = new XWPFDocument();
        XWPFParagraph paragraph = document.createParagraph();
        XWPFRun run = paragraph.createRun();
        run.setText("Hello, World!");
        run.setBold(true);
        run.setFontSize(16);
        run.setColor("FF0000");

        // 創建表格
        XWPFTable table = document.createTable(3, 3);

        // 填充表格內容
        for (int row = 0; row < 3; row++) {
            XWPFTableRow tableRow = table.getRow(row);
            for (int col = 0; col < 3; col++) {
                XWPFTableCell cell = tableRow.getCell(col);
                cell.setText("Row " + row + ", Col " + col);
            }
        }

        // 插入圖片
        FileInputStream imageStream = new FileInputStream("path/to/image.png");
        byte[] imageBytes = IOUtils.toByteArray(imageStream);
        run.addBreak();
        run.addPicture(imageBytes, XWPFDocument.PICTURE_TYPE_PNG, "image.png", 200, 200);

        return document;
    }
}

處理復雜文檔

在實際應用中，我們可能需要處理更復雜的文檔，如包含多個段落、表格、圖片和樣式的內容。POI提供了豐富的API來處理這些需求。

import org.apache.poi.xwpf.usermodel.*;
import org.apache.poi.util.IOUtils;

import java.io.FileInputStream;
import java.io.IOException;

public class WordExportService {

    public XWPFDocument createDocument() throws IOException {
        XWPFDocument document = new XWPFDocument();

        // 添加標題
        XWPFParagraph titleParagraph = document.createParagraph();
        titleParagraph.setAlignment(ParagraphAlignment.CENTER);
        XWPFRun titleRun = titleParagraph.createRun();
        titleRun.setText("Sample Document");
        titleRun.setBold(true);
        titleRun.setFontSize(20);

        // 添加段落
        XWPFParagraph paragraph = document.createParagraph();
        paragraph.setAlignment(ParagraphAlignment.LEFT);
        XWPFRun run = paragraph.createRun();
        run.setText("This is a sample document created using Apache POI and Spring Boot.");
        run.setFontSize(12);

        // 添加表格
        XWPFTable table = document.createTable(3, 3);
        for (int row = 0; row < 3; row++) {
            XWPFTableRow tableRow = table.getRow(row);
            for (int col = 0; col < 3; col++) {
                XWPFTableCell cell = tableRow.getCell(col);
                cell.setText("Row " + row + ", Col " + col);
            }
        }

        // 插入圖片
        FileInputStream imageStream = new FileInputStream("path/to/image.png");
        byte[] imageBytes = IOUtils.toByteArray(imageStream);
        XWPFParagraph imageParagraph = document.createParagraph();
        XWPFRun imageRun = imageParagraph.createRun();
        imageRun.addPicture(imageBytes, XWPFDocument.PICTURE_TYPE_PNG, "image.png", 200, 200);

        return document;
    }
}

導出Word文檔

最后，我們需要將生成的Word文檔導出為文件?？梢酝ㄟ^FileOutputStream將文檔寫入到文件中。

import org.apache.poi.xwpf.usermodel.XWPFDocument;

import java.io.FileOutputStream;
import java.io.IOException;

public class WordExportService {

    public void exportDocument(XWPFDocument document, String filePath) throws IOException {
        try (FileOutputStream out = new FileOutputStream(filePath)) {
            document.write(out);
        }
    }

    public static void main(String[] args) throws IOException {
        WordExportService service = new WordExportService();
        XWPFDocument document = service.createDocument();
        service.exportDocument(document, "output.docx");
    }
}

完整代碼示例

以下是完整的代碼示例，包括創建文檔、添加內容、設置樣式、插入表格和圖片，以及導出文檔。

import org.apache.poi.xwpf.usermodel.*;
import org.apache.poi.util.IOUtils;

import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;

public class WordExportService {

    public XWPFDocument createDocument() throws IOException {
        XWPFDocument document = new XWPFDocument();

        // 添加標題
        XWPFParagraph titleParagraph = document.createParagraph();
        titleParagraph.setAlignment(ParagraphAlignment.CENTER);
        XWPFRun titleRun = titleParagraph.createRun();
        titleRun.setText("Sample Document");
        titleRun.setBold(true);
        titleRun.setFontSize(20);

        // 添加段落
        XWPFParagraph paragraph = document.createParagraph();
        paragraph.setAlignment(ParagraphAlignment.LEFT);
        XWPFRun run = paragraph.createRun();
        run.setText("This is a sample document created using Apache POI and Spring Boot.");
        run.setFontSize(12);

        // 添加表格
        XWPFTable table = document.createTable(3, 3);
        for (int row = 0; row < 3; row++) {
            XWPFTableRow tableRow = table.getRow(row);
            for (int col = 0; col < 3; col++) {
                XWPFTableCell cell = tableRow.getCell(col);
                cell.setText("Row " + row + ", Col " + col);
            }
        }

        // 插入圖片
        FileInputStream imageStream = new FileInputStream("path/to/image.png");
        byte[] imageBytes = IOUtils.toByteArray(imageStream);
        XWPFParagraph imageParagraph = document.createParagraph();
        XWPFRun imageRun = imageParagraph.createRun();
        imageRun.addPicture(imageBytes, XWPFDocument.PICTURE_TYPE_PNG, "image.png", 200, 200);

        return document;
    }

    public void exportDocument(XWPFDocument document, String filePath) throws IOException {
        try (FileOutputStream out = new FileOutputStream(filePath)) {
            document.write(out);
        }
    }

    public static void main(String[] args) throws IOException {
        WordExportService service = new WordExportService();
        XWPFDocument document = service.createDocument();
        service.exportDocument(document, "output.docx");
    }
}

總結

通過本文的介紹，我們學習了如何使用Java SpringBoot集成Apache POI庫來實現Word文檔的導出功能。我們從創建文檔、添加文本內容、設置樣式、插入表格和圖片，到最終導出文檔，逐步實現了完整的文檔導出功能。希望本文能夠幫助你在實際項目中快速實現Word文檔導出功能。