🌈 [Section3] 13. [ Spring MVC ] 애플리케이션 빌드/실행/배포

📕 오늘 배운 내용!

• 애플리케이션 소스 코드를 빌드
• 애플리케이션 실행
• 프로파일 적용
• 애플리케이션 배포

---

✏️ Spring Boot 기반의 애플리케이션 소스 코드를 빌드하는 방법

✔ IntelliJ IDE를 이용한 빌드

• Spring Boot의 Gradle 빌드 툴을 이용하여 Gradle task 명령으로 빌드하는 방법

  1. 우측 상단의 [Gradle] 윈도우 탭 클릭
  2. 프로젝트 명 > Tasks > build 의 :bootJar or :build task 더블 클릭
     

3. build/libs 디렉토리에 생긴 Jar 파일로 애플리케이션 실행 가능
   

💡 :build vs :bootJar

• :build 태스크 실행하면
  ➜ Gradle에서 빌드와 관련된 모든 task들을 실행시킴
  ➜ 실행 가능한 Jar 파일 이외에 plain Jar 파일 하나를 더 생성
  ⠀
• :bootJar 태스크 실행하면
  ➜ 애플리케이션의 실행 가능한 Jar(Executable Jar)파일을 생성하기 위한 task만 실행시킴
  ➜ 단순히 Executable Jar 파일만 필요하다면 :bootJar task를 실행

✔ Gradle Task를 이용한 빌드

1. Windows 터미널이나 Git Bash로 프로젝트가 위치해 있는 디렉토리 경로로 이동
   Ex. cd desktop/projects/be-template-build

2. 명령을 입력하여 빌드 진행

• Windows 터미널의 경우, 아래 명령 입력해서 애플리케이션 빌드 진행
  ➜ .\gradlew bootJar

• Git Bash의 경우
  ➜ $ ./gradlew build

( 아래는 Git Bash로 빌드한 경우임 )

4. 빌드가 정상적으로 종료되면 build/libs 디렉토리에 Jar 파일 생성됨

---

애플리케이션 실행

1. Windows 터미널이나 Git Bash로 생성된 Jar 파일이 있는 디렉토리 경로로 이동
   Ex. cd desktop/projects/be-template-build/build/libs
   ( build/libs 가 jar 파일이 생성된 디렉토리임 ! )

2. java -jar Jar 파일명.jar 명령 입력하여 애플리케이션을 서버 환경에서 실행 !
   Ex. java -jar section3-week3-template-build-0.0.1-SNAPSHOT.jar

( 아래는 Git Bash로 실행한 경우임 )

❗ intellij에서 애플리케이션이 실행중이라면 같은 port 번호를 사용하고 있어서
아래와 같이 실행에 실패하니 intellij의 실행을 멈춘 후 Git Bash에서 실행할 것 !!

💡 But, 현재 우리가 만든 프로젝트들은 로컬 환경에서 인메모리 DB인 H2 사용중 !
⠀
서버 환경에서 배포 / 운영 한다면 인메모리 DB로 하면 안됨
( 재시작 할 경우 데이터 모두 초기화 )
⠀
로컬 환경에서 사용시와 서버용 jar 파일 빌드 시 application.yml 파일의 DB 정보를 계속 바꿔가며 빌드하는 것은 아주 비효율적
⠀
➜ 프로파일 기능 사용

[IntelliJ IDE 이외의 방법으로 Spring Boot 기반의 애플리케이션을 실행하는 방법 참고]
https://docs.spring.io/spring-boot/docs/current/reference/html/cli.html#cli.using-the-cli.run
https://spring.io/guides/gs/spring-boot/

---

✏️ 프로파일 적용하기

• 로컬 환경에서 개발할 때와 서버에서 배포 / 운영할 경우의 DB를 다르게 하기 위해 프로파일이라는 기능을 적용

• IntelliJ IDE 같은 개발 환경에서 테스트를 위해 프로파일을 변경해야 할 경우도 있지만
  프로파일 기능은 주로 빌드된 실행 파일을 어느 환경에서 실행할지 여부를 결정할 때 사용
  ➜ 빌드 후 생성되는 애플리케이션 실행 파일에 대한 실행 환경을 손쉽게 지정 가능

[참고]
https://www.baeldung.com/spring-profiles
https://docs.spring.io/spring-boot/docs/current/reference/html/features.html#features.profiles

✔ IntelliJ IDE에서 프로파일 적용

1. 아래와 같이 application.yml 파일 두개를 더 만들기

• application.yml
  ➜ 애플리케이션의 실행 환경에 상관없이 공통으로 사용하는 정보들 설정

• application-local.yml
  ➜ 로컬 환경에서 사용하는 정보들 설정
  ( 원래 application.yml에 있던 정보들을 붙여넣기 )

