Como gerar PDF a partir de HTML em Java e Spring Boot
Publicado em 2 min de leitura
Em Java, transformar HTML em PDF costuma significar colocar uma biblioteca de renderização, as suas fontes e as suas dependências no build e mantê-las em dia com o runtime. Com uma API, é uma requisição HTTP, e o JDK tem um cliente HTTP desde a versão 11. Este guia mostra um cliente pequeno e um controller do Spring Boot que devolve o arquivo, com a API do rustedf.cloud.
Um cliente no HttpClient padrão
import com.fasterxml.jackson.databind.ObjectMapper;import java.io.IOException;import java.net.URI;import java.net.http.HttpClient;import java.net.http.HttpRequest;import java.net.http.HttpResponse;import java.time.Duration;import java.util.Map;
public final class PdfClient { private static final URI RENDER = URI.create("https://api.rustedf.com/v1/render");
private final HttpClient http = HttpClient.newHttpClient(); private final ObjectMapper json = new ObjectMapper(); private final String key;
public PdfClient(String key) { this.key = key; }
public byte[] render(String templateId, Map<String, Object> data, String locale) throws IOException, InterruptedException { String body = json.writeValueAsString( Map.of("template_id", templateId, "locale", locale, "data", data));
HttpRequest request = HttpRequest.newBuilder(RENDER) .timeout(Duration.ofSeconds(40)) .header("Authorization", "Bearer " + key) .header("Content-Type", "application/json") .POST(HttpRequest.BodyPublishers.ofString(body)) .build();
HttpResponse<byte[]> response = http.send(request, HttpResponse.BodyHandlers.ofByteArray()); if (response.statusCode() != 200) { String message = json.readTree(response.body()).path("error").path("message") .asText("Falha ao gerar (" + response.statusCode() + ")"); throw new IllegalStateException(message); } return response.body(); }}Uma resposta bem-sucedida é o próprio PDF, então os bytes são o arquivo. Em uma falha, o corpo é um
JSON com um code estável e uma message, que o cliente lê para montar a exceção.
Defina o tempo limite acima do limite do seu plano, para que a sua requisição não desista antes do serviço. Mantenha a chave fora do código-fonte, em uma variável de ambiente ou em um cofre de segredos.
Um controller do Spring Boot
import java.util.Map;import org.springframework.beans.factory.annotation.Value;import org.springframework.context.annotation.Bean;import org.springframework.http.HttpHeaders;import org.springframework.http.MediaType;import org.springframework.http.ResponseEntity;import org.springframework.web.bind.annotation.GetMapping;import org.springframework.web.bind.annotation.PathVariable;import org.springframework.web.bind.annotation.RestController;
@RestControllerclass FaturaController { private final PdfClient pdf; private final String templateId;
FaturaController(PdfClient pdf, @Value("${rustedf.invoice-template}") String templateId) { this.pdf = pdf; this.templateId = templateId; }
@GetMapping("/faturas/{numero}/pdf") ResponseEntity<byte[]> fatura(@PathVariable String numero) throws Exception { byte[] arquivo = pdf.render(templateId, Map.of( "number", numero, "customer", Map.of("name", "Ana Souza"), "total", "2040.50"), "pt-BR");
return ResponseEntity.ok() .contentType(MediaType.APPLICATION_PDF) .header(HttpHeaders.CONTENT_DISPOSITION, "inline; filename=\"fatura-" + numero + ".pdf\"") .body(arquivo); }}
@org.springframework.context.annotation.Configurationclass PdfConfig { @Bean PdfClient pdfClient(@Value("${rustedf.key}") String key) { return new PdfClient(key); }}Coloque rustedf.key no application.properties como rustedf.key=${RUSTEDF_KEY}, para que o
valor venha do ambiente.
Para enviar HTML em vez do id de um template salvo, use uma entrada html no lugar de
template_id. Passe tudo o que um usuário digitou por data, e não dentro da string de HTML: os
valores em data são escapados, e o próprio HTML é lido como um template.
Tentar de novo quando o serviço está ocupado
Um 429 (limite de requisições) ou um 503 (ocupado) traz um cabeçalho Retry-After. Uma geração
que falha não custa crédito, então tentar de novo é seguro: leia
response.headers().firstValue("Retry-After"), espere esse número de segundos e envie a
requisição de novo, um número limitado de vezes.
Erros que vale tratar
| Status | code |
O que fazer |
|---|---|---|
| 401 | unauthorized |
A chave está ausente, errada ou revogada. |
| 402 | insufficient_credits |
Os créditos acabaram. Nada foi gerado. |
| 422 | invalid_template |
O template ou os dados falharam. Leia a message. |
| 429 | rate_limited |
Espere o Retry-After e tente de novo. |
| 503 | busy |
O serviço está ocupado. Espere o Retry-After e tente de novo. |
| 504 | render_timeout |
O documento levou mais do que o seu plano permite. |
Rode POST /v1/validate com o mesmo corpo enquanto monta o template: ele lista tudo o que o
serviço não suportou por completo, sem devolver o PDF nem usar crédito.
Leia Gerar um PDF, Autenticação e Erros e limites.
Continue lendo
Código e integrações
Gerar PDF no ASP.NET Core: MVC, Razor Pages e minimal APIs
Transforme uma view Razor em PDF no ASP.NET Core com uma chamada de API: renderizador de views, view pronta para impressão, action MVC e handler do Razor Pages.
3 min de leitura
Código e integrações
Converter página web em PDF em C# sem navegador headless
Busque uma página com HttpClient e transforme o HTML em PDF com uma chamada de API em C#. Quais páginas isso atende, quais não e como conferir antes de depender.
3 min de leitura
Código e integrações
Gerador de relatório PDF em C#: tabela paginada com totais
Monte um relatório em PDF em C# a partir de uma lista de objetos: tabela com cabeçalho repetido em cada página, total, número de página e contagem de páginas.
3 min de leitura
Código e integrações
Salvar PDF em C#: em disco, como download ou em blob storage
Salve o PDF devolvido por uma chamada de renderização em C#: grave em disco, envie como download no ASP.NET Core, guarde um link assinado ou suba para o storage.
2 min de leitura