# 機能設計書 45-パイプライン処理

## 概要

本ドキュメントは、Laravel Frameworkのパイプライン処理機能の設計仕様を定義する。Pipelineクラスを中心とした、オブジェクトを複数のステージに通す処理パターンについて詳述する。

### 本機能の処理概要

パイプライン処理は、オブジェクトを複数の処理ステージ（パイプ）を通して順次処理するデザインパターンを実装する。Laravelのミドルウェアパターンの基盤として使用され、HTTPリクエスト処理やコマンドバスでのジョブ実行前処理など、様々な場面で活用される。

**業務上の目的・背景**：複数の処理を順番に適用する必要がある場面は多い。例えば、HTTPリクエストに対して認証、認可、バリデーション、ログ記録などを順次適用する場合や、データ変換パイプラインを構築する場合に有用である。パイプラインパターンにより、各処理を独立したクラスとして実装でき、処理の追加・削除・順序変更が容易になる。

**機能の利用シーン**：HTTPミドルウェアスタック、コマンドバスのパイプ処理、カスタムデータ変換パイプライン、バリデーションチェーンなどで利用される。

**主要な処理内容**：
1. 処理対象オブジェクトの設定（send）
2. パイプの設定（through、pipe）
3. 処理メソッドの指定（via）
4. 最終処理の実行（then、thenReturn）
5. 後処理コールバックの設定（finally）
6. トランザクション内実行（withinTransaction）

**関連システム・外部連携**：DIコンテナ（パイプのインスタンス化）、HTTPカーネル（ミドルウェア実行）、コマンドバス（ジョブパイプライン）と連携する。

**権限による制御**：パイプライン自体には権限制御は存在しないが、個々のパイプ（ミドルウェア等）内で認証・認可チェックを実装することが一般的。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | 画面機能マッピングにパイプライン処理関連の画面なし |

## 機能種別

データ処理 / デザインパターン実装

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| passable | mixed | Yes | パイプラインを通過するオブジェクト | - |
| pipes | array | No | 適用するパイプの配列（クラス名、オブジェクト、Closure） | - |
| method | string | No | パイプで呼び出すメソッド名（デフォルト: handle） | - |
| destination | Closure | Yes（then時） | 最終処理クロージャ | - |

### 入力データソース

- HTTPカーネルからのミドルウェアスタック
- コマンドバスからのパイプ設定
- 開発者コードからの直接呼び出し

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| result | mixed | パイプラインの最終処理結果 |

### 出力先

- 呼び出し元への戻り値

## 処理フロー

### 処理シーケンス

```
1. パイプライン構築
   └─ send()で処理対象オブジェクト設定
   └─ through()でパイプ配列設定
   └─ via()で呼び出しメソッド設定（オプション）

2. パイプライン実行
   └─ then()またはthenReturn()で実行開始

3. パイプスタック構築
   └─ array_reduceでパイプを逆順に連結
   └─ 各パイプは次のパイプを$next引数として受け取る

4. パイプ実行
   └─ 各パイプのhandleメソッド（またはvia指定メソッド）を実行
   └─ $next($passable)で次のパイプに委譲

5. 最終処理実行
   └─ destination（then引数のClosure）を実行

6. 後処理実行
   └─ finallyコールバックがあれば実行
```

### フローチャート

