Laravel 新代码分析生态 — surveyor / ranger / roster

composer require laravel/surveyor

use Laravel\Surveyor\Analyzer\Analyzer;

$analyzer = app(Analyzer::class);

// 按文件路径分析
$result = $analyzer->analyze('/path/to/your/File.php');

// 访问已分析的 scope
$scope = $result->analyzed();

// 访问类分析结果
$classResult = $result->result();

$result = $analyzer->analyzeClass(\App\Models\User::class);
$classResult = $result->result();

$classResult = $analyzer->analyzeClass(App\Models\User::class)->result();

// 类信息
$name = $classResult->name();            // 'App\Models\User'
$namespace = $classResult->namespace();  // 'App\Models'
$filePath = $classResult->filePath();

// 继承关系
$extends = $classResult->extends();
$implements = $classResult->implements();

// 方法信息
$method = $classResult->getMethod('store');
$returnType = $method->returnType();
$parameters = $method->parameters();
$rules = $method->validationRules(); // 也能取到验证规则

// 属性信息
$property = $classResult->getProperty('email');
$type = $property->type;
$visibility = $property->visibility; // 'public'、'protected'、'private'

// 公开的方法和属性列表
$publicMethods = $classResult->publicMethods();
$publicProperties = $classResult->publicProperties();

use Laravel\Surveyor\Types\Type;

// 各种类型的构造
$stringType = Type::string();
$intType = Type::int();
$boolType = Type::bool();
$nullType = Type::null();

// 联合类型(string|null 等)
$unionType = Type::union(Type::string(), Type::null());

// 类型判定
use Laravel\Surveyor\Types\StringType;

if (Type::is($returnType, StringType::class)) {
    // 字符串类型的处理
}

use Laravel\Surveyor\Analyzer\AnalyzedCache;

// 启用磁盘缓存
AnalyzedCache::enableDiskCache(storage_path('surveyor-cache'));

// 清理缓存
AnalyzedCache::clear();

SURVEYOR_CACHE_ENABLED=true
SURVEYOR_CACHE_DIR=/path/to/cache

$result = $analyzer->analyzeClass(App\Models\User::class)->result();

// 自动检测数据库属性
$emailProperty = $result->getProperty('email');

// 判定是否为关联方法
$method = $result->getMethod('posts');
if ($method->isModelRelation()) {
    // 这是一个关联方法
}

composer require laravel/ranger

use Laravel\Ranger\Ranger;
use Laravel\Ranger\Components;
use Illuminate\Support\Collection;

$ranger = app(Ranger::class);

// 每发现一条路由都会被调用
$ranger->onRoute(function (Components\Route $route) {
    echo $route->uri();
});

// 每发现一个模型都会被调用
$ranger->onModel(function (Components\Model $model) {
    foreach ($model->getAttributes() as $name => $type) {
        // 处理属性名和类型
    }
});

// 每发现一个 Enum 都会被调用
$ranger->onEnum(function (Components\Enum $enum) {
    //
});

// 每发现一个广播事件都会被调用
$ranger->onBroadcastEvent(function (Components\BroadcastEvent $event) {
    //
});

// 所有路由收集完成后会被调用一次
$ranger->onRoutes(function (Collection $routes) {
    //
});

// 所有模型收集完成后会被调用一次
$ranger->onModels(function (Collection $models) {
    //
});

// 遍历整个应用并触发回调
$ranger->walk();

composer require laravel/roster --dev

use Laravel\Roster\Roster;
use Laravel\Roster\Packages;

// 扫描目录得到 Roster
$roster = Roster::scan($directory);

// 已安装包列表
$roster->packages();

// 只看生产依赖
$roster->packages()->production();

// 只看开发依赖
$roster->packages()->dev();

// 判断是否存在指定包
$roster->uses(Packages::INERTIA);        // bool
$roster->uses(Packages::LIVEWIRE);       // bool

// 带版本条件判断
$roster->usesVersion(Packages::INERTIA, '2.0.0', '>=');   // Inertia 是否 >= 2.0.0?
$roster->usesVersion(Packages::LIVEWIRE, '3.0.0', '>=');  // Livewire 是否 >= 3.0.0?

// JavaScript 包管理器检测
$packageManager = $roster->nodePackageManager(); // 'npm'、'yarn'、'bun' 等

use Laravel\Roster\Roster;
use Laravel\Roster\Packages;

$roster = Roster::scan(base_path());

if ($roster->uses(Packages::INERTIA)) {
    // 面向 Inertia 的处理
    if ($roster->usesVersion(Packages::INERTIA, '2.0.0', '>=')) {
        // 面向 Inertia v2 及以上的处理
    }
}

if ($roster->uses(Packages::LIVEWIRE)) {
    // 面向 Livewire 的处理
}

// 根据 JavaScript 包管理器切换安装命令
$pm = $roster->nodePackageManager();
echo "Run: {$pm} install your-package";

use Laravel\Ranger\Ranger;
use Laravel\Ranger\Components;

$ranger = app(Ranger::class);
$docs = [];

$ranger->onRoute(function (Components\Route $route) use (&$docs) {
    $docs['routes'][] = [
        'uri' => $route->uri(),
        // 也可以获取路由的验证规则、响应类型等
    ];
});

$ranger->onModel(function (Components\Model $model) use (&$docs) {
    $docs['models'][] = [
        'attributes' => $model->getAttributes(),
    ];
});

$ranger->walk();

// $docs 中收集了整个应用的结构信息