v13.37.0 の実装を確認しています。基本操作はファイルストレージ、プロバイダーの読み込みはパッケージの自動検出を参照してください。
ドライバー名とディスク名を分ける
Storage::extend() の第1引数はドライバー名です。一方、Storage::disk() の引数は filesystems.disks に定義するディスク名です。同じドライバーを使うディスクを複数定義できます。
FilesystemManager::resolve() は、設定の driver に対応するカスタム生成処理を探し、あれば組み込みドライバーより先に呼び出します。local や s3 を拡張名に使うと既存の生成処理を置き換えるため、パッケージ固有の名前を選びます。
プロバイダーでは生成方法だけを登録する
次は登録経路を理解するため、Laravel標準のローカルドライバー生成処理を再利用する最小例です。ローカル保存だけが目的なら通常のlocal で十分です。独自バックエンドを提供する場合は、公式ドキュメントの例のようにFlysystemアダプターを構築し、Laravelの FilesystemAdapter で包む処理へ置き換えます。
runningInConsole() では登録を制限しません。また、拡張の登録だけを担当するプロバイダーは遅延プロバイダーにしません。
コールバックにはアプリケーションと解決対象のディスク設定全体が渡されます。設定の検証やクライアントの生成はこの中で行い、boot() ではファイル操作をしません。例の createLocalDriver() は生成時にディレクトリを作ることがあるため、登録時と生成時を分けることが重要です。
利用者は config/filesystems.php の disks 配列に設定を追加します。
この例はローカル保存の生成経路だけを示します。
serve によるファイル配信や一時URLの提供は対象外です。独自アダプターでURL生成、可視性、読み取り専用などをサポートする場合も、それぞれの実装と必要な依存パッケージを確認し、設定キーを渡すだけで有効になると判断しないでください。名前付きディスクは生成後に保持される
disk('reports') は毎回コールバックを呼びません。Managerの get() が、内部の $disks 配列にある生成済みインスタンスを優先します。未生成の場合だけ resolve() を通り、生成結果がディスク名をキーとして保持されます。
したがって、同じプロセスで以下を行っても生成済みディスクは自動更新されません。
config()でfilesystems.disks.reportsを変更する。- 同じドライバー名に対して
Storage::extend()をもう一度呼ぶ。
FilesystemServiceProvider はManager自体もsingletonとして登録します。長時間動くプロセスでは、リクエストやジョブごとにディスクが必ず作り直されると仮定しないでください。
設定変更後は必要なディスクだけ再解決する
同一プロセスで設定を変更して検証する場合は、設定の更新と、保持されたディスクの除去を分けます。forgetDisk() は指定名をManagerの保持配列から取り除きます。次の disk() で現在の設定を読み直します。確認したバージョンの purge() も指定名を取り除く実装で、独自バックエンドの接続終了メソッドを呼ぶわけではありません。
本番の設定変更やパッケージ更新では、通常のデプロイに沿って設定キャッシュを再作成し、長時間動くワーカーも再起動します。設定キャッシュと、このプロセス内のディスク保持配列は別物です。
一時的な設定にはbuildを使う
名前付きの共有設定を変更したくない場合は、オンデマンドディスクを使えます。build() は指定設定で直接 resolve() を呼び、結果を名前付きディスクの保持配列へ追加しません。カスタムドライバーの登録は必要ですが、呼び出すたびに生成処理へ進みます。動的な保存先を使う場合も、保存先や接続先を利用者の入力から無制限に選べる設計にはしません。
fakeとは別に生成経路をテストする
Storage::fake('reports') は、Managerの set() でそのディスクをテスト用のローカルディスクに置き換えます。アプリケーションのファイル操作テストには便利ですが、パッケージのカスタム生成処理が正しく登録・実行されることは検証しません。
パッケージのテスト環境で ArchiveServiceProvider を読み込んだうえで、以下を分けて検証します。
独自の外部バックエンドでは、ネットワークを使わない生成テストと、明示的に準備した検証環境での接続テストを分けます。fakeの成功を実サービスとの互換性の証拠にはしません。
長期保守のチェックリスト
- ドライバー名、設定キー、戻り値のAPI、例外や
throwの扱いを公開仕様として文書化する。 - 標準ドライバーや他パッケージと衝突しない拡張名を使う。
- プロバイダーの起動だけでディスクを解決・使用しない。
- 設定変更時は設定キャッシュ、Managerの保持配列、利用側の参照、別プロセスを区別する。
- Laravelの対応バージョンごとに、生成・再解決・実際のファイル操作を継続して検証する。