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

[アーティクル]
05/23/2023

この記事では、GitHub の r2dbc-mssql リポジトリの Microsoft SQL Server 用の R2DBC 実装を使用して、Spring Data R2DBC で Azure SQL Database に情報を格納および取得するサンプルアプリケーションを作成する方法を説明します。

R2DBC は、従来のリレーショナルデータベースにリアクティブ API を提供します。これを Spring WebFlux と共に使用すると、非ブロッキング API を使用する完全にリアクティブな Spring Boot アプリケーションを作成できます。 "接続ごとに 1 つのスレッド" という従来の手法よりも優れたスケーラビリティが実現されます。

前提条件

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

sqlcmd ユーティリティ。
cURL または機能をテストするための類似の HTTP ユーティリティ。

サンプルアプリケーションを確認する

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

作業環境を準備する

まず、次のコマンドを使用して、いくつかの環境変数を設定します。

export AZ_RESOURCE_GROUP=database-workshop
export AZ_DATABASE_NAME=<YOUR_DATABASE_NAME>
export AZ_LOCATION=<YOUR_AZURE_REGION>
export AZ_SQL_SERVER_ADMIN_USERNAME=spring
export AZ_SQL_SERVER_ADMIN_PASSWORD=<YOUR_AZURE_SQL_ADMIN_PASSWORD>
export AZ_SQL_SERVER_NON_ADMIN_USERNAME=nonspring
export AZ_SQL_SERVER_NON_ADMIN_PASSWORD=<YOUR_AZURE_SQL_NON_ADMIN_PASSWORD>
export AZ_LOCAL_IP_ADDRESS=<YOUR_LOCAL_IP_ADDRESS>

プレースホルダーは、この記事全体で使用される次の値に置き換えてください。

