Azure Database for PostgreSQL で Spring Data JDBC を使用する

[アーティクル]
08/28/2024

このチュートリアルでは、Spring Data JDBC を使用して Azure Database for PostgreSQL データベースにデータを格納する方法について説明します。

JDBC は、従来のリレーショナルデータベースに接続するための標準の Java API です。

このチュートリアルには、Microsoft Entra 認証と PostgreSQL 認証の 2 つの認証方法が含まれています。 [パスワードレス] タブには Microsoft Entra 認証が表示され、[パスワード] タブには PostgreSQL 認証が表示されます。

Microsoft Entra 認証は、Microsoft Entra ID で定義された ID を使用して Azure Database for PostgreSQL に接続するための仕組みです。 Microsoft Entra 認証を使用すると、データベースユーザーの ID や他の Microsoft サービスを一元管理でき、アクセス許可の管理が容易になります。

PostgreSQL 認証では、PostgreSQL に格納されているアカウントが使用されます。アカウントの資格情報としてパスワードを使用することを選択した場合、これらの資格情報は user テーブルに格納されます。これらのパスワードは PostgreSQL に格納されるため、パスワードのローテーションを自分で管理する必要があります。

前提条件

Azure サブスクリプション - 無料アカウントを作成します。
Java Development Kit (JDK)、バージョン 8 以降。
Apache Maven。
Azure CLI。

PostgreSQL コマンドラインクライアント。
Spring Boot アプリケーションがない場合は、 Spring Initializrで Maven プロジェクトを作成します。 [Maven プロジェクト] を選択して、[依存関係] で、[Spring Web]、[Spring Data JDBC]、[PostgreSQLz Driver] 依存関係を追加したら、バージョン 8 以降の Java を選択します。

お持ちでない場合は、postgresqlflexibletest という名前の Azure Database for PostgreSQL フレキシブルサーバーインスタンスと、demo という名前のデータベースを作成します。手順については、「クイックスタート: Azure portal 内で Azure Database for PostgreSQL - フレキシブルサーバーを作成する」を参照してください。

サンプルアプリケーション参照

このチュートリアルでは、サンプルアプリケーションをコーディングします。より早く進めたい場合は、このアプリケーションは既にコーディングされており、https://github.com/Azure-Samples/quickstart-spring-data-jdbc-postgresql で入手できます。

PostgreSQL サーバーのファイアウォール規則を構成する

Azure Database for PostgreSQL インスタンスは、既定でセキュリティ保護されています。受信接続を一切許可しないファイアウォールがあります。

データベースを使用できるようにするには、サーバーのファイアウォールを開いて、データベースサーバーにアクセスするためのローカル IP アドレスを許可する必要があります。詳細については、「Azure Database for PostgreSQL - フレキシブルサーバーのファイアウォール規則」を参照してください。

Windows コンピューター上の Windows Subsystem for Linux (WSL) から PostgreSQL サーバーに接続する場合は、WSL ホストの ID をファイアウォールに追加する必要があります。

PostgreSQL の非管理者ユーザーを作成し、アクセス許可を付与する

次に、非管理者ユーザーを作成し、データベースに対するすべてのアクセス許可を付与します。

パスワードレス (推奨)
パスワード

次の方法を使用して、パスワードレス接続を使用する管理者以外のユーザーを作成できます。

Service Connector (推奨)
手動で構成

次のコマンドを使用して、Azure CLIの Service Connector パスワードレス拡張機能をインストールします。
```
 az extension add --name serviceconnector-passwordless --upgrade
```

次のコマンドを使用して、Microsoft Entra の管理者以外のユーザーを作成します。

  az connection create postgres-flexible \
       --resource-group <your_resource_group_name> \
       --connection postgres_conn \
       --target-resource-group <your_resource_group_name> \
       --server postgresqlflexibletest \
       --database demo \
       --user-account \
       --query authInfo.userName \
       --output tsv

コマンドが完了したら、コンソール出力のユーザー名を書き留めます。

重要

パスワードレス接続を使用するには、Azure Database for PostgreSQL フレキシブルサーバーインスタンスの Microsoft Entra 管理者ユーザーを構成します。詳細については、「Azure Database for PostgreSQL - フレキシブルサーバーでのMicrosoft Entraロールの管理」を参照してください。

