[박나경] sprint8#269
Conversation
application-dev.yaml, application-prod.yaml 파일 추가
- 커스텀 예외 설계 및 구현 - ErrorResponse 정의 - 예외 핸들러 구현
- Auth, User, Channel 관련 유효성 검사 어노테이션 적용
- 비공개 채널 생성 시 유저 존재 여부를 먼저 검증하도록 로직 순서 변경 - ChanelService의 create, update, delete, findByUserId 단위 테스트 추가
- 작성자 본인만 메시지를 수정 및 삭제할 수 있도록 검증 로직 추가 - MessageService의 create, update, delete, findByChannelId 단위 테스트 추가
- 테스트 환경 구축 - User, Channel, Message Repository 테스트 케이스 작성
- User, Channel, Message 컨트롤러 테스트 케이스 작성
- 요청 추적을 위한 MDCLoggingInterceptor 구현 - MDCLoggingInterceptor를 등록하기 위한 WebMvcConfig 구현
joonfluence
left a comment
joonfluence
left a comment
There was a problem hiding this comment.
전체 요약
Docker 컨테이너화, S3 스토리지 연동, AWS ECS 배포, GitHub Actions CI/CD 파이프라인까지 체계적으로 구현된 PR입니다. 멀티스테이지 빌드, MDC 로깅, 예외 계층 구조 등 좋은 시도가 많습니다. 다만 Public ECR 로그인 설정 오류와 presigned URL 만료시간 미적용 등 실제 동작에 영향을 주는 버그가 있어 수정이 필요합니다.
라인 특정 불가 코멘트
[p3] Dockerfile — Amazon Corretto 베이스 이미지 미사용
요구사항에서 "Amazon Corretto 17 이미지를 베이스 이미지로 사용하세요"라고 명시되어 있는데, eclipse-temurin을 사용했습니다. 기능상 차이는 거의 없지만 과제 요구사항과 일치시키는 것이 좋습니다.
FROM amazoncorretto:17-alpine AS builder
런타임 스테이지도 동일하게 변경해주세요: FROM amazoncorretto:17-alpine
| # 2. Private ECR 로그인 | ||
| - name: Amazon ECR 로그인 | ||
| id: login-ecr | ||
| uses: aws-actions/amazon-ecr-login@v2 |
There was a problem hiding this comment.
[p2] Public ECR을 사용하는데 Private ECR 로그인 액션을 사용하고 있습니다.
aws-actions/amazon-ecr-login@v2는 Private ECR 전용이라 실제 배포 시 인증 오류가 발생합니다. Public ECR은 별도의 액션과 us-east-1 리전이 필요합니다.
| uses: aws-actions/amazon-ecr-login@v2 | |
| - name: Amazon Public ECR 로그인 | |
| id: login-ecr | |
| uses: aws-actions/amazon-ecr-public-login@v1 | |
| with: | |
| aws-region: us-east-1 |
또한 위의 configure-aws-credentials 단계의 aws-region도 Public ECR 로그인 시 us-east-1로 설정하거나, 별도 step에서 자격증명을 설정해야 합니다.
| --cluster ${{ vars.ECS_CLUSTER }} \ | ||
| --service ${{ vars.ECS_SERVICE }} \ | ||
| --desired-count 0 | ||
|
|
There was a problem hiding this comment.
[p4] sleep 15는 ECS 태스크 종료를 보장하지 않습니다.
태스크 종료가 15초보다 늦어지면 다음 배포가 메모리 부족으로 실패할 수 있습니다. aws ecs wait tasks-stopped를 사용하면 더 안정적입니다.
| aws ecs wait services-stable \ | |
| --cluster ${{ vars.ECS_CLUSTER }} \ | |
| --services ${{ vars.ECS_SERVICE }} |
| build: . | ||
| container_name: discodeit-app | ||
| depends_on: # 의존성 설정 | ||
| - db # db 서비스가 먼저 시작되어야 에러가 안 뜸 |
There was a problem hiding this comment.
[p2] depends_on만으로는 PostgreSQL이 실제로 준비된 상태인지 보장되지 않습니다.
컨테이너가 시작됐다고 해서 DB가 쿼리를 받을 준비가 된 것은 아닙니다. 앱이 먼저 연결을 시도해 실패할 수 있습니다.
db 서비스에 healthcheck를 추가하고 조건을 지정해주세요:
db:
...
healthcheck:
test: ["CMD-SHELL", "pg_isready -U ${POSTGRES_USER} -d ${POSTGRES_DB}"]
interval: 10s
timeout: 5s
retries: 5그리고 depends_on을:
depends_on:
db:
condition: service_healthy| COPY --from=builder /build/build/libs/*.jar app.jar | ||
|
|
||
| # 컨테이너 실행 (JAVA_TOOL_OPTIONS 환경변수는 알아서 매핑) | ||
| ENTRYPOINT ["java", "-jar", "app.jar"] No newline at end of file |
There was a problem hiding this comment.
[p3] 요구사항에서 명시한 환경변수와 포트 설정이 누락되어 있습니다.
다음 3가지가 빠져 있습니다:
EXPOSE 80— 포트 노출ENV PROJECT_NAME=discodeit/ENV PROJECT_VERSION=1.2-M8— 프로젝트 환경변수ENV JVM_OPTS=""— JVM 옵션 환경변수 (기본값 빈 문자열)
| ENTRYPOINT ["java", "-jar", "app.jar"] | |
| EXPOSE 80 | |
| ENV PROJECT_NAME=discodeit | |
| ENV PROJECT_VERSION=1.2-M8 | |
| ENV JVM_OPTS="" | |
| ENTRYPOINT ["sh", "-c", "java $JVM_OPTS -jar /app/${PROJECT_NAME}-${PROJECT_VERSION}.jar"] |
| .build(); | ||
|
|
||
| GetObjectPresignRequest presignRequest = GetObjectPresignRequest.builder() | ||
| .signatureDuration(Duration.ofMinutes(10)) // 10분 후 만료 |
There was a problem hiding this comment.
[p2] application.yml에 정의한 presigned-url-expiration 설정값이 사용되지 않고 있습니다.
${AWS_S3_PRESIGNED_URL_EXPIRATION:600} 설정을 yaml에 선언해두셨지만 여기서 Duration.ofMinutes(10)으로 하드코딩되어 있어 환경변수로 만료시간을 제어할 수 없습니다.
생성자에 파라미터를 추가하고 주입받아 사용하도록 수정해주세요:
// 생성자에 추가
@Value("${discodeit.storage.s3.presigned-url-expiration:600}") long presignedUrlExpiration
// 필드로 저장
this.presignedUrlExpiration = presignedUrlExpiration;
// 사용 시
.signatureDuration(Duration.ofSeconds(presignedUrlExpiration))| .build(); | ||
|
|
||
| log.info("S3 저장소가 초기화되었습니다. 버킷: {}", bucket); | ||
| } |
There was a problem hiding this comment.
[p3] S3Client와 S3Presigner의 리소스 정리가 없습니다.
두 객체는 내부적으로 스레드 풀과 커넥션 풀을 관리합니다. 애플리케이션 종료 시 명시적으로 닫지 않으면 리소스 누수가 발생할 수 있습니다.
@PreDestroy
public void close() {
s3Client.close();
s3Presigner.close();
}(jakarta.annotation.PreDestroy import 필요)
| // --- Helper Methods --- | ||
|
|
||
| private S3Client getS3Client() { | ||
| return this.s3Client; |
There was a problem hiding this comment.
[p5] getS3Client()는 별도 로직 없이 필드를 그대로 반환합니다.
| return this.s3Client; | |
| this.s3Client.putObject(putObjectRequest, RequestBody.fromBytes(data)); |
this.s3Client를 직접 사용하면 코드가 더 간결해집니다.
| application: | ||
| name: discodeit | ||
| profiles: | ||
| active: prod # 기본적으로 dev 환경 활성화 |
There was a problem hiding this comment.
[p3] 기본 프로필이 prod로 설정되어 있습니다.
로컬에서 실행 시에도 prod 설정이 활성화되어 RDS 연결 정보가 없으면 시작 자체가 안 됩니다. 기본값은 dev로 두고, 실제 배포 환경(Docker Compose, ECS)에서만 SPRING_PROFILES_ACTIVE=prod를 주입하는 방식을 권장합니다.
| active: prod # 기본적으로 dev 환경 활성화 | |
| active: ${SPRING_PROFILES_ACTIVE:dev} |
2 participants
프로젝트 마일스톤
AWS S3)AWS ECS,RDS)GitHub Actions)주요 변경 사항
1. 원활한 실습 진행을 위해
Spring Boot Admin관련 코드는 삭제되었습니다.admin모듈IntelliJ Gradle툴 윈도우에서도 삭제해주세요.spring boot admin의존성 삭제2. 프로젝트 버전이 변경되었습니다.
v1.2-M8세부 사항
1.2:api-doc버전을 따릅니다.M8: 미션 8을 의미합니다.애플리케이션 컨테이너화
Dockerfile 작성
/app).dockerignore를 활용해 제외하세요.80포트를 노출하도록 설정하세요.PROJECT_NAME: discodeitPROJECT_VERSION: 1.2-M8JVM_OPTS: 기본값은 빈 문자열로 정의이미지 빌드 및 실행 테스트
local)를 지정하세요.prod프로필로 실행하세요.http://localhost:8081로 접속 가능하도록 포트를 매핑하세요.Docker Compose 구성
docker-compose.yml파일을 작성합니다..env파일을 활용하되,.env는 형상관리에서 제외하여 보안을 유지하세요.BinaryContentStorage데이터가 유지되도록 하세요.schema.sql이 자동으로 실행되도록 구성하세요.depends_on).--build플래그를 사용하여 서비스 시작 전에 이미지를 빌드하도록 합니다.BinaryContentStorage 고도화 (AWS S3)
AWS S3 버킷 구성
discodeit-binary-content-storage-(사용자 이니셜)형식으로 지정하세요.AWS S3 접근을 위한 IAM 구성
S3 버킷에 접근하기 위한 IAM 사용자(
discodeit)를 생성하세요.AmazonS3FullAccess권한을 할당하고, 사용자 생성을 완료하세요.생성된 사용자에 엑세스 키를 생성하세요.
발급받은 키를 포함해서 AWS 관련 정보는
.env파일에 추가합니다..env파일은 리뷰를 위해 PR에 별도로 첨부해주세요. 단, 엑세스 키와 시크릿 키는 제외하세요.AWS S3 테스트
AWS S3 SDK 의존성을 추가하세요.
implementation 'software.amazon.awssdk:s3:2.31.7'S3 API를 간단하게 테스트하세요.
com.sprint.mission.discodeit.storage.s3AWSS3TestProperties클래스를 활용해서.env에 정의한 AWS 정보를 로드하세요.AWS S3를 활용한
BinaryContentStorage고도화앞서 작성한 테스트 메소드를 참고해
S3BinaryContentStorage를 구현하세요.클래스 다이어그램
discodeit.storage.type값이s3인 경우에만 Bean으로 등록되어야 합니다.S3BinaryContentStorageTest를 함께 작성하면서 구현하세요.BinaryContentStorage설정을 유연하게 제어할 수 있도록application.yaml을 수정하세요..env파일에 작성된 값을 임포트하는 방식으로 설정하세요.download메소드는PresignedUrl을 활용해 리다이렉트하는 방식으로 구현하세요.AWS를 활용한 배포 (AWS RDS, ECR, ECS)
AWS RDS 구성
AWS RDS PostgreSQL 인스턴스를 생성하세요.
과금이 발생할 수 있으니 다음 항목은 한번 더 확인해주세요.
프리티어아니오7일모두 체크 해제비활성화SSH 터널링을 통해 개발 환경에서 접근할 수 있도록 EC2를 구성하세요.
EC2 인스턴스를 생성하세요.
보안 그룹에서 인바운드 규칙을 편집하세요.
SSH내 IPDataGrip을 통해 연결 후 데이터베이스와 사용자, 테이블을 초기화하세요.
데이터 소스 추가 시
SSH/SSL > Use SSH tunnel설정을 활성화하세요. 이때 이전에 다운로드한.pem파일을 활용하세요.연결이 성공하면 데이터베이스와 사용자, 테이블을 초기화하세요.
구성이 완료되면
rds-ssh인스턴스는 완전히 삭제하여 과금에 유의하세요.AWS ECR 구성
이미지를 배포할 퍼블릭 레포지토리(
discodeit)를 생성하세요.AWS CLI를 설치하세요.
aws configure실행 후 앞서 생성한discodeitIAM 사용자 정보를 입력하세요.ap-northeast-2jsondiscodeitIAM 사용자가 ECR에 접근할 수 있도록 다음 권한을 부여하세요.AmazonElasticContainerRegistryPublicFullAccessDocker 클라이언트를 배포할 레지스트리에 대해 인증합니다.
AWS 콘솔을 통해 생성한 레포지토리 페이지로 이동 후 우측 상단
푸시 명령 보기를 클릭하면 관련 명령어를 확인할 수 있습니다.멀티플랫폼을 지원하도록 애플리케이션 이미지를 빌드하고,
discodeit레포지토리에 push 하세요.latest,1.2-M8linux/amd64,linux/arm64AWS 콘솔에서 푸시된 이미지를 확인하세요.
AWS ECS 구성
배포 환경에서 컨테이너 실행 간 사용할 환경 변수를 정의하고, S3에 업로드하세요.
discodeit.env파일을 만들어 다음의 내용을 작성하세요.이 파일을 S3에 업로드하세요.
이 파일은 형상관리되지 않도록 주의하세요.
AWS ECS 콘솔에서 클러스터를 생성하세요.
태스크를 정의하세요.
태스크 실행 역할에 S3 관련 권한을 추가하세요.discodeit클러스터 상세 화면에서 서비스를 생성하세요.태스크의 EC2 보안 그룹의 인바운드 규칙을 설정하여 어디서든 접근할 수 있도록 하세요.
HTTP를 선택하세요.Anywhere-IPv4를 선택하여 모든 IP를 허용하세요.태스크 실행이 완료되면 해당 EC2의 퍼블릭 IP에 접속해보세요.
심화 요구사항
이미지 최적화하기
빌드,런타임) 빌드를 활용해 이미지의 크기를 줄여보세요.local-slim1.2-M8또는local)와 크기를 비교해보세요.GitHub Actions를 활용한 CI/CD 파이프라인 구축
CI(지속적 통합)를 위한 워크플로우를 설정하세요.
.github/workflows/test.yml파일을 생성하세요.main브랜치에 PR이 생성되면 실행되도록 설정하세요.테스트가 실행하는 Job을 정의하세요.
CodeCov를 통해 테스트 커버리지 뱃지를 README에 추가해보세요.
CD(지속적 배포)를 위한 워크플로우를 설정하세요.
.github/workflows/deploy.yml파일을 생성하세요.release브랜치에 코드가 푸시되면 실행되도록 설정하세요.AWS_ACCESS_KEY: IAM 사용자의 액세스 키AWS_SECRET_KEY: IAM 사용자의 시크릿 키AWS_REGION: AWS 리전(ap-northeast-2)ECR_REPOSITORY_URI: ECR 레포지토리 URIECS_CLUSTER: ECS 클러스터 이름(discodeit-cluster)ECS_SERVICE: ECS 서비스 이름(discodeit-service)ECS_TASK_DEFINITION: ECS 태스크 정의 이름(discodeit-task)us-east-1으로 설정해야합니다.x86_64입니다.latest와 GitHub 커밋 해시를 사용하도록 설정하세요.AWS_REGION으로 설정해야합니다.aws ecs update-service --desired-count옵션을 활용하세요.리뷰를 위해 PR에 포함해야할 정보
.env파일.env파일discodeit.env파일RDS
ECR
ECS
VPC
IAM