A Guide to Upload Files to Amazon S3 Bucket Using Spring Boot

Overview

In today’s digital landscape, managing and storing files scalable and cost-effectively is a crucial aspect of many software applications. Amazon Web Services (AWS) Simple Storage Service (S3) offers a versatile solution for storing and retrieving files securely in the cloud. Integrating AWS S3 with a powerful framework like Spring Boot can provide developers an efficient and streamlined way to handle file uploads within their applications.

Pioneers in Cloud Consulting & Migration Services

Reduced infrastructural costs
Accelerated application deployment

Get Started

Introduction

With the knowledge of Amazon S3, using SpringBoot will help effortlessly implement file uploads. This powerful combination simplifies the file management process and provides a secure and reliable way to store and retrieve files, ensuring that your application is well-prepared to meet the demands of modern, data-intensive web applications. In this blog, we will explore between Spring Boot and Amazon S3 for efficient file uploads.

Pre-requisites

Some knowledge of Java and Spring Boot
The Java Development Kit is already installed on your computer
An IDE

Step-by-Step Guide

Before we start developing our application, register for an account on the Amazon Console. For a full year, you can utilize any of Amazon’s online services at no cost to you to test them out.

Go to the Amazon console after signing up and use the search box to check for Amazon S3 there.

Step 1 – Amazon S3 Bucket

After choosing Amazon S3 in the preceding step, create a new Amazon S3 bucket to hold the files we will upload from our application.

step1

Step 2 – Access and secret keys

Create a new access key using the My Security Credentials navigation option. Copy the access and the created secret key since we will use them to access the bucket from the application we are building.

step2

Step 3 – Creating the application

We’re going to use Spring initializr to create our application. To produce the project, create a new Spring Boot application in spring initializr, then add the dependencies for h2, spring boot dev tools, spring data jpa, and spring web.

step3

Unzipping the downloaded project will allow you to launch your favorite IDE.

Step 4 – Adding a reliance on Amazon SDK

Due to the Amazon SDK, our apps can interface with many Amazon services. As shown below, include the Amazon SDK requirement in the pom.xml file.

<dependency>
    <groupId>com.amazonaws</groupId>
    <artifactId>aws-java-sdk</artifactId>
    <version>1.12.99</version> <!-- Use the latest version -->
</dependency>

<groupId>com.amazonaws</groupId>

</dependency>

Step 5 – Create a Configuration Bean

Make a configuration bean to set up the AmazonS3 client. The ‘BasicAWSCredentials’ class can pass your AWS access and secret keys.

import com.amazonaws.auth.BasicAWSCredentials;
import com.amazonaws.services.s3.AmazonS3;
import com.amazonaws.services.s3.AmazonS3Client;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
 
@Configuration
public class AmazonS3Config {
 
    @Value("${aws.accessKey}")
    private String accessKey;
 
    @Value("${aws.secretKey}")
    private String secretKey;
 
    @Value("${aws.s3.region}")
    private String region;
 
    @Bean
    public AmazonS3 amazonS3() {
        BasicAWSCredentials credentials = new BasicAWSCredentials(accessKey, secretKey);
        return AmazonS3Client.builder()
                .withRegion(region)
                .withCredentials(new AWSStaticCredentialsProvider(credentials))
                .build();
    }
}

import com.amazonaws.auth.BasicAWSCredentials;

import com.amazonaws.services.s3.AmazonS3;

import com.amazonaws.services.s3.AmazonS3Client;

import org.springframework.beans.factory.annotation.Value;

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.Configuration;

@Configuration

public class AmazonS3Config {

@Value("${aws.accessKey}")

private String accessKey;

@Value("${aws.secretKey}")

private String secretKey;

@Value("${aws.s3.region}")

private String region;

@Bean

public AmazonS3 amazonS3() {

BasicAWSCredentials credentials = new BasicAWSCredentials(accessKey, secretKey);

return AmazonS3Client.builder()

.withRegion(region)

.withCredentials(new AWSStaticCredentialsProvider(credentials))

.build();

}

Upload Service:

Utilizing the AmazonS3 client, create a service class that manages the file upload logic.

import com.amazonaws.services.s3.AmazonS3;
import com.amazonaws.services.s3.model.PutObjectRequest;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Service;
import org.springframework.web.multipart.MultipartFile;
import java.io.IOException;
 
@Service
public class S3FileUploadService {
 
