Como criar um PDF a partir de um modelo em Java

IronPDF

IronPDF é uma biblioteca Java desenvolvida e mantida pela Iron Software . Ela oferece uma interface fácil de usar que abstrai muitas das complexidades da geração de PDFs, permitindo que os desenvolvedores se concentrem no conteúdo de seus PDFs em vez dos detalhes de como os arquivos são gerados. O IronPDF também oferece uma série de recursos que facilitam o trabalho com modelos de PDF, formulários preenchíveis e assinaturas digitais .

Este tutorial irá orientá-lo passo a passo na criação de um arquivo PDF a partir de um modelo usando o IronPDF em Java.

O primeiro passo é criar um projeto.

Passo 1: Crie um novo projeto Java

Aqui estão os passos para criar um novo projeto Java usando o IntelliJ IDEA:

1. Abra o IntelliJ IDEA e selecione "Criar novo projeto" na tela de boas-vindas ou no menu "Arquivo".
2. Selecione "Java" no menu à esquerda e escolha a versão do JDK que deseja usar em seu projeto. Clique em "Próximo".
3. Escolha um nome e um local para o seu projeto e selecione o tipo de projeto. Você pode escolher entre diversos tipos de projeto, como "Aplicativo Java", "Biblioteca Java" ou "Aplicativo JavaFX". Clique em "Próximo".
4. Configure as definições do projeto. Você pode especificar o SDK do projeto, o nível de idioma do projeto e outras configurações. Você também pode optar por criar um módulo ou selecionar um já existente. Clique em "Próximo".
5. Escolha o modelo de projeto. Você pode optar por criar um projeto em branco, um projeto com um código de exemplo ou importar um projeto existente. Clique em "Concluir".

Criar um novo projeto Java usando o IntelliJ IDEA

Passo 2: Adicione a biblioteca IronPDF ao seu projeto

O segundo passo é adicionar a biblioteca IronPDF ao seu projeto Java usando um arquivo XML. Você pode fazer isso adicionando a seguinte dependência ao arquivo pom.xml do seu projeto:

<dependency>
    <groupId>com.ironsoftware</groupId>
    <artifactId>ironpdf</artifactId>
    <version>VERSION_NUMBER</version> 
</dependency>

<dependency>
    <groupId>com.ironsoftware</groupId>
    <artifactId>ironpdf</artifactId>
    <version>VERSION_NUMBER</version> 
</dependency>

Etapa 3: Criar o modelo em PDF

Em seguida, você precisa criar um modelo de PDF que será usado para gerar seu arquivo PDF. Você pode criar seu modelo de PDF usando qualquer editor de PDF. O modelo pode incluir marcadores que serão substituídos por dados dinâmicos em tempo de execução.

Imagine um caso de uso em que vários certificados são emitidos para 50 alunos. Atualmente, criar certificados separados para cada usuário tornou-se uma tarefa muito complexa. Assim, utiliza-se um modelo e basta alterar o nome usando este programa de demonstração, conforme mostrado abaixo.

Instância de imagem do modelo de certificado

Etapa 4: Criar documentos PDF a partir do modelo

Após criar o modelo de certificado em PDF, o primeiro passo é carregá-lo no aplicativo Java. A classe IronPDF PdfDocument é usada para carregar o modelo PDF na memória. Segue um exemplo de código que mostra como carregar um modelo de PDF usando o IronPDF:

// Load the PDF template into memory using IronPDF
PdfDocument pdfDoc = PdfDocument.fromFile(Paths.get("CERTIFICATE.pdf"));

// Load the PDF template into memory using IronPDF
PdfDocument pdfDoc = PdfDocument.fromFile(Paths.get("CERTIFICATE.pdf"));

Agora, vamos escrever um exemplo de código que criará 5 certificados com base no modelo fornecido.

import com.ironsoftware.ironpdf.PageSelection;
import com.ironsoftware.ironpdf.PdfDocument;