<YOUR_DATABASE_NAME>: Azure SQL Database サーバーの名前。Azure 全体で一意である必要があります。
<YOUR_AZURE_REGION>:使用する Azure リージョン。既定で eastus を使用できますが、居住地に近いリージョンを構成することをお勧めします。を使用 az account list-locationsすると、使用可能なリージョンの完全な一覧を確認できます。
<AZ_SQL_SERVER_ADMIN_PASSWORD> and <AZ_SQL_SERVER_NON_ADMIN_PASSWORD>: Azure SQL Database サーバーのパスワード。少なくとも 8 文字にする必要があります。これには、英大文字、英小文字、数字 (0 から 9)、英数字以外の文字 (!、$、#、% など) のうち、3 つのカテゴリの文字が含まれている必要があります。
<YOUR_LOCAL_IP_ADDRESS>:ローカルコンピューターの IP アドレス。そこから、Spring Boot アプリケーションを実行します。これを見つける簡単な方法は、ブラウザーで whatismyip.akamai.com にアクセスすることです。

次に、次のコマンドを使用し、リソースグループを作成します。

az group create \
    --name $AZ_RESOURCE_GROUP \
    --location $AZ_LOCATION \
    --output tsv

Azure SQL Database インスタンスを作成する

次に、次のコマンドを実行して、マネージド Azure SQL Database サーバーインスタンスを作成します。

Note

MS SQL のパスワードは特定の条件を満たす必要があり、準拠していないパスワードではセットアップに失敗します。詳細については、「 Password Policy」をご参照ください。

az sql server create \
    --resource-group $AZ_RESOURCE_GROUP \
    --name $AZ_DATABASE_NAME \
    --location $AZ_LOCATION \
    --admin-user $AZ_SQL_SERVER_ADMIN_USERNAME \
    --admin-password $AZ_SQL_SERVER_ADMIN_PASSWORD \
    --output tsv

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

Azure SQL Database インスタンスは、既定でセキュリティ保護されています。受信接続を一切許可しないファイアウォールがあります。データベースを使用できるようにするには、データベースサーバーにアクセスするためのローカル IP アドレスを許可するファイアウォール規則を追加する必要があります。

この記事の冒頭でローカル IP アドレスを構成したので、次のコマンドを実行してサーバーのファイアウォールを開くことができます。

az sql server firewall-rule create \
    --resource-group $AZ_RESOURCE_GROUP \
    --name $AZ_DATABASE_NAME-database-allow-local-ip \
    --server $AZ_DATABASE_NAME \
    --start-ip-address $AZ_LOCAL_IP_ADDRESS \
    --end-ip-address $AZ_LOCAL_IP_ADDRESS \
    --output tsv

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

WSL で以下のコマンドを実行して、ホストマシンの IP アドレスを取得します。

cat /etc/resolv.conf

nameserver の後に続く IP アドレスをコピーし、次のコマンドで WSL の IP アドレスを環境変数に設定します。

export AZ_WSL_IP_ADDRESS=<the-copied-IP-address>

次に、以下のコマンドを使って、サーバーのファイアウォールを WSL ベースのアプリに開放します。


az sql server firewall-rule create \
    --resource-group $AZ_RESOURCE_GROUP \
    --name $AZ_DATABASE_NAME-database-allow-local-ip-wsl \
    --server $AZ_DATABASE_NAME \
    --start-ip-address $AZ_WSL_IP_ADDRESS \
    --end-ip-address $AZ_WSL_IP_ADDRESS \
    --output tsv

Azure SQL データベースを構成する

先ほど作成した Azure SQL Database サーバーは空です。 Spring Boot アプリケーションで使用できるデータベースはありません。次のコマンドを実行し、demo という名前の新しいデータベースを作成します。

az sql db create \
    --resource-group $AZ_RESOURCE_GROUP \
    --name demo \
    --server $AZ_DATABASE_NAME \
    --output tsv

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

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

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

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

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

sqlcmd -S $AZ_DATABASE_NAME.database.windows.net,1433  -d demo -U $AZ_SQL_SERVER_ADMIN_USERNAME -P $AZ_SQL_SERVER_ADMIN_PASSWORD  -i create_user.sql

Note

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

リアクティブ Spring Boot アプリケーションを作成する

リアクティブ Spring Boot アプリケーションを作成するために、Spring Initializr を使用します。作成するアプリケーションでは、以下が使用されます。

Spring Boot 2.7.11。
次の依存関係: Spring Reactive Web (Spring WebFlux とも呼ばれます) と Spring Data R2DBC。

Spring Initializr を使用してアプリケーションを生成する

以下のコマンドを実行し、コマンドラインでアプリケーションを生成します。

curl https://start.spring.io/starter.tgz -d dependencies=webflux,data-r2dbc -d baseDir=azure-database-workshop -d bootVersion=2.7.11 -d javaVersion=17 | tar -xzvf -

リアクティブ Azure SQL Database ドライバーの実装を追加する

生成されたプロジェクトの pom.xml ファイルを開き、GitHub の r2dbc-mssql リポジトリからリアクティブ Azure SQL Database ドライバーを追加します。

spring-boot-starter-webflux 依存関係の後に、次のテキストを追加します。

<dependency>
    <groupId>io.r2dbc</groupId>
    <artifactId>r2dbc-mssql</artifactId>
    <scope>runtime</scope>
</dependency>

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

src/main/resources/application.properties ファイルを開き、以下のテキストを追加します。

logging.level.org.springframework.data.r2dbc=DEBUG

spring.r2dbc.url=r2dbc:pool:mssql://$AZ_DATABASE_NAME.database.windows.net:1433/demo
spring.r2dbc.username=nonspring@$AZ_DATABASE_NAME
spring.r2dbc.password=$AZ_SQL_SERVER_NON_ADMIN_PASSWORD

2 つの $AZ_DATABASE_NAME 変数と、$AZ_SQL_SERVER_NON_ADMIN_PASSWORD 変数を、この記事の冒頭で構成した値に置き換えます。

Note

パフォーマンスを向上させるために、spring.r2dbc.url プロパティは r2dbc-pool を使用して接続プールを使用するように構成されています。

これで、次のように、提供されている Maven Wrapper を使用してアプリケーションを起動できるはずです。

./mvnw spring-boot:run

アプリケーションを初めて実行したときのスクリーンショットを次に示します。

データベーススキーマを作成する

DemoApplication メインクラス内で、次のコードを使用し、データベーススキーマを作成する新しい Spring Bean を構成します。

package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.core.io.ClassPathResource;
import org.springframework.data.r2dbc.connectionfactory.init.ConnectionFactoryInitializer;
import org.springframework.data.r2dbc.connectionfactory.init.ResourceDatabasePopulator;

import io.r2dbc.spi.ConnectionFactory;

@SpringBootApplication
public class DemoApplication {

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

    @Bean
    public ConnectionFactoryInitializer initializer(ConnectionFactory connectionFactory) {
        ConnectionFactoryInitializer initializer = new ConnectionFactoryInitializer();
        initializer.setConnectionFactory(connectionFactory);
        ResourceDatabasePopulator populator = new ResourceDatabasePopulator(new ClassPathResource("schema.sql"));
        initializer.setDatabasePopulator(populator);
        return initializer;
    }
}

この Spring Bean では schema.sql というファイルが使用されるので、src/main/resources フォルダーにそのファイルを作成し、次のテキストを追加します。

DROP TABLE IF EXISTS todo;
CREATE TABLE todo (id INT IDENTITY PRIMARY KEY, description VARCHAR(255), details VARCHAR(4096), done BIT);

次のコマンドを使用して、実行中のアプリケーションを停止して再起動します。これで、アプリケーションは、先ほど作成した demo データベースを使用し、その中に todo テーブルを作成します。

./mvnw spring-boot:run

データベーステーブルの作成中のスクリーンショットを次に示します。

アプリケーションをコーディングする

次に、R2DBC を使用して Azure SQL Database サーバーにデータを格納および取得する Java コードを追加します。

次のコードを使用し、DemoApplication クラスの横に新しい Todo Java クラスを作成します。

package com.example.demo;

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;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }

    public String getDetails() {
        return details;
    }

    public void setDetails(String details) {
        this.details = details;
    }

    public boolean isDone() {
        return done;
    }

    public void setDone(boolean done) {
        this.done = done;
    }
}

