Łączenie aplikacji Spring Boot z Cloud SQL

1. Zanim zaczniesz

Cloud SQL to usługa bazy danych w pełni zarządzana, która ułatwia konfigurowanie, obsługę, zarządzanie i administrowanie relacyjnymi bazami danych w Google Cloud. Możesz używać Cloud SQL z Cloud SQL for MySQL lub Cloud SQL for PostgreSQL.

Z tego przewodnika dowiesz się, jak skonfigurować instancję Cloud SQL for MySQL, a następnie zaktualizować aplikację Spring Boot, aby używała instancji Cloud SQL jako pamięci backendu. Spring Boot Starter for Google Cloud SQL zapewnia automatycznie skonfigurowane DataSource, dzięki czemu możesz łatwo korzystać z Cloud SQL przy minimalnych zmianach w kodzie. W tym laboratorium używany jest kod źródłowy Spring Petclinic.

Wymagania wstępne

• Znajomość języka programowania Java i narzędzi
• Znajomość standardowych edytorów tekstu systemu Linux, takich jak Vim, Emacs i nano.

Co musisz zrobić

• Używanie Cloud SQL w aplikacji Spring Boot.

Czego potrzebujesz

• projekt Google Cloud,
• przeglądarka, np. Google Chrome lub Firefox;

2. Konfiguracja i wymagania

Samodzielne konfigurowanie środowiska

1. Zaloguj się w konsoli Google Cloud i utwórz nowy projekt lub użyj istniejącego. Jeśli nie masz jeszcze konta Gmail ani Google Workspace, musisz je utworzyć.

• Nazwa projektu to wyświetlana nazwa uczestników tego projektu. Jest to ciąg znaków, który nie jest używany przez interfejsy API Google. Zawsze możesz ją zaktualizować.
• Identyfikator projektu jest unikalny we wszystkich projektach Google Cloud i nie można go zmienić po ustawieniu. Konsola Cloud automatycznie generuje unikalny ciąg znaków. Zwykle nie musisz się nim przejmować. W większości ćwiczeń z programowania musisz odwoływać się do identyfikatora projektu (zwykle oznaczanego jako PROJECT_ID). Jeśli wygenerowany identyfikator Ci się nie podoba, możesz wygenerować inny losowy identyfikator. Możesz też spróbować własnej nazwy i sprawdzić, czy jest dostępna. Po tym kroku nie można go zmienić i pozostaje on taki przez cały czas trwania projektu.
• Warto wiedzieć, że istnieje też trzecia wartość, numer projektu, której używają niektóre interfejsy API. Więcej informacji o tych 3 wartościach znajdziesz w dokumentacji.

Ostrzeżenie: identyfikator projektu jest unikalny na całym świecie i po jego wybraniu nie może być używany przez nikogo innego. Jesteś jedynym użytkownikiem tego identyfikatora. Nawet po usunięciu projektu nie można ponownie użyć jego identyfikatora.

Uwaga: jeśli używasz konta Gmail, możesz pozostawić domyślną lokalizację ustawioną na Brak organizacji. Jeśli używasz konta Google Workspace, wybierz lokalizację odpowiednią dla Twojej organizacji.

2. Następnie musisz włączyć płatności w konsoli Cloud, aby korzystać z zasobów i interfejsów API Google Cloud. Wykonanie tego laboratorium nie będzie kosztować dużo, a może nawet nic. Aby wyłączyć zasoby i uniknąć naliczania opłat po zakończeniu tego samouczka, możesz usunąć utworzone zasoby lub projekt. Nowi użytkownicy Google Cloud mogą skorzystać z programu bezpłatnego okresu próbnego o wartości 300 USD.

Aktywowanie Cloud Shell

1. W konsoli Cloud kliknij Aktywuj Cloud Shell .

Jeśli uruchamiasz Cloud Shell po raz pierwszy, zobaczysz ekran pośredni z opisem tego środowiska. Jeśli pojawił się ekran pośredni, kliknij Dalej.

Uzyskanie dostępu do środowiska Cloud Shell i połączenie się z nim powinno zająć tylko kilka chwil.

Ta maszyna wirtualna zawiera wszystkie potrzebne narzędzia dla programistów. Zawiera również stały katalog domowy o pojemności 5 GB i działa w Google Cloud, co znacznie zwiększa wydajność sieci i usprawnia proces uwierzytelniania. Większość zadań w tym module, a być może wszystkie, możesz wykonać w przeglądarce.

Po połączeniu z Cloud Shell zobaczysz, że uwierzytelnianie zostało już przeprowadzone, a projekt jest już ustawiony na Twój identyfikator projektu.

2. Aby potwierdzić, że uwierzytelnianie zostało przeprowadzone, uruchom w Cloud Shell to polecenie:

gcloud auth list

Wynik polecenia

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

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

Uwaga: narzędzie wiersza poleceń gcloud to zaawansowane i ujednolicone narzędzie wiersza poleceń w Google Cloud. Jest już zainstalowane w Cloud Shell. Zauważysz, że obsługuje on uzupełnianie za pomocą klawisza Tab. Więcej informacji znajdziesz w omówieniu narzędzia wiersza poleceń gcloud.

3. Aby potwierdzić, że polecenie gcloud zna Twój projekt, uruchom w Cloud Shell to polecenie:

gcloud config list project

Wynik polecenia

[core]
project = <PROJECT_ID>

Jeśli nie, możesz go ustawić za pomocą tego polecenia:

gcloud config set project <PROJECT_ID>

Wynik polecenia

