DEV Community

lu liu
lu liu

Posted on

Seamless HTML to Word Conversion in Java with Spire.Doc

Converting HTML content into editable Word documents is a frequent requirement in many Java applications. Whether for generating reports, archiving web content, or enabling offline access, the ability to convert html to word efficiently is crucial. This article will guide you through a practical solution for this common challenge, leveraging the powerful capabilities of a dedicated Java library.

Introducing Spire.Doc for Java

Spire.Doc for Java is a professional API designed for creating, writing, editing, converting, and printing Word documents in Java applications without requiring Microsoft Word to be installed. It supports a wide range of Word document formats, including DOC, DOCX, RTF, and XML, and offers robust features for document manipulation, including advanced html to word conversion. Its comprehensive feature set makes it an excellent choice for developers needing to handle complex document processing tasks.

Installation

Integrating Spire.Doc for Java into your project is straightforward. You can achieve this via Maven, Gradle, or by manually including the JAR file.

Maven Dependency:
Add the following dependency to your pom.xml file:

<repositories>
    <repository>
        <id>com.e-iceblue</id>
        <name>e-iceblue</name>
        <url>https://repo.e-iceblue.com/nexus/content/groups/public/</url>
    </repository>
</repositories>
<dependencies>
    <dependency>
        <groupId>e-iceblue</groupId>
        <artifactId>spire.doc</artifactId>
        <version>13.10.6</version>
    </dependency>
</dependencies>
Enter fullscreen mode Exit fullscreen mode

Manual JAR Inclusion:

Download the Spire.Doc for Java JAR file from the official website and add it to your project's build path.

Converting HTML Files to Word Documents

One of the most common scenarios is converting existing html files to word doc format. Spire.Doc for Java simplifies this process significantly. The library enables you to load an HTML file directly and save it as a Word document with just a few lines of code.

Here’s a complete Java example demonstrating how to convert an HTML file (sample.html) into a DOCX document (FromHtmlFile.docx):

import com.spire.doc.Document;
import com.spire.doc.FileFormat;
import com.spire.doc.Section;
import com.spire.doc.documents.XHTMLValidationType;

public class ConvertHtmlFileToWord {
    public static void main(String[] args) {
        // Create a Document object
        Document document = new Document();

        // Load an HTML file
        document.loadFromFile("C:\\Users\\Administrator\\Desktop\\sample.html",
                FileFormat.Html,
                XHTMLValidationType.None);

        // Adjust margins
        Section section = document.getSections().get(0);
        section.getPageSetup().getMargins().setAll(2);

        // Save as Word file
        document.saveToFile("output/FromHtmlFile.docx", FileFormat.Docx);

        // Release resources
        document.dispose();

        System.out.println("HTML file successfully converted to Word!");
    }
}
Enter fullscreen mode Exit fullscreen mode

In this example, document.loadFromFile() handles parsing the HTML structure, and document.saveToFile() then writes the content to a .docx file, preserving formatting as much as possible.

Converting HTML Strings to Word Documents

There are instances where HTML content is available as a string within your application, perhaps retrieved from a database or a web service. Spire.Doc for Java provides a straightforward method to convert such HTML strings directly into a Word document.

The process is similar to file-based conversion, but instead of loading from a file, you append the HTML string directly to a section within the document.

import com.spire.doc.Document;
import com.spire.doc.FileFormat;
import com.spire.doc.Section;
import com.spire.doc.documents.Paragraph;

