connetti un'app Spring Boot a Cloud SQL

1. Prima di iniziare

Cloud SQL è un servizio di database completamente gestito che semplifica la configurazione, la manutenzione, la gestione e l'amministrazione dei database relazionali su Google Cloud. Puoi utilizzare Cloud SQL con Cloud SQL per MySQL o Cloud SQL per PostgreSQL.

In questo codelab imparerai a configurare un'istanza Cloud SQL per MySQL e poi ad aggiornare un'app Spring Boot per utilizzare l'istanza Cloud SQL come spazio di archiviazione di backend. Spring Boot Starter per Google Cloud SQL fornisce un DataSource configurato automaticamente, consentendoti di sfruttare facilmente Cloud SQL con modifiche minime al codice. Questo codelab utilizza il codice sorgente di Spring Petclinic.

Prerequisiti

• Familiarità con il linguaggio di programmazione Java e gli strumenti
• Conoscenza degli editor di testo standard di Linux, ad esempio Vim, Emacs e nano

Attività previste

• Utilizza Cloud SQL nella tua app Spring Boot.

Che cosa ti serve

• Un progetto Google Cloud
• Un browser, ad esempio Google Chrome o Firefox

2. Configurazione e requisiti

Configurazione dell'ambiente autonomo

1. Accedi alla console Google Cloud e crea un nuovo progetto o riutilizzane uno esistente. Se non hai ancora un account Gmail o Google Workspace, devi crearne uno.

• Il nome del progetto è il nome visualizzato per i partecipanti a questo progetto. È una stringa di caratteri non utilizzata dalle API di Google. Puoi sempre aggiornarlo.
• L'ID progetto è univoco in tutti i progetti Google Cloud ed è immutabile (non può essere modificato dopo l'impostazione). La console Cloud genera automaticamente una stringa univoca, di solito non ti interessa di cosa si tratta. Nella maggior parte dei codelab, dovrai fare riferimento all'ID progetto (in genere identificato come PROJECT_ID). Se non ti piace l'ID generato, puoi generarne un altro casuale. In alternativa, puoi provare a crearne uno e vedere se è disponibile. Non può essere modificato dopo questo passaggio e rimane per tutta la durata del progetto.
• Per tua informazione, esiste un terzo valore, un numero di progetto, utilizzato da alcune API. Scopri di più su tutti e tre questi valori nella documentazione.

Attenzione:un ID progetto è univoco a livello globale e non può essere utilizzato da altri dopo che lo hai selezionato. Sei l'unico utente di questo ID. Anche se un progetto viene eliminato, l'ID non può essere riutilizzato

Nota:se utilizzi un account Gmail, puoi lasciare la posizione predefinita impostata su Nessuna organizzazione. Se utilizzi un account Google Workspace, scegli una posizione adatta alla tua organizzazione.

2. Successivamente, devi abilitare la fatturazione in Cloud Console per utilizzare le risorse/API Cloud. Completare questo codelab non costa molto, se non nulla. Per arrestare le risorse ed evitare addebiti oltre a quelli previsti in questo tutorial, puoi eliminare le risorse che hai creato o il progetto. I nuovi utenti di Google Cloud possono usufruire del programma prova senza costi di 300$.

Attiva Cloud Shell

1. Nella console Cloud, fai clic su Attiva Cloud Shell .

Se è la prima volta che avvii Cloud Shell, viene visualizzata una schermata intermedia che ne descrive le funzionalità. Se è stata visualizzata una schermata intermedia, fai clic su Continua.

Bastano pochi istanti per eseguire il provisioning e connettersi a Cloud Shell.

Questa macchina virtuale è caricata con tutti gli strumenti di sviluppo necessari. Offre una home directory permanente da 5 GB e viene eseguita in Google Cloud, migliorando notevolmente le prestazioni e l'autenticazione della rete. Gran parte del lavoro per questo codelab, se non tutto, può essere svolto con un browser.

Una volta eseguita la connessione a Cloud Shell, dovresti vedere che il tuo account è autenticato e il progetto è impostato sul tuo ID progetto.

2. Esegui questo comando in Cloud Shell per verificare che l'account sia autenticato:

gcloud auth list

Output comando

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

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

Nota:lo strumento a riga di comando gcloud è il potente strumento a riga di comando unificato di Google Cloud. È già installato in Cloud Shell. Noterai il supporto del completamento automatico. Per saperne di più, consulta la panoramica dello strumento a riga di comando gcloud.