```mermaid
flowchart TD
    A[Pipeline生成] --> B[send で対象設定]
    B --> C[through でパイプ設定]
    C --> D{via 指定?}
    D -->|Yes| E[メソッド名設定]
    D -->|No| F[デフォルト handle]
    E --> G[then/thenReturn 呼び出し]
    F --> G
    G --> H[array_reduce でスタック構築]
    H --> I{withinTransaction?}
    I -->|Yes| J[トランザクション内で実行]
    I -->|No| K[通常実行]
    J --> L[パイプ順次実行]
    K --> L
    L --> M{callable?}
    M -->|Yes| N[直接呼び出し]
    M -->|No| O{object?}
    O -->|Yes| P[メソッド呼び出し]
    O -->|No| Q[コンテナでmake]
    Q --> P
    N --> R[次のパイプへ]
    P --> R
    R --> S{最終パイプ?}
    S -->|No| L
    S -->|Yes| T[destination実行]
    T --> U{finally設定?}
    U -->|Yes| V[finallyコールバック]
    U -->|No| W[結果返却]
    V --> W
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-45-1 | パイプ逆順処理 | パイプは逆順でスタックに積まれ、最初に定義したものから実行 | array_reduce使用時 |
| BR-45-2 | Callable直接実行 | パイプがcallableの場合は直接実行 | is_callable($pipe) が true |
| BR-45-3 | パイプパラメータ | パイプ文字列に:で区切ったパラメータを含められる | Class:param1,param2 形式 |
| BR-45-4 | 例外伝播 | パイプ内で例外が発生した場合、handleExceptionで処理 | Throwableがスローされた場合 |

### 計算ロジック

該当なし

## データベース操作仕様

### 操作別データベース影響一覧

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| withinTransaction | - | トランザクション | パイプライン全体をトランザクション内で実行 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| RuntimeException | コンテナ未設定 | コンテナなしでクラス名パイプを使用 | setContainer()でコンテナを設定 |
| Throwable | パイプ内例外 | パイプ処理中に例外発生 | handleException()でキャッチ（デフォルトは再スロー） |

### リトライ仕様

リトライ処理は実装されていない。

## トランザクション仕様

withinTransaction()でトランザクション内実行を有効化可能。指定したデータベースコネクションのトランザクション内でパイプライン全体が実行される。

## パフォーマンス要件

- パイプ数に比例したオーバーヘッドが発生
- 各パイプはリクエストごとにインスタンス化されるか、コンテナのキャッシュを利用

## セキュリティ考慮事項

- 外部入力からパイプクラス名を直接設定しないこと
- 各パイプで適切な入力検証を実施

## 備考

- Conditionableトレイトによりwhenメソッドでの条件付きパイプ追加が可能
- Macroableトレイトによるマクロ拡張が可能

---

## コードリーディングガイド

本機能を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

Pipelineが管理する内部状態を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Pipeline.php | `src/Illuminate/Pipeline/Pipeline.php` | プロパティ定義（23-58行目）で管理される状態を把握 |
| 1-2 | Pipeline.php（Contract） | `src/Illuminate/Contracts/Pipeline/Pipeline.php` | インターフェース定義 |

**読解のコツ**: $passableが処理対象、$pipesがパイプの配列、$methodが呼び出すメソッド名、$finallyが後処理コールバック。これらの関係を把握すると全体像が見える。

#### Step 2: エントリーポイントを理解する

パイプラインの構築と実行の入口を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Pipeline.php | `src/Illuminate/Pipeline/Pipeline.php` | send()（76-81行目）で処理対象設定 |
| 2-2 | Pipeline.php | `src/Illuminate/Pipeline/Pipeline.php` | through()（89-94行目）でパイプ設定 |
| 2-3 | Pipeline.php | `src/Illuminate/Pipeline/Pipeline.php` | then()（128-143行目）で実行 |

**主要処理フロー**:
1. **76-81行目**: send()で$passableを設定
2. **89-94行目**: through()で$pipesを設定
3. **130-132行目**: array_reduceでパイプスタック構築
4. **134-138行目**: トランザクション有無で分岐

#### Step 3: パイプ実行処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Pipeline.php | `src/Illuminate/Pipeline/Pipeline.php` | carry()（192-228行目）がパイプ実行の核心 |
| 3-2 | Pipeline.php | `src/Illuminate/Pipeline/Pipeline.php` | parsePipeString()（236-247行目）でパイプ文字列解析 |

**主要処理フロー**:
- **197-201行目**: callableならそのまま実行
- **202-210行目**: 文字列ならコンテナでmakeしてパラメータ追加
- **211-215行目**: オブジェクトならパラメータのみ設定
- **218-220行目**: メソッドがあればそれを呼び出し、なければ直接呼び出し

#### Step 4: 補助機能を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Pipeline.php | `src/Illuminate/Pipeline/Pipeline.php` | via()（115-120行目）でメソッド名変更 |
| 4-2 | Pipeline.php | `src/Illuminate/Pipeline/Pipeline.php` | finally()（163-168行目）で後処理設定 |
| 4-3 | Pipeline.php | `src/Illuminate/Pipeline/Pipeline.php` | withinTransaction()（265-270行目）でトランザクション設定 |
| 4-4 | Pipeline.php | `src/Illuminate/Pipeline/Pipeline.php` | pipe()（102-107行目）で追加パイプ設定 |

**主要処理フロー**:
- **115-120行目**: via()で$methodを変更（デフォルトはhandle）
- **163-168行目**: finally()で$finallyコールバック設定
- **265-270行目**: withinTransaction()で$withinTransactionを設定

#### Step 5: エラーハンドリングを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 5-1 | Pipeline.php | `src/Illuminate/Pipeline/Pipeline.php` | prepareDestination()（176-185行目） |
| 5-2 | Pipeline.php | `src/Illuminate/Pipeline/Pipeline.php` | handleException()（321-324行目） |

**主要処理フロー**:
- **180-183行目**: destination実行時の例外をhandleExceptionで処理
- **223-224行目**: パイプ実行時の例外をhandleExceptionで処理
- **321-324行目**: デフォルトは例外を再スロー（サブクラスでオーバーライド可能）

### プログラム呼び出し階層図

```
Pipeline::send($passable)
    │
    └─ Pipeline::through($pipes)
           │
           └─ Pipeline::then($destination)
                  │
                  ├─ array_reduce(array_reverse($pipes), carry(), prepareDestination())
                  │      │
                  │      ├─ prepareDestination($destination)
                  │      │      └─ Closure wrapping $destination with try-catch
                  │      │
                  │      └─ carry() [各パイプに対して]
                  │             │
                  │             ├─ [callable] $pipe($passable, $stack)
                  │             │
                  │             ├─ [string]
                  │             │      ├─ parsePipeString($pipe)
                  │             │      └─ $container->make($name)
                  │             │             └─ $pipe->{$method}($passable, $stack, ...$params)
                  │             │
                  │             └─ [object] $pipe->{$method}($passable, $stack)
                  │
                  ├─ [withinTransaction]
                  │  $db->connection()->transaction(fn() => $pipeline($passable))
                  │
                  └─ [finally]
                     ($finally)($passable)
