Spanner を Spring Data JPA（PostgreSQL 言語）と統合する

Spring Data JPA は、より大きな Spring Data ファミリーの一部であり、JPA ベースのリポジトリの実装を容易にします。Spring Data JPA は、PostgreSQL やその他のさまざまなデータベース システムをサポートしています。アプリケーションとデータベースの間に抽象化レイヤが追加され、アプリケーションがデータベース間で簡単に移行できるようになります。

Spanner PostgreSQL 言語データベースに Spring Data JPA を設定する

標準の PostgreSQL Hibernate 言語と PGAdapter を使用して、Spanner PostgreSQL 言語データベースを Spring Data JPA と統合できます。

サンプルについては、GitHub の完全な作業用サンプル アプリケーションをご覧ください。

依存

プロジェクトで、Spring Data JPA、PostgreSQL JDBC ドライバ、PGAdapter の Apache Maven 依存関係を追加します。

  <dependencies>
    <!-- Spring Data JPA -->
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-data-jpa</artifactId>
    </dependency>
    <!-- Add the PostgreSQL JDBC driver -->
    <dependency>
      <groupId>org.postgresql</groupId>
      <artifactId>postgresql</artifactId>
    </dependency>
    <!-- Add PGAdapter as a dependency, so we can start it in-process -->
    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>google-cloud-spanner-pgadapter</artifactId>
    </dependency>
  </dependencies>

PGAdapter を処理中に開始する

Java アプリケーションから PGAdapter を直接起動するには、次のメソッドをアプリケーションに追加します。PGAdapter はアプリケーションと同じ JVM で実行され、アプリケーションは localhost:port で PGAdapter に接続します。

  /** Starts PGAdapter in-process and returns a reference to the server. */
  static ProxyServer startPGAdapter() {
    // Start PGAdapter using the default credentials of the runtime environment on port 9432.
    OptionsMetadata options = OptionsMetadata.newBuilder().setPort(9432).build();
    ProxyServer server = new ProxyServer(options);
    server.startServer();
    server.awaitRunning();

    return server;
  }

構成

PostgreSQL Hibernate 言語と PostgreSQL JDBC ドライバを使用するように application.properties を構成します。PGAdapter を介して PostgreSQL 言語データベースに接続するように PostgreSQL JDBC ドライバを構成します。

# The example uses the standard PostgreSQL Hibernate dialect.
spring.jpa.database-platform=org.hibernate.dialect.PostgreSQLDialect

# Defining these properties here makes it a bit easier to build the connection string.
# Change these to match your Cloud Spanner PostgreSQL-dialect database.
spanner.project=my-project
spanner.instance=my-instance
spanner.database=my-database
# This setting ensures that PGAdapter automatically commits the current transaction if it encounters
# a DDL statement in a read/write transaction, and then executes the DDL statements as a single DDL
# batch. 
spanner.ddl_transaction_mode=options=-c%20spanner.ddl_transaction_mode=AutocommitExplicitTransaction

# This is the connection string to PGAdapter running in-process.
spring.datasource.url=jdbc:postgresql://localhost:9432/projects%2F${spanner.project}%2Finstances%2F${spanner.instance}%2Fdatabases%2F${spanner.database}?${spanner.ddl_transaction_mode}

# You can display SQL statements and stats for debugging if needed.
spring.jpa.properties.hibernate.show_sql=true
spring.jpa.properties.hibernate.format_sql=true

# Enable JDBC batching.
spring.jpa.properties.hibernate.jdbc.batch_size=100
spring.jpa.properties.hibernate.order_inserts=true

完全なサンプル アプリケーション

動作するサンプル アプリケーションは GitHub で入手できます。

次のステップ