Das Spring Data Spanner-Modul unterstützt Sie bei der Verwendung von Spanner in jeder Java-Anwendung, die mit dem Spring Framework erstellt wurde.
Wie alle Spring Data-Module bietet Spring Data Spanner ein Spring-basiertes Programmiermodell, das die Konsistenzgarantien und Skalierbarkeit von Spanner beibehält. Die Funktionen ähneln Spring Data JPA und Hibernate ORM, mit Anmerkungen, die für Spanner entwickelt wurden. Weitere Informationen zur Verwendung von Spring Data JPA mit Spanner finden Sie unter Spanner in Spring Data JPA einbinden (GoogleSQL-Dialekt).
Wenn Sie bereits mit Spring vertraut sind, erleichtert Ihnen Spring Data Spanner die Arbeit mit Spanner in Ihrer Anwendung und reduziert die Menge an Code, den Sie schreiben müssen.
Auf dieser Seite wird beschrieben, wie Sie Spring Data Spanner einer Java-Anwendung hinzufügen. Ausführliche Informationen zum Modul finden Sie in der Spring Data Spanner-Referenz.
Modul installieren
Wenn Sie Maven verwenden, fügen Sie die Spring Cloud GCP Bill of Materials (BOM) und Spring Data Spanner in Ihre pom.xml-Datei ein. Diese Abhängigkeiten stellen die Spring Data Spanner-Komponenten für Ihre Spring-ApplicationContext bereit:
Außerdem müssen Sie ein Dienstkonto erstellen und den Dienstkontoschlüssel zum Authentifizieren bei Google Cloudverwenden.
Weitere Informationen finden Sie in der Anleitung zum Java-Entwicklungsumgebung einrichten. Sie müssen die Google Cloud -Clientbibliothek für Java nicht installieren. Der Spring Boot-Starter installiert sie automatisch.
Modul konfigurieren
In diesem Abschnitt werden einige der am häufigsten verwendeten Konfigurationseinstellungen für Spring Data Spanner beschrieben. Eine vollständige Liste der Einstellungen finden Sie in der Referenzdokumentation.
Instanz und Datenbank angeben
Um die Standardinstanz und -datenbank anzugeben, legen Sie die folgenden Konfigurationsattribute für Ihre Anwendung fest:
| Attribut | Beschreibung |
|---|---|
spring.cloud.gcp.spanner.project-id |
Optional. Die Google Cloud Projekt-ID. Überschreibt den Wert von spring.cloud.gcp.config.project-id. |
spring.cloud.gcp.spanner.instance-id |
Die Cloud Spanner-Instanz-ID. |
spring.cloud.gcp.spanner.database |
Die Datenbank, zu der eine Verbindung hergestellt werden soll. |
Spanner-Daten modellieren
Mit Spring Data Spanner können Sie einfache alte Java-Objekte (POJOs) verwenden, um die Daten zu modellieren, die Sie in Ihren Spanner-Tabellen speichern.
Deklarieren Sie für jede Tabelle in der Datenbank eine Entität, die einen Datensatz in dieser Tabelle darstellt. Verwenden Sie Anmerkungen, um die Entität und dazugehörige Attribute einer Tabelle und ihren Spalten zuzuordnen.
Sie können die folgenden Annotationen verwenden, um einfache Beziehungen zwischen Entitäten und Tabellen zu modellieren:
| Entitätsanmerkungen | |
|---|---|
@Column(name = "columnName")
|
Optional. Ordnet das Attribut einer bestimmten Spalte in der Spanner-Tabelle zu und überschreibt damit die Namensstrategie, die die Namen automatisch zuordnet.
Wenn Sie diese Eigenschaft weglassen, wird die Standardbenennungsstrategie für Spring Data Spanner verwendet, bei der Java-Eigenschaftsnamen ( |
@Embedded |
Gibt an, dass das Attribut ein eingebettetes Objekt ist, das Komponenten eines Primärschlüssels enthalten kann. Wenn das Attribut tatsächlich im Primärschlüssel verwendet wird, müssen Sie auch die Anmerkung |
|
|
Gibt an, dass ein Attribut eine Liste von Zeilen enthält, die mit der aktuellen Zeile verschränkt sind.
Standardmäßig ruft Spring Data Spanner die verschachtelten Zeilen beim Erstellen der Instanz ab. Zum verzögerten Abruf der Zeilen verwenden Sie
Beispiel: Wenn die Entität |
@NotMapped |
Gibt an, dass ein Attribut nicht in der Datenbank gespeichert ist und ignoriert werden soll. |
|
|
Gibt an, dass das Attribut eine Komponente des Primärschlüssels ist und die Position des Attributs innerhalb des Primärschlüssels angibt, beginnend bei 1. Der Standardwert von Beispiel: |
@Table(name = "TABLE_NAME") |
Die Tabelle, die die Entität modelliert. Jede Instanz der Entität stellt einen Datensatz in der Tabelle dar. Ersetzen Sie
Beispiel: |
Wenn Sie komplexere Beziehungen modellieren müssen, finden Sie in der Spring Data Spanner-Referenz Details zu anderen Annotationen, die vom Modul unterstützt werden.
Die folgenden Beispiele zeigen eine Möglichkeit, die Tabellen Singers und Albums für Spring Data Spanner zu modellieren:
- Für
Singer-Entitäten enthält das Beispiel das Attributalbumsmit der Anmerkung@Interleaved. Dieses Attribut enthält eine Liste von Alben, die mit der EntitätSingerverschränkt sind. Diese Property wird automatisch von Spring Data Spanner ausgefüllt. - Für
Album-Entitäten enthält das Beispiel einerelatedAlbums-Property, die nicht in Spanner gespeichert wird.
Daten abfragen und ändern
Wenn Sie Daten mit Spring Data Spanner abfragen und ändern möchten, können Sie einen SpannerTemplate-Bean abrufen, der SpannerOperations implementiert. SpannerTemplate
bietet Methoden zum Ausführen von SQL-Abfragen und zum Ändern von Daten mit DML-Anweisungen (Data Manipulation Language). Sie können diese Bean auch verwenden, um auf die Read API und die Mutation API für Spanner zuzugreifen.
Außerdem können Sie die SpannerRepository-Schnittstelle erweitern, um die gesamte Anwendungslogik zu kapseln, mit der Daten in Spanner abgefragt und geändert werden.
In den folgenden Abschnitten wird die Verwendung von SpannerTemplate und SpannerRepository erläutert.
Vorlagen-Bean abrufen
Mit der Anmerkung @Autowired können Sie eine SpannerTemplate-Bean automatisch übernehmen. Anschließend können Sie SpannerTemplate in der gesamten Klasse verwenden.
Das folgende Beispiel zeigt eine Klasse, die die Bean übernimmt und verwendet:
Sie können die SpannerTemplate-Bean verwenden, um nur schreibgeschützte Transaktionen und Lese-Schreib-Transaktionen auszuführen. Außerdem können Sie die @Transactional-Anmerkung verwenden, um deklarative Transaktionen zu erstellen.
Repository-Bean abrufen
Bei Verwendung eines SpannerRepository können Sie die @Autowired-Anmerkung zur Übernahme einer Bean verwenden, die die Oberfläche Ihres Repositorys implementiert. Ein Repository enthält Methoden zum Ausführen von Java-Funktionen als schreibgeschützte Transaktionen und Lese-Schreib-Transaktionen. Für untergeordnete Vorgänge können Sie die vom Repository verwendete Vorlagen-Bean abrufen.
Die folgenden Beispiele zeigen die Oberfläche für ein Repository und eine Klasse, die die Bean übernimmt und verwendet:
Spanner verwalten
Wenn Sie Informationen zu Ihren Spanner-Datenbanken abrufen, ein Schema mit einer Datendefinitionssprache (DDL)-Anweisung aktualisieren oder andere administrative Aufgaben ausführen möchten, können Sie eine SpannerDatabaseAdminTemplate-Bean abrufen.
Mit der Anmerkung @Autowired können Sie eine -Bean automatisch übernehmen. Anschließend können Sie die SpannerDatabaseAdminTemplate in der gesamten Klasse verwenden.
Das folgende Beispiel zeigt eine Klasse, die die Bean übernimmt und verwendet:
Nächste Schritte
- Erste Schritte mit Spring Cloud GCP
- Weitere Informationen zur Verwendung von Spring Data Spanner in Ihren Anwendungen
- Ein GitHub-Problem senden, um einen Fehler zu melden oder eine Frage zum Modul zu stellen
- Spring Framework-Support in Google Cloud
- Ein Code-Lab ausprobieren, um eine Anwendung bereitzustellen und auszuführen, die Spring Cloud GCP verwendet.