Scramble项目中的JsonResource Schema解析问题分析与解决方案

问题背景

在使用Laravel Octane配合FrankenPHP部署应用时，开发者发现了一个关于API文档生成的异常现象：当应用通过php artisan serve运行时，JsonResource的Schema能够正常显示；但切换到Octane/FrankenPHP环境后，Schema却无法正确解析。

问题现象

具体表现为：

1. 在普通PHP服务环境下，API文档能正确显示UserResource中定义的name和email字段
2. 在Octane/FrankenPHP环境下，生成的api.json中schemas部分为空，仅显示基本类型信息而丢失了具体字段定义

技术分析

经过深入排查，发现问题根源在于Scramble的索引机制实现方式。Scramble在解析JsonResource时依赖Dedoc\Scramble\Infer\Scope\Index类来维护类定义信息，而该类的实例在Octane环境下未能正确保持状态。

关键发现点：

1. 索引类(Index)在解析过程中负责存储类定义和方法信息
2. 在Octane的持久化应用模式下，索引实例未能正确共享导致每次请求都重新初始化
3. 这导致之前解析的类定义信息丢失，最终表现为Schema解析不完整

解决方案

通过修改ScrambleServiceProvider中的绑定方式，将Index类以共享模式(singleton)绑定，确保在应用生命周期内保持唯一实例：

$this->app->singleton(Index::class);

或者使用bind方法的shared参数：

$this->app->bind(Index::class, shared: true);

这种修改确保了：

1. 在Octane的持久化环境下索引状态得以保持
2. 类定义信息不会在请求间丢失
3. Schema解析能够正常工作

临时解决方案

在官方修复前，开发者可以采用导出API文档的方式作为临时解决方案：

Route::get('docs/api.json', function (Dedoc\Scramble\Generator $generator) {
    return File::exists($doc = base_path(config('scramble.export_path')))
        ? File::json($doc)
        : $generator();
})->name('scramble.docs.index');

技术启示

这个问题揭示了在持久化应用环境下需要考虑的几个重要方面：

1. 状态保持：长期运行的应用需要特别注意单例和共享状态的管理
2. 依赖注入：服务绑定方式会显著影响在特殊环境下的行为
3. 环境兼容性：开发工具需要针对不同运行环境进行充分测试

该问题已在Scramble的v0.10.7版本中得到修复，建议用户升级到最新版本以获得最佳体验。