非管理者ユーザーを作成するための create_ad_user.sql という名前の SQL スクリプトを作成します。次の内容を追加し、ローカルに保存します。

cat << EOF > create_ad_user.sql
select * from pgaadauth_create_principal('<your_postgresql_ad_non_admin_username>', false, false);
EOF

次に、次のコマンドを使用して SQL スクリプトを実行し、Microsoft Entra の非管理者ユーザーを作成します。

psql "host=postgresqlflexibletest.postgres.database.azure.com user=<your_postgresql_ad_admin_username> dbname=postgres port=5432 password=$(az account get-access-token --resource-type oss-rdbms --output tsv --query accessToken) sslmode=require" < create_ad_user.sql

ヒント

Microsoft Entra 認証を使用して Azure Database for PostgreSQL に接続するには、設定した Microsoft Entra 管理者ユーザーでサインインし、アクセストークンをパスワードとして取得する必要があります。詳細については、「Azure Database for PostgreSQL - フレキシブルサーバーでの認証に Microsoft Entra ID を使用する」を参照してください。

非管理者ユーザーを作成するための create_user.sql という名前の SQL スクリプトを作成します。次の内容を追加し、ローカルに保存します。

cat << EOF > create_user.sql
CREATE ROLE "<your_postgresql_non_admin_username>" WITH LOGIN PASSWORD '<your_postgresql_non_admin_password>';
GRANT ALL PRIVILEGES ON DATABASE demo TO "<your_postgresql_non_admin_username>";
EOF

次に、次のコマンドを使用して SQL スクリプトを実行し、Microsoft Entra の非管理者ユーザーを作成します。

psql "host=postgresqlflexibletest.postgres.database.azure.com user=<your_postgresql_admin_username> dbname=demo port=5432 password=<your_postgresql_admin_password> sslmode=require" < create_user.sql

Note

詳細については、「Azure Database for PostgreSQL - フレキシブルサーバーでユーザーを作成する」をご覧ください。

Azure Database for PostgreSQL のデータを格納する

Azure Database for PostgreSQL フレキシブルサーバーインスタンスが作成されたので、Spring Cloud Azure を使用してデータを格納できます。

Spring Cloud Azure Starter JDBC PostgreSQL モジュールをインストールするには、次の依存関係を pom.xml ファイルに追加します。

Spring Cloud Azure 部品表 (BOM):
```
<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.azure.spring</groupId>
      <artifactId>spring-cloud-azure-dependencies</artifactId>
      <version>5.18.0</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>
```
Note

Spring Boot 2.xを使用している場合は、 spring-cloud-azure-dependencies バージョンを 4.19.0に設定してください。この部品表（BOM）は、 pom.xml ファイルの <dependencyManagement> セクションで設定する必要があります。これにより、すべてのSpring Cloud Azure依存関係が同じバージョンを使用していることが保証されます。このBOMに使用されるバージョンの詳細については、「Spring Cloud Azureのどのバージョンを使うべきか」を参照してください。

Spring Cloud Azure Starter JDBC PostgreSQL アーティファクト:

<dependency>
  <groupId>com.azure.spring</groupId>
  <artifactId>spring-cloud-azure-starter-jdbc-postgresql</artifactId>
</dependency>

Note

パスワードレス接続はバージョン 4.5.0 以降サポートされています。

Azure Database for PostgreSQL を使用するように Spring Boot を構成する

Spring Data JDBC を使用して Azure Database for PostgreSQL のデータを格納するには、次の手順に従ってアプリケーションを構成します。

application.properties 構成ファイルに次のプロパティを追加して、Azure Database for PostgreSQL 資格情報を構成します。

パスワードレス (推奨)
パスワード

logging.level.org.springframework.jdbc.core=DEBUG

spring.datasource.url=jdbc:postgresql://postgresqlflexibletest.postgres.database.azure.com:5432/demo?sslmode=require
spring.datasource.username=<your_postgresql_ad_non_admin_username>
spring.datasource.azure.passwordless-enabled=true

spring.sql.init.mode=always

logging.level.org.springframework.jdbc.core=DEBUG

spring.datasource.url=jdbc:postgresql://postgresqlflexibletest.postgres.database.azure.com:5432/demo?sslmode=require
spring.datasource.username=<your_postgresql_non_admin_username>
spring.datasource.password=<your_postgresql_non_admin_password>

