在开发过程中,常常需要在 php 和 typescript 之间共享数据结构,确保类型安全却又不想重复编写代码,这一直是个挑战。最近,我在处理一个项目时遇到了这个问题:需要在 php 中定义的数据结构能够自动生成对应的 typescript 类型定义。经过一番探索,我找到了 spatie/laravel-typescript-transformer 这个库,它完美地解决了我的问题。
spatie/laravel-typescript-transformer 是一个 Laravel 包,它可以将 PHP 中的类和枚举自动转换为 TypeScript 类型定义。这意味着你可以在 PHP 中定义数据结构,只需添加一个简单的注释,就能自动生成对应的 TypeScript 类型定义,从而在两个语言之间实现类型安全。
使用这个库非常简单,只需通过 composer 安装:
composer require spatie/laravel-typescript-transformer
接下来,在你的 PHP 类或枚举上添加 @typescript 注释,例如:
/** @typescript **/ class Languages extends Enum { const TYPESCRIPT = 'typescript'; const PHP = 'php'; }
这个 PHP 枚举将自动生成以下 TypeScript 类型定义:
立即学习“PHP免费学习笔记(深入)”;
export type Languages = 'typescript' | 'php';
对于类也是如此:
/** @typescript */ class User { public int $id; public string $name; public ?string $address; }
将生成:
export type User = { id: number; name: string; address: string | null; }
这个库不仅节省了大量重复的工作,还确保了类型定义的一致性和准确性,大大提升了开发效率和代码质量。如果你也面临着在 PHP 和 TypeScript 之间共享数据结构的问题,spatie/laravel-typescript-transformer 绝对是一个值得尝试的解决方案。
© 版权声明
文章版权归作者所有,未经允许请勿转载。
THE END
喜欢就支持一下吧