Updated property [core/project].

Uwaga: jeśli wykonujesz ten samouczek poza Cloud Shell, postępuj zgodnie z instrukcjami w artykule Konfigurowanie domyślnego uwierzytelniania aplikacji.

3. Konfigurowanie instancji Cloud SQL for MySQL

1. Po uruchomieniu Cloud Shell możesz utworzyć nową instancję Cloud SQL za pomocą wiersza poleceń:

$ gcloud sql instances create my-instance

Po zakończeniu tej operacji instancja będzie gotowa do użycia.

2. Teraz utwórz bazę danych, której będziesz używać w aplikacji Petclinic:

$ gcloud sql databases create petclinic --instance my-instance

Możesz też uzyskać dostęp do instancji i skonfigurować ją w konsoli Google Cloud.

Instancja Cloud SQL jest strefowa. Oznacza to, że będzie działać w jednej ze stref Google Cloud. W tym laboratorium nie określasz strefy ani regionu. Wiersz poleceń automatycznie użyje regionu us-central i wybierze strefę do hostowania bazy danych. Więcej informacji znajdziesz w artykule gcloud sql instances create.

3. Aby uzyskać nazwę połączenia instancji w formacie project-id:zone-id:instance-id, uruchom to polecenie. Użyjesz go później podczas konfigurowania aplikacji Spring Boot.

$ gcloud sql instances describe my-instance | grep connectionName

4. Klonowanie i testowanie aplikacji Petclinic lokalnie

1. Teraz sklonujesz lokalnie aplikację Petclinic.

$ git clone https://github.com/spring-projects/spring-petclinic

$ cd spring-petclinic

2. Sprawdź, czy ustawiona jest prawidłowa wersja Javy, i uruchom aplikację Petclinic lokalnie.

$ export JAVA_HOME=/usr/lib/jvm/java-17-openjdk-amd64/

$ ./mvnw spring-boot:run

3. W Cloud Shell kliknij Podgląd w przeglądarce , a następnie wybierz Podejrzyj na porcie 8080.

W przeglądarce powinna być widoczna strona główna Petclinic, jak pokazano poniżej:

4. Eksperymentuj i dodawaj dane. Aplikacja korzysta z bazy danych HyperSQL w pamięci. Teraz przejdziesz z HyperSQL na Cloud SQL jako bazę danych.

5. Korzystanie z Cloud SQL w Petclinic

Zaktualizuj plik pom.xml Maven.

Zaktualizuj plik pom.xml zgodnie z instrukcjami. Starter udostępnia automatycznie skonfigurowany obiekt DataSource do łączenia się z bazą danych Cloud SQL. Do edycji pliku możesz użyć edytora Vim, nano lub 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>com.google.cloud</groupId>
          <artifactId>spring-cloud-gcp-dependencies</artifactId>
          <version>4.1.4</version>
          <type>pom</type>
          <scope>import</scope>
          </dependency>
      </dependencies>
    </dependencyManagement>
    <dependencies>
      ...
      <!-- Add CloudSQL Starter for MySQL -->
      <dependency>
        <groupId>com.google.cloud</groupId>
        <artifactId>spring-cloud-gcp-starter-sql-mysql</artifactId>
      </dependency>
      ...
    </dependencies>
</project>

Aktualizacja pliku application-mysql.properties

1. Zastąp zawartość pliku src/main/resources/application-mysql.properties tymi właściwościami. Musisz ustawić nazwę połączenia z instancją z poprzedniego kroku.

src/main/resources/application-mysql.properties

database=mysql

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.5+.
spring.sql.init.mode=always  

2. Na koniec włącz profil Cloud SQL for MySQL w aplikacji Spring Boot, dodając mysql do właściwości application.properties' spring.profiles.active:

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. Uruchamianie aplikacji w Cloud Shell

1. Aplikację Spring Boot możesz uruchomić normalnie za pomocą wtyczki Spring Boot:

$ ./mvnw -DskipTests spring-boot:run

2. Po uruchomieniu aplikacji kliknij Podgląd w przeglądarcena pasku narzędzi Cloud Shell, a następnie wybierz Podejrzyj na porcie 8080.

W przeglądarce powinna ponownie wyświetlić się strona główna Spring Petclinic, jak pokazano poniżej:

Uwaga: dodany przez Ciebie starter Spring Cloud GCP automatycznie skonfigurował adres URL połączenia Cloud SQL for MySQL. Domyślnie serwery Cloud SQL nie są udostępniane za pomocą publicznego adresu IP. Starter Spring Cloud GCP używał też specjalnej fabryki gniazd SSL, która automatycznie nawiązywała bezpieczne połączenie z serwerem bazy danych Cloud SQL.

3. Dodaj wpis właściciela zwierzęcia.

Opcjonalnie: sprawdź, czy Cloud SQL zapisał dane

Możesz sprawdzić, czy wprowadzone dane zostały zapisane w Cloud SQL, jak pokazano tutaj. Gdy pojawi się prośba o podanie hasła, naciśnij Enter.

$ 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;

Opcjonalnie: usuń instancję Cloud SQL

Po zatrzymaniu aplikacji możesz usunąć instancję Cloud SQL za pomocą tego polecenia:

$ gcloud sql instances delete my-instance

7. Gratulacje

Dowiedzieliśmy się, jak połączyć się z Cloud SQL w aplikacji Spring Boot.

Więcej informacji

• Dokumentacja Cloud SQL
• Spring Cloud GCP
• repozytorium Spring Cloud GCP na GitHubie,
• Java w Google Cloud