<p><!-- STYLE_GUIDE_APPLIED --> 本記事は<strong>Geminiの出力をプロンプト工学で整理した業務ドラフト（未検証）</strong>です。</p> <h1 class="wp-block-heading">データの整合性を守る：シェルスクリプトにおける異常停止と後処理の自動化</h1> <h2 class="wp-block-heading">【導入と前提】</h2> <p>本稿では、API経由で取得したJSONデータを処理し、データベースや外部ストレージに同期するバッチ処理の堅牢化を解説します。不完全なデータ処理による副作用を最小限に抑え、異常終了時に確実にゴミを残さない設計を目指します。</p> <ul class="wp-block-list"> <li><p><strong>OS/実行環境</strong>: GNU/Linux (Ubuntu/RHEL)</p></li> <li><p><strong>必須ツール</strong>: Bash 4.4+, <code>curl</code>, <code>jq</code>, <code>systemd</code></p></li> </ul> <h2 class="wp-block-heading">【処理フローと設計】</h2> <p>スクリプトのライフサイクル全体を通じて、どのフェーズで失敗してもシステムをクリーンな状態に保つためのフローです。</p> <div class="wp-block-merpress-mermaidjs diagram-source-mermaid"><pre class="mermaid"> graph TD A["スクリプト開始"] --> B["一時ファイル作成"] B --> C{"APIデータ取得"} C -->|失敗| D["EXITトラップ発動"] C -->|成功| E["jqによる検証/変換"] E -->|不正JSON| D E -->|正常| F["最終処理/デプロイ"] F --> G["正常終了"] D --> H["一時ファイル削除/ログ記録"] G --> H </pre></div> <ol class="wp-block-list"> <li><p><strong>初期化</strong>: <code>set</code>オプションによる厳格なエラーハンドリングの有効化。</p></li> <li><p><strong>保護</strong>: <code>trap</code>によるシグナル捕捉とリソース解放の予約。</p></li> <li><p><strong>実行</strong>: パイプラインを含む各コマンドの成否を監視。</p></li> </ol> <h2 class="wp-block-heading">【実装：堅牢な自動化スクリプト】</h2> <p>以下は、外部APIからシステム設定を取得し、検証した上で保存する実戦的なスクリプト例です。</p> <h3 class="wp-block-heading">1. 堅牢なシェルスクリプト (<code>sync_data.sh</code>)</h3> <div class="codehilite"> <pre data-enlighter-language="generic">#!/usr/bin/env bash # -e: コマンドの失敗で即終了 # -u: 未定義変数の参照でエラー # -o pipefail: パイプ途中の失敗を反映 set -euo pipefail # ロギング関数 log() { echo "[$(date +'%Y-%m-%dT%H:%M:%S%z')] $*"; } # 一時ファイルの管理 TMPFILE=$(mktemp /tmp/api_data.XXXXXX.json) # EXITシグナル（正常・異常終了の両方）で一時ファイルを削除 trap 'rm -f "$TMPFILE"; log "Cleanup completed."' EXIT # APIエンドポイント（例） API_URL="https://api.example.com/v1/config" log "Starting data fetch..." # curlの安全な実行 # -s: 進捗非表示, -S: エラー表示, -f: HTTPエラー時に失敗扱い, -L: リダイレクト追跡 # --retry: 一時的なネットワークエラーへの対応 curl -sSfL --retry 3 --retry-delay 2 "$API_URL" -o "$TMPFILE" log "Validating JSON integrity..." # jqによるスキーマ検証（例：特定のキーが存在するか） if ! jq -e '.version' "$TMPFILE" > /dev/null; then log "Error: Invalid JSON schema detected." exit 1 fi # データの安全な配置（アトミックな書き換えのために一旦別名で保存してmv） mv "$TMPFILE" "./config_actual.json" log "Process finished successfully." </pre> </div> <h3 class="wp-block-heading">2. systemd ユニットファイルによる定時実行</h3> <p>スクリプトをデーモン化または定期実行（Timer）する場合の設定例です。</p> <div class="codehilite"> <pre data-enlighter-language="generic"># /etc/systemd/system/api-sync.service [Unit] Description=Robust API Data Sync Service After=network-online.target [Service] Type=oneshot User=syncuser ExecStart=/usr/local/bin/sync_data.sh # 異常終了時の挙動定義 Restart=on-failure RestartSec=30s [Install] WantedBy=multi-user.target </pre> </div> <h2 class="wp-block-heading">【検証と運用】</h2> <p>スクリプトを導入した後は、以下の手順で動作を確認します。</p> <ul class="wp-block-list"> <li><p><strong>終了ステータスの確認</strong>: <code>echo $?</code> を実行し、正常時は <code>0</code>、異常時はそれ以外であることを確認します。</p></li> <li><p><strong>ログの追跡</strong>: <code>journalctl -u api-sync.service</code> で実行履歴と <code>trap</code> によるクリーンアップログを確認します。</p></li> <li><p><strong>疑似エラー注入</strong>: <code>API_URL</code> を無効なものに書き換え、<code>set -e</code> によって即座に停止し、かつ <code>trap</code> により <code>/tmp</code> 内のファイルが削除されることを確認します。</p></li> </ul> <h2 class="wp-block-heading">【トラブルシューティングと落とし穴】</h2> <ul class="wp-block-list"> <li><p><strong>パイプラインの罠</strong>: <code>set -o pipefail</code> がないと、<code>curl ... | jq ...</code> の <code>curl</code> が失敗しても <code>jq</code> が成功すればスクリプトは続行されてしまいます。必ずセットで使用してください。</p></li> <li><p><strong>sudoの環境変数</strong>: <code>sudo</code> 経由で実行する場合、環境変数が引き継がれないことがあります。<code>sudo -E</code> を使用するか、スクリプト内で明示的にパスを通してください。</p></li> <li><p><strong>trapの多重定義</strong>: <code>trap</code> は後から書いたものに上書きされます。複数の処理を入れたい場合は、関数にまとめて呼び出すのがベストプラクティスです。</p></li> </ul> <h2 class="wp-block-heading">【まとめ】</h2> <p>運用の冪等性と堅牢性を維持するための3つのポイント：</p> <ol class="wp-block-list"> <li><p><strong>アトミックな操作</strong>: ファイル更新は直接上書きせず、一時ファイルを作成してから <code>mv</code> で置換する。</p></li> <li><p><strong>Fail-Fast設計</strong>: <code>set -euo pipefail</code> でエラーを隠蔽せず、問題発生時に即座に停止させる。</p></li> <li><p><strong>リソースの自己破棄</strong>: <code>trap</code> を利用し、実行パスに関わらず一時ファイルやロックファイルを確実に削除する。</p></li> </ol>

