S3 SDK 의존성추가
우선 Amazon S3 SDK 의존성을 추가한다.
implementation platform('software.amazon.awssdk:bom:2.17.230')
implementation 'software.amazon.awssdk:s3'환경변수 및 yml 설정
그 다음, @ConfigurationProperties 와 @NestedConfigurationProperty 를 통해 프로젝트에서 사용할 Environment 를 설정한다.
@ConfigurationProperties("onsquad.aws")
public record S3BucketProperties(
@NestedConfigurationProperty S3 s3
) {
@ConfigurationProperties("s3")
public record S3(
String bucket,
String region,
String accessKey,
String secretKey,
@NestedConfigurationProperty DirectoryProperties directory
) {}
@ConfigurationProperties("directory")
public record DirectoryProperties(
String root,
@NestedConfigurationProperty Directories directories
) {
}
@ConfigurationProperties("directories")
public record Directories(
String crewDirectory,
String squadDirectory
) {
}
}위와 같이 설정을 완료하였으면 해당 설정에 대한 값들을 key: value 형태로 application.yml 에 작성하면 된다.
onsquad:
aws:
s3:
access-key: <액세스 키>
secret-key: <시크릿 키>
bucket: <버킷 이름>
region: <리전>
directory:
root: <루트 디렉터리 without slash> # ex. root not /root
directories:
crew-directory: <경로 1> # ex. sub1/sub2 not /sub1/sub2
squad-directory: <경로 2> # ex. sub1/sub2 not /sub1/sub2S3 설정파일 작성
Amazon S3 SDK 를 사용하기 위한 기본설정을 한다. region, Credential(액세스 키, 시크릿 키) 정보로 S3Client 객체를 Bean 으로 등록하면 된다.
@RequiredArgsConstructor
@Configuration
public class S3ClientConfig {
private final S3BucketProperties s3BucketProperties;
@Bean
public S3Client amazonS3(){
AwsBasicCredentials credentials = AwsBasicCredentials.create(
s3BucketProperties.s3().accessKey(), s3BucketProperties.s3().secretKey()
);
return S3Client.builder()
.region(Region.of(s3BucketProperties.s3().region()))
.credentialsProvider(StaticCredentialsProvider.create(credentials))
.build();
}
}Uploader 코드 작성
S3Client 를 주입받아 S3 에 업로드하는 코드를 짜주면 된다. 참고로 파일을 업로드 와 파일 업데이트 는 동일함에 주의해야 한다. 정확히는 이미 존재하는 경로에 또 다른 파일을 업로드하면, 새로 업로드된 파일로 Overwrite 되는 원리이다.
리팩토링 전
해당 클래스는 매우 좋지 않다.
해당 클래스는 정상적으로 작동하는것에 의미를 두고 작성한 것이다. TODO 로 이미 표시를 해놨지만, Crew, Squad 와 같은 기능이 많아질수록 uploadCrew, uploadSquad 와 같은 이상한 메서드들이 많아지게 된다. 이는 기능확장을 할때 OCP 를 지킬 수 없게 되기 때문에 꼭 리팩토링 해야 한다.
// TODO 리팩토링 필요. 해당 클래스 코드 매우 안좋음
@Slf4j
@RequiredArgsConstructor
@Component
public class S3BucketUploader {
private static final String PATH_DELIMITER = "/";
private static final String FILE_EXTENSION_DELIMITER = ".";
private static final String S3_LINK_FORMAT = "https://%s.s3.%s.amazonaws.com/%s"; // https://{bucketName}.s3.{region}.amazonaws.com/{path}
private final S3BucketProperties s3BucketProperties;
private final S3Client s3Client;
public String uploadCrew(byte[] content, String originalFileName) { // TODO 확장할 여지가 있을 때 객체지향적으로 해결하여 OCP 를 지켜야 한다.
Directories directories = s3BucketProperties.s3().directory().directories();
return uploadImage(directories.crewDirectory(), content, originalFileName);
}
public String uploadSquad(byte[] content, String originalFileName) { // TODO 확장할 여지가 있을 때 객체지향적으로 해결하여 OCP 를 지켜야 한다.
Directories directories = s3BucketProperties.s3().directory().directories();
return uploadImage(directories.squadDirectory(), content, originalFileName);
}
public String uploadImage(String directoryPath, byte[] content, String originalFileName) {
AttachmentMagicByteValidator.validateMagicByte(content);
try (InputStream inputStream = new ByteArrayInputStream(content)) {
RequestBody requestBody = RequestBody.fromInputStream(inputStream, content.length);
MediaType mediaType = MediaType.parseMediaType(Files.probeContentType(Paths.get(originalFileName)));
return uploadFile(directoryPath, originalFileName, requestBody, mediaType);
} catch (IOException e) {
log.error("{} s3 업로드 실패", directoryPath, e);
throw new IllegalArgumentException("byte array s3업로드 예외", e);
}
}
private String uploadFile(String directoryPath, String originalFileName, RequestBody requestBody, MediaType mediaType) {
S3 s3 = s3BucketProperties.s3();
String rootDirectory = s3.directory().root();
String randomFileName = generateUuidFileName(originalFileName);
String fileNameWithFullPath = String.join(PATH_DELIMITER, rootDirectory, directoryPath, randomFileName);
PutObjectRequest putObjectRequest = PutObjectRequest.builder()
.key(fileNameWithFullPath)
.contentType(mediaType.toString())
.bucket(s3.bucket())
.build();
s3Client.putObject(putObjectRequest, requestBody);
String uploadRemoteAddress = String.format(S3_LINK_FORMAT, s3.bucket(), s3.region(), fileNameWithFullPath);
log.info("file uploaded : {}", uploadRemoteAddress);
return uploadRemoteAddress;
}
public void updateImage(String remoteAddress, byte[] imageData, String imageName) {
AttachmentMagicByteValidator.validateMagicByte(imageData);
try (InputStream inputStream = new ByteArrayInputStream(imageData)) {
S3 s3 = s3BucketProperties.s3();
RequestBody requestBody = RequestBody.fromInputStream(inputStream, imageData.length);
MediaType mediaType = MediaType.parseMediaType(Files.probeContentType(Paths.get(imageName)));
String uri = parseUriFromUrl(remoteAddress);
PutObjectRequest putObjectRequest = PutObjectRequest.builder()
.key(uri)
.contentType(mediaType.toString())
.bucket(s3.bucket())
.build();
s3Client.putObject(putObjectRequest, requestBody);
} catch (IOException e) {
throw new IllegalArgumentException("byte array s3업로드 예외", e);
}
}
private String generateUuidFileName(String originalFileName) {
int delimeterIndex = originalFileName.lastIndexOf(FILE_EXTENSION_DELIMITER) + 1;
String extension = originalFileName.substring(delimeterIndex);
return UUID.randomUUID() + FILE_EXTENSION_DELIMITER + extension;
}
private String parseUriFromUrl(String remoteAddress) {
try {
URL url = new URL(remoteAddress);
String path = url.getPath();
if (path != null && path.length() > 1) {
return path.substring(1);
}
return path;
} catch (MalformedURLException e) {
throw new IllegalArgumentException("Invalid URL", e);
}
}
}리팩토링 후
비교
{
"Version": "2012-10-17",
"Id": "Policy1464968545158",
"Statement": [
{
"Sid": "PublicReadGetObject",
"Effect": "Allow",
"Principal": "*",
"Action": "s3:GetObject",
"Resource": "arn:aws:s3:::onsquad-s3/*"
},
{
"Sid": "DenyOtherAccess",
"Effect": "Deny",
"Principal": "*",
"Action": "s3:PutObject",
"NotResource": [
"arn:aws:s3:::onsquad-s3/*.jpg",
"arn:aws:s3:::onsquad-s3/*.png",
"arn:aws:s3:::onsquad-s3/*.jpeg",
"arn:aws:s3:::onsquad-s3/*.svg"
]
}
]
}{
"Version": "2012-10-17",
"Id": "Policy1464968545158",
"Statement": [
{
"Sid": "PublicReadGetObject",
"Effect": "Allow", // 허용
"Principal": "*",
"Action": "s3:GetObject", // 객체 읽기 권한
"Resource": "arn:aws:s3:::<버킷명>/*"
},
{
"Sid": "DenyOtherAccess",
"Effect": "Deny", // 차단
"Principal": "*",
"Action": "s3:PutObject", // 객체 업로드 권한
"NotResource": [
"arn:aws:s3:::<버킷명>/*.jpg",
"arn:aws:s3:::<버킷명>/*.png",
"arn:aws:s3:::<버킷명>/*.jpeg",
"arn:aws:s3:::<버킷명>/*.gif"
] // 해당 확장자를 가지지 않은 객체
}
]
}https://docs.aws.amazon.com/ko_kr/sdk-for-java/latest/developer-guide/java_s3_code_examples.html