Azure SQL Database で Spring Data JPA を使用する

[アーティクル]
01/19/2024

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

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

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

Microsoft Entra 認証は、Microsoft Entra ID で定義されている識別情報を使用して Azure Database for SQL Database に接続するためのメカニズムです。 Microsoft Entra 認証を使用すると、データベースユーザーの ID や他の Microsoft サービスを一元管理でき、アクセス許可の管理が容易になります。

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

前提条件

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

sqlcmd Utility
ODBCドライバー 17または18。
お持ちでない場合は、sqlservertest という名前の Azure SQL Server インスタンスと demo という名前のデータベースを作成します。手順については、「クイックスタート: Azure SQL Database の単一データベースを作成する」を参照してください。
Spring Boot アプリケーションがない場合は、Spring Initializr で Maven プロジェクトを作成します。 [Maven プロジェクト] を選択して、[依存関係] で、[Spring Web]、[Spring Data JPA]、[MS SQL Server Driver] 依存関係を追加したら、バージョン 8 以降の Java を選択します。

重要

パスワードレス接続を使用するには、MS SQL Server Driver をバージョン 12.1.0 以上にアップグレードしてから、Azure SQL Database サーバーインスタンスの Microsoft Entra 管理者ユーザーを作成します。詳細については、「チュートリアル: Azure SQL Database でのデータベースのセキュリティ保護」の「Microsoft Entra 管理者の作成」セクションを参照してください。

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

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

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

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

データベースを使用できるようにするには、サーバーのファイアウォールを開いて、データベースサーバーにアクセスするためのローカル IP アドレスを許可する必要があります。詳細については、「チュートリアル: Azure SQL Databaseでデータベースをセキュリティで保護する」を参照してください。

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

SQL データベースの管理者以外のユーザーを作成し、アクセス許可を付与する

この手順では、管理者以外のユーザーを作成し、demo データベースに対するすべてのアクセス許可をそのユーザーに付与します。

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

パスワードレス接続を使用するには、「チュートリアル: Azure SQL Database でデータベースをセキュリティで保護する」を参照するか、Service Connector を使用して Azure SQL Database サーバーの Microsoft Entra 管理者ユーザーを作成します。次の手順を参照してください。

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

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

az connection create sql \
    --resource-group <your-resource-group-name> \
    --connection sql_conn \
    --target-resource-group <your-resource-group-name> \
    --server sqlservertest \
    --database demo \
    --user-account \
    --query authInfo.userName \
    --output tsv

作成した Microsoft Entra 管理者は SQL データベース管理者ユーザーであるため、新しいユーザーを作成する必要はありません。

重要

Azure SQL データベースのパスワードレス接続では、MS SQL Server ドライバーをバージョン 12.1.0 以上にアップグレードする必要があります。接続オプションは、authentication=DefaultAzureCredential (バージョン 12.1.0) と authentication=ActiveDirectoryDefault (バージョン 12.2.0) です。

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

cat << EOF > create_user.sql
USE demo;
GO
CREATE USER <your_sql_server_non_admin_username> WITH PASSWORD='<your_sql_server_non_admin_password>'
GO
GRANT CONTROL ON DATABASE::demo TO <your_sql_server_non_admin_username>;
GO
EOF

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

sqlcmd -S sqlservertest.database.windows.net,1433 -d demo -U <your_sql_server_admin_username> -P <your_sql_server_admin_password> -i create_user.sql

Note

SQL データベースユーザー作成の詳細については、「CREATE USER (Transact-SQL)」を参照してください。

Azure SQL Database からのデータの格納

Azure SQL Database インスタンスでは、Spring Cloud Azure を使用してデータを格納できます。

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

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

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

これは依存関係なので、<dependencies>pom.xmlのセクションに追加する必要があります。以前に追加したBOMによって管理されているため、バージョンはここでは設定されていません。

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

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

application.properties 構成ファイルで Azure SQL Database の資格情報を構成します。

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

logging.level.org.hibernate.SQL=DEBUG

spring.datasource.url=jdbc:sqlserver://sqlservertest.database.windows.net:1433;databaseName=demo;authentication=DefaultAzureCredential;

spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.SQLServer2016Dialect
spring.jpa.hibernate.ddl-auto=create-drop

logging.level.org.hibernate.SQL=DEBUG

spring.datasource.url=jdbc:sqlserver://sqlservertest.database.windows.net:1433;database=demo;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.database.windows.net;loginTimeout=30;
spring.datasource.username=<your_sql_server_non_admin_username>
spring.datasource.password=<your_sql_server_non_admin_password>

spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.SQLServer2016Dialect
spring.jpa.hibernate.ddl-auto=create-drop

警告

構成プロパティ spring.jpa.hibernate.ddl-auto=create-drop は、アプリケーションの起動時に Spring Boot によってデータベーススキーマが自動的に作成され、シャットダウン時にその削除が試行されることを意味します。この機能はテストには適していますが、再起動するたびにデータが削除されるため、運用環境では使用しないでください。

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

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;

}

スタートアップクラスファイルを編集して、次の内容を表示します。
```
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 は複数の認証方法をサポートしており、実行時に使用する方法が決定されます。このアプローチを採用すると、環境固有のコードを実装することなく、異なる環境 (ローカルと運用環境など) で異なる認証方法をアプリに使用できます。詳細については、DefaultAzureCredential を参照してください。

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

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

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 にデプロイする」を参照してください。

次のステップ

Spring 開発者向けの Azure

Azure SQL Database で Spring Data JPA を使用する

前提条件

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

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

SQL データベースの管理者以外のユーザーを作成し、アクセス許可を付与する

Azure SQL Database からのデータの格納

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

Azure Spring Apps にデプロイする

次のステップ

フィードバック

フィードバック

その他のリソース

Azure SQL Database で Spring Data JPA を使用する

前提条件

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

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

SQL データベースの管理者以外のユーザーを作成し、アクセス許可を付与する

Azure SQL Database からのデータの格納

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

Azure Spring Apps にデプロイする

次のステップ

フィードバック

フィードバック

その他のリソース

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