"config" ってなんだ？ / What is "config"?

2024/04/13 開催の「PHP カンファレンス小田原 2024」（https://phpcon-odawara.jp/ ）の LT 資料です。

詳細：https://fortee.jp/phpconodawara-2024/proposal/5021a10a-670e-4d89-b003-d903feb2e365

Transcript

1. "config" ってなんだ？ 2024-04-13 PHP カンファレンス小田原 2024
2. 所属：株式会社ウィルゲート 登壇： 寄稿： おかしょい／岡田 正平 X: @okashoi GitHub: @okashoi
3. 本トークは登壇者の調査、考察にもとづく私見です ※参考となる情報源等があれば教えていただけると幸いです🙏 おことわり
4. config(configuration)
5. ※他の FW や他の言語でも適用できるお話です config ファイル：Laravel の例
6. 「定数を何でも突っ込む場所」 になってないだろうか？
7. 例：特定の概念の表示にまつわる定数や文言 <?php return [ /** * 過去の更新履歴最大表示月 */ 'max_past_display_months' => 3, /** * 社内権限名 */ 'office_authority_name' => 'ウィルゲート' ];
8. 例：マスタデータの ID と名前の対応 <?php return [ 'account_type' => [ 'saving' => [ 'id' => 1, 'name' => '普通', ], 'checking' => [ 'id' => 2, 'name' => '当座', ], ], 'other' => [ 'name' => 'その他', ], ];
9. configuration ≠ constant
10. フレームワークの公式ドキュメントを見ても...... • config の書き方についての説明はある • 一方で「config とは何か（= 何を書くべきか）」 についてはほとんど説明されていない（私調べ） これについて考えてみる config とはいったい何なのか
11. 英単語 configuration の語義 https://eow.alc.co.jp/search?q=configuration&ref=wl
12. 英単語 configuration の語義 https://eow.alc.co.jp/search?q=configuration&ref=wl
13. 英単語 configuration の語義 https://dictionary.cambridge.org/ja/dictionary/english/configuration
14. 英単語 configuration の語義 https://dictionary.cambridge.org/ja/dictionary/english/configuration
15. 英単語 configuration の語義 https://dictionary.cambridge.org/ja/dictionary/english/configuration
16. • システムの構成に関わる情報をハードコードしないための仕組み • ミドルウェアの種類とか接続情報とか • アプリケーションとその外界との境界、つながりを記述する • 環境変数と組み合わせるなどして、環境ごとにカスタマイズできる • テスト環境／ステージング環境／本番環境 • 開発者ごとの開発環境 config（configuration）ファイルの役割
17. • システムの構成に関わる情報をハードコードしないための仕組み • ミドルウェアの種類とか接続情報とか • アプリケーションとその外界との境界、つながりを記述する • 環境変数と組み合わせるなどして、環境ごとにカスタマイズできる • テスト環境／ステージング環境／本番環境 • 開発者ごとの開発環境 config（configuration）ファイルの役割
18. アプリケーション （コード）
19. RDB アプリケーション （コード） SMTP サーバー 暗号鍵 メッセージキュー KVS タイムゾーン
20. RDB アプリケーション （コード） SMTP サーバー 暗号鍵 メッセージキュー KVS タイムゾーン 動作環境に依らず不変なもの
21. RDB アプリケーション （コード） KVS SMTP サーバー タイムゾーン 暗号鍵 メッセージキュー 動作環境毎に異なるもの（外界）
22. RDB アプリケーション （コード） SMTP サーバー 暗号鍵 メッセージキュー KVS タイムゾーン config によって外界の情報を与えることで 特定の環境でのシステム全体を動作させられる
23. じゃあ （冒頭のコードのような） 定数はどこに定義すべきか？
24. • マジックナンバーを避けて値の意図を明らかにする • 一箇所の変更で済むようにする（DRY 原則） →「名前づけ」と「共通化」（関数定義などと同じ） 定数（constant）を使う動機とは
25. ロジックと同じで「凝集性」がポイント ↓ 関連するクラス、モジュール等に定数として定義しよう じゃあ定数はどこに定義すべきか？
26. じゃあ定数はどこに定義すべきか？ <?php return [ /** * 過去の更新履歴最大表示月 */ 'max_past_display_months' => 3, /** * 社内権限名 */ 'office_authority_name' => 'ウィルゲート' ]; before
27. じゃあ定数はどこに定義すべきか？ 表示に関する責務であれば Controller あたり あるいは View とか ViewModel みたいなものがあればそこに <?php namespace App\Http\Controllers; class ActivityController extends Controller { private const MAX_PAST_DISPLAY_MONTH = 3; private const OFFICE_AUTHORITY_NAME = 'ウィルゲート'; // 略 } after
28. じゃあ定数はどこに定義すべきか？ <?php return [ 'account_type' => [ 'saving' => [ 'id' => 1, 'name' => '普通', ], 'checking' => [ 'id' => 2, 'name' => '当座', ], ], 'other' => [ 'name' => 'その他', ], ]; before
29. じゃあ定数はどこに定義すべきか？ <?php class Bank { private const ACCOUNT_TYPE_SAVING = [ 'id' => 1, 'name' => '普通', ]; private const ACCOUNT_TYPE_CHECKING = [ 'id' => 2, 'name' => '当座', ]; // 略 } Bank モデルが定義されているならそのクラス定数に → Bank に関する知識をちゃんとモデルに閉じ込めてあげる after - 1
30. じゃあ定数はどこに定義すべきか？ Enum のようなものを使うという手も （PHP の場合は 8.1〜） <?php enum BankAccountType: int { case Saving = 1; case Checking = 2; public function name(): string { return match($this) { BankAccountType::Saving => '普通', BankAccountType::Checking => '当座', }; } } after - 2
31. • configuration ≠ constants • 「構成」と「共通化」を区別しよう • もし定数にあてはまるものを書くときは 凝集度を意識して、クラス定数や Enum を活用しよう まとめ