Spring Boot Maven profile 운영 & 개발 DB 분리(AWS EC2)

📎 Spring Boot(Maven) profile 운영 & 개발 DB 분리

(틀린 내용이 있을수도 있으니 비판적으로 봐주시면 될 것 같습니다..! 😂)

 

 

안녕하세요! 이번에 정리할 내용은 스프링 부트에서 운영 & 개발 분리 및 AWS EC2에 배포 입니다.

 

실무에서는 실제 서비스되는 DB와 개발중인 DB의 정보는 다르게 관리를 하는데 이를 위해 스프링 부트에서 profile을 통해 애플리케이션을 배포할 때 운영과 개발을 분리해서 배포할 수 있도록 진행해보겠습니다.

 

또한 저는 현재 애플리케이션을 AWS EC2 환경에서 운영, 배포를 진행하고 있습니다.

로컬에서 개발 후 배포를 하기 위해 GitHub에 코드를 push한 뒤 AWS에서 pull을 하고 배포를 진행하게 되는데요, 이러한 과정에서 민감한 정보들(DB의 url, id, pw 등)을 GitHub에 코드를 공개하게 된다면 이를 악용할 수 있으므로 공개를 해서는 안됩니다.

 

 

목차는 간략하게 다음과 같습니다.

• ⌨️  properties 파일 분리
• ⌨️  애플리케이션 실행
• ⌨️  애플리케이션 실행오류
• ⌨️  AWS EC2에 애플리케이션 배포

---

 

 

⌨️  properties 파일 분리

기존 application.properties 파일을 운영 & 개발로 분리하여 파일을 생성합니다.

application-{name}.properties

스프링 부트 프로젝트 만들때 자동으로 생성되는 경로인 resources 디렉토리 하위에 같이 생성합니다.

(저는 개발계를 dev, 운영계를 prod 라는 네이밍으로 파일을 생성해주었습니다.)

 

 

 

그 후 각 DB의 정보를 분리해주었는데요, 내용은 다음과 같습니다.

application.properties

위 파일에는 프로젝트에서 공통적으로 사용되는 설정들을 작성합니다.

 

 

 

application-dev.properties

dev 파일에는 개발계의 정보를 작성합니다.

 

 

 

application-prod.properties

prod 파일에는 운영계의 정보를 작성합니다.

(저는 AWS RDS를 사용하고 있습니다.)

---

 

 

 

 

⌨️  애플리케이션 실행

애플리케이션을 실행할 때는 스프링부트의 실행 환경에서 Active profiles을 properties에 맞게 설정을 해주어야 합니다.

(IntelliJ) 상단의 실행 환경 부분에서 Edit Configurations(Run/Debug Configurations)를 클릭합니다.

 

 

 

Configuration > Active profiles 에서 prod로 설정을 합니다.

 

 

그 후 애플리케이션을 실행하면 운영 DB로 정상적으로 접속이 되는걸 확인할 수 있습니다.

---

 

 

⌨️  애플리케이션 실행오류

만약 Active profiles에 아무런 값을 지정하지 않거나, 다른 이름으로 설정하면 애플리케이션이 정상적으로 실행되지 않습니다.

 

아무런 값을 지정하지 않은 경우

 

 

 

 

다른 이름을 지정한 경우

 

 

 

※ 위 설정이 끝나면 .gitignore 파일을 통해 DB 정보를 GitHub에 올리지 않도록 설정을 해야합니다.

https://steady-hello.tistory.com/44

---

 

 

 

 

⌨️  AWS EC2에 애플리케이션 배포

이제 저의 운영 환경인 AWS EC2에서 운영 DB로 애플리케이션을 배포해보도록 하겠습니다.

(AWS 접속 및 GitHub 관련된 세부 사항은 생략하도록 하겠습니다.)

 

대략적인 프로세스는 다음과 같습니다

 

로컬 개발 & GitHub Push -> AWS에서 pull -> gitignore한 파일들(prod, dev properties) 복사 -> Maven Build -> 배포

 

 

 

먼저 application.properties 파일에 아래 내용을 추가합니다.

spring.profiles.active=@spring.profiles.active@

 

 

 

다음으로 메이븐으로 빌드할 때 개발 및 운영 서버별로 따로 빌드를 할 수 있도록 pom.xml에 다음 설정을 추가합니다.

	<!-- profile 추가: dev, prod -->
	<profiles>
		<profile>
			<id>dev</id>
			<properties>
				<environment>dev</environment>
				<maven.test.skip>true</maven.test.skip>
			</properties>
		</profile>
		<profile>
			<id>prod</id>
			<properties>
				<environment>prod</environment>
				<maven.test.skip>true</maven.test.skip>
			</properties>
		</profile>
	</profiles>


	<!-- profile 수정 -->
	<build>
		<sourceDirectory>src/main/java</sourceDirectory>
		<resources>
			<resource>
				<directory>src/main/resources</directory>
				<filtering>true</filtering>
				<excludes>
					<exclude>**/*.java</exclude>
				</excludes>
			</resource>
			<resource>
				<directory>src/main/resources-${environment}</directory>
			</resource>
		</resources>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
				<configuration>
					<excludes>
						<exclude>
							<groupId>org.projectlombok</groupId>
							<artifactId>lombok</artifactId>
						</exclude>
					</excludes>
				</configuration>
			</plugin>
		</plugins>
	</build>

properties의 정보를 읽기 위해 filtering을 true로 활성화 합니다(default = false)

 

 

 

※ Maven - pom - profiles에 대한 설명은 아래 공식문서를 참고해주세요 !

https://maven.apache.org/guides/introduction/introduction-to-profiles.html

Maven – Introduction to build profiles

 

 

그 후 resources 하위에 application-prod.properties 파일을 생성합니다.

(현재 AWS는 운영 서버입니다.)

 

 

 

다음 명령어를 통해 메이븐 패키징을 진행합니다.(실행 파일 jar 생성)

./mvnw clean package -Pprod

-P 옵션으로 프로파일(profile)을 선택할 수 있습니다.

즉 위 명령어를 통해 id가 prod인 profile을 선택합니다.

(environment = prod)

 

 

 

 

※ 혹시 아래와 같이 권한이 없을 경우(Permission denied) chmod 명령어로 권한을 수정합니다.

$ chmod +x mvnw

• mvnw 파일에 대해 실행 권한(+x) 부여

 

 

 

 

 

그 후 패키징을 하면 아래와 같이 실행이 되고, BUILD SUCCESS 라는 문구가 보이면 정상적으로 빌드가 되었습니다.

 

 

 

아래 명령어를 통해 생성된 target 디렉토리의 .jar파일을 통해 애플리케이션을 배포합니다.

java -jar -Dspring.profiles.active=prod jar file
java -jar -Dspring.profiles.active=prod oneline-course-0.0.1-SNAPSHOT.jar

jar 파일을 실행하면 위와 같이 정상적으로 애플리케이션이 배포가 됩니다.

 

 

 

애플리케이션을 배포하고 URL로 접속을 해보면(AWS EC2의 탄력적 IP) 정상적으로 접속이 되는걸 확인할 수 있습니다. 😊

 

 

 

 

 

 

 

References

• https://maven.apache.org/guides/introduction/introduction-to-profiles.html
• https://sgc109.github.io/2020/07/06/spring-profiles/#Maven-profiles-%EB%A5%BC-%ED%86%B5%ED%95%9C-%EB%B0%A9%EB%B2%95
• https://www.lesstif.com/java/maven-profile-14090588.html
• https://jeong-pro.tistory.com/168