spring.sql.init.mode=always

警告

構成プロパティ spring.sql.init.mode=always は、サーバーが起動されるたびに、schema.sql ファイル (次に作成します) を使用して、Spring Boot がデータベーススキーマを自動的に生成することを意味します。この機能はテストには適していますが、再起動するたびにデータが削除されるため、運用環境では使用しないでください。

お持ちでない場合は、postgresqlsingletest という名前の Azure Database for PostgreSQL 単一サーバーインスタンスと、demo という名前のデータベースを作成します。手順については、「クイックスタート: Azure portal を使用した Azure Database for PostgreSQL サーバーの作成」を参照してください。。

サンプルアプリケーション参照

この記事では、サンプルアプリケーションをコーディングします。より早く進めたい場合は、このアプリケーションは既にコーディングされており、https://github.com/Azure-Samples/quickstart-spring-data-jdbc-postgresql で入手できます。

PostgreSQL サーバーのファイアウォール規則を構成する

Azure Database for PostgreSQL インスタンスは、既定でセキュリティ保護されています。受信接続を一切許可しないファイアウォールがあります。

データベースを使用できるようにするには、サーバーのファイアウォールを開いて、データベースサーバーにアクセスするためのローカル IP アドレスを許可する必要があります。詳細は、「Azure portal を使用して Azure Database for PostgreSQL - 単一サーバー用のファイアウォール規則を作成して管理する」を参照してください。

PostgreSQL の非管理者ユーザーを作成し、アクセス許可を付与する

次に、非管理者ユーザーを作成し、データベースに対するすべてのアクセス許可を付与します。

パスワードレス (推奨)
パスワード

次の方法を使用して、パスワードレス接続を使用する管理者以外のユーザーを作成できます。

Service Connector (推奨)
手動で構成

次のコマンドを使用して、Azure CLIの Service Connector パスワードレス拡張機能をインストールします。
```
 az extension add --name serviceconnector-passwordless --upgrade
```

次のコマンドを使用して、Microsoft Entra の管理者以外のユーザーを作成します。

  az connection create postgres \
       --resource-group <your_resource_group_name> \
       --connection postgres_conn \
       --target-resource-group <your_resource_group_name> \
       --server postgresqlsingletest \
       --database demo \
       --user-account \
       --query authInfo.userName \
       --output tsv

コマンドが完了したら、コンソール出力のユーザー名を書き留めます。

重要

パスワードレス接続を使用するには、Azure Database for PostgreSQL 単一サーバーインスタンスの Microsoft Entra 管理者ユーザーを構成します。詳細については、「Microsoft Entra ID を使用して PostgreSQL での認証を行う」を参照してください。

非管理者ユーザーを作成するための create_ad_user.sql という名前の SQL スクリプトを作成します。次の内容を追加し、ローカルに保存します。

cat << EOF > create_ad_user.sql
SET aad_validate_oids_in_tenant = off;
CREATE ROLE "<your_postgresql_ad_non_admin_username>" WITH LOGIN IN ROLE azure_ad_user;
GRANT ALL PRIVILEGES ON DATABASE demo TO "<your_postgresql_ad_non_admin_username>";
EOF

次に、次のコマンドを使用して SQL スクリプトを実行し、Microsoft Entra の非管理者ユーザーを作成します。

psql "host=postgresqlsingletest.postgres.database.azure.com user=<your_postgresql_ad_admin_username>@postgresqlsingletest dbname=postgres port=5432 password=$(az account get-access-token --resource-type oss-rdbms --output tsv --query accessToken) sslmode=require" < create_ad_user.sql

ヒント

Microsoft Entra 認証を使用して Azure Database for PostgreSQL に接続するには、設定した Microsoft Entra 管理者ユーザーでサインインし、アクセストークンをパスワードとして取得する必要があります。詳細については、「Microsoft Entra ID を使用して PostgreSQL での認証を行う」を参照してください。

非管理者ユーザーを作成するための create_user.sql という名前の SQL スクリプトを作成します。次の内容を追加し、ローカルに保存します。

cat << EOF > create_user.sql
CREATE ROLE "<your_postgresql_non_admin_username>" WITH LOGIN PASSWORD '<your_postgresql_non_admin_password>';
GRANT ALL PRIVILEGES ON DATABASE demo TO "<your_postgresql_non_admin_username>";
EOF

