次の方法で共有


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

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

Java永続化 API (JPA) は、オブジェクト リレーショナル マッピング用の標準的なJava API です。

このチュートリアルでは、Microsoft Entra認証と PostgreSQL 認証の 2 つの認証方法について説明します。 Passwordless タブにはMicrosoft Entra認証が表示され、Password タブには PostgreSQL 認証が表示されます。

Microsoft Entra認証は、Microsoft Entra IDで定義されている ID を使用してAzure Database for PostgreSQLに接続するためのメカニズムです。 Microsoft Entra認証を使用すると、データベース ユーザー ID やその他の Microsoft サービスを一元的な場所で管理できるため、アクセス許可の管理が簡素化されます。

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

前提条件

  • PostgreSQL コマンド ライン クライアント。

  • Spring Boot アプリケーションがない場合は、 Spring Initializrで Maven プロジェクトを作成します。 必ず Maven Project を選択し、DependenciesSpring WebSpring Data JDBC、および PostgreSQL Driver 依存関係を追加し、バージョン 8 以降Java選択します。

重要

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

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

このチュートリアルでは、サンプル アプリケーションをコーディングします。 このアプリケーションは既にコード化されており、https://github.com/Azure-Samples/quickstart-spring-data-jpa-postgresql で使用できます。

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

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

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

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

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

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

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

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

  • Service Connector (推奨)
  • 手動で構成
  1. 次のコマンドを使用して、Azure CLIのService Connector パスワードなしの拡張機能をインストールします。

     az extension add --name serviceconnector-passwordless --upgrade
    
  2. 次のコマンドを使用して、管理者以外のユーザー 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からデータを格納する

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>7.0.0</version>
          <type>pom</type>
          <scope>import</scope>
        </dependency>
      </dependencies>
    </dependencyManagement>
    

    Spring Boot 4.0.x を使用している場合は、必ず バージョンを に設定してください。

    Spring Boot 3.5.x を使用している場合は、必ず バージョンを に設定してください。

    Spring Boot 3.1.x-3.5.x を使用している場合は、必ず バージョンを に設定してください。

    Spring Boot 2.xを使用している場合は、 バージョンを に設定してください。

    この部品表(BOM)は、 の pom.xml セクションで設定する必要があります。 これにより、すべての 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>
    

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

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

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

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

    • パスワードレス (推奨)
    • パスワード
    logging.level.org.hibernate.SQL=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.jpa.hibernate.ddl-auto=create-drop
    spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect
    

重要

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

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

この記事では、サンプル アプリケーションをコーディングします。 このアプリケーションは既にコード化されており、https://github.com/Azure-Samples/quickstart-spring-data-jpa-postgresql で使用できます。

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

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

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

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

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

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

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

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

  • Service Connector (推奨)
  • 手動で構成
  1. 次のコマンドを使用して、Azure CLIのService Connector パスワードなしの拡張機能をインストールします。

     az extension add --name serviceconnector-passwordless --upgrade
    
  2. 次のコマンドを使用して、管理者以外のユーザー 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からデータを格納する

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>7.0.0</version>
          <type>pom</type>
          <scope>import</scope>
        </dependency>
      </dependencies>
    </dependencyManagement>
    

    Spring Boot 4.0.x を使用している場合は、必ず バージョンを に設定してください。

    Spring Boot 3.5.x を使用している場合は、必ず バージョンを に設定してください。

    Spring Boot 3.1.x-3.5.x を使用している場合は、必ず バージョンを に設定してください。

    Spring Boot 2.xを使用している場合は、 バージョンを に設定してください。

    この部品表(BOM)は、 の pom.xml セクションで設定する必要があります。 これにより、すべての 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>
    

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

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

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

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

    • パスワードレス (推奨)
    • パスワード
    logging.level.org.hibernate.SQL=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.jpa.hibernate.ddl-auto=create-drop
    spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect
    
  1. 新しい Todo Java クラスを作成します。 このクラスは、JPA によって自動的に作成される、 テーブルにマップされたドメイン モデルです。 次のコードは、 メソッドと メソッドを無視します。

    package com.example.demo;
    
    import javax.persistence.Entity;
    import javax.persistence.GeneratedValue;
    import javax.persistence.Id;
    
    @Entity
    public class Todo {
    
        public Todo() {
        }
    
        public Todo(String description, String details, boolean done) {
            this.description = description;
            this.details = details;
            this.done = done;
        }
    
        @Id
        @GeneratedValue
        private Long id;
    
        private String description;
    
        private String details;
    
        private boolean done;
    
    }
    
  2. スタートアップ クラス ファイルを編集して、次の内容を表示します。

    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.jpa.repository.JpaRepository;
    
    import java.util.stream.Collectors;
    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)).collect(Collectors.toList()))
                .forEach(System.out::println);
        }
    
    }
    
    interface TodoRepository extends JpaRepository<Todo, Long> {
    
    }
    

    ヒント

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

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

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

  3. アプリケーションを起動します。 次の例のようなログが表示されます。

    2023-02-01 10:29:19.763 DEBUG 4392 --- [main] org.hibernate.SQL : insert into todo (description, details, done, id) values (?, ?, ?, ?)
    com.example.demo.Todo@1f
    

Azure Spring Appsにデプロイする

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

次のステップ