graph TD
A["スクリプト開始"] --> B["一時ファイル作成"]
B --> C{"APIデータ取得"}
C -->|失敗| D["EXITトラップ発動"]
C -->|成功| E["jqによる検証/変換"]
E -->|不正JSON| D
E -->|正常| F["最終処理/デプロイ"]
F --> G["正常終了"]
D --> H["一時ファイル削除/ログ記録"]
G --> H

#!/usr/bin/env bash

# -e: コマンドの失敗で即終了


# -u: 未定義変数の参照でエラー


# -o pipefail: パイプ途中の失敗を反映

set -euo pipefail

# ロギング関数

log() { echo "[$(date +'%Y-%m-%dT%H:%M:%S%z')] $*"; }

# 一時ファイルの管理

TMPFILE=$(mktemp /tmp/api_data.XXXXXX.json)

# EXITシグナル（正常・異常終了の両方）で一時ファイルを削除

trap 'rm -f "$TMPFILE"; log "Cleanup completed."' EXIT

# APIエンドポイント（例）

API_URL="https://api.example.com/v1/config"

log "Starting data fetch..."

# curlの安全な実行


# -s: 進捗非表示, -S: エラー表示, -f: HTTPエラー時に失敗扱い, -L: リダイレクト追跡


# --retry: 一時的なネットワークエラーへの対応

curl -sSfL --retry 3 --retry-delay 2 "$API_URL" -o "$TMPFILE"

log "Validating JSON integrity..."

# jqによるスキーマ検証（例：特定のキーが存在するか）

if ! jq -e '.version' "$TMPFILE" > /dev/null; then
    log "Error: Invalid JSON schema detected."
    exit 1
fi

# データの安全な配置（アトミックな書き換えのために一旦別名で保存してmv）

mv "$TMPFILE" "./config_actual.json"

log "Process finished successfully."

# /etc/systemd/system/api-sync.service

[Unit]
Description=Robust API Data Sync Service
After=network-online.target

[Service]
Type=oneshot
User=syncuser
ExecStart=/usr/local/bin/sync_data.sh

# 異常終了時の挙動定義

Restart=on-failure
RestartSec=30s

[Install]
WantedBy=multi-user.target