# バッチ設計書 11-shopware.sitemap_generate

## 概要

本ドキュメントは、Shopwareプラットフォームにおけるサイトマップ自動生成バッチの設計仕様を定義します。SEO最適化のためにXML形式のサイトマップファイルを定期的に生成し、検索エンジンのクローラーによるサイトインデックス作成を支援します。

### 本バッチの処理概要

**業務上の目的・背景**：ECサイトにおいて検索エンジン最適化（SEO）は売上に直結する重要な要素です。サイトマップはGoogleなどの検索エンジンがサイト構造を効率的に把握するために不可欠なファイルであり、商品ページや各種コンテンツページへのインデックス登録を促進します。手動でのサイトマップ更新は現実的でないため、商品追加や更新時に自動的にサイトマップを再生成する仕組みが必要です。

**バッチの実行タイミング**：日次（86400秒間隔）でスケジュール実行されます。ただし、システム設定（`shopware.sitemap.scheduled_task.enabled`）により有効化が必要で、また`core.sitemap.sitemapRefreshStrategy`がスケジュールタスク戦略に設定されている場合のみ実際に処理が実行されます。

**主要な処理内容**：
1. システム設定のサイトマップ更新戦略を確認し、スケジュールタスク戦略でない場合はスキップ
2. ストアフロントタイプの販売チャネルを取得（ドメイン設定を含む）
3. 各販売チャネルのドメインから言語IDを抽出し、一意な言語ごとにサイトマップ生成メッセージを発行
4. 非同期メッセージキュー経由でSitemapExporterが実際のXML生成を実行
5. 各URLプロバイダー（商品、カテゴリ等）からURLを収集し、バッチ処理でXMLファイルを出力

**前後の処理との関連**：前提となるバッチは特にありませんが、商品データや販売チャネルデータが正しく登録されていることが前提です。後続処理として、生成されたサイトマップはGoogle Search Consoleなどの検索エンジンウェブマスターツールに登録されます。

**影響範囲**：このバッチは各販売チャネルのファイルシステム上にサイトマップXMLファイルを出力します。既存のサイトマップファイルは上書きされます。処理中はキャッシュによるロック機構が働き、同一販売チャネル・言語に対する重複実行を防止します。

## バッチ種別

データ連携 / ファイル生成（サイトマップXML生成）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 日次 |
| 実行時刻 | スケジュールタスクランナーに依存 |
| 実行曜日 | 毎日 |
| 実行日 | - |
| トリガー | cron（スケジュールタスク） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| shopware.sitemap.scheduled_task.enabled | パラメータバッグでtrue設定が必要 |
| core.sitemap.sitemapRefreshStrategy | STRATEGY_SCHEDULED_TASK（2）に設定されていること |
| 販売チャネル | ストアフロントタイプの販売チャネルが1つ以上存在し、ドメインが設定されていること |

### 実行可否判定

1. `shouldRun()`メソッドで`shopware.sitemap.scheduled_task.enabled`パラメータを確認
2. `run()`メソッド内で`core.sitemap.sitemapRefreshStrategy`がSTRATEGY_SCHEDULED_TASKかを確認
3. 両条件を満たす場合のみサイトマップ生成処理を実行

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | 入力パラメータは不要 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| sales_channel | DB | ストアフロントタイプの販売チャネル情報 |
| sales_channel_domain | DB | 販売チャネルのドメイン情報（言語ID含む） |
| system_config | DB | サイトマップ更新戦略設定 |
| URLプロバイダー | Service | 商品、カテゴリ等のURL情報を提供するサービス群 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| sitemap.xml | XML | メインサイトマップファイル |
| sitemap-*.xml | XML | 分割されたサイトマップファイル群 |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | sitemap.xml, sitemap-1.xml, sitemap-2.xml等 |
| 出力先 | ファイルシステム（themeファイルシステム） |
| 文字コード | UTF-8 |
| 区切り文字 | - |

## 処理フロー

### 処理シーケンス

