3/25/2020 Spring Boot Serve PDF tutorial - creating PDF report in Spring Boot

Home Subscrib

Creating PDF report in Spring Boot

Spring Boot Serve PDF report tutorial shows how to serve PDF file in Spring Boot web application. The
report is generated with iText library.

Like 4 Share Tweet

iText is an open source library for creating and manipulating PDF files in Java.

Spring is a Java application framework for developing Java enterprise applications. It also helps
integrate various enterprise components. Spring Boot makes it easy to create Spring-powered,
production-grade applications and services with minimum setup requirements.

H2 is an open source relational database management system implemented entirely in Java. It can be
embedded in Java applications or run in the client-server mode. It has small footprint and is easy to
deploy and install. It contains a browser based console application for viewing and editing datatabase
tables.

Spring Data JPA is part of the umbrella Spring Data project that makes it easier to implement JPA base
repositories. Spring Data JPA uses JPA to store data in a relational database. It can create repository
implementations automatically, at runtime, from a repository interface.

Spring Boot Serve PDF example

The following Spring Boot application loads data from a database table and produces a PDF report from
it with iText library. It uses ResponseEntity and InputStreamResource to send PDF data to the clien

pom.xml
src
├───main
│ ├───java
│ │ └───com
│ │ └───zetcode
│ │ │ Application.java
│ │ ├───controller
│ │ │ MyController.java
│ │ ├───model
│ │ │ City.java
│ │ ├───repository
│ │ │ CityRepository.java
│ │ ├───service
│ │ │ CityService.java
│ │ │ ICityService.java
zetcode.com/springboot/servepdf/ 1/11
3/25/2020 Spring Boot Serve PDF tutorial - creating PDF report in Spring Boot

│ │ └───util
│ │ GeneratePdfReport.java
│ └───resources
│ application.yml
│ import.sql
└───test
└───java

This is the project structure.

pom.xml

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<groupId>com.zetcode</groupId>
<artifactId>springbootservepdf</artifactId>
<version>1.0-SNAPSHOT</version>

<packaging>jar</packaging>

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.source>11</maven.compiler.source>
<maven.compiler.target>11</maven.compiler.target>
</properties>

<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.5.RELEASE</version>
</parent>

<dependencies>

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>

<dependency>
<groupId>com.lowagie</groupId>
<artifactId>itext</artifactId>
<version>4.2.2</version>
</dependency>

<dependency>
<groupId>com.h2database</groupId>
<artifactId>h2</artifactId>
<scope>runtime</scope>
</dependency>

zetcode.com/springboot/servepdf/ 2/11
3/25/2020 Spring Boot Serve PDF tutorial - creating PDF report in Spring Boot

</dependencies>

<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>

</project>

This is the Maven build file.

Spring Boot starters are a set of useful dependency descriptors which greatly simplify Maven
configuration. The spring-boot-starter-parent has some common configurations for a Spring Boot
application. The spring-boot-starter-web is a starter for building web applications with Spring MVC
It uses Tomcat as the default embedded container. The spring-boot-starter-data-jpa is a starter fo
using Spring Data JPA with Hibernate.

In addition, we include dependencies for H2 database and iText library.

The spring-boot-maven-plugin provides Spring Boot support in Maven, allowing us to package

executable JAR or WAR archives. Its spring-boot:run goal runs the Spring Boot application.

com/zetcode/model/City.java

package com.zetcode.model;

import java.util.Objects;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Table;

