Integrar o Spanner ao Spring Data JPA (dialeto do PostgreSQL)

O Spring Data JPA, parte da família mais ampla do Spring Data, facilita a implementação de repositórios baseados em JPA. O Spring Data JPA oferece suporte ao PostgreSQL e a uma ampla variedade de outros sistemas de banco de dados. Ele adiciona uma camada de abstração entre o aplicativo e o banco de dados, facilitando a portabilidade de um sistema de banco de dados para outro.

Configurar o Spring Data JPA para bancos de dados de dialeto PostgreSQL do Spanner

É possível integrar bancos de dados do dialeto PostgreSQL do Spanner com o Spring Data JPA usando o dialeto padrão do PostgreSQL Hibernate e o PGAdapter.

Para conferir um exemplo, consulte o aplicativo de exemplo funcional (link em inglês) no GitHub.

Dependências

No projeto, adicione as dependências do Apache Maven para Spring Data JPA, o driver JDBC do PostgreSQL e o PGAdapter.

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

Iniciar o PGAdapter em processo

Adicione o método abaixo ao seu aplicativo para iniciar o PGAdapter diretamente do seu aplicativo Java. O PGAdapter é executado na mesma JVM que seu aplicativo, e o aplicativo se conecta ao PGAdapter em localhost:port.

  /** 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;
  }

Configuração

Configure application.properties para usar o dialeto do Hibernate do PostgreSQL e o driver JDBC do PostgreSQL. Configure o driver JDBC do PostgreSQL para se conectar a um banco de dados de dialeto PostgreSQL pelo PGAdapter.

# 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

Exemplo de aplicativo completo

Um aplicativo de exemplo funcional está disponível no GitHub.

A seguir