import java.io.IOException;
import java.nio.file.Paths;

public class CertificateGenerator {
    public static void main(String[] args) throws IOException {
        // Array of student names
        String[] studentNames = {"Georgia Wade", "Juliet Dave", "Olive Seth", "Miles Jorg", "Oscar Den"};

        // Iterate through each student's name
        for (String name : studentNames) {
            // Load the PDF template
            PdfDocument pdfDoc = PdfDocument.fromFile(Paths.get("CERTIFICATE.pdf"));

            // Replace the placeholder text with the student's name
            pdfDoc.replaceText(PageSelection.firstPage(), "Recipient Name", name);

            // Save the new PDF with the student's name as the file name
            pdfDoc.saveAs(Paths.get("Certificate/" + name + ".pdf"));
        }
    }
}

import com.ironsoftware.ironpdf.PageSelection;
import com.ironsoftware.ironpdf.PdfDocument;

import java.io.IOException;
import java.nio.file.Paths;

public class CertificateGenerator {
    public static void main(String[] args) throws IOException {
        // Array of student names
        String[] studentNames = {"Georgia Wade", "Juliet Dave", "Olive Seth", "Miles Jorg", "Oscar Den"};

        // Iterate through each student's name
        for (String name : studentNames) {
            // Load the PDF template
            PdfDocument pdfDoc = PdfDocument.fromFile(Paths.get("CERTIFICATE.pdf"));

            // Replace the placeholder text with the student's name
            pdfDoc.replaceText(PageSelection.firstPage(), "Recipient Name", name);

            // Save the new PDF with the student's name as the file name
            pdfDoc.saveAs(Paths.get("Certificate/" + name + ".pdf"));
        }
    }
}

A seguir estão os registros de saída:

Saída

O código acima cria uma matriz com os nomes dos alunos e, em seguida, usa a biblioteca IronPDF para substituir um texto de espaço reservado em um modelo PDF preexistente pelo nome de cada aluno. Depois, salva uma nova cópia do PDF com o nome do aluno como nome do arquivo.

Eis como o código funciona:

1. O array studentNames é definido e inicializado com cinco nomes de alunos.
2. O loop for itera por cada nome na matriz studentNames .
3. O método PdfDocument.fromFile carrega o arquivo de modelo PDF chamado "CERTIFICATE.pdf" em um objeto PdfDocument .
4. O método PdfDocument.replaceText é usado para substituir o texto "Nome do Destinatário" no modelo PDF pelo nome do aluno atual.
5. O método PdfDocument.saveAs salva o arquivo PDF modificado com o nome do aluno como nome do arquivo no diretório "Certificado".
6. O ciclo continua até que todos os nomes dos alunos tenham sido processados.

Dessa forma, são gerados vários certificados, cada um com um nome de aluno único, com base em um único modelo de PDF. A mesma abordagem pode ser usada para gerar documentos PDF com qualquer modelo.

Arquivo de saída do certificado

Segue abaixo o certificado gerado por este programa de demonstração.

Saída de certificado

Passo 5: Criar modelo PDF a partir do modelo HTML

Neste exemplo, o arquivo HTML será usado para criar um modelo de PDF e, em seguida, esse modelo será usado para gerar um documento PDF.

Este é o arquivo HTML usado para demonstração no exemplo.

Saída HTML

Considere o seguinte exemplo de código para criar um novo documento a partir do formato HTML fornecido.

import com.ironsoftware.ironpdf.PdfDocument;

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;

public class HtmlToPdfExample {
    public static void main(String[] args) throws IOException {
        // Path to the HTML template
        Path fileName = Path.of("D:\\index.html");

        // Dynamic data to replace placeholders in the template
        String userName = "Mike";
        String title = "Sample PDF File";
        String body = "This is the body of our template PDF";

        // Read the HTML file content as a string
        String htmlStr = Files.readString(fileName);

        // Replace placeholders with actual data
        htmlStr = htmlStr.replace("{UserName}", userName);
        htmlStr = htmlStr.replace("{Title}", title);
        htmlStr = htmlStr.replace("{message}", body);

        // Render the HTML as a PDF document using IronPDF
        PdfDocument pdfDoc = PdfDocument.renderHtmlAsPdf(htmlStr);

        // Save the generated PDF document in the specified directory
        pdfDoc.saveAs(Paths.get("htmlTemplate/" + userName + ".pdf"));
    }
}

