Spring Boot와 S3 연동하여 파일 저장하기

S3 - Simple Storage Service

https 형태의 API로 데이터를 저장하거나 추출하게 해주는 웹서비스
웹 상의 영역(bucket)에 우리의 데이터(객체)를 저장

Setting

build.gradle

repositories {
    mavenCentral()
    maven { url 'https://repo.spring.io/snapshot' }
}

ext {
    set('springCloudVersion', "Greenwich.BUILD-SNAPSHOT")
}

dependencies {
    implementation 'org.springframework.cloud:spring-cloud-starter-aws'
}

dependencyManagement {
    imports {
        mavenBom "org.springframework.cloud:spring-cloud-dependencies:${springCloudVersion}"
    }
}

application.yml
```
cloud:
  aws:
    stack:
      auto: false
    s3:
      bucket: woowa-turkey
    region:
      static: ap-northeast-2
    credentials:
      accessKey: [발급받은 accessKey]
      secretKey: [발급받은 secretKey]
```
프로젝트 배포시 기본으로 CloudFormation 구성을 시작하기 때문에 설정한 CloudFormation이 없으면 프로젝트 실행이 되지 않음. 해당 기능을 사용하지 않도록 false로 설정. (출처: https://private.tistory.com/76)

credentials 설정 같은 경우 git 저장소에 올라가 공개되지 않도록 별도의 파일에 작성한 다음 .gitignore에 등록할 것

code

Configuration

@Configuration
public class AwsConfig {
    @Value("${amazonProperties.accessKey}")
    private String accessKey;
    @Value("${amazonProperties.secretKey}")
    private String secretKey;
    @Value("${cloud.aws.region.static}")
    private String region;
    
    @Bean
    public BasicAWSCredentials basicAWSCredentials() {
        return new BasicAWSCredentials(accessKey, secretKey);
    }

    @Bean
    public AmazonS3 amazonS3Client() {
        return AmazonS3ClientBuilder.standard()
                .withCredentials(new AWSStaticCredentialsProvider(awsCredentials))
                .withRegion(region)
                .build();
    }
}

S3Uploader

@Component
public class S3Uploader {

    private final AmazonS3Client amazonS3Client;

    @Value("${cloud.aws.s3.bucket}")
    private String bucket;

    private String upload(File uploadFile, String fileName) {
        amazonS3Client.putObject(new PutObjectRequest(bucket, fileName, uploadFile).withCannedAcl(CannedAccessControlList.PublicRead));
        return amazonS3Client.getUrl(bucket, fileName).toString();
    }

}

MockS3

테스트를 할 때, 실제 S3 저장소를 활용하는 것이 아닌 Mock을 활용해 테스트

build.gradle

dependencies {
    testImplementation 'io.findify:s3mock_2.12:0.2.5'
}

TestConfiguration

@TestConfiguration
public class AwsMockConfig {

    public static final String S3MOCK_ENDPOINT = "http://localhost:8001";

    @Value("${cloud.aws.region.static}")
    private String region;

    @Bean
    public S3Mock s3Mock() {
        return new S3Mock.Builder().withPort(8001).withInMemoryBackend().build();
    }

    @Bean
    @Primary
    public AmazonS3 amazonS3(S3Mock s3Mock) {
        s3Mock.start();
        AwsClientBuilder.EndpointConfiguration endpoint = new AwsClientBuilder.EndpointConfiguration(S3MOCK_ENDPOINT, region);
        AmazonS3 client = AmazonS3ClientBuilder
                .standard()
                .withPathStyleAccessEnabled(true)
                .withEndpointConfiguration(endpoint)
                .withCredentials(new AWSStaticCredentialsProvider(new AnonymousAWSCredentials()))
                .build();
        client.createBucket(bucket);

        return client;
    }
}

Example (S3UploaderTest)

@Import(AwsMockConfig.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
class S3UploaderTest {

    @Autowired
    private S3Uploader s3Uploader;

    @Autowired
    private AmazonS3 mockS3Client;

    @Autowired
    private String bucket;

    private ByteArrayResource testFile = new ByteArrayResource(new byte[]{1, 2, 3, 4}) {
        @Override
        public String getFilename() {
            return "test_file.jpg";
        }
    };
    private String fileName = "savedFileName";

    @Test
    void 파일_업로드_테스트() throws IOException {
        //when
        String savedUrl = s3Uploader.upload(testFile, fileName);

        // then
        String resourceUrl = String.format("%s/%s/%s", S3MOCK_ENDPOINT, bucket, fileName);
        assertThat(savedUrl).isEqualTo(resourceUrl);
    }
}