• application-server.yml
  ➜ 서버 환경에서 사용하는 정보들 설정

( 프로파일을 지정하는 가장 손쉬운 방법은 위처럼 -를 기준으로 프로파일명을 yml 파일 이름안에 포함하는 것 ! )

2. Intellij IDEA 에서 애플리케이션 실행 파일이 위치한 셀렉트 박스를 클릭한 후, [Edit Configurations] 클릭
   

3. 활성화할 프로파일(Active Profile)을 local로 지정한다면,
   --spring.profiles.active=local 입력하여 설정
   ( 여기서 local은 application-local.yml 파일명에서의 local을 가리킴 )
   ( 그냥 local이라고만 작성해도 가능 )
   

4. 애플리케이션 실행 후 로그를 보면, local 프로파일이 활성화 된 것을 확인할 수 있음
   

✔️ @Profile 애너테이션을 추가해 프로파일 적용하는 방법도 있음

• 클래스 레벨에 추가
  ⠀
• @Profile("local")
  ➜ 로컬일 때만 작동하게
  ⠀
• @Profile(value = {"local", "server"})
  ➜ 로컬이거나 서버일 때만 작동하게
  ⠀
  ( 위와 같이 사용 )

✔ 빌드된 실행 파일에 프로파일 적용

• Windows 터미널이나 Git Bash로 Jar 파일이 있는 디렉토리 경로에서
  Jar 을 실행시켰던 java -jar Jar 파일명.jar 명령에 Intellij IDEA 에서 프로파일 적용했던 것과 동일하게
  --spring.profiles.active=local 설정 추가해주면 됨
  ⠀
  Ex. java -jar section3-week3-template-build-0.0.1-SNAPSHOT.jar --spring.profiles.active=local

( 아래는 Git Bash로 실행한 경우임 )

---

✏️ 애플리케이션 배포

( Spring Boot 기반의 Executable Jar 파일을 서버에 배포하는 방법 )

✔ 전통적인 배포 방법

• 표준 유닉스 툴을 이용해서 서버로 간단히 전송
  ( 서버로 전송된 Jar 파일은 JVM이 설치된 환경이라면 어디서든 손쉽게 실행 가능 )
  Ex. scp / sftp
  ⠀
  [scp 참고]
  https://www.freecodecamp.org/news/scp-linux-command-example-how-to-ssh-file-transfer-from-remote-to-local/

✔ 클라우드 서비스를 위한 배포 방법

• PaaS (Platform as a Service)

  • Cloud Foundry, Heroku
    ⠀
    ➜ PaaS 제공 기업인 Cloud Foundry에서 제공하는 cf command line 툴 사용
    ⠀
    Ex. $ cf push acloudyspringtime -p target/app-0.0.1-SNAPSHOT.jar

• IaaS (Infrastructure as a Service)

  • AWS Elastic Beanstalk, AWS Container Registry, AWS Code Deploy 같은 서비스 이용

  • Azure Spring Cloud, Azure App Service 에서 Spring Boot 기반의 Executable Jar 파일 배포 기능을 제공
    ( Microsoft의 클라우드 서비스인 Azure )

  • Google Cloud 사용
    ➜ Executable Jar 파일 배포를 위한 여러가지 옵션을 제공

• CI / CD 플랫폼을 사용한 배포

  • CI / CD 플랫폼 이용하여 AWS나 Azure 같은 클라우드 서비스에 Executable Jar 파일을 자동 배포하도록 구성 가능
    Ex. Github Actions / Circle CI

  • 배포 시간 단축 / 실제 실무에서도 굉장히 많이 쓰이는 기술

---

😜 실습

• projects - be-reference-profile-examples
• git - be-homework-build

오늘 실습 과제는 application-server.yml 파일에 MySQL과 연동하기 였다 !

먼저, build.gradle 폴더에 아래와 같은 의존성을 추가해주고

implementation 'mysql:mysql-connector-java'

application-server.yml 파일에

spring:
  jpa:
    hibernate:
      ddl-auto: create-drop  # (1) 스키마 자동 생성
    show-sql: true      # (2) SQL 쿼리 출력
    properties:
      hibernate:
        format_sql: true  # (3) SQL pretty print
  datasource: // 여기서부터 추가한 부분
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/coffee_order?useSSL=false&allowPublicKeyRetrieval=true&useUnicode=true&serverTimezone=Asia/Seoul
    username: root
    password: 1234

이렇게 추가해주고

Edit Configurations에서 --spring.profiles.active=server 이렇게 설정해주면

서버로 mysql이 연동된다 !

개발 환경에 따른 application.yml 설정 참고

---

🌈 느낀점

오늘은 쉬어가는 챕터였다!
구글에 정보도 많았고 간단하게 따라하기만 되는 부분이었다.
벌써 내일이 또 면접 ㅠ