public class ConvertHtmlStringToWord {
    public static void main(String[] args) {
        // Sample HTML string
        String htmlString = "<h1>Java HTML to Word Conversion</h1>" +
                "<p><b>Spire.Doc</b> allows you to convert HTML content into Word documents seamlessly. " +
                "This includes support for headings, paragraphs, lists, tables, links, and images.</p>" +
                "<h2>Features</h2>" +
                "<ul>" +
                "<li>Preserve text formatting such as <i>italic</i>, <u>underline</u>, and <b>bold</b></li>" +
                "<li>Support for ordered and unordered lists</li>" +
                "<li>Insert tables with multiple rows and columns</li>" +
                "<li>Add hyperlinks and bookmarks</li>" +
                "<li>Embed images from URLs or base64 strings</li>" +
                "</ul>" +
                "<h2>Example Table</h2>" +
                "<table border='1' style='border-collapse:collapse;'>" +
                "<tr><th>Item</th><th>Description</th><th>Quantity</th></tr>" +
                "<tr><td>Notebook</td><td>Spire.Doc Java Guide</td><td>10</td></tr>" +
                "<tr><td>Pen</td><td>Blue Ink</td><td>20</td></tr>" +
                "<tr><td>Marker</td><td>Permanent Marker</td><td>5</td></tr>" +
                "</table>" +
                "<h2>Links and Images</h2>" +
                "<p>Visit <a href='https://www.e-iceblue.com/'>E-iceblue Official Site</a> for more resources.</p>" +
                "<p>Sample Image:</p>" +
                "<img src='https://cdn.e-iceblue.com/images/intro_pic/Product_Logo/doc-j.png' alt='Product Logo' width='150' height='150'/>" +
                "<h2>Conclusion</h2>" +
                "<p>Using Spire.Doc, Java developers can easily generate Word documents from rich HTML content while preserving formatting and layout.</p>";

        // Create a Document
        Document document = new Document();

        // Add section and paragraph
        Section section = document.addSection();
        section.getPageSetup().getMargins().setAll(72);

        Paragraph paragraph = section.addParagraph();

        // Render HTML string
        paragraph.appendHTML(htmlString);

        // Save as Word
        document.saveToFile("output/FromHtmlString.docx", FileFormat.Docx);

        document.dispose();

        System.out.println("HTML string successfully converted to Word!");
    }
}
Enter fullscreen mode Exit fullscreen mode

The appendHTML() method is key here, allowing you to inject HTML content directly into a paragraph within your Word document. This flexibility is invaluable for dynamic content generation.

Advanced: Batch Conversion of HTML Files to Word

For applications requiring the conversion of multiple HTML files, implementing a batch conversion process is essential. This typically involves iterating through a directory of HTML files and applying the conversion logic to each.

Here’s a conceptual outline for performing a batch HTML-to-Word conversion:

import com.spire.doc.Document;
import com.spire.doc.FileFormat;
import com.spire.doc.documents.XHTMLValidationType;
import java.io.File;

public class BatchConvertHtmlToWord {
    public static void main(String[] args) {
        File folder = new File("C:\\Users\\Administrator\\Desktop\\HtmlFiles");

        for (File file : folder.listFiles()) {
            if (file.getName().endsWith(".html") || file.getName().endsWith(".htm")) {
                Document document = new Document();
                document.loadFromFile(file.getAbsolutePath(), FileFormat.Html, XHTMLValidationType.None);

                String outputPath = "output/" + file.getName().replace(".html", ".docx");
                document.saveToFile(outputPath, FileFormat.Docx);
                document.dispose();

                System.out.println(file.getName() + " converted to Word!");
            }
        }
    }
}
Enter fullscreen mode Exit fullscreen mode

This example demonstrates iterating through files in a specified input directory, filtering for .html or .htm extensions, and then converting each to a .docx file in an output directory. Robust error handling and logging would be crucial in a production environment to manage failed conversions gracefully.

Conclusion

The ability to convert html to word documents in Java is a powerful asset for developers, addressing a wide array of document generation and management needs. Spire.Doc for Java stands out as an effective and reliable library for this purpose, offering intuitive methods for both file-based and string-based conversions, as well as enabling efficient batch processing. By integrating this library, developers can significantly simplify complex document tasks within their Java applications, enhancing functionality and user experience. We encourage you to explore Spire.Doc for Java further to unlock its full potential for your projects.

Top comments (0)