```
1. タスク実行条件チェック
   └─ shouldRun()でパラメータ確認
2. サイトマップ更新戦略確認
   └─ systemConfigServiceからsitemapRefreshStrategyを取得
3. 販売チャネル取得
   └─ ストアフロントタイプ、ドメイン設定ありの条件でクエリ
4. イベントディスパッチ
   └─ SitemapSalesChannelCriteriaEventを発火
5. 言語別メッセージ発行
   └─ 各販売チャネル・言語の組み合わせでSitemapMessageをディスパッチ
6. [非同期] サイトマップ生成
   └─ SitemapExporterがURLプロバイダーからURL収集、XML生成
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B{パラメータ確認}
    B -->|無効| Z[スキップ終了]
    B -->|有効| C{更新戦略確認}
    C -->|非スケジュール| Z
    C -->|スケジュール| D[販売チャネル取得]
    D --> E{チャネル存在?}
    E -->|なし| Z
    E -->|あり| F[チャネルループ開始]
    F --> G{ドメイン存在?}
    G -->|なし| H[次のチャネル]
    G -->|あり| I[言語ID抽出]
    I --> J[言語ループ]
    J --> K[SitemapMessage発行]
    K --> L{言語残り?}
    L -->|あり| J
    L -->|なし| M{チャネル残り?}
    M -->|あり| F
    M -->|なし| N[バッチ終了]
    H --> M
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 販売チャネル取得 | sales_channel | SELECT | ストアフロントタイプのチャネル取得 |
| ドメイン取得 | sales_channel_domain | SELECT | 販売チャネルに紐づくドメイン取得 |
| 設定取得 | system_config | SELECT | サイトマップ更新戦略取得 |

### テーブル別操作詳細

#### sales_channel

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | id, name, domains | type_id = SALES_CHANNEL_TYPE_STOREFRONT | ドメイン関連をJOIN |

#### sales_channel_domain

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | id, language_id, url | domains.id IS NOT NULL | 販売チャネルに紐づくドメイン |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| SITEMAP_ALREADY_LOCKED | 排他エラー | 同一チャネル・言語で生成中 | 処理をスキップ、次回実行を待つ |
| INVALID_DOMAIN | 設定エラー | 有効なドメインが存在しない | 販売チャネルのドメイン設定を確認 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 失敗時再スケジュール有効 |
| リトライ間隔 | 次回スケジュール実行時 |
| リトライ対象エラー | 全般的なエラー |

### 障害時対応

1. ログを確認し、エラー原因を特定
2. ロックが残っている場合はキャッシュをクリア
3. ドメイン設定や販売チャネル設定を確認
4. 手動でサイトマップ生成コマンドを実行（`bin/console sitemap:generate`）

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | メッセージ発行はトランザクション外 |
| コミットタイミング | 即座（メッセージキュー発行時） |
| ロールバック条件 | 特になし（非同期処理） |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 販売チャネル数 × 言語数 |
| 目標処理時間 | タスクハンドラーは数秒（メッセージ発行のみ） |
| メモリ使用量上限 | 通常のPHP制限に準拠 |

## 排他制御

キャッシュベースのロック機構を使用。販売チャネルID + 言語IDの組み合わせでキャッシュキーを生成し、生成中は他のプロセスからのアクセスをブロック。forceフラグで強制実行可能。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | タスクハンドラー開始時 | タスク開始通知 |
| 進捗ログ | メッセージ発行時 | 販売チャネルID、言語ID |
| 終了ログ | タスクハンドラー終了時 | 処理完了通知 |
| エラーログ | エラー発生時 | エラー詳細、スタックトレース |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理時間 | 300秒 | システム管理者 |
| エラー件数 | 1件以上 | システム管理者 |

## 備考

- サイトマップ生成は非同期メッセージキュー経由で実行されるため、実際の生成完了はタスクハンドラー終了後となります
- SitemapGeneratedEventが生成完了時に発火され、キャッシュ無効化などの後処理をトリガーできます
- URL数が多い場合は複数のXMLファイルに分割されます（サイトマップインデックス形式）
