phpdoc 支持通过 `@template` 和 `class-string
在 PHP 中,原生不支持函数级泛型(如 function create
/** * 创建指定类的实例 * @template T of object * @param class-string$class 类的完整限定名(如 'App\Models\User') * @return T 实例化后的对象,类型精确到传入的类 */ public function create(string $class): object { return new $class(); }
? class-string 是 PHPStan/PSALM 定义的标准类型,表示“一个字符串字面量,其值是类 T 的类名”。配合 @template T of object,即可建立参数字符串 → 返回对象类型的双向绑定。
$repo = $factory->create('App\Repositories\UserRepository');
// IDE 此时将识别 $repo 为
UserRepository 类型,
// 支持 method() 补全、属性跳转、类型检查等完整智能提示。IDE 支持现状:
不要使用 @return object:
这种写法不符合任何主流标准(PHPDoc RFC、PSALM、PHPStan),IDE 将忽略或报错,且无法建立类型关联。
类型安全性保障:
单靠 PHPDoc 无法阻止传入非法类名(如 'NonExistentClass')。建议在运行时补充校验:
if (!class_exists($class)) {
throw new InvalidArgumentException("Class {$class} does not exist");
}| 场景 | 推荐方案 |
|---|---|
| 需要 IDE 智能提示 | 使用 @template T of object + class-string |
| 兼容 PHPStan / Psalm | 同上,二者均原生支持 |
| 最小侵入式升级 | 无需修改函数签名(仍可返回 object),仅增强注解 |
| 避免误用 | 禁用 @return object<...>、@return $class 等非标准写法 |
通过合理使用模板注解,你可以在不引入复杂依赖(如 PHP Generics RFC)的前提下,显著提升工厂类、容器、ORM 构建器等场景的开发体验与代码健壮性。