# 帳票設計書 3-StreamedJsonResponse

## 概要

本ドキュメントは、Laravel FrameworkにおけるStreamedJsonResponse（ストリーミングJSONレスポンス）機能の設計仕様を定義する。JSON形式のデータをストリーミング出力する機能であり、大量データのJSON出力に適している。

### 本帳票の処理概要

StreamedJsonResponseは、大量のJSONデータをメモリ効率よくストリーミング形式で出力する機能を提供する。配列やイテレータをJSONとして逐次エンコードしながら出力するため、数万〜数百万件のデータでもメモリ制限を超えることなく処理できる。

**業務上の目的・背景**：REST APIやデータエクスポート機能において、大量のレコードをJSON形式で返却する必要がある場面は多い。従来のjson_encode()を使用した方式では、全データをメモリに保持する必要があり、大量データ時にメモリ不足エラーが発生する。StreamedJsonResponseを使用することで、データを逐次JSONエンコードしながら出力し、メモリ使用量を一定に保つことができる。

**帳票の利用シーン**：
- 大量レコードのAPI応答（数万件以上のデータ取得）
- データベースからの大量データエクスポート
- リアルタイムデータストリーミング
- 大規模レポートのJSON形式出力

**主要な出力内容**：
1. ストリーミング形式のJSONデータ
2. Content-Type: application/json ヘッダー
3. JSON配列またはオブジェクト構造の逐次出力
4. カスタムエンコーディングオプション対応

**帳票の出力タイミング**：ResponseFactory::streamJson()メソッドの呼び出し時にStreamedJsonResponseが生成され、クライアントへのJSON出力が開始される。

**帳票の利用者**：API開発者、フロントエンドエンジニア、データ分析担当者

## 帳票種別

JSONストリーミングレスポンス / APIレスポンス

## 利用画面

| 画面No | 画面名 | URL/ルーティング | 出力操作 |
|--------|--------|-----------------|---------|
| - | API エンドポイント | 開発者定義 | Response::streamJson()呼び出し |

## 出力形式

### 基本仕様

| 項目 | 内容 |
|-----|------|
| ファイル形式 | JSON（application/json） |
| 用紙サイズ | - |
| 向き | - |
| ファイル名 | - |
| 出力方法 | HTTPストリーミングレスポンス |
| 文字コード | UTF-8 |

### StreamedJsonResponse固有設定

| 項目 | 内容 |
|-----|------|
| Content-Type | application/json |
| encodingOptions | JsonResponse::DEFAULT_ENCODING_OPTIONS（デフォルト） |
| ストリーミング | イテラブルデータを逐次JSON出力 |

## 帳票レイアウト

### レイアウト概要

StreamedJsonResponseはJSON形式でデータを出力する。配列やイテレータの各要素がJSON配列の要素として順次出力される。

```
┌─────────────────────────────────────┐
│          HTTPヘッダー部              │
├─────────────────────────────────────┤
│         JSON配列開始 [              │
│           要素1,                    │
│           要素2,                    │
│           ...                       │
│         JSON配列終了 ]              │
└─────────────────────────────────────┘
```

### ヘッダー部

| No | 項目名 | 説明 | データ取得元 | 表示形式 |
|----|-------|------|-------------|---------|
| 1 | Content-Type | JSONコンテンツタイプ | 自動設定 | application/json |
| 2 | Transfer-Encoding | 転送エンコーディング | 自動設定 | chunked |

### 明細部

| No | 項目名 | 説明 | データ取得元 | 表示形式 | 列幅 |
|----|-------|------|-------------|---------|-----|
| 1 | JSONデータ | 配列/オブジェクトの各要素 | $dataパラメータ | JSON形式 | - |

### フッター部

フッター部は特に定義されない（JSON配列の終了ブラケットのみ）。

## 出力条件

### 抽出条件

| 条件名 | 説明 | 必須 |
|-------|------|-----|
| data | 出力するデータ（配列またはイテレータ） | Yes |
| status | HTTPステータスコード | No（デフォルト: 200） |
| headers | 追加HTTPヘッダー | No |
| encodingOptions | json_encode()のオプション | No（デフォルト: DEFAULT_ENCODING_OPTIONS） |

### ソート順

データのソートは呼び出し元で事前に行う。

| 優先度 | 項目 | 昇順/降順 |
|-------|------|---------|
| - | - | - |

### 改ページ条件

ストリーミングJSONレスポンスには改ページの概念は適用されない。

## データベース参照仕様

### 参照テーブル一覧

StreamedJsonResponse自体はデータベースを参照しない。データは呼び出し元から$dataパラメータで渡される。

