Spring Boot 앱을 Cloud SQL에 연결하기

Spring Boot 앱을 Cloud SQL에 연결하기

이 Codelab 정보

subject최종 업데이트: 4월 22, 2020
account_circle작성자: Google 직원

1. 시작하기 전에

Cloud SQL은 Google Cloud에서 관계형 데이터베이스를 손쉽게 설정, 유지, 관리할 수 있는 완전 관리형 데이터베이스 서비스입니다. MySQL용 Cloud SQL 또는 PostgreSQL용 Cloud SQL과 함께 Cloud SQL을 사용할 수 있습니다.

이 Codelab에서는 MySQL용 Cloud SQL 인스턴스를 설정한 다음 Cloud SQL 인스턴스를 백엔드 스토리지로 사용하도록 Spring Boot 앱을 업데이트하는 방법을 알아봅니다. Google Cloud SQL용 Spring Boot Starter는 자동 구성된 DataSource를 제공하므로 코드를 거의 변경하지 않고도 Cloud SQL을 쉽게 활용할 수 있습니다. 이 Codelab에서는 Spring Petclinic 소스 코드를 사용합니다.

기본 요건

  • 자바 프로그래밍 언어 및 도구에 관한 기본 지식
  • Vim, Emacs, nano와 같은 표준 Linux 텍스트 편집기에 대한 지식

실행할 작업

  • Spring Boot 앱에서 Cloud SQL 사용하기

필요한 항목

  • Google Cloud 프로젝트
  • Chrome, Firefox와 같은 브라우저

2. 설정 및 요건

자습형 환경 설정

  1. Cloud Console에 로그인한 후 새 프로젝트를 만들거나 기존 프로젝트를 재사용합니다. Gmail 또는 G Suite 계정이 아직 없다면 계정을 만들어야 합니다.

모든 Google Cloud 프로젝트에서 고유한 이름인 프로젝트 ID를 기억하세요(위의 이름은 이미 사용되었으므로 사용할 수 없습니다). 이 ID는 나중에 이 Codelab에서 PROJECT_ID라고 부릅니다.

  1. 다음으로 Google Cloud 리소스를 사용하려면 Cloud Console에서 결제를 사용 설정해야 합니다.

이 Codelab을 진행하는 데는 비용이 몇 달러 이상 들지 않지만 더 많은 리소스를 사용하기로 결정하거나 계속 실행하는 경우 비용이 더 많이 들 수 있습니다.

Google Cloud 신규 사용자는 $300 무료 체험판을 사용할 수 있습니다.

Cloud Shell 활성화

  1. Cloud Console에서 Cloud Shell 활성화 를 클릭합니다.

이전에 Cloud Shell을 시작하지 않았으면 설명이 포함된 중간 화면(스크롤해야 볼 수 있는 부분)이 제공됩니다. 이 경우 계속을 클릭합니다(이후 다시 표시되지 않음). 이 일회성 화면은 다음과 같습니다.

Cloud Shell을 프로비저닝하고 연결하는 데 몇 분 정도만 걸립니다.

가상 머신에는 필요한 개발 도구가 모두 들어있습니다. 영구적인 5GB 홈 디렉터리를 제공하고 Google Cloud에서 실행되므로 네트워크 성능과 인증이 크게 개선됩니다. 이 Codelab에서 대부분의 작업은 브라우저나 Chromebook만 사용하여 수행할 수 있습니다.

Cloud Shell에 연결되면 인증이 완료되었고 프로젝트가 해당 프로젝트 ID로 이미 설정된 것을 볼 수 있습니다.

  1. Cloud Shell에서 다음 명령어를 실행하여 인증되었는지 확인합니다.
gcloud auth list

명령어 결과

 Credentialed Accounts
ACTIVE  ACCOUNT
*       <my_account>@<my_domain.com>

To set the active account, run:
    $ gcloud config set account `ACCOUNT`
gcloud config list project

명령어 결과

[core]
project = <PROJECT_ID>

또는 다음 명령어로 설정할 수 있습니다.

gcloud config set project <PROJECT_ID>

명령어 결과

Updated property [core/project].

3. MySQL용 Cloud SQL 인스턴스 설정

  1. Cloud Shell이 실행되면 명령줄을 사용하여 새 Cloud SQL 인스턴스를 만들 수 있습니다.
$ gcloud sql instances create my-instance

이 작업이 완료되면 인스턴스를 사용할 수 있습니다.

  1. 이제 Petclinic 앱에 사용할 데이터베이스를 만듭니다.
$ gcloud sql databases create petclinic --instance my-instance

또한 Cloud Console을 통해 인스턴스에 액세스하고 구성할 수 있습니다.

  1. 다음 명령어를 실행하여 project-id:zone-id:instance-id 형식의 인스턴스 연결 이름을 가져옵니다. 이 값은 나중에 Spring Boot 앱을 구성할 때 사용합니다.
