Informacje o tym ćwiczeniu (w Codelabs)
1. Zanim zaczniesz
Cloud SQL to w pełni zarządzana usługa bazy danych ułatwiająca konfigurację i obsługę relacyjnych baz danych w Google Cloud oraz zarządzanie i administrowanie nimi. Cloud SQL możesz używać z Cloud SQL for MySQL lub Cloud SQL for PostgreSQL.
Z tego ćwiczenia w Codelabs dowiesz się, jak skonfigurować instancję Cloud SQL for MySQL, a następnie zaktualizować aplikację Spring Boot, aby używać instancji Cloud SQL jako miejsca na dane w backendzie. Spring Boot Starter for Google Cloud SQL udostępnia automatycznie skonfigurowane źródło danych DataSource, które pozwala łatwo korzystać z Cloud SQL przy minimalnych zmianach w kodzie. W tym ćwiczeniu w Codelabs wykorzystuje się kod źródłowy Spring Petclinic.
Wymagania wstępne
- Znajomość języka programowania i narzędzi Java
- znajomości standardowych edytorów tekstu systemu Linux, takich jak Vim, Emacs czy nano;
Co trzeba zrobić
- użyć Cloud SQL w aplikacji Spring Boot.
Czego potrzebujesz
- Projekt Google Cloud
- przeglądarki, np. Google Chrome lub Firefox;
2. Konfiguracja i wymagania
Samodzielne konfigurowanie środowiska
- Zaloguj się w konsoli Google Cloud i utwórz nowy projekt lub wykorzystaj już istniejący. Jeśli nie masz jeszcze konta Gmail ani Google Workspace, musisz je utworzyć.
- Nazwa projektu jest wyświetlaną nazwą uczestników tego projektu. To ciąg znaków, który nie jest używany przez interfejsy API Google. W każdej chwili możesz ją zaktualizować.
- Identyfikator projektu jest unikalny we wszystkich projektach Google Cloud i nie można go zmienić (po jego ustawieniu nie można go zmienić). Cloud Console automatycznie wygeneruje unikalny ciąg znaków. zwykle nieważne, co ona jest. W większości ćwiczeń w Codelabs musisz podać swój identyfikator projektu (zwykle identyfikowany jako
PROJECT_ID
). Jeśli nie podoba Ci się wygenerowany identyfikator, możesz wygenerować kolejny losowy. Możesz też spróbować własnych sił i sprawdzić, czy jest dostępna. Po wykonaniu tej czynności nie można jej już zmienić. Pozostanie ona przez cały czas trwania projektu. - Jest jeszcze trzecia wartość, numer projektu, z którego korzystają niektóre interfejsy API. Więcej informacji o wszystkich 3 wartościach znajdziesz w dokumentacji.
- Następnie musisz włączyć płatności w Cloud Console, aby korzystać z zasobów Cloud/interfejsów API. Ukończenie tego ćwiczenia z programowania nic nie kosztuje. Aby wyłączyć zasoby w celu uniknięcia 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
- W konsoli Cloud kliknij Aktywuj Cloud Shell
.
Jeśli uruchamiasz Cloud Shell po raz pierwszy, zobaczysz ekran pośredni z opisem tej usługi. Jeśli wyświetlił się ekran pośredni, kliknij Dalej.
Uzyskanie dostępu do Cloud Shell i połączenie się z nim powinno zająć tylko kilka chwil.
Ta maszyna wirtualna ma wszystkie potrzebne narzędzia dla programistów. Zawiera stały katalog domowy o pojemności 5 GB i działa w Google Cloud, co znacznie zwiększa wydajność sieci i uwierzytelnianie. Większość zadań w ramach tego ćwiczenia z programowania można wykonać w przeglądarce.
Po nawiązaniu połączenia z Cloud Shell powinno pojawić się potwierdzenie, że użytkownik jest uwierzytelniony, a projekt jest ustawiony na identyfikator Twojego projektu.
- Uruchom to polecenie w Cloud Shell, aby potwierdzić, że jesteś uwierzytelniony:
gcloud auth list
Dane wyjściowe polecenia
Credentialed Accounts ACTIVE ACCOUNT * <my_account>@<my_domain.com> To set the active account, run: $ gcloud config set account `ACCOUNT`
- Uruchom to polecenie w Cloud Shell, aby sprawdzić, czy polecenie gcloud zna Twój projekt:
gcloud config list project
Dane wyjściowe polecenia
[core] project = <PROJECT_ID>
Jeśli tak nie jest, możesz go ustawić za pomocą tego polecenia:
gcloud config set project <PROJECT_ID>
Dane wyjściowe polecenia
Updated property [core/project].
3. Konfigurowanie instancji Cloud SQL for MySQL
- Po uruchomieniu Cloud Shell możesz utworzyć nową instancję Cloud SQL przy użyciu wiersza poleceń:
$ gcloud sql instances create my-instance
Po zakończeniu tej operacji instancja będzie gotowa do użycia.
- Teraz utwórz bazę danych, której będziesz używać na potrzeby aplikacji Petclinic:
$ gcloud sql databases create petclinic --instance my-instance
Możesz też uzyskać dostęp do instancji i ją skonfigurować za pomocą konsoli Google Cloud.
- Uzyskaj nazwę połączenia instancji w formacie
project-id:zone-id:instance-id
, uruchamiając następujące polecenie. Użyjesz go później do konfigurowania aplikacji Spring Boot.
$ gcloud sql instances describe my-instance | grep connectionName
4. Klonuj i testuj aplikację Petclinic lokalnie
- Teraz sklonujesz aplikację Petclinic lokalnie.
$ git clone https://github.com/spring-projects/spring-petclinic $ cd spring-petclinic
- Upewnij się, że 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
- Kliknij Podgląd w przeglądarce
w Cloud Shell , a następnie wybierz Podejrzyj na porcie 8080.
Strona główna Petclinic powinna wyglądać tak jak w tym miejscu w przeglądarce:
- Poeksperymentuj i dodawaj dane. Aplikacja używa pamięci bazy danych HyperSQL. 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
w sposób pokazany w tym miejscu. Polecenie inicjujące udostępnia automatycznie skonfigurowany obiekt DataSource
, który umożliwia połączenie z bazą danych Cloud SQL. Plik możesz edytować za pomocą 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>
Zaktualizuj plik application-mysql.properties
- Zastąp zawartość elementu
src/main/resources/application-mysql.properties
poniższymi właściwościami. Musisz ustawić nazwę połączenia instancji 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
- Na koniec włącz profil Cloud SQL for MySQL w aplikacji Spring Boot, dodając
mysql
doapplication.properties
Usługaspring.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
- Aplikację Spring Boot możesz uruchomić w zwykły sposób, używając wtyczki Spring Boot:
$ ./mvnw -DskipTests spring-boot:run
- Po uruchomieniu aplikacji kliknij Podgląd w przeglądarce
na pasku narzędzi Cloud Shell, a następnie wybierz Podejrzyj na porcie 8080.
Strona główna Spring Petclinic powinna pojawić się ponownie w postaci widocznej tutaj w przeglądarce:
- Dodaj wpis właściciela zwierzęcia.
Opcjonalnie: sprawdź, czy dane z Cloud SQL zostały utrwalone
Możesz sprawdzić, czy wpisane dane zostały zachowane w Cloud SQL, jak pokazano poniżej. 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: usuwanie instancji Cloud SQL
Po zatrzymaniu aplikacji możesz usunąć instancję Cloud SQL za pomocą tego polecenia:
$ gcloud sql instances delete my-instance
7. Gratulacje
Już wiesz, jak nawiązać połączenie z Cloud SQL w aplikacji Spring Boot.