3. Esegui questo comando in Cloud Shell per verificare che il comando gcloud conosca il tuo progetto:

gcloud config list project

Output comando

[core]
project = <PROJECT_ID>

In caso contrario, puoi impostarlo con questo comando:

gcloud config set project <PROJECT_ID>

Output comando

Updated property [core/project].

Nota:se completi questo tutorial al di fuori di Cloud Shell, segui la procedura per configurare le credenziali predefinite dell'applicazione.

3. Configura un'istanza Cloud SQL per MySQL

1. Dopo l'avvio di Cloud Shell, puoi utilizzare la riga di comando per creare una nuova istanza Cloud SQL:

$ gcloud sql instances create my-instance

Al termine di questa operazione, l'istanza sarà pronta all'uso.

2. Ora crea un database che utilizzerai per l'app Petclinic:

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

Puoi anche accedere all'istanza e configurarla tramite la console Cloud.

Un'istanza Cloud SQL è zonale. Ciò significa che verrà eseguito in una delle zone Google Cloud. In questo codelab, non specificare la zona o la regione. La riga di comando utilizzerà automaticamente us-central come regione e selezionerà una zona per ospitare il database. Per saperne di più, consulta gcloud sql instances create.

3. Recupera il nome della connessione dell'istanza nel formato project-id:zone-id:instance-id eseguendo questo comando. Lo utilizzerai in un secondo momento per configurare l'app Spring Boot.

$ gcloud sql instances describe my-instance | grep connectionName

4. Clona e testa l'app Petclinic in locale

1. Ora clona l'app Petclinic in locale.

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

$ cd spring-petclinic

2. Assicurati che sia impostata la versione corretta di Java ed esegui l'app Petclinic localmente.

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

$ ./mvnw spring-boot:run

3. Fai clic su Anteprima web in Cloud Shell , quindi seleziona Anteprima sulla porta 8080.

Nel browser dovresti visualizzare la home page di Petclinic come mostrato qui:

4. Gioca un po' e aggiungi dati. L'app utilizza un database HyperSQL in memoria. Ora passerai da HyperSQL a Cloud SQL come database.

5. Utilizzare Cloud SQL in Petclinic

Aggiorna il file pom.xml di Maven

Aggiorna il file pom.xml come mostrato qui. Lo starter fornisce un oggetto DataSource configurato automaticamente per connettersi al database Cloud SQL. Puoi utilizzare Vim, nano o Emacs per modificare il file.

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>

Aggiorna application-mysql.properties

1. Sostituisci i contenuti di src/main/resources/application-mysql.properties con le seguenti proprietà. Dovrai impostare il nome della connessione dell'istanza dal passaggio precedente.

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. Infine, abilita un profilo Cloud SQL per MySQL nell'app Spring Boot aggiungendo mysql alla proprietà 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. Esegui l'app in Cloud Shell

1. Puoi avviare l'app Spring Boot normalmente con il plug-in Spring Boot:

$ ./mvnw -DskipTests spring-boot:run

2. Una volta avviata l'app, fai clic su Anteprima web nella barra degli strumenti di Cloud Shell, quindi seleziona Anteprima sulla porta 8080.

Dovresti visualizzare di nuovo la home page di Spring Petclinic come mostrato qui nel browser:

Nota: lo starter Spring Cloud GCP che hai aggiunto ha configurato automaticamente l'URL di connessione Cloud SQL per MySQL. Per impostazione predefinita, i server Cloud SQL non sono esposti tramite un indirizzo IP pubblico. Lo starter Spring Cloud GCP utilizzava anche una speciale fabbrica di socket SSL che stabiliva automaticamente una connessione sicura al server di database Cloud SQL.

3. Aggiungi una voce per il proprietario dell'animale domestico.

(Facoltativo) Verifica che Cloud SQL abbia reso persistenti i dati

Puoi verificare che i dati inseriti siano stati salvati in modo permanente in Cloud SQL come mostrato qui. Premi Invio quando ti viene richiesta una password.

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

(Facoltativo) Elimina l'istanza Cloud SQL

Dopo aver arrestato l'app, puoi eliminare l'istanza Cloud SQL utilizzando il seguente comando:

$ gcloud sql instances delete my-instance

7. Complimenti

Hai imparato a connetterti a Cloud SQL nella tua app Spring Boot.

Scopri di più

• Documentazione di Cloud SQL
• Spring Cloud GCP
• Repository GitHub di Spring Cloud GCP
• Java su Google Cloud