Integrare Spanner con Spring Data

Il modulo Spring Data Spanner ti aiuta a utilizzare Spanner in qualsiasi applicazione Java creata con lo Spring Framework.

Come tutti i moduli Spring Data, Spring Data Spanner fornisce un modello di programmazione basato su Spring che mantiene le garanzie di 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 hai già familiarità con 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.

Installare il modulo

Se utilizzi Maven, aggiungi la distinta base (BOM) di Spring Cloud GCP e Spring Data Spanner al file pom.xml. Queste dipendenze forniscono i componenti Spring Data Spanner al tuo Spring ApplicationContext:

<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>spring-cloud-gcp-dependencies</artifactId>
      <version>3.7.7</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-dependencies</artifactId>
      <version>${spring.boot.version}</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>

<dependencies>
  <dependency>
    <groupId>com.google.cloud</groupId>
    <artifactId>spring-cloud-gcp-starter-data-spanner</artifactId>
  </dependency>
</dependencies>

Devi anche creare un account di servizio e utilizzare la chiave dell'account di servizio per l'autenticazione Google Cloud.

Per saperne di più, consulta le istruzioni per la configurazione di un ambiente di sviluppo Java. Non è necessario installare la Google Cloud libreria client per Java; lo starter di Spring Boot installa automaticamente la libreria client.

Configurare il modulo

Questa sezione descrive alcune delle impostazioni di configurazione più utilizzate per Spring Data Spanner. Per un elenco completo delle impostazioni, consulta la documentazione di riferimento.

Specificare 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 progetto Google Cloud . Esegue l'override del valore di `spring.cloud.gcp.config.project-id`.
`spring.cloud.gcp.spanner.instance-id`	L'ID istanza Spanner.
`spring.cloud.gcp.spanner.database`	Il database a cui connettersi.

Modellare i dati di Spanner

Con Spring Data Spanner, puoi utilizzare oggetti Java semplici (POJO) per modellare i dati archiviati nelle tabelle Spanner.

Per ogni tabella del database, dichiara un'entità che rappresenta un record in quella tabella. Utilizza le annotazioni per mappare l'entità e le relative proprietà a una tabella e alle relative colonne.

Puoi utilizzare le seguenti annotazioni per modellare le relazioni semplici tra entità e tabelle:

Annotazioni delle entità
`@Column(name = "columnName")`	Facoltativo. Mappa la proprietà a una colonna specifica nella 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 `camelCase` ai nomi delle colonne `PascalCase`. Ad esempio, la proprietà `singerId` viene mappata al nome della colonna `SingerId`.
`@Embedded`	Indica che la proprietà è un oggetto incorporato che può contenere i componenti di una chiave primaria. Se la proprietà viene effettivamente utilizzata nella chiave primaria, devi includere anche l'annotazione `@PrimaryKey`.
`@Interleaved` `@Interleaved(lazy = true)`	Indica che una proprietà contiene un elenco di righe intercalate con la riga corrente. Per impostazione predefinita, Spring Data Spanner recupera le righe intercalate al momento della creazione dell'istanza. Per recuperare le righe in modo lazy, quando accedi alla proprietà, utilizza `@Interleaved(lazy = true)`. Esempio: se un'entità `Singer` può avere voci intercalate `Album` come elementi secondari, aggiungi una proprietà `List<Album>` all'entità `Singer`. Inoltre, aggiungi un'annotazione `@Interleaved` alla proprietà.
`@NotMapped`	Indica che una proprietà non è archiviata nel database e deve essere ignorata.
`@PrimaryKey` `@PrimaryKey(keyOrder = N)`	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 `keyOrder` è `1`. Esempio: `@PrimaryKey(keyOrder = 3)`
`@Table(name = "TABLE_NAME")`	La tabella che l'entità modella. Ogni istanza dell'entità rappresenta un record nella tabella. Sostituisci `TABLE_NAME` con il nome della tabella. Esempio: `@Table(name = "Singers")`

Se devi modellare relazioni più complesse, consulta il riferimento di Spring Data Spanner per i dettagli su altre annotazioni supportate dal modulo.

Gli esempi seguenti 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 intercalati con l'entità Singer. Spring Data Spanner popola automaticamente questa proprietà.
Per le entità Album, l'esempio include una proprietà relatedAlbums che non è archiviata in Spanner.

import com.google.cloud.spring.data.spanner.core.mapping.Interleaved;
import com.google.cloud.spring.data.spanner.core.mapping.PrimaryKey;
import com.google.cloud.spring.data.spanner.core.mapping.Table;
import java.util.Date;
import java.util.List;


/**
 * An entity and table holding singers.
 */
@Table(name = "Singers")
public class Singer {
  @PrimaryKey
  long singerId;

  String firstName;

  String lastName;

  Date birthDate;

  @Interleaved
  List<Album> albums;
}

import com.google.cloud.spring.data.spanner.core.mapping.NotMapped;
import com.google.cloud.spring.data.spanner.core.mapping.PrimaryKey;
import com.google.cloud.spring.data.spanner.core.mapping.Table;
import java.util.List;

/**
 * An entity class representing an Album.
 */
@Table(name = "Albums")
public class Album {

