[배포 및 인프라] 해보자 배포 [5] - 스프링 애플리케이션에서 MYSQL 연동하기

 

 

 

이전 글에서는 애플리케이션용 EC2 서버에서만 접근할 수 있는 데이터베이스용 EC2 인스턴스를 생성하고 해당 인스턴스에 MYSQL을 설치하는 과정을 진행했습니다.

이번에는 스프링 애플리케이션과 DB를 직접 연동해보도록 하겠습니다.

 

 

 

 

 

🧐 데이터베이스를 사용하는 스프링 코드 작성하기

우선 테스트를 위해서 간단한 코드를 하나 작성할 예정입니다.

public class Member {

    private Long id;
    private String email;
    private String password;

    public Member(Long id, String email, String password) {
        this.id = id;
        this.email = email;
        this.password = password;
    }

    public Long getId() {
        return id;
    }

    public String getEmail() {
        return email;
    }

    public String getPassword() {
        return password;
    }
}

 

@Repository
public class MemberDao {

    private final JdbcTemplate jdbcTemplate;

    public MemberDao(JdbcTemplate jdbcTemplate) {
        this.jdbcTemplate = jdbcTemplate;
    }

    public void addMember(Member member) {
        String sql = "INSERT INTO member (email, password) VALUES (?, ?)";
        jdbcTemplate.update(sql, member.getEmail(), member.getPassword());
    }
}

 

@RestController
public class MemberController {

    private final MemberDao memberDao;

    public MemberController(MemberDao memberDao) {
        this.memberDao = memberDao;
    }

    @PostMapping("/members")
    ResponseEntity<String> signUp(
            @RequestBody SignUpRequest request
    ) {
        memberDao.addMember(request.toMember());
        return ResponseEntity.ok("OK!");
    }
}

 

/members로 POST 요청이 들어오면 회원을 데이터베이스에 저장하는 예제입니다.

이제 DB에 대한 설정을 해주어야 합니다.

 

 

 

데이터베이스 연동을 위해 필요한 설정들은 다음과 같습니다.

⚙️ application.yml

spring:
  datasource:
    url: DB의 주소
    driver-class-name: 데이터베이스별 Driver class의 이름
    username: DB 접속 아이디
    password: DB 접속 비밀번호

 

 

 

그러나 이들의 값을 단순히 채워서 연결해서는 안되고, 다음과 같은 사항들을 고려해서 연결해야 합니다.

 

 

 

 

 

📕 프로덕션용 데이터베이스와 개발용 데이터베이스의 분리

첫번째 고려사항은 실제 프로덕션 환경에서 사용되는 데이터베이스와 개발을 위한 환경에서 사용되는 데이터베이스를 분리하는 것입니다. 

이들을 분리함으로써 개발 작업 중에 임시 데이터를 추가하거나 몇 가지 데이터를 삭제하는 등의 작업을 수행하더라도 실제 서비스를 제공하는 데이터베이스에 영향을 미치는 문제를 예방할 수 있습니다.

 

 

 

 

 

 

 

📙 실제 데이터베이스의 정보 감추기

두 번째로 고려해야 할 사항은 실제 데이터베이스의 주소, 아이디, 비밀번호와 같은 정보를 외부에 노출하지 않는 것입니다.

이러한 정보가 노출되면 보안상의 문제가 발생할 수 있습니다.

즉 이러한 정보는 다른 사람이 확인할 수 없도록 관리해야 하며, 이러한 설정 값을 GitHub의 public repository에 올려서도 안됩니다.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

🧐 개발 환경과 프로덕션 환경 분리하기

이를 위한 방법은 크게 두가지가 있는데요, 저는 이들 중 한가지 방법만 살펴보도록 하겠습니다.

 

이제부터 개발 환경을 dev, 프로덕션 환경을 prod로 칭하도록 하겠습니다.

 

 

 

 

기존 application.yml이 다음과 같았다고 가정하겠습니다.

spring:
  datasource:
    url: jdbc:h2:mem:testdb;MODE=MySQL
    driver-class-name: org.h2.Driver
    username: sa
    password:

my-env:
  first: ${FIRST_MALLANG_ENV}
  second: ${SECOND_MALLANG_ENV}

 

이제 이들을 각각 application.yml, application-dev.yml, application-prod.yml 로 나눠주도록 하겠습니다.

 

 

 

 

⚙️ application.yml

spring:
  profiles:
    active: dev
    
my-env:  # 공통으로 적용된다.
  first: ${FIRST_MALLANG_ENV}
  second: ${SECOND_MALLANG_ENV}

 

 

 

⚙️ application-dev.yml

spring:
  datasource:
    url: jdbc:h2:mem:testdb;MODE=MySQL
    driver-class-name: org.h2.Driver
    username: sa
    password:

 

 

 

 

⚙️ application-prod.yml

spring:
  datasource:
    url: 실제 DB 주소
    driver-class-name: com.mysql.cj.jdbc.Driver
    username: DB 아이디
    password: DB 비번

 

 

이와 같이 설정 파일을들 만들어주었다면 이후 애플리케이션을 실행시킬 때 SPRING_PROFILES_ACTIVE 라는 이름의 환경변수를 dev로 설정해주면 application-dev.yml이, prod로 설정해주면 application-prod.yml이 설정됩니다.

SPRING_PROFILES_ACTIVE=dev -> application-dev.yml
SPRING_PROFILES_ACTIVE=prod -> application-prod.yml

또한 기본 application.yml에 기본 spring.profiles.active를 dev로 설정해 주었으므로, SPRING_PROFILES_ACTIVE에 아무 값도 설정하지 않으면 dev가 적용됩니다.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

🧐 실제 DB 정보 감추기

이를 위해서는 다양한 방법을 사용할 수 있지만, 이번 글에서는 가장 간단한 환경변수를 통해서 값을 숨기는 방법에 대해 알아보겠습니다.

 

위에서 살펴본 application-prod.yml 코드를 다음과 같이 환경변수를 통해서 값을 숨길 수 있습니다.

spring:
  datasource:
    driver-class-name: ${RDS_DRIVER}
    url: ${RDS_URL}
    username: ${RDS_USERNAME}
    password: ${RDS_PASSWORD}

설정이 변경되었기 때문에, 애플리케이션을 배포할 서버의 쉘 스크립트를 조금 수정해 주어야 합니다.

(진행하기 전에 현재까지의 코드를 깃허브에 push 해주어야 합니다.)

 

 

 

 

 

 

 

 

 

 

 

 

🧐 EC2 쉘 스크립트 수정하기

우선 다시 애플리케이션용 EC2에 접속합니다.

이제 배포를 위한 쉘 스크립트 파일(제 경우 bapo.sh)을 수정해 주도록 하겠습니다.

현재 EC2 서버의 파일들

 

 

 

vim [배포 스크립트 파일]

 

 

 

 

 

현재 제가 작성한 파일은 다음과 같습니다.

 

⚙️ bapo.sh

#!/bin/sh

PROJECT_PATH=/home/ubuntu/mallang-projects
PROJECT_NAME=bapo-test
PORT=8080
BUILD_PATH=build/libs
JAR_NAME=jwp-shopping-order.jar


echo "\n 🐳   [$PROJECT_PATH/$PROJECT_NAME] 경로로 이동합니다.\n"

cd $PROJECT_PATH/$PROJECT_NAME

echo " 🐳   최신 코드를 PULL 합니다!\n"

git pull

echo " 🐳   프로젝트를 새롭게 빌드합니다.\n"

./gradlew clean build

echo " 🐳   [$PORT] 번 포트를 사용하는 애플리케이션을 찾습니다...\n"

PID=$(lsof -i :$PORT -t)

if [ -z $PID ]; then
        echo " 🎉   실행중인 애플리케이션이 없어서 곧바로 실행합니다.\n"

else
        echo " ❌   실행중인 애플리케이션이 있어서 이를 종료합니다. [PID = $PID]\n"
        kill -15 $PID