@Entity
@Table(name = "cities")
public class City {

@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;

private String name;

private int population;

public City() {
}

public City(String name, int population) {

this.name = name;
this.population = population;
}

zetcode.com/springboot/servepdf/ 3/11
3/25/2020 Spring Boot Serve PDF tutorial - creating PDF report in Spring Boot

public Long getId() {

return id;
}

public void setId(Long id) {

this.id = id;
}

public String getName() {

return name;
}

public void setName(String name) {

this.name = name;
}

public int getPopulation() {

return population;
}

public void setPopulation(int population) {

this.population = population;
}

@Override
public int hashCode() {
int hash = 7;
hash = 79 * hash + Objects.hashCode(this.id);
hash = 79 * hash + Objects.hashCode(this.name);
hash = 79 * hash + this.population;
return hash;
}

@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
final City other = (City) obj;
if (this.population != other.population) {
return false;
}
if (!Objects.equals(this.name, other.name)) {
return false;
}
return Objects.equals(this.id, other.id);
}

@Override
public String toString() {

var builder = new StringBuilder();

builder.append("City{id=").append(id).append(", name=")
.append(name).append(", population=")

zetcode.com/springboot/servepdf/ 4/11
3/25/2020 Spring Boot Serve PDF tutorial - creating PDF report in Spring Boot

.append(population).append("}");

return builder.toString();
}
}

This is the City entity. Each entity must have at least two annotations defined: @Entity and @Id. The
default value of the spring.jpa.hibernate.ddl-auto property is create-drop which means that
Hibernate will create the table schema from this entity.