```

### データフロー図

```
[入力]                   [処理]                          [出力]

$passable        ───▶  send()                  ───▶  Pipeline（$passable設定済）
(処理対象)              (対象設定)

$pipes           ───▶  through()               ───▶  Pipeline（$pipes設定済）
(パイプ配列)            (パイプ設定)

$pipes           ───▶  array_reduce()          ───▶  Closure（パイプスタック）
(パイプ配列)            (スタック構築)

$passable        ───▶  各パイプ.handle()       ───▶  変換された$passable
(処理対象)              (パイプ処理)

$passable        ───▶  $destination()          ───▶  最終結果
(処理済み対象)          (最終処理)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Pipeline.php | `src/Illuminate/Pipeline/Pipeline.php` | ソース | パイプラインのメイン実装 |
| PipelineServiceProvider.php | `src/Illuminate/Pipeline/PipelineServiceProvider.php` | ソース | サービスプロバイダ |
| Hub.php | `src/Illuminate/Pipeline/Hub.php` | ソース | パイプラインハブ（名前付きパイプライン管理） |
| Pipeline.php | `src/Illuminate/Contracts/Pipeline/Pipeline.php` | コントラクト | インターフェース定義 |
| Hub.php | `src/Illuminate/Contracts/Pipeline/Hub.php` | コントラクト | ハブインターフェース |
| Router.php | `src/Illuminate/Routing/Router.php` | ソース | ミドルウェアパイプライン使用例 |
| Kernel.php | `src/Illuminate/Foundation/Http/Kernel.php` | ソース | HTTPカーネルでのパイプライン使用 |