| テーブル名 | 用途 | 結合条件 |
|-----------|------|---------|
| - | - | - |

## 計算仕様

### 計算項目一覧

| 項目名 | 計算式 | 端数処理 | 備考 |
|-------|-------|---------|------|
| - | - | - | JSONエンコードはSymfonyコンポーネントで処理 |

## 処理フロー

### 出力フロー

```mermaid
flowchart TD
    A[streamJson()メソッド呼び出し] --> B[StreamedJsonResponse生成]
    B --> C[HTTPヘッダー送信]
    C --> D[JSON配列開始出力]
    D --> E{データ要素あり?}
    E -->|Yes| F[要素をJSONエンコード]
    F --> G[チャンク出力]
    G --> E
    E -->|No| H[JSON配列終了出力]
    H --> I[レスポンス完了]
```

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 表示メッセージ | 対処方法 |
|----------|---------|--------------|---------|
| JSONエンコードエラー | エンコード不可能なデータ | JsonException | データ形式を確認 |
| メモリ不足 | 単一要素が巨大 | Allowed memory size exhausted | 要素サイズを分割 |
| タイムアウト | 大量データ処理 | Maximum execution time exceeded | 処理時間を調整 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定データ件数 | 制限なし（ストリーミングのため） |
| 目標出力時間 | データ量に依存（即時開始） |
| 同時出力数上限 | サーバーリソースに依存 |

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

- JSONデータに機密情報が含まれる場合は、認証・認可を適切に実装すること
- XSS対策として、JSON_HEX_TAGオプションの使用を検討すること
- 大量データ出力時は、DDoS対策としてレート制限を検討すること

## 備考

- Symfony\Component\HttpFoundation\StreamedJsonResponseを使用している
- DEFAULT_ENCODING_OPTIONSはJsonResponseクラスで定義されている
- イテレータを渡すことで、データベースカーソルからの直接ストリーミングが可能

---

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

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

### 推奨読解順序

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

StreamedJsonResponseはSymfony HttpFoundationコンポーネントのクラスを使用している。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | StreamedJsonResponse.php | `vendor/symfony/http-foundation/StreamedJsonResponse.php` | StreamedJsonResponseの基本実装を理解する |
| 1-2 | JsonResponse.php | `src/Illuminate/Http/JsonResponse.php` | DEFAULT_ENCODING_OPTIONSの定義を確認 |

**読解のコツ**: SymfonyのStreamedJsonResponseは配列/イテレータを受け取り、JSON形式で逐次出力する仕組みを理解する。

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

処理の起点となるResponseFactoryのstreamJson()メソッドを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | ResponseFactory.php | `src/Illuminate/Routing/ResponseFactory.php` | streamJson()メソッドの実装を確認 |

**主要処理フロー**:
1. **行215-227**: streamJson()メソッドの実装
2. **行224**: StreamedJsonResponseのインスタンス生成
3. **行226**: $encodingOptionsのデフォルト値としてJsonResponse::DEFAULT_ENCODING_OPTIONS使用

#### Step 3: コントラクトインターフェースを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | ResponseFactory.php | `src/Illuminate/Contracts/Routing/ResponseFactory.php` | streamJson()メソッドのインターフェース定義 |

**主要処理フロー**:
- **行70-79**: streamJson()メソッドのインターフェース定義

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

```
ResponseFactory::streamJson()
    │
    └─ new StreamedJsonResponse($data, $status, $headers, $encodingOptions)
           │
           ├─ JSONヘッダー設定
           │
           └─ イテレーション処理
                  ├─ 要素ごとにjson_encode()
                  └─ チャンク出力
```

### データフロー図

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

配列/イテレータ ───▶ ResponseFactory     ───▶ HTTPレスポンス
$data                ::streamJson()           (JSON形式)
                          │
                          ▼
                   StreamedJsonResponse
                          │
                          ▼
                   要素ごとにJSONエンコード
                          │
                          ▼
                   チャンク出力
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| ResponseFactory.php | `src/Illuminate/Routing/ResponseFactory.php` | ソース | streamJson()メソッドの実装 |
| ResponseFactory.php | `src/Illuminate/Contracts/Routing/ResponseFactory.php` | ソース | インターフェース定義 |
| JsonResponse.php | `src/Illuminate/Http/JsonResponse.php` | ソース | DEFAULT_ENCODING_OPTIONS定義 |
| Response.php | `src/Illuminate/Support/Facades/Response.php` | ソース | Facadeクラス |
| StreamedJsonResponse.php | `vendor/symfony/http-foundation/StreamedJsonResponse.php` | ソース | Symfony基底クラス |