@Entity
@Table(name = "cities")
public class City {

The @Entity annotation specifies that the class is an entity and is mapped to a database table. The
@Table entity specifies the name of the database table to be used for mapping.

@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;

The @Id annotation specifies the primary key of an entity and the @GeneratedValue provides for the
specification of generation strategies for the values of primary keys.

resources/application.yml

spring:
main:
banner-mode: "off"

logging:
level:
org:
springframework: ERROR

The application.yml is the main Spring Boot configuration file. With the banner-mode property we
turn off the Spring banner. The spring framework logging is set to ERROR.

resources/import.sql

INSERT INTO cities(name, population) VALUES('Bratislava', 432000);

INSERT INTO cities(name, population) VALUES('Budapest', 1759000);
INSERT INTO cities(name, population) VALUES('Prague', 1280000);
INSERT INTO cities(name, population) VALUES('Warsaw', 1748000);
INSERT INTO cities(name, population) VALUES('Los Angeles', 3971000);
INSERT INTO cities(name, population) VALUES('New York', 8550000);
INSERT INTO cities(name, population) VALUES('Edinburgh', 464000);
INSERT INTO cities(name, population) VALUES('Suzhou', 4327066);
INSERT INTO cities(name, population) VALUES('Zhengzhou', 4122087);
INSERT INTO cities(name, population) VALUES('Berlin', 3671000);
INSERT INTO cities(name, population) VALUES('Brest', 139163);
INSERT INTO cities(name, population) VALUES('Bucharest', 1836000);

zetcode.com/springboot/servepdf/ 5/11
3/25/2020 Spring Boot Serve PDF tutorial - creating PDF report in Spring Boot

The schema is automatically created by Hibernate; later, the import.sql file is executed to fill the table
with data.

com/zetcode/repository/CityRepository.java

package com.zetcode.repository;

import com.zetcode.model.City;
import org.springframework.data.repository.CrudRepository;
import org.springframework.stereotype.Repository;

@Repository
public interface CityRepository extends CrudRepository<City, Long> {

By extending from the Spring CrudRepository, we have some methods for our data repository
implemented, including findAll() and findOne(). This way we do not have to write a lot of boilerplat
code.

com/zetcode/service/ICityService.java

package com.zetcode.service;

import com.zetcode.model.City;
import java.util.List;

public interface ICityService {

List<City> findAll();
}

ICityService provides a contract method to get all cities from the database.

com/zetcode/service/CityService.java

package com.zetcode.service;

import com.zetcode.model.City;
import com.zetcode.repository.CityRepository;
import java.util.List;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class CityService implements ICityService {

@Autowired
private CityRepository repository;

@Override
public List<City> findAll() {

return (List<City>) repository.findAll();

}
}

zetcode.com/springboot/servepdf/ 6/11
3/25/2020 Spring Boot Serve PDF tutorial - creating PDF report in Spring Boot

CityService contains the implementation of the findAll() method. We use repository to retrieve dat
from the database.

@Autowired
private CityRepository repository;

CityRepository is injected.

return (List<City>) repository.findAll();

The findAll() method of the repository returns the list of cities.

com/zetcode/controller/MyController.java

package com.zetcode.controller;

import com.zetcode.model.City;
import com.zetcode.service.ICityService;
import com.zetcode.util.GeneratePdfReport;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.io.InputStreamResource;
import org.springframework.http.HttpHeaders;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

import java.io.ByteArrayInputStream;
import java.util.List;

@Controller
public class MyController {

@Autowired
private ICityService cityService;

@RequestMapping(value = "/pdfreport", method = RequestMethod.GET,

produces = MediaType.APPLICATION_PDF_VALUE)
public ResponseEntity<InputStreamResource> citiesReport() {

var cities = (List<City>) cityService.findAll();

ByteArrayInputStream bis = GeneratePdfReport.citiesReport(cities);

var headers = new HttpHeaders();

headers.add("Content-Disposition", "inline; filename=citiesreport.pdf");

return ResponseEntity
.ok()
.headers(headers)
.contentType(MediaType.APPLICATION_PDF)
.body(new InputStreamResource(bis));
}
}

zetcode.com/springboot/servepdf/ 7/11
3/25/2020 Spring Boot Serve PDF tutorial - creating PDF report in Spring Boot

The citiesReport() method returns the generated PDF report. The Resource interface abstracts acce
to low-level resources; InputStreamResource is its implementation for stream resources.

@Autowired
private ICityService cityService;

We inject ICityService object into the attribute. The service object is used to retrieve data from the
database.

var cities = (List<City>) cityService.findAll();

We find all cities with the findAll() method.

ByteArrayInputStream bis = GeneratePdfReport.citiesReport(cities);

The GeneratePdfReport.citiesReport() generates PDF file from the list of cities using iText library

HttpHeaders headers = new HttpHeaders();

headers.add("Content-Disposition", "inline; filename=citiesreport.pdf");

By setting the Content-Disposition to inline, the PDF file is shown directly in browser.

return ResponseEntity
.ok()
.headers(headers)
.contentType(MediaType.APPLICATION_PDF)
.body(new InputStreamResource(bis));

We create a response with ResponseEntity. We specify the headers, content type, and body. The conte
type is MediaType.APPLICATION_PDF. The body is an InputStreamResource.

com/zetcode/util/GeneratePdfReport.java

package com.zetcode.util;

import com.itextpdf.text.Document;
import com.itextpdf.text.DocumentException;
import com.itextpdf.text.Element;
import com.itextpdf.text.Font;
import com.itextpdf.text.FontFactory;
import com.itextpdf.text.Phrase;
import com.itextpdf.text.pdf.PdfPCell;
import com.itextpdf.text.pdf.PdfPTable;
import com.itextpdf.text.pdf.PdfWriter;
import com.zetcode.model.City;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.util.List;

public class GeneratePdfReport {

zetcode.com/springboot/servepdf/ 8/11
3/25/2020 Spring Boot Serve PDF tutorial - creating PDF report in Spring Boot

private static final Logger logger = LoggerFactory.getLogger(GeneratePdfReport.class);

public static ByteArrayInputStream citiesReport(List<City> cities) {

Document document = new Document();

ByteArrayOutputStream out = new ByteArrayOutputStream();

try {

PdfPTable table = new PdfPTable(3);

table.setWidthPercentage(60);
table.setWidths(new int[]{1, 3, 3});

Font headFont = FontFactory.getFont(FontFactory.HELVETICA_BOLD);

PdfPCell hcell;
hcell = new PdfPCell(new Phrase("Id", headFont));
hcell.setHorizontalAlignment(Element.ALIGN_CENTER);
table.addCell(hcell);

hcell = new PdfPCell(new Phrase("Name", headFont));

hcell.setHorizontalAlignment(Element.ALIGN_CENTER);
table.addCell(hcell);

hcell = new PdfPCell(new Phrase("Population", headFont));

hcell.setHorizontalAlignment(Element.ALIGN_CENTER);
table.addCell(hcell);

for (City city : cities) {

PdfPCell cell;

cell = new PdfPCell(new Phrase(city.getId().toString()));

cell.setVerticalAlignment(Element.ALIGN_MIDDLE);
cell.setHorizontalAlignment(Element.ALIGN_CENTER);
table.addCell(cell);

cell = new PdfPCell(new Phrase(city.getName()));

cell.setPaddingLeft(5);
cell.setVerticalAlignment(Element.ALIGN_MIDDLE);
cell.setHorizontalAlignment(Element.ALIGN_LEFT);
table.addCell(cell);

cell = new PdfPCell(new Phrase(String.valueOf(city.getPopulation())));

cell.setVerticalAlignment(Element.ALIGN_MIDDLE);
cell.setHorizontalAlignment(Element.ALIGN_RIGHT);
cell.setPaddingRight(5);
table.addCell(cell);
}

PdfWriter.getInstance(document, out);
document.open();
document.add(table);

document.close();

} catch (DocumentException ex) {

logger.error("Error occurred: {0}", ex);

}

zetcode.com/springboot/servepdf/ 9/11
3/25/2020 Spring Boot Serve PDF tutorial - creating PDF report in Spring Boot

return new ByteArrayInputStream(out.toByteArray());

}
}

GeneratePdfReport creates PDF file from the provided data.

ByteArrayOutputStream out = new ByteArrayOutputStream();

The data will be written to ByteArrayOutputStream.

PdfPTable table = new PdfPTable(3);

We put our data in a table; for this, we have the PdfPTable class. The table has three columns: Id, Nam
and Population.

Font headFont = FontFactory.getFont(FontFactory.HELVETICA_BOLD);

For the table header, we use bold Helvetica font.

PdfPCell hcell;
hcell = new PdfPCell(new Phrase("Id", headFont));
hcell.setHorizontalAlignment(Element.ALIGN_CENTER);
table.addCell(hcell);

The data is placed inside table cells, represented by PdfPCell. The text is horizontally aligned using the
setHorizontalAlignment() method.

PdfWriter.getInstance(document, out);

With PdfWriter, the document is written to the ByteArrayOutputStream.

document.open();
document.add(table);

The table is inserted into the PDF document.

document.close();

In order for the data to be written to the ByteArrayOutputStream, the document must be closed.

return new ByteArrayInputStream(out.toByteArray());

In the end, the data is returned as ByteArrayInputStream.

com/zetcode/Application.java

package com.zetcode;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
zetcode.com/springboot/servepdf/ 10/11
3/25/2020 Spring Boot Serve PDF tutorial - creating PDF report in Spring Boot

@SpringBootApplication
public class Application {

public static void main(String[] args) {

SpringApplication.run(Application.class, args);
}
}

The Application sets up the Spring Boot application.

$ mvn spring-boot:run

We start Spring Boot application.

We navigate to http://localhost:8080/pdfreport to generate the report.

In this tutorial, we have shown how to send a generated PDF file back to the client. The PDF report was
generated with iText and the data came an H2 database. We used Spring Data JPA to access data. You
might also be interested in these related tutorials: Spring Boot basic annotations, Spring Boot H2
tutorial, Spring Boot JasperReports web integration, Java tutorial, or list all Spring Boot tutorials.

Home Top of Page

ZetCode last modified June 3, 2019 © 2007 - 2020 Jan Bodnar Follow on Facebook

zetcode.com/springboot/servepdf/ 11/11