Spring Boot Download CSV File Example

Welcome, in this tutorial, we will see how to download a CSV file in a spring boot application. We will use the postman tool to view the CSV data however you are free to enhance by adding a simple HTML page containing a link to download the CSV.

1. Introduction

Before going further in this tutorial, we will look at the common terminology such as introduction to Spring Boot and Lombok.

1.1 Spring Boot

1.2 Lombok

1.2.1 Lombok features

Feature Details
val Local variables are declared as final
var Mutable local variables
@Slf4J Creates an SLF4J logger
@Cleanup Will call close() on the resource in the finally block
@Getter Creates getter methods for all properties
@Setter Creates setter for all non-final properties
  • Generates implementations of equals(Object other) and hashCode()
  • By default will use all non-static, non-transient properties
  • Can optionally exclude specific properties
  • Generates String of class name, and each field separated by commas
  • Optional parameter to include field names
  • Optional parameter to include a call to the super toString method
  • Generates no-args constructor
  • Will cause compiler error if there are final fields
  • Can optionally force, which will initialize final fields with 0/false/null var – mutable local variables
  • Generates a constructor for all fields that are final or marked @NonNull
  • The constructor will throw a NullPointerException if any @NonNull fields are null val – local variables are declared final
  • Generates a constructor for all properties of the class
  • Any @NotNull properties will have null checks
  • Generates typical boilerplate code for POJOs
  • Combines – @Getter, @Setter, @ToString, @EqualsAndHashCode, @RequiredArgsConstructor
  • No constructor is generated if constructors have been explicitly declared
  • Implements the Builder pattern for object creation
  • The immutable variant of @Data
  • All fields are made private and final by default

Let us go ahead with the tutorial implementation but before going any further I’m assuming that you’re aware of the Spring boot basics.

2. Spring Boot Download CSV File Example

2.1 Tools Used for Spring boot application and Project Structure

We are using Eclipse Kepler SR2, JDK 8, and Maven. In case you’re confused about where you should create the corresponding files or folder, let us review the project structure of the spring boot application.

Fig. 1: Project structure

Let us start building the application!

3. Creating a Spring Boot application

Below are the steps involved in developing the application.

3.1 Maven Dependency

Here, we specify the dependency for the Spring boot (Web and JPA), Common Csv, H2 database, Java Faker, and Lombok. The updated file will have the following code.


<?xml version="1.0" encoding="UTF-8"?>
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
        <relativePath/> <!-- lookup parent from repository -->
    <description>Download csv in springboot application</description>

3.2 Application properties file

Create a new properties file at the location: DownloadCsvInSpringboot/src/main/resources/ and add the following code to it. Here we will define the H2 database connection, database creation, and h2 console details. You’re free to change the application or the database details as per your wish.


# h2 database settings
# db-creation settings
## browser url for h2 console - http://localhost:9800/h2-console

3.3 Java Classes

Let us write the important java class(es) involved in this application. For brevity, we will skip the following classes –

3.3.1 Implementation/Main class

Add the following code to the main class to bootstrap the application from the main method. Always remember, the entry point of the spring boot application is the class containing @SpringBootApplication annotation and the static main method.


