Il modulo Spring Data Spanner consente di utilizzare Spanner in qualsiasi applicazione Java creata con il framework Spring.
Come tutti i moduli Spring Data, Spring Data Spanner offre un modello di programmazione basato su Spring che conserva la coerenza e la scalabilità di Spanner. Le sue funzionalità sono simili a Spring Data JPA e Hibernate ORM, con annotazioni progettate per Spanner. Per saperne di più su come utilizzare Spring Data JPA con Spanner, consulta Integrare Spanner con Spring Data JPA (dialetto GoogleSQL).
Se conosci già Spring, Spring Data Spanner può semplificare l'utilizzo di Spanner nella tua applicazione e ridurre la quantità di codice che devi scrivere.
Questa pagina spiega come aggiungere Spring Data Spanner a un'applicazione Java. Per informazioni dettagliate sul modulo, consulta il riferimento di Spring Data Spanner.
Installa il modulo
Se utilizzi Maven, aggiungi BOM (Bill of Materials) di Google Cloud Spring Cloud e Spanner dati Spring al tuo file pom.xml
. Queste dipendenze forniscono i componenti Spring Data Spanner a ApplicationContext
Spring:
Devi inoltre creare un account di servizio e utilizzare la chiave dell'account di servizio per l'autenticazione con Google Cloud.
Per ulteriori informazioni, consulta le istruzioni per la configurazione di un ambiente di sviluppo Java. Non è necessario installare la libreria client di Google Cloud per Java; il comando iniziale Spring Boot installa la libreria client automaticamente.
Configura il modulo
Questa sezione descrive alcune delle impostazioni di configurazione più comuni per Spring Data Spanner. Per un elenco completo delle impostazioni, consulta la documentazione di riferimento.
Specifica un'istanza e un database
Per specificare l'istanza e il database predefiniti, imposta le seguenti proprietà di configurazione per l'applicazione:
Proprietà | Descrizione |
---|---|
spring.cloud.gcp.spanner.project-id |
Facoltativo. L'ID del progetto Google Cloud. Sostituisce il valore spring.cloud.gcp.config.project-id . |
spring.cloud.gcp.spanner.instance-id |
L'ID dell'istanza Spanner. |
spring.cloud.gcp.spanner.database |
Il database a cui connettersi. |
Dati Spanner del modello
Con Spring Data Spanner, puoi utilizzare oggetti Java (POJO) semplici per modellare i dati archiviati nelle tabelle Spanner.
Per ogni tabella nel database, dichiara un'entità che rappresenta un record nella tabella. Utilizza le annotazioni per mappare l'entità e le sue proprietà a una tabella e alle relative colonne.
Puoi utilizzare le seguenti annotazioni per modellare semplici relazioni tra entità e tabelle:
Annotazioni entità | |
---|---|
@Column(name = "columnName")
|
Facoltativo. Mappa la proprietà a una colonna specifica della tabella Spanner, eseguendo l'override della strategia di denominazione che mappa automaticamente i nomi.
Se ometti questa proprietà, la strategia di denominazione predefinita per
Spring Data Spanner mappa i nomi delle proprietà Java |
@Embedded |
Indica che la proprietà è un oggetto incorporato che può contenere componenti di una chiave primaria. Se la proprietà viene effettivamente utilizzata nella chiave primaria, devi includere anche l'annotazione |
|
Indica che una proprietà contiene un elenco di righe con interleaving con la riga corrente.
Per impostazione predefinita, Spring Data Spanner recupera le righe con interleaving al momento della creazione dell'istanza. Per recuperare le righe in modo lento, quando accedi alla
proprietà, utilizza
Esempio: se un'entità |
@NotMapped |
Indica che una proprietà non è archiviata nel database e deve essere ignorata. |
|
Indica che la proprietà è un componente della chiave primaria e identifica la posizione della proprietà all'interno della chiave primaria, a partire da 1. Il valore predefinito di
Esempio: |
@Table(name = "TABLE_NAME") |
La tabella modellata dall'entità. Ogni istanza dell'entità
rappresenta un record nella tabella. Sostituisci
Esempio: |
Se hai bisogno di modellare relazioni più complesse, consulta il riferimento di Spring Data Spanner per dettagli sulle altre annotazioni supportate dal modulo.
I seguenti esempi mostrano un modo per modellare le tabelle Singers
e Albums
per Spring Data Spanner:
- Per le entità
Singer
, l'esempio include una proprietàalbums
, con un'annotazione@Interleaved
. Questa proprietà contiene un elenco di album con interleaving con l'entitàSinger
. Spring Data Spanner compila questa proprietà automaticamente. - Per le entità
Album
, l'esempio include una proprietàrelatedAlbums
che non è archiviata in Spanner.
Eseguire query e modificare i dati
Per eseguire query e modificare i dati con Spring Data Spanner, puoi acquisire un bean SpannerTemplate
, che implementa SpannerOperations
. SpannerTemplate
offre metodi per eseguire query SQL e modificare i dati con istruzioni DML (Data Manipulation Language). Puoi utilizzare questo bean anche per accedere all'API Read e all'API Mutazione per Spanner.
Inoltre, puoi estendere l'interfaccia di SpannerRepository
per incapsulare tutta la logica dell'applicazione che esegue query e modifica i dati in Spanner.
Le sezioni seguenti spiegano come lavorare con SpannerTemplate
e
SpannerRepository
.
Acquisisci un bean di modello
Utilizza l'annotazione @Autowired
per acquisire automaticamente un bean SpannerTemplate
. Potrai quindi utilizzare SpannerTemplate
in tutto il corso.
L'esempio seguente mostra una classe che acquisisce e utilizza il bean:
Puoi utilizzare il bean SpannerTemplate
per eseguire transazioni di sola lettura e transazioni di lettura e scrittura. Inoltre, puoi utilizzare l'annotazione @Transactional
per creare transazioni dichiarative.
Acquisisci un bean di repository
Se utilizzi un SpannerRepository
, puoi utilizzare l'annotazione @Autowired
per acquisire un bean che implementa l'interfaccia del tuo repository. Un repository include metodi per eseguire funzioni Java come transazioni di sola lettura e transazioni di lettura e scrittura. Per le operazioni di livello inferiore, puoi
ottenere il bean modello utilizzato dal repository.
I seguenti esempi mostrano l'interfaccia per un repository e una classe che acquisisce e utilizza il bean:
Gestisci Spanner
Per ottenere informazioni sui tuoi database Spanner, aggiorna uno schema con un'istruzione DDL (Data Definition Language) o completa altre attività amministrative, puoi acquisire un bean SpannerDatabaseAdminTemplate
.
Utilizza l'annotazione @Autowired
per acquisire automaticamente il bean. Potrai quindi
utilizzare SpannerDatabaseAdminTemplate
durante il corso.
L'esempio seguente mostra una classe che acquisisce e utilizza il bean:
Passaggi successivi
- Inizia a utilizzare Spring Cloud GCP.
- Scopri di più sull'utilizzo di Spring Data Spanner nelle applicazioni.
- Invia un problema su GitHub per segnalare un bug o fare una domanda sul modulo.
- Scopri di più sul supporto del framework Spring su Google Cloud.
- Prova un codelab per eseguire il deployment ed eseguire un'applicazione che utilizza Spring Cloud GCP.