次に、次のコマンドを使用して SQL スクリプトを実行し、Microsoft Entra の非管理者ユーザーを作成します。

psql "host=postgresqlsingletest.postgres.database.azure.com user=<your_postgresql_admin_username>@postgresqlsingletest dbname=demo port=5432 password=<your_postgresql_admin_password> sslmode=require" < create_user.sql

Note

PostgreSQL ユーザーの作成の詳細については、Azure Database for PostgreSQL でのユーザーの作成に関するページを参照してください。

Azure Database for PostgreSQL のデータを格納する

Azure Database for PostgreSQL 単一サーバーインスタンスが作成されたので、Spring Cloud Azure を使用してデータを格納できます。

Spring Cloud Azure Starter JDBC PostgreSQL モジュールをインストールするには、次の依存関係を pom.xml ファイルに追加します。

Spring Cloud Azure 部品表 (BOM):
```
<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.azure.spring</groupId>
      <artifactId>spring-cloud-azure-dependencies</artifactId>
      <version>5.18.0</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>
```
Note

Spring Boot 2.xを使用している場合は、 spring-cloud-azure-dependencies バージョンを 4.19.0に設定してください。この部品表（BOM）は、 pom.xml ファイルの <dependencyManagement> セクションで設定する必要があります。これにより、すべてのSpring Cloud Azure依存関係が同じバージョンを使用していることが保証されます。このBOMに使用されるバージョンの詳細については、「Spring Cloud Azureのどのバージョンを使うべきか」を参照してください。

Spring Cloud Azure Starter JDBC PostgreSQL アーティファクト:

<dependency>
  <groupId>com.azure.spring</groupId>
  <artifactId>spring-cloud-azure-starter-jdbc-postgresql</artifactId>
</dependency>

Note

パスワードレス接続はバージョン 4.5.0 以降サポートされています。

Azure Database for PostgreSQL を使用するように Spring Boot を構成する

Spring Data JDBC を使用して Azure Database for PostgreSQL のデータを格納するには、次の手順に従ってアプリケーションを構成します。

application.properties 構成ファイルに次のプロパティを追加して、Azure Database for PostgreSQL 資格情報を構成します。

パスワードレス (推奨)
パスワード

logging.level.org.springframework.jdbc.core=DEBUG

spring.datasource.url=jdbc:postgresql://postgresqlsingletest.postgres.database.azure.com:5432/demo?sslmode=require
spring.datasource.username=<your_postgresql_ad_non_admin_username>@postgresqlsingletest
spring.datasource.azure.passwordless-enabled=true

spring.sql.init.mode=always

logging.level.org.springframework.jdbc.core=DEBUG

spring.datasource.url=jdbc:postgresql://postgresqlsingletest.postgres.database.azure.com:5432/demo?sslmode=require
spring.datasource.username=<your_postgresql_non_admin_username>@postgresqlsingletest
spring.datasource.password=<your_postgresql_non_admin_password>

spring.sql.init.mode=always

警告

src/main/resources/schema.sql 構成ファイルを作成してデータベーススキーマを構成し、次の内容を追加します。
```
DROP TABLE IF EXISTS todo;
CREATE TABLE todo (id SERIAL PRIMARY KEY, description VARCHAR(255), details VARCHAR(4096), done BOOLEAN);
```

新しい Todo Java クラスを作成します。このクラスは、Spring Boot によって自動的に作成される、todo テーブルにマップされたドメインモデルです。次のコードは、getters メソッドと setters メソッドを無視します。

import org.springframework.data.annotation.Id;

public class Todo {

    public Todo() {
    }

    public Todo(String description, String details, boolean done) {
        this.description = description;
        this.details = details;
        this.done = done;
    }

    @Id
    private Long id;

    private String description;

    private String details;

    private boolean done;

}