$ gcloud sql instances describe my-instance |grep connectionName

4. 로컬에서 Petclinic 앱 클론 및 테스트

  1. 이제 Petclinic 앱을 로컬로 클론하고 테스트합니다.
$ git clone https://github.com/spring-projects/spring-petclinic
$ cd spring-petclinic
$ ./mvnw spring-boot:run
  1. Cloud Shell에서 웹 미리보기 를 클릭한 다음 포트 8080에서 미리보기를 선택합니다.

브라우저에 다음과 같이 Petclinic 홈페이지가 표시됩니다.

  1. 데이터 둘러보기 및 데이터 추가 앱이 메모리 내 HyperSQL 데이터베이스를 사용합니다. 이제 HyperSQL에서 데이터베이스로 Cloud SQL을 사용하도록 전환하겠습니다.

5. Petclinic에서 Cloud SQL 사용하기

Maven pom.xml 파일 업데이트

다음과 같이 pom.xml 파일을 업데이트합니다. 시작 조건을 통해 Cloud SQL 데이터베이스에 연결할 자동 구성된 DataSource 객체를 제공합니다. Vim, nano 또는 Emacs를 사용하여 파일을 수정할 수 있습니다.

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" ...>
    ...
   
<!-- Add Spring Cloud GCP Dependency BOM -->
   
<dependencyManagement>
       
<dependencies>
         
<dependency>
         
<groupId>org.springframework.cloud</groupId>
         
<artifactId>spring-cloud-gcp-dependencies</artifactId>
         
<version>1.0.0.RC1</version>
         
<type>pom</type>
         
<scope>import</scope>
         
</dependency>
     
</dependencies>
   
</dependencyManagement>
   
<dependencies>
      ...
     
<!-- Add CloudSQL Starter for MySQL -->
     
<dependency>
       
<groupId>org.springframework.cloud</groupId>
       
<artifactId>spring-cloud-gcp-starter-sql-mysql</artifactId>
     
</dependency>
      ...
   
</dependencies>
   
<repositories>
     
<!-- Use Spring Milestone Repository -->
     
<repository>
       
<id>repository.spring.milestone</id>
       
<name>Spring Milestones Repository</name>
       
<url>http://repo.spring.io/milestone</url>
     
</repository>
   
</repositories>
</project>

application-mysql.properties 업데이트

  1. src/main/resources/application-mysql.properties 의 콘텐츠를 다음 속성으로 바꿉니다. 이전 단계에서 인스턴스 연결 이름을 설정해야 합니다.

src/main/resources/application-mysql.properties

database=mysql

# Delete the rest of the original content of the file and replace with the following:
spring
.cloud.gcp.sql.database-name=petclinic
spring
.cloud.gcp.sql.instance-connection-name=YOUR_CLOUD_SQL_INSTANCE_CONNECTION_NAME

# Initialize the database since the newly created Cloud SQL database has no tables. The following flag is for Spring Boot 2.
spring
.datasource.initialization-mode=always
  1. 마지막으로 mysqlapplication.properties' spring.profiles.active 속성에 추가하여 Spring Boot 앱에서 MySQL용 Cloud SQL 프로필을 사용 설정합니다.

src/main/resources/application.properties

# Keep the content of the file the same
...

# In the last line, add mysql to the spring.profiles.active property
spring
.profiles.active=mysql

6. Cloud Shell에서 앱 실행

  1. Spring Boot 플러그인을 사용하여 Spring Boot 앱을 정상적으로 시작할 수 있습니다.
$ ./mvnw -DskipTests spring-boot:run
  1. 앱이 시작되면 Cloud Shell 툴바에서 웹 미리보기 를 클릭한 다음 포트 8080에서 미리보기를 선택합니다.

브라우저에 다음과 같이 Spring Petclinic 홈페이지가 다시 표시됩니다.

  1. 반려동물 소유자 항목을 추가합니다.

선택사항: Cloud SQL이 데이터를 유지했는지 확인

입력한 데이터가 아래와 같이 Cloud SQL에 유지되었는지 확인할 수 있습니다. 비밀번호를 입력하라는 메시지가 표시되면 Enter (Macintosh에서 반환)를 누릅니다.

$ gcloud sql connect my-instance -u root
Whitelisting your IP for incoming connection for 5 minutes...done.
Enter password: <Press Enter, there is no password by default>
...
mysql> use petclinic;
mysql> select * from owners;
  

선택사항: Cloud SQL 인스턴스 삭제

앱을 중지한 후 다음 명령어를 사용하여 Cloud SQL 인스턴스를 삭제할 수 있습니다.

$ gcloud sql instances delete my-instance 

7. 축하합니다

Spring Boot 앱에서 Cloud SQL에 연결하는 방법을 알아보았습니다.

자세히 알아보기