このクラスは、先ほど作成した todo テーブルにマップされるドメインモデルです。

このクラスを管理するにはリポジトリが必要です。次のコードを使用し、同じパッケージ内に新しい TodoRepository インターフェイスを定義します。

package com.example.demo;

import org.springframework.data.repository.reactive.ReactiveCrudRepository;

public interface TodoRepository extends ReactiveCrudRepository<Todo, Long> {
}

このリポジトリは、Spring Data R2DBC によって管理されるリアクティブリポジトリです。

データを格納および取得できるコントローラーを作成して、アプリケーションを完成させます。同じパッケージに TodoController クラスを実装し、次のコードを追加します。

package com.example.demo;

import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.*;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;

@RestController
@RequestMapping("/")
public class TodoController {

    private final TodoRepository todoRepository;

    public TodoController(TodoRepository todoRepository) {
        this.todoRepository = todoRepository;
    }

    @PostMapping("/")
    @ResponseStatus(HttpStatus.CREATED)
    public Mono<Todo> createTodo(@RequestBody Todo todo) {
        return todoRepository.save(todo);
    }

    @GetMapping("/")
    public Flux<Todo> getTodos() {
        return todoRepository.findAll();
    }
}

最後に、次のコマンドを使用して、アプリケーションを停止して再起動します。

./mvnw spring-boot:run

アプリケーションをテストする

アプリケーションをテストするには、cURL を使用します。

まず、次のコマンドを使用して、データベースに新しい "todo" 項目を作成します。

curl --header "Content-Type: application/json" \
    --request POST \
    --data '{"description":"configuration","details":"congratulations, you have set up R2DBC correctly!","done": "true"}' \
    http://127.0.0.1:8080

このコマンドからは、ここに示すように、作成された項目が返されるはずです。

{"id":1,"description":"configuration","details":"congratulations, you have set up R2DBC correctly!","done":true}

次に、次のコマンドを使用し、新しい cURL 要求を使用してデータを取得します。

curl http://127.0.0.1:8080

このコマンドからは、ここに示すように、作成した項目を含む "todo" 項目の一覧が返されます。

[{"id":1,"description":"configuration","details":"congratulations, you have set up R2DBC correctly!","done":true}]

これらの cURL 要求のスクリーンショットを次に示します。

お疲れさまでした。 R2DBC を使用して Azure SQL Database にデータを格納および取得する、完全なリアクティブ Spring Boot アプリケーションを作成しました。

リソースをクリーンアップする

このクイックスタートで使用したすべてのリソースをクリーンするには、次のコマンドを使用してリソースグループを削除します。

az group delete \
    --name $AZ_RESOURCE_GROUP \
    --yes

次のステップ

Spring Data アプリケーションを Azure Spring Apps にデプロイし、マネージド ID を使用する方法の詳細については、「チュートリアル: Azure データベースへのパスワードなしの接続を使用して Spring アプリケーションを Azure Spring Apps にデプロイする」を参照してください。

Spring および Azure の詳細については、Azure ドキュメントセンターで引き続き Spring に関するドキュメントをご確認ください。

Azure の Spring

次の方法で共有

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

前提条件

サンプルアプリケーションを確認する

作業環境を準備する

Azure SQL Database インスタンスを作成する

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

Azure SQL データベースを構成する

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

リアクティブ Spring Boot アプリケーションを作成する

Spring Initializr を使用してアプリケーションを生成する

リアクティブ Azure SQL Database ドライバーの実装を追加する

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

データベーススキーマを作成する

アプリケーションをコーディングする

アプリケーションをテストする

リソースをクリーンアップする

次のステップ

関連項目

フィードバック

その他のリソース

次の方法で共有

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

前提条件

サンプル アプリケーションを確認する

作業環境を準備する

Azure SQL Database インスタンスを作成する

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

Azure SQL データベースを構成する

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

リアクティブ Spring Boot アプリケーションを作成する

Spring Initializr を使用してアプリケーションを生成する

リアクティブ Azure SQL Database ドライバーの実装を追加する

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

データベース スキーマを作成する

アプリケーションをコーディングする

アプリケーションをテストする

リソースをクリーンアップする

次のステップ

関連項目

フィードバック

その他のリソース

サンプルアプリケーションを確認する

データベーススキーマを作成する