fi

echo " 🐳   애플리케이션을 실행하는데 필요한 환경변수를 세팅합니다.\n"

export FIRST_MALLANG_ENV="mallang1"
export SECOND_MALLANG_ENV=1234

echo " 🎉   애플리케이션 실행합니다~ 🎉\n"

nohup java -jar $PROJECT_PATH/$PROJECT_NAME/$BUILD_PATH/$JAR_NAME &

 

 

 

 

 

 

우선 어떻게 동작하는지 확인해 보기 위해 해당 스크립트 파일을 실행해 주도록 하겠습니다.

 

잘 실행되는 것 같은데, 한번 nohup.out 로그를 확인해 보도록 하겠습니다.

(제 설정을 그대로 따라하셨다면 mallang-projects/bapo-test 에 위치합니다.)

 

cat mallang-project/bapo-test/nohup.txt

 

 

잘 실행되었지만 하나 문제가 있는데요, 분명 해당 EC2는 프로덕션 환경을 목적으로 생성한 서버인데 profile이 dev로 설정되었습니다.

이곳에서는 dev가 아닌 prod 환경으로 애플리케이션이 실행되어야 하는데요, 이를 위해 쉘 스크립트를 아래와 같이 수정할 수 있습니다.

 

 

 

 

 

 

 

추가할 부분은 다음과 같습니다.

export SPRING_PROFILES_ACTIVE="prod"

 

 

 

 

⚙️ 변경된 bapo.sh

#!/bin/sh

PROJECT_PATH=/home/ubuntu/mallang-projects
PROJECT_NAME=bapo-test
PORT=8080
BUILD_PATH=build/libs
JAR_NAME=jwp-shopping-order.jar


echo "\n 🐳   [$PROJECT_PATH/$PROJECT_NAME] 경로로 이동합니다.\n"

cd $PROJECT_PATH/$PROJECT_NAME

echo " 🐳   최신 코드를 PULL 합니다!\n"

git pull

echo " 🐳   프로젝트를 새롭게 빌드합니다.\n"

./gradlew clean build

echo " 🐳   [$PORT] 번 포트를 사용하는 애플리케이션을 찾습니다...\n"

PID=$(lsof -i :$PORT -t)

if [ -z $PID ]; then
	echo " 🎉   실행중인 애플리케이션이 없어서 곧바로 실행합니다.\n"

else
	echo " ❌   실행중인 애플리케이션이 있어서 이를 종료합니다. [PID = $PID]\n"
	kill -15 $PID
fi

echo " 🐳   애플리케이션을 실행하는데 필요한 환경변수를 세팅합니다.\n"

export FIRST_MALLANG_ENV="mallang1"
export SECOND_MALLANG_ENV=1234

# 해당 부분 추가
export SPRING_PROFILES_ACTIVE="prod"  

echo " 🎉   애플리케이션 실행합니다~ 🎉\n"

nohup java -jar $PROJECT_PATH/$PROJECT_NAME/$BUILD_PATH/$JAR_NAME &

 

아까 전에 살펴본 SPRING_PROFILES_ACTIVE 환경변수를 prod로 설정하여 애플리케이션을 실행하였습니다.

 

 

 

 

다시 nohup.out 로그를 확인해 보도록 하겠습니다.

 

 

개발 환경은 prod로 제대로 설정되었지만, DB 설정정보를 아직 설정해주지 않았기에 오류가 발생한 것을 알 수 있습니다.

 

이제 데이터베이스 연동을 위해 쉘 스크립트를 추가로 설정해 주도록 하겠습니다.

 

 

 

 

 

 

 

추가할 부분은 다음과 같습니다.

export RDS_DRIVER="com.mysql.cj.jdbc.Driver"
export RDS_URL="jdbc:mysql://[DB용 EC2 Private IPv4 주소]:3306/[이전 글에서 생성한 데이터베이스 이름]"
export RDS_USERNAME="root"
export RDS_PASSWORD="이전 글에서 설정한 root 계정 비밀번호"

 