  @PrimaryKey
  long singerId;

  @PrimaryKey(keyOrder = 2)
  long albumId;

  String albumTitle;

  long marketingBudget;

  @NotMapped
  List<Album> relatedAlbums;

  public Album(long singerId, long albumId, String albumTitle, long marketingBudget) {
    this.singerId = singerId;
    this.albumId = albumId;
    this.albumTitle = albumTitle;
    this.marketingBudget = marketingBudget;
  }
}

Eseguire query e modificare i dati

Per eseguire query e modificare i dati con Spring Data Spanner, puoi acquisire un SpannerTemplate bean, che implementa SpannerOperations. SpannerTemplate fornisce metodi per eseguire query SQL e modificare i dati con istruzioni DML (Data Manipulation Language). Puoi utilizzare anche questo bean per accedere all'API di lettura e all'API di mutazione per Spanner.

Inoltre, puoi estendere l' SpannerRepository interfaccia per incapsulare tutta la logica dell'applicazione che esegue query e modifica i dati in Spanner.

Le sezioni seguenti spiegano come utilizzare SpannerTemplate e SpannerRepository.

Acquisire un bean modello

Utilizza l'annotazione @Autowired per acquisire automaticamente un bean SpannerTemplate. Puoi quindi utilizzare SpannerTemplate in tutta la classe.

L'esempio seguente mostra una classe che acquisisce e utilizza il bean:

import com.google.cloud.spanner.KeySet;
import com.google.cloud.spanner.Statement;
import com.google.cloud.spring.data.spanner.core.SpannerQueryOptions;
import com.google.cloud.spring.data.spanner.core.SpannerTemplate;
import java.util.List;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

/**
 * A quick start code for Spring Data Cloud Spanner. It demonstrates how to use SpannerTemplate to
 * execute DML and SQL queries, save POJOs, and read entities.
 */
@Component
public class SpannerTemplateSample {

  @Autowired
  SpannerTemplate spannerTemplate;

  public void runTemplateExample(Singer singer) {
    // Delete all of the rows in the Singer table.
    this.spannerTemplate.delete(Singer.class, KeySet.all());

    // Insert a singer into the Singers table.
    this.spannerTemplate.insert(singer);

    // Read all of the singers in the Singers table.
    List<Singer> allSingers = this.spannerTemplate
        .query(Singer.class, Statement.of("SELECT * FROM Singers"),
                new SpannerQueryOptions().setAllowPartialRead(true));
  }

}

Puoi utilizzare il SpannerTemplate bean per eseguire transazioni di sola lettura e transazioni di lettura/scrittura. Inoltre, puoi utilizzare l' @Transactional annotazione per creare transazioni dichiarative.

Acquisire un bean repository

Se utilizzi un SpannerRepository, puoi utilizzare l'annotazione @Autowired per acquisire un bean che implementa l'interfaccia del repository. Un repository include metodi per eseguire funzioni Java come transazioni di sola lettura e transazioni di lettura/scrittura. Per le operazioni di livello inferiore, puoi ottenere il bean modello utilizzato dal repository.

Gli esempi seguenti mostrano l'interfaccia per un repository e una classe che acquisisce e utilizza il bean:

import com.google.cloud.spanner.Key;
import com.google.cloud.spring.data.spanner.repository.SpannerRepository;
import com.google.cloud.spring.data.spanner.repository.query.Query;
import java.util.List;
import org.springframework.data.repository.query.Param;


/**
 * An interface of various Query Methods. The behavior of the queries is defined only by
 * their names, arguments, or annotated SQL strings. The implementation of these functions
 * is generated by Spring Data Cloud Spanner.
 */
public interface SingerRepository extends SpannerRepository<Singer, Key> {
  List<Singer> findByLastName(String lastName);

  int countByFirstName(String firstName);

  int deleteByLastName(String lastName);

  List<Singer> findTop3DistinctByFirstNameAndSingerIdIgnoreCaseOrLastNameOrderByLastNameDesc(
      String firstName, String lastName, long singerId);

  @Query("SELECT * FROM Singers WHERE firstName LIKE '%@fragment';")
  List<Singer> getByQuery(@Param("fragment") String firstNameFragment);
}

import java.util.List;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

/**
 * A quick start code for Spring Data Cloud Spanner.
 * It demonstrates how to use a SpannerRepository to execute read-write queries
 * generated from interface definitions.
 *
 */
@Component
public class SpannerRepositorySample {

  @Autowired
  SingerRepository singerRepository;

  public void runRepositoryExample() {
    List<Singer> lastNameSingers = this.singerRepository.findByLastName("a last name");

    int fistNameCount = this.singerRepository.countByFirstName("a first name");

    int deletedLastNameCount = this.singerRepository.deleteByLastName("a last name");
  }

}

Gestire Spanner

Per ottenere informazioni sui database Spanner, aggiornare uno schema con un istruzione DDL (Data Definition Language) o completare altre attività amministrative , puoi acquisire un SpannerDatabaseAdminTemplate bean.

Utilizza l'annotazione @Autowired per acquisire automaticamente il bean. Puoi quindi utilizzare SpannerDatabaseAdminTemplate in tutta la classe.