
# セッションフック

`JdbcSessionHook` の Bean は、これから実行される処理のために、接続のデータベースセッションを準備します。すべてのステートメントを現在のユーザーとして実行する (行レベルセキュリティのためのロールとユーザーのクレーム)、テナントを設定する、サーチパスを設定する、といったことの方法です。

## 使う理由

プールは、同じ接続をすべての呼び出し元に渡します。そのため、あるユーザーのために行った設定は、次のユーザーのときにもまだ残っています。手で行うなら、データベースに触れるすべての場所で、クエリの前にステートメントを一つ、後にもう一つ実行することになり、一度忘れただけで情報が漏れます。フックは、重要な二つの瞬間にスターターが呼び出し、リセットできなかった接続は、再利用されずに閉じられます。

## 例

```dart
@Component()
class CurrentUserSession extends JdbcSessionHook {
  CurrentUserSession(this.users);

  final CurrentUser users;

  // Right after a transaction began: transaction scope, gone at its end.
  @override
  Future<void> afterBegin(ConnectionHolder transaction) async {
    await transaction.connection.query(
      "select set_config('app.user_id', ?, true)",
      [users.id],
    );
  }

  // Around one unit of work outside a transaction, on a pooled connection.
  @override
  Future<void> beforeWork(DataSource dataSource, JdbcConnection c) async {
    await c.query("select set_config('app.user_id', ?, false)", [users.id]);
  }

  @override
  Future<void> afterWork(DataSource dataSource, JdbcConnection c) =>
      c.execute('reset app.user_id');
}
```

データベースのポリシーは、これで `current_setting('app.user_id')` を読めます。

## 三つの瞬間

| メソッド | いつ |
|---|---|
| `afterBegin(transaction)` | トランザクションごとに一度。開始した直後、最初のステートメントの前。そのデータソースのすべての `DataSourceTransactionManager` が呼び出す。トランザクションのスコープで設定したもの (`set local`、`set_config(…, true)`) は、トランザクションが終わると消える。 |
| `beforeWork(dataSource, connection)` | トランザクションの外での `JdbcTemplate`、`JdbcClient`、リポジトリの各呼び出しの前。取得したプールの接続に対して。ストリームでは、ストリームが終わるまで。 |
| `afterWork(dataSource, connection)` | その処理の後、接続がプールに戻る前。`beforeWork` が設定したものを取り除く。 |

どれも、オーバーライドしない限り何もしません。

## ルール

- **すべてのフックが、すべてのデータソースで実行されます。** この型のすべての Bean が、`@Order` の順に、すべての `DataSource` の Bean で実行されます。`afterWork` は逆順です。一つのデータベースのためのフックは、渡された `dataSource` を確認します。
- **処理の前に失敗したフックは、処理を失敗させ**、接続は閉じられます。
- **処理の後に失敗したフック**はログに記録され、接続はプールに戻らずに閉じられます。
- そのため、準備なしに実行されるステートメントはなく、別のユーザーの状態を持ったまま再利用される接続もありません。
- **フックを通らないもの:** マイグレーション、スキーマの初期化、ヘルスチェック。

権限がない、または行レベルセキュリティのポリシーによってデータベースが拒否したステートメント (PostgreSQL の `42501`) は、`PermissionDeniedDataAccessException` です。[エラー](errors.md) を参照してください。

## 使っているもの

[spring_boot_starter_supabase](../spring-boot-starter-supabase/data.md) の `spring.supabase.db.rls: user` は、セッションフックです。ロール `authenticated` または `anon` と、ユーザーのトークンのクレームを設定します。

## コードで

`jdbcSessionHookRegistrar` という Bean が、すべての `DataSource` の Bean にフックを渡します (`DataSource.sessionHooks`)。手で作ったデータソースも、同じ方法で受け取ります。

```dart
dataSource.sessionHooks.add(hook);
```

## Spring (Java) との対応

Spring には、このような Bean はありません。最も近いのは、オーバーライドする `DataSourceTransactionManager.prepareTransactionalConnection` と、`UserCredentialsDataSourceAdapter` のような `DataSource` のアダプターです。

## 関連項目

- [データソース](data-sources.md)
- [トランザクション](transactions.md)
- [JdbcTemplate と JdbcClient](jdbc.md)
- [PostgreSQL](postgresql.md)