이때 DB용 EC2 Private IPv4 주소는 다음 중 핑크색 박스친 부분과 같습니다.

 

이전 글에서 생성한 데이터베이스 이름은 아래와 같습니다.

위 사진의 경우 bapo_test가 됩니다.

 

 

 

 

⚙️ 변경된 bapo.sh

#!/bin/sh

PROJECT_PATH=/home/ubuntu/mallang-projects
PROJECT_NAME=bapo-test
PORT=8080
BUILD_PATH=build/libs
JAR_NAME=jwp-shopping-order.jar


echo "\n 🐳   [$PROJECT_PATH/$PROJECT_NAME] 경로로 이동합니다.\n"

cd $PROJECT_PATH/$PROJECT_NAME

echo " 🐳   최신 코드를 PULL 합니다!\n"

git pull

echo " 🐳   프로젝트를 새롭게 빌드합니다.\n"

./gradlew clean build

echo " 🐳   [$PORT] 번 포트를 사용하는 애플리케이션을 찾습니다...\n"

PID=$(lsof -i :$PORT -t)

if [ -z $PID ]; then
        echo " 🎉   실행중인 애플리케이션이 없어서 곧바로 실행합니다.\n"

else
        echo " ❌   실행중인 애플리케이션이 있어서 이를 종료합니다. [PID = $PID]\n"
        kill -15 $PID
fi

echo " 🐳   애플리케이션을 실행하는데 필요한 환경변수를 세팅합니다.\n"

export FIRST_MALLANG_ENV="mallang1"
export SECOND_MALLANG_ENV=1234
export SPRING_PROFILES_ACTIVE="prod"
export RDS_DRIVER="com.mysql.cj.jdbc.Driver"
export RDS_URL="jdbc:mysql://[DB용 EC2 Private IPv4 주소]:3306/bapo_test"
export RDS_USERNAME="root"
export RDS_PASSWORD="1234"

echo " 🎉   애플리케이션 실행합니다~ 🎉\n"

nohup java -jar $PROJECT_PATH/$PROJECT_NAME/$BUILD_PATH/$JAR_NAME &

 

이제 다시 실행하고 로그를 살펴보면 아래와 같습니다.

바로 실패해 버렸습니다.

 

 

 

이유는 바로 DB의 root 계정의 외부 접속 권한이 없기 때문인데요, 이제부터 권한을 부여해 보도록 하겠습니다.

 

 

 

 

 

 

 

 

 

 

 

🧐 외부 접속 권한을 가진 DB 유저 생성하기

우선 DB용 EC2에 접근해 주도록 하겠습니다.

ssh -i mallang-test-ec2-key.pem ubuntu@[DB용 private IPv4 주소]

 

 

 

 

접속했으면 mysql에 접속합니다.

mysql -u root -p

 

 

 

 

기존 root 계정에 외부 접속 권한을 부여하기보다는 새로운 계정을 만들어 주는 것이 좋습니다.

create user '유저이름'@'외부 접속 ip' identified by '비밀번호';

localhost를 제외한 모든 외부 ip를 허용할 때에는 %를 사용합니다.
ex: create user '유저이름'@'%' identified by '비밀번호';

이때 외부접속 ip는 애플리케이션용 EC2의 프라이빗 IPv4 주소를 입력해 주시면 됩니다.

 

 

 

 

 

 

저는 mallag이라는 계정을 만들도록 하겠습니다.

create user 'mallang'@'[애플리케이션용 EC2 Private IPv4 주소]' identified by '비밀번호';

 

 

 

 

 

 

 

 

 

grant all privileges on 데이터베이스명.* to '유저이름'@'설정한 IP';

[*.*] 의 경우 모든 데이터베이스에 권한을 줍니다.
[데이터베이스명.테이블명] 은 특정 테이블에 권한을 줍니다.

이제 mallang 이라는 계정에게 이전 글에서 생성한 bapo_test라는 데이터베이스에 대한 모든 권한을 주도록 하겠습니다.