    @Autowired
    private AmazonS3 amazonS3;
 
    @Value("${aws.s3.bucketName}")
    private String bucketName;
 
    public void uploadFile(String key, MultipartFile file) throws IOException {
        PutObjectRequest putObjectRequest = new PutObjectRequest(bucketName, key, file.getInputStream(), null);
        amazonS3.putObject(putObjectRequest);
    }
}

import com.amazonaws.services.s3.AmazonS3;

import com.amazonaws.services.s3.model.PutObjectRequest;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.beans.factory.annotation.Value;

import org.springframework.stereotype.Service;

import org.springframework.web.multipart.MultipartFile;

import java.io.IOException;

@Service

public class S3FileUploadService {

@Autowired

private AmazonS3 amazonS3;

@Value("${aws.s3.bucketName}")

private String bucketName;

public void uploadFile(String key, MultipartFile file) throws IOException {

PutObjectRequest putObjectRequest = new PutObjectRequest(bucketName, key, file.getInputStream(), null);

amazonS3.putObject(putObjectRequest);

}

Controller:

Create a controller that allows file uploads and uses the ‘S3FileUploadService’ to upload the files to the Amazon S3 bucket.

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;
import java.io.IOException;
 
@RestController
@RequestMapping("/api")
public class FileUploadController {
 
    @Autowired
    private S3FileUploadService fileUploadService;
 
    @PostMapping("/upload")
    public String uploadFile(@RequestParam("file") MultipartFile file) {
        try {
            fileUploadService.uploadFile(file.getOriginalFilename(), file);
            return "File uploaded successfully!";
        } catch (IOException e) {
            return "Error uploading file: " + e.getMessage();
        }
    }
}

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.web.bind.annotation.*;

import org.springframework.web.multipart.MultipartFile;

import java.io.IOException;

@RestController

@RequestMapping("/api")

public class FileUploadController {

@Autowired

private S3FileUploadService fileUploadService;

@PostMapping("/upload")

public String uploadFile(@RequestParam("file") MultipartFile file) {

try {

fileUploadService.uploadFile(file.getOriginalFilename(), file);

return "File uploaded successfully!";

} catch (IOException e) {

return "Error uploading file: " + e.getMessage();

}

Note: As you configure your application, be sure to replace placeholders like ${aws.accessKey}, ${aws.secretKey}, ${aws.s3.region}, and ${aws.s3.bucketName} with the correct values.

Conclusion

Utilizing Spring Boot to upload files to an Amazon S3 bucket empowers developers to create robust, scalable, and secure applications that efficiently manage and store various data assets. This integration represents a powerful combination of tools that can greatly enhance the capabilities of modern web and cloud-based applications.

Drop a query if you have any questions regarding Amazon S3 and we will get back to you quickly.

Making IT Networks Enterprise-ready – Cloud Management Services

Accelerated cloud migration
End-to-end view of the cloud environment

Get Started

About CloudThat

CloudThat is an official AWS (Amazon Web Services) Advanced Consulting Partner and Training partner, AWS Migration Partner, AWS Data and Analytics Partner, AWS DevOps Competency Partner, Amazon QuickSight Service Delivery Partner, AWS EKS Service Delivery Partner, and Microsoft Gold Partner, helping people develop knowledge of the cloud and help their businesses aim for higher goals using best-in-industry cloud computing practices and expertise. We are on a mission to build a robust cloud computing ecosystem by disseminating knowledge on technological intricacies within the cloud space. Our blogs, webinars, case studies, and white papers enable all the stakeholders in the cloud computing sphere.

To get started, go through our Consultancy page and Managed Services Package, CloudThat’s offerings.

FAQs

1. Why would one use Spring Boot to upload files to an Amazon S3 bucket?

ANS: – You may quickly store and retrieve data using the cloud storage service Amazon S3 (Simple Storage Service). You can increase scalability by offloading your application’s storage requirements to Amazon S3. The connectivity with Amazon S3 is simple due to Spring Boot.

2. Are there any security issues to be aware of while using Spring Boot to upload data to Amazon S3?

ANS: – Security is crucial, no doubt. Your AWS credentials should never be hardcoded or publicized in your source code. Instead, maintain credentials using environment variables, AWS IAM roles, or other safe techniques. Ensure your Amazon S3 bucket’s access controls are also set properly.