NEVO
すべてのノート
システム設計

設定は境界で扱う

約 3 分

設定とアプリケーションコードの間に小さな境界を置くと、変更を理解しやすくなります。

設定は便利な抜け道として増えていきます。ここに URL、あちらにタイムアウト、関数の隣に機能フラグ。やがて値の読み取りがコード全体に散らばり、デプロイ時の変更には、どこが何をいつ読むかを知る必要が出てきます。

最初に読み、早めに検証する

設定はエントリーポイントの近くで読み込みます。文字列を必要な型に変換し、必須項目を確認し、処理を受け付ける前にエラーを知らせます。接続先の不足は、リクエストの途中よりも起動時の方が診断しやすいものです。

必要な部分には、検証済みの小さなオブジェクトを渡します。請求書を処理するコードが、環境変数の名前まで知る必要はありません。

責任の所在を決める

各設定には、目的と管理する場所が必要です。タイムアウトは待機が発生する境界に、制限は保護するリソースの近くに置きます。同じ値を複数のモジュールに持つと、それぞれがずれていく可能性が生まれます。

既定値も意図を持って決めます。開発用の値が本番に適しているとは限りません。文書化されていない命名規則に頼らず、その違いを見える形にします。

秘密情報を表示しない

設定の概要は、運用中のサービスを理解する助けになります。ただし、何が有効かを示すことと、認証情報を出力することは別です。認証情報そのものではなく、読み込みに成功した事実を記録します。

診断、例外メッセージ、テストのスナップショット、サポート用の出力にも同じ注意が必要です。情報は、それを直接扱う処理よりも、便利な補助機能から漏れることがあります。

変更を確認できるようにする

設定を再読み込みできるなら、すぐ反映される項目と再起動が必要な項目を明記します。秘密情報を含まない版の識別子があれば、現在どの設定が使われているかを確認できます。

こうして、アプリケーションは意味のある値を扱い、デプロイ側はその値の取得元を管理します。互いの責任を静かに変えてしまうことなく、それぞれを変更できます。


すべてのノート