grant all privileges on bapo_test.* to 'mallang'@'[애플리케이션용 EC2 Private IPv4 주소]';

 

 

 

 

 

 

이를 적용해 주도록 하겠습니다.

flush privileges;

 

 

 

 

 

이제 다시 애플리케이션용 EC2로 돌아가 쉘 스크립트에서 datasource의 username과 password 를 위에서 설정한 유저로 변경합니다.

예를 들어 저는 다음과 같이 변경합니다.

export RDS_USERNAME="mallang"
export RDS_PASSWORD="1234"

 

 

이제 다시 스크립트를 실행해 보겠습니다.

결과는 또 실패입니다.

 

이유는 아직 MYSQL의 외부 접속 설정을 해주지 않았기 때문인데요, 이제부터 설정을 해주도록 하겠습니다.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

🧐 MYSQL 외부 접속 설정

다시 DB용 EC2에 접근해 주도록 하겠습니다.

ssh -i mallang-test-ec2-key.pem ubuntu@[DB용 private IPv4 주소]

 

 

 

 

 

이제 mysqld.cnf 파일을 수정해야 합니다.

cd /etc/mysql/mysql.conf.d
sudo vi mysqld.cnf

위의 bind-address가 현재는 127.0.0.1로 설정되어 있는데, 이를 0.0.0.0으로 바꾸어줍니다.

 

 

 

 

 

sudo service mysql restart

mysql 서버를 재시작합니다.

 

 

 

 

 

이제 다시 애플리케이션 EC2로 돌아와서 스크립트를 재실행하면 다음과 같이 성공하는 것을 볼 수 있습니다.

 

 

 

 

 

DB에 연동이 잘 됐는지를 확인하기 위해 맨 처음에 만들었던 "/member" 로 회원가입 요청을 보내보도록 하겠습니다.

(가려진 주소는 애플리케이션 EC2의 public IPv4 주소입니다.)

요청은 성공하는 것을 확인했으니, 데이터베이스에 접속하여 데이터가 잘 저장되는지 확인하도록 하겠습니다.

성공했습니다 휴

 

 

 

 

 

 

 

 

 

 

 

🧐 참고 - Datagrip을 MYSQL 서버와 연동하기

이부분은 Datagrip을 통해서 MYSQL 서버와 연동하는 부분을 다룹니다.

굳이 연동하지 않으셔도 되거나 Datagrip을 사용하지 않으시는 분들은 넘어가셔도 좋을 것 같습니다.

+버튼을 누른 뒤, Data Source -> MySQL을 선택합니다.

 

 

 

 

SSH/SSL 창으로 들어가서 Use SSH tunnel을 체크합니다.

이후 ...을 눌러 SSH 설정 창을 엽니다.

 

SSH 설정 창에서 Host는 애플리케이션용 EC2 서버의 퍼블릭 IPv4 주소를 입력합니다.

username은 ubuntu입니다.

이후 Authentication type은 Key pair를 선택한 뒤, 키페어의 경로를 설정해줍니다.

 

위처럼 설정한 이후 SSH 설정 창에서 OK를 눌러줍니다.

 

 

이후 General 창으로 돌아와서 Host와 User, Password를 입력합니다.

 

Host는 DB용 EC2 서버의 프라이빗 IPv4 주소이며,

User와 Password는 외부 접속 권한이 설정된 Mysql 유저 정보를 입력해줍니다.

제 블로그의 예시로는 mallang과 1234를 입력합니다.

 

 

 

 

 

다음과 같이 성공한 것을 알 수 있습니다.

 

 

 

 

 

 

 

🧐 마무리

이번 글에서는 스프링 애플리케이션과 MYSQL을 연동하는 과정을 진행해 보았습니다.

생각보다 내용이 너무 길어진 것 같네요.. ㅠㅠ 😭

다음 글에서는 이번에 설정한 환경 변수를 통한 설정 정보를 감추는 방법 외에 사용할 수 있는 git submodule에 대해 학습해 보도록 하겠습니다.