package com.springboot.downloadcsv;
import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
//lombok annotation
//spring annotation
public class DownloadCsvInSpringbootApplication {
    public static void main(String[] args) {
        SpringApplication.run(DownloadCsvInSpringbootApplication.class, args);
        log.info("Download csv in springboot application started successfully");

3.3.2 Entity class

Add the following code to the entity class and the class will be annotated with the Spring JPA and Lombok annotations.


package com.springboot.downloadcsv.entity;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.stereotype.Component;
import javax.persistence.*;
import java.time.LocalDate;
//spring jpa annotations
@Table(name = "resident")
//lombok annotations
//spring annotation
public class Resident {
    @GeneratedValue(strategy = GenerationType.AUTO)
    int id;
    @Column(name = "full_name", nullable = false)
    String fullName;
    int age;
    String gender;
    @Column(name = "phone_number", unique = true)
    String phoneNumber;
    @Column(name = "email_address", nullable = false, unique = true)
    String emailAddress;
    @Column(name = "date_of_birth")
    LocalDate dateOfBirth;
    @Column(name = "home_address")
    String homeAddress;
    String nationality;

3.3.3 CSV service class

Add the following code to the CSV service class where the load() method will accept the residents list as an input argument and write the records to the ByteArrayInputStream stream.


package com.springboot.downloadcsv.service;
import com.springboot.downloadcsv.entity.Resident;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.csv.CSVFormat;
import org.apache.commons.csv.CSVPrinter;
import org.springframework.stereotype.Service;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.PrintWriter;
import java.util.Arrays;
import java.util.List;
//lombok annotation
//spring annotation
public class CsvService {
    private static final String[] HEADERS = {"Id", "Full name", "Age", "Gender", "Phone number",
            "Email address", "Date of birth", "Home address", "Nationality"};
    private static final CSVFormat FORMAT = CSVFormat.DEFAULT.withHeader(HEADERS);
    //load data into csv
    public ByteArrayInputStream load(final List<Resident> residents) {
        return writeDataToCsv(residents);
    //write data to csv
    private ByteArrayInputStream writeDataToCsv(final List<Resident> residents) {
        log.info("Writing data to the csv printer");
        try (final ByteArrayOutputStream stream = new ByteArrayOutputStream();
             final CSVPrinter printer = new CSVPrinter(new PrintWriter(stream), FORMAT)) {
            for (final Resident resident : residents) {
                final List<String> data = Arrays.asList(
            return new ByteArrayInputStream(stream.toByteArray());
        } catch (final IOException e) {
            throw new RuntimeException("Csv writing error: " + e.getMessage());

3.3.4 Controller class

Add the following code to the controller class. The class is injected with the Resident service layer dependency to call the DAO layer methods and the CSV service dependency to prepare the data and return a ByteArrayInputStream stream for further use.


package com.springboot.downloadcsv.controller;
import com.springboot.downloadcsv.entity.Resident;
import com.springboot.downloadcsv.service.CsvService;
import com.springboot.downloadcsv.service.ResidentService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.io.InputStreamResource;
import org.springframework.core.io.Resource;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;
import java.util.List;
//note - for simplicity we have removed the ui configuration.
//you're free to add the code changes for the ui (thymeleaf configuration).
//lombok annotation
//spring annotations
public class CsvController {
    ResidentService service;
    CsvService csvService;
    //get all residents from db
    //URL - http://localhost:9800/api/get-residents
    public List<Resident> getResidents() {
        log.info("Get all residents");
        return service.getResidents();
    // download all residents info from db
    //URL - http://localhost:9800/api/download-residents-csv
    //note - incoming request to contain the mandatory "Content-disposition" and "Content-Type" headers
    public ResponseEntity<Resource> getCsv(
            @RequestHeader(name = "Content-disposition") final String fileName,
            @RequestHeader(name = "Content-Type") final String mediaType) {
        log.info("Downloading residents csv");
        final List<Resident> residents = service.getResidents();
        final InputStreamResource resource = new InputStreamResource(csvService.load(residents));
        return ResponseEntity.ok()
                .header(HttpHeaders.CONTENT_DISPOSITION, fileName)

4. Run the Application

To execute the application, right-click on the DownloadCsvInSpringbootApplication.java class, Run As -> Java Application.

Fig. 2: Run the Application

6. Project Demo

When the application is started, open the Postman tool to hit the application endpoints to either fetch the data from the DB and return in a JSON format or to download the data in a CSV format.

Application endpoints

-- HTTP GET endpoint (get all residents from db in json format) –
-- HTTP GET endpoint (to download the data in CSV format) –
-- note - incoming request to contain the mandatory "Content-disposition" and "Content-Type" headers --

That is all for this tutorial and I hope the article served you whatever you were looking for. Happy Learning and do not forget to share!

7. Summary

In this section, you learned,

You can download the sample application as an Eclipse project in the Downloads section.

8. Download the Project

This was an example of download data in a CSV in a spring boot application.

You can download the full source code of this example here: Spring Boot Download CSV File Example
Exit mobile version