import com.ironsoftware.ironpdf.PdfDocument;

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;

public class HtmlToPdfExample {
    public static void main(String[] args) throws IOException {
        // Path to the HTML template
        Path fileName = Path.of("D:\\index.html");

        // Dynamic data to replace placeholders in the template
        String userName = "Mike";
        String title = "Sample PDF File";
        String body = "This is the body of our template PDF";

        // Read the HTML file content as a string
        String htmlStr = Files.readString(fileName);

        // Replace placeholders with actual data
        htmlStr = htmlStr.replace("{UserName}", userName);
        htmlStr = htmlStr.replace("{Title}", title);
        htmlStr = htmlStr.replace("{message}", body);

        // Render the HTML as a PDF document using IronPDF
        PdfDocument pdfDoc = PdfDocument.renderHtmlAsPdf(htmlStr);

        // Save the generated PDF document in the specified directory
        pdfDoc.saveAs(Paths.get("htmlTemplate/" + userName + ".pdf"));
    }
}

O código acima lê o conteúdo de um arquivo HTML, substitui os marcadores de posição no arquivo HTML por dados dinâmicos, renderiza o HTML como um documento PDF usando a biblioteca IronPDF e salva o documento PDF gerado em um diretório específico.

Segue uma explicação passo a passo do que o código faz:

1. O código começa criando um objeto Path que aponta para um arquivo HTML no sistema de arquivos local. Neste caso, o arquivo está localizado em "D:\index.html".
2. Três variáveis ​​são declaradas e inicializadas com alguns dados de exemplo: userName, title e body.
3. O conteúdo do arquivo HTML é lido em uma variável de string chamada htmlStr usando o método Files.readString.
4. O método String.replace é usado para substituir três marcadores de posição ({UserName}, {Title} e {message}) no arquivo HTML pelos dados dinâmicos correspondentes.
5. O método PdfDocument.renderHtmlAsPdf é chamado com a string HTML modificada como argumento para renderizar o HTML como um documento PDF. O documento PDF resultante é armazenado em um objeto PdfDocument chamado pdfDoc.
6. O método pdfDoc.saveAs é chamado para salvar o documento PDF gerado em um diretório chamado "htmlTemplate" no sistema de arquivos local, com o nome do arquivo construído a partir da variável userName.

Saída

Dessa forma, é fácil criar arquivos PDF a partir de modelos HTML programaticamente.

É possível substituir esta marca d'água obtendo uma versão de avaliação gratuita ou adquirindo uma licença comercial .

Conclusão

Este artigo explorou como usar o IronPDF for Java para gerar arquivos PDF. O IronPDF oferece uma interface simples e poderosa que permite criar e manipular arquivos PDF com facilidade. Com o IronPDF, você pode criar facilmente documentos PDF com aparência profissional, que podem ser usados ​​para diversas finalidades, como gerar relatórios, faturas e outros tipos de documentos.

O IronPDF também é altamente personalizável, com opções para controlar a aparência e o layout dos arquivos PDF. Os desenvolvedores podem especificar margens de página, tamanhos de fonte, cores e outras propriedades para criar arquivos PDF que atendam às suas necessidades específicas.

Em resumo, o IronPDF é uma biblioteca poderosa e flexível para geração de PDFs em Java. Com sua interface fácil de usar e ampla gama de recursos, o IronPDF é uma ótima opção para qualquer aplicação que exija a geração de PDFs.

Baixe o IronPDF for Java , o produto de software .