スタートアップクラスファイルを編集して、次の内容を表示します。
```
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.context.event.ApplicationReadyEvent;
import org.springframework.context.ApplicationListener;
import org.springframework.context.annotation.Bean;
import org.springframework.data.repository.CrudRepository;

import java.util.stream.Stream;

@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }

    @Bean
    ApplicationListener<ApplicationReadyEvent> basicsApplicationListener(TodoRepository repository) {
        return event->repository
            .saveAll(Stream.of("A", "B", "C").map(name->new Todo("configuration", "congratulations, you have set up correctly!", true)).toList())
            .forEach(System.out::println);
    }

}

interface TodoRepository extends CrudRepository<Todo, Long> {

}
```
ヒント

このチュートリアルでは、構成またはコードに認証操作はありません。ただし、Azure サービスに接続するには認証が必要です。認証を完了するには、Azure ID を使用する必要があります。 Spring Cloud Azure では、DefaultAzureCredential を使用します。これは、コードを変更せずに資格情報を取得できるようにするために、Azure ID ライブラリで提供されます。

DefaultAzureCredential は複数の認証方法をサポートしており、実行時に使用する方法が決定されます。このアプローチを採用すると、環境固有のコードを実装することなく、異なる環境 (ローカルと運用環境など) で異なる認証方法をアプリに使用できます。詳細については、DefaultAzureCredential を参照してください。

ローカル開発環境で認証を完了するには、Azure CLI、Visual Studio Code、PowerShell、またはその他の方法を使用できます。詳細については、「Java 開発環境での Azure 認証」を参照してください。 Azure ホスティング環境で認証を完了するには、ユーザー割り当てマネージド ID を使用することをお勧めします。詳細については、「Azure リソースのマネージド ID とは」を参照してください。

アプリケーションを起動します。アプリケーションは、データベースにデータを格納します。次の例のようなログが表示されます。

2023-02-01 10:22:36.701 DEBUG 7948 --- [main] o.s.jdbc.core.JdbcTemplate : Executing prepared SQL statement [INSERT INTO todo (description, details, done) VALUES (?, ?, ?)]    
com.example.demo.Todo@4bdb04c8

Azure Spring Apps にデプロイする

Spring Boot アプリケーションがローカルで実行されたので、運用環境に移行します。 Azure Spring Apps では、コードを変更せずに、Spring Boot アプリケーションを Azure に簡単にデプロイできます。 Spring アプリケーションのインフラストラクチャはこのサービスによって管理されるため、開発者はコードに専念できます。 Azure Spring Apps では、包括的な監視と診断、構成管理、サービス検出、CI/CD 統合、ブルー/グリーンデプロイなどを使用して、ライフサイクルを管理できます。 Azure Spring Apps にアプリケーションをデプロイするには、「初めてのアプリケーションを Azure Spring Apps にデプロイする」を参照してください。

次のステップ

Spring 開発者向け Azure Spring Cloud Azure PostgreSQL サンプル

次の方法で共有

Azure Database for PostgreSQL で Spring Data JDBC を使用する

前提条件

サンプルアプリケーション参照

PostgreSQL サーバーのファイアウォール規則を構成する

PostgreSQL の非管理者ユーザーを作成し、アクセス許可を付与する

Azure Database for PostgreSQL のデータを格納する

Azure Database for PostgreSQL を使用するように Spring Boot を構成する

サンプルアプリケーション参照

PostgreSQL サーバーのファイアウォール規則を構成する

PostgreSQL の非管理者ユーザーを作成し、アクセス許可を付与する

Azure Database for PostgreSQL のデータを格納する

Azure Database for PostgreSQL を使用するように Spring Boot を構成する

Azure Spring Apps にデプロイする

次のステップ

フィードバック

その他のリソース

次の方法で共有

Azure Database for PostgreSQL で Spring Data JDBC を使用する

前提条件

サンプル アプリケーション参照

PostgreSQL サーバーのファイアウォール規則を構成する

PostgreSQL の非管理者ユーザーを作成し、アクセス許可を付与する

Azure Database for PostgreSQL のデータを格納する

Azure Database for PostgreSQL を使用するように Spring Boot を構成する

サンプル アプリケーション参照

PostgreSQL サーバーのファイアウォール規則を構成する

PostgreSQL の非管理者ユーザーを作成し、アクセス許可を付与する

Azure Database for PostgreSQL のデータを格納する

Azure Database for PostgreSQL を使用するように Spring Boot を構成する

Azure Spring Apps にデプロイする

次のステップ

フィードバック

その他のリソース

サンプルアプリケーション参照

サンプルアプリケーション参照