Downloading Files from an API Using Java's HttpClient

Downloading Files from an API

Welcome back! Today's focus will be on downloading files from an API using Java . Understanding how to retrieve files efficiently not only enhances your technical skills but also broadens your application's capabilities. In this lesson, we'll explore a practical scenario using a hypothetical To-Do list API . This API supports handling text files, such as notes, which can be downloaded or uploaded through the /notes endpoint. By the end of this lesson, you'll know how to request a file from an API, save it locally, and verify its contents. Let's dive into downloading files with precision and confidence using Java and its HttpClient!

Basic File Download with GET Requests

GET requests are fundamental for retrieving files from an API. When you send a GET request using Java's HttpClient, your client communicates with the server at a specified URL, asking it to provide the file. The server responds with the file data, if available and permissible, along with an HTTP status code (like 200 OK). Here's a basic example of downloading a file named welcome.txt from our API at http://localhost:8000/notes. This approach downloads the entire file at once, which is manageable for smaller files. Javaimport java.net.URI; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; import java.io.IOException; import java.nio.file.Files; import java.nio.file.Path; import java.nio.file.Paths; public class FileDownloader { public static void main(String[] args) { String baseUrl = "http://localhost:8000"; String noteName = "welcome.txt"; try { // Create HttpClient HttpClient client = HttpClient.newHttpClient(); // Build GET Request HttpRequest request = HttpRequest.newBuilder() .uri(URI.create(baseUrl + "/notes/" + noteName)) .build(); // Send Request and capture response HttpResponse<byte[]> response = client.send(request, HttpResponse.BodyHandlers.ofByteArray()); // Check if request was successful if (response.statusCode() == 200) { // Save file locally Path filePath = Paths.get("downloaded_" + noteName); Files.write(filePath, response.body()); } else { System.out.println("HTTP error occurred: " + response.statusCode()); } } catch (IOException | InterruptedException e) { System.out.println("An error occurred: " + e.getMessage()); } } } This code sends a GET request and writes the response content to a local file. This method works well for small files but can strain memory for larger files.

Join the 1M+ learners on CodeSignal

Be a part of our community of 1M+ users who develop and demonstrate their skills on CodeSignal

Leveraging GET Requests and Streaming

When dealing with large files, downloading them all at once can be inefficient and strain memory. To address this, Java's HttpClient allows handling the response as a stream using InputStream, which optimizes memory usage.

Below is a detailed code example demonstrating how to download the same file using streaming:

Java

import java.io.FileOutputStream;
import java.io.InputStream;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.file.Path;
import java.nio.file.Paths;

public class StreamFileDownloader {
    public static void main(String[] args) {
        String baseUrl = "http://localhost:8000";
        String noteName = "welcome.txt";

        try {
            // Create HttpClient
            HttpClient client = HttpClient.newHttpClient();

            // Build GET Request
            HttpRequest request = HttpRequest.newBuilder()
                    .uri(URI.create(baseUrl + "/notes/" + noteName))
                    .build();

            // Send request and print response
            HttpResponse<InputStream> response = client.send(request, HttpResponse.BodyHandlers.ofInputStream());

            // Handle response for successful download
            if (response.statusCode() == 200) {
                Path path = Paths.get("downloaded_" + noteName);
                try (InputStream inputStream = response.body();
                     FileOutputStream fileOutputStream = new FileOutputStream(path.toFile())) {
                    byte[] buffer = new byte[1024];
                    int bytesRead;
                    while ((bytesRead = inputStream.read(buffer)) != -1) {
                        fileOutputStream.write(buffer, 0, bytesRead);
                    }
                }
            } else {
                System.out.println("HTTP error occurred: " + response.statusCode());
            }
        } catch (IOException | InterruptedException e) {
            System.out.println("An error occurred: " + e.getMessage());
        }
    }
}

import java.io.FileOutputStream;
import java.io.InputStream;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.file.Path;
import java.nio.file.Paths;

public class StreamFileDownloader {
    public static void main(String[] args) {
        String baseUrl = "http://localhost:8000";
        String noteName = "welcome.txt";

        try {
            // Create HttpClient
            HttpClient client = HttpClient.newHttpClient();

            // Build GET Request
            HttpRequest request = HttpRequest.newBuilder()
                    .uri(URI.create(baseUrl + "/notes/" + noteName))
                    .build();

            // Send request and print response
            HttpResponse<InputStream> response = client.send(request, HttpResponse.BodyHandlers.ofInputStream());

            // Handle response for successful download
            if (response.statusCode() == 200) {
                Path path = Paths.get("downloaded_" + noteName);
                try (InputStream inputStream = response.body();
                     FileOutputStream fileOutputStream = new FileOutputStream(path.toFile())) {
                    byte[] buffer = new byte[1024];
                    int bytesRead;
                    while ((bytesRead = inputStream.read(buffer)) != -1) {
                        fileOutputStream.write(buffer, 0, bytesRead);
                    }
                }
            } else {
                System.out.println("HTTP error occurred: " + response.statusCode());
            }
        } catch (IOException | InterruptedException e) {
            System.out.println("An error occurred: " + e.getMessage());
        }
    }
}

FileOutputStream is used to write data to a file on disk.
The try-with-resources block (try (...) {...}) automatically closes the streams after the operation is complete, preventing resource leaks.
A buffer (byte[] buffer = new byte[1024]) is created to store chunks of data.
inputStream.read(buffer) reads up to 1024 bytes at a time from the response body.
If bytesRead == -1, it means end of file (EOF) is reached, and we stop reading.
fileOutputStream.write(buffer, 0, bytesRead); writes the read bytes into the file.

By utilizing streaming, even large files are downloaded efficiently. This approach is especially useful when file sizes increase.