設定値バリデーター は何をしますか?
設定ファイルと環境変数を検証し、ランタイムエラーや設定漏れを防止します。
使用するタイミング
- 環境変数や設定ファイルを扱っているとき
- デプロイや設定に関する問題が発生したとき
- ユーザーが「.env」「config」「環境変数」「設定」に言及したとき
手順
1. 設定ファイルを探す
以下を検索してください:
.env,.env.example,.env.localconfig/,config.js,config.jsonsettings.py,application.ymlappsettings.json,.env.production
2. 欠落している変数を検出する
.env.example と .env を比較:
# .env.example にあって .env にない変数
comm -23 <(grep -o '^[A-Z_]*' .env.example | sort) <(grep -o '^[A-Z_]*' .env | sort)
一般的な必須変数:
DATABASE_URL
API_KEY
SECRET_KEY
NODE_ENV
PORT
3. 変数の形式を検証する
よくある問題を確認:
// スペースを含む値に引用符がない
DATABASE_URL=postgres://localhost/db name // 悪い
DATABASE_URL="postgres://localhost/db name" // 良い
// プロトコルがない
API_URL=example.com // 悪い
API_URL=https://example.com // 良い
// 真偽値が文字列として解釈される
DEBUG=true // 文字列として解釈される可能性あり
DEBUG=1 // より明示的
4. 実行時に必須変数を検証する
Node.js の例:
const requiredEnvVars = [
'DATABASE_URL',
'API_KEY',
'JWT_SECRET'
];
const missing = requiredEnvVars.filter(v => !process.env[v]);
if (missing.length > 0) {
throw new Error(`Missing required env vars: ${missing.join(', ')}`);
}
Python の例:
import os
REQUIRED_ENV_VARS = [
'DATABASE_URL',
'SECRET_KEY',
'ALLOWED_HOSTS'
]
missing = [var for var in REQUIRED_ENV_VARS if not os.getenv(var)]
if missing:
raise EnvironmentError(f"Missing env vars: {', '.join(missing)}")
5. 型検証
型を検証:
const config = {
port: parseInt(process.env.PORT || '3000', 10),
debug: process.env.DEBUG === 'true',
apiUrl: new URL(process.env.API_URL), // 不正な場合に例外をスロー
maxConnections: Number(process.env.MAX_CONNECTIONS),
};
// 検証
if (isNaN(config.port) || config.port < 1 || config.port > 65535) {
throw new Error('PORT must be a valid port number');
}
6. .env.example を生成する
実際の .env からテンプレートを作成:
# 値を削除し、キーのみ残す
sed 's/=.*/=/' .env > .env.example
またはプレースホルダー付き:
DATABASE_URL=postgres://user:password@localhost:5432/dbname
API_KEY=your_api_key_here
SECRET_KEY=generate_random_secret
PORT=3000
NODE_ENV=development
7. 設定スキーマ
スキーマの定義(Joi の例):
const Joi = require('joi');
const envSchema = Joi.object({
NODE_ENV: Joi.string()
.valid('development', 'production', 'test')
.required(),
PORT: Joi.number()
.port()
.default(3000),
DATABASE_URL: Joi.string()
.uri()
.required(),
API_KEY: Joi.string()
.min(32)
.required(),
DEBUG: Joi.boolean()
.default(false),
}).unknown();
const { error, value } = envSchema.validate(process.env);
if (error) {
throw new Error(`Config validation error: ${error.message}`);
}
module.exports = value;
8. セキュリティチェック
シークレットをコミットしない:
# .env が gitignore されているか確認
if ! grep -q "^\.env$" .gitignore; then
echo "警告: .env が .gitignore にありません"
fi
# コード内のハードコードされたシークレットを確認
grep -r "api_key.*=.*['\"]" --exclude-dir=node_modules
よくあるセキュリティ問題:
- ハードコードされたパスワード/キー
- 本番環境でのデフォルトシークレット
- 機密設定の露出
- 暗号化されていないシークレット
9. 環境別設定
環境ごとに整理:
.env.development
.env.staging
.env.production
.env.test
適切に読み込む:
require('dotenv').config({
path: `.env.${process.env.NODE_ENV || 'development'}`
});
10. すべての変数をドキュメント化する
CONFIG.md を作成:
# 設定
## 環境変数
### 必須
- `DATABASE_URL`: PostgreSQL 接続文字列
- 形式: `postgres://user:pass@host:port/db`
- 例: `postgres://app:secret@localhost:5432/myapp`
- `API_KEY`: サードパーティ API キー
- 入手元: https://dashboard.example.com
- 必要なスコープ: read, write
### オプション
- `PORT`: サーバーポート(デフォルト: 3000)
- `DEBUG`: デバッグログを有効にする(デフォルト: false)
- `MAX_CONNECTIONS`: データベースプールサイズ(デフォルト: 10)
## セットアップ
1. `.env.example` を `.env` にコピー
2. すべての必須値を入力
3. `npm run validate-config` を実行して検証
11. 検証スクリプト
scripts/validate-config.js を作成:
const fs = require('fs');
function validateConfig() {
const required = ['DATABASE_URL', 'API_KEY'];
const missing = required.filter(v => !process.env[v]);
if (missing.length > 0) {
console.error(`❌ 欠落: ${missing.join(', ')}`);
process.exit(1);
}
console.log('✓ すべての必須設定変数が存在します');
}
validateConfig();
12. ベストプラクティス
- .env を絶対にコミットしない: 常に gitignore すること
- .env.example を維持する: 最新の状態を保つ
- 起動時に検証する: 設定ミスがあればすぐに検出
- 適切なデフォルト値を使う: 賢いフォールバックを用意
- すべてをドキュメント化する: 各変数を説明する
- シークレットをローテーションする: 定期的にキーを更新
- シークレットマネージャーを使用する: 本番環境では Vault、AWS Secrets Manager などを利用
- 型チェックを行う: 存在確認だけでなく型も検証する
サポートファイル
templates/config-validator.jstemplates/.env.examplescripts/generate-env-example.sh