在开发 rest api 时，实现 hateoas 是一个常见但复杂的任务。hateoas 通过在 api 响应中添加超媒体链接，帮助客户端发现资源和操作，从而提高 api 的可发现性和用户体验。然而，在实际开发中，如何动态生成这些链接和嵌入资源，常常成为一个难题。
最近，我在开发一个用户管理系统的 API 时，遇到了这个问题。我希望在返回用户数据时，能够自动生成指向用户详细信息、相关资源（如用户的管理者）的链接，以及嵌入用户的相关数据（如用户的帖子列表）。手动编写这些逻辑不仅繁琐，而且容易出错。
在尝试了多种方法后，我发现了 willdurand/hateoas 库。这个库通过 Composer 可以轻松安装，并且提供了丰富的功能来简化 HATEOAS 的实现。让我们看看如何使用它来解决这个问题。
首先，通过 Composer 安装 willdurand/hateoas 库：
composer require willdurand/hateoas
安装完成后，我们可以开始配置和使用这个库。假设我们有一个 User 类，我们希望在其 API 响应中添加 self 链接和嵌入用户的管理者信息。我们可以使用注解（Annotations）或属性（Attributes，PHP 8.1 及以上版本）来配置这些关系。
对于 PHP 8.1 及以上版本，我们可以使用属性来配置：
use JMS\Serializer\Annotation as Serializer;
use Hateoas\Configuration\Annotation as Hateoas;
#[Serializer\XmlRoot('user')]
#[Hateoas\Relation('self', href: "expr('/api/users/' ~ object.getId())")]
#[Hateoas\Relation(
'manager',
href: "expr('/api/users/' ~ object.getManager().getId())",
embedded: "expr(object.getManager())",
exclusion: new Hateoas\Exclusion(excludeIf: "expr(object.getManager() === null)")
)]
class User
{
#[Serializer\XmlAttribute]
private $id;
private $firstName;
private $lastName;
private $manager;
public function getId() {}
public function getManager() {}
}通过这种配置，Hateoas 库会在序列化 User 对象时自动生成 self 链接和嵌入管理者信息。使用 HateoasBuilder 可以轻松构建和序列化这些对象：
use Hateoas\HateoasBuilder; $hateoas = HateoasBuilder::create()->build(); $user = new User(42, 'Adrien', 'Brault', new User(23, 'Will', 'Durand')); $json = $hateoas->serialize($user, 'json');
这样，我们就得到了一个包含 HATEOAS 链接和嵌入资源的 JSON 响应：
{
"id": 42,
"first_name": "Adrien",
"last_name": "Brault",
"_links": {
"self": {
"href": "/api/users/42"
},
"manager": {
"href": "/api/users/23"
}
},
"_embedded": {
"manager": {
"id": 23,
"first_name": "Will",
"last_name": "Durand",
"_links": {
"self": {
"href": "/api/users/23"
}
}
}
}
}使用 willdurand/hateoas 库带来的优势显而易见：
- 简化配置：通过注解或属性，我们可以轻松配置链接和嵌入资源，无需手动编写复杂的逻辑。
- 提高可维护性：配置集中在模型类中，易于管理和修改。
- 支持多种格式：Hateoas 支持 JSON 和 XML 格式，并且可以轻松扩展到其他格式。
- 动态生成：利用表达式语言，可以根据对象的状态动态生成链接和嵌入资源。
在实际应用中，使用 willdurand/hateoas 库大大简化了我的 API 开发过程。API 响应变得更加丰富和易于使用，客户端可以更容易地发现和操作资源。通过 Composer 安装和使用这个库，不仅解决了 HATEOAS 实现的复杂性问题，还提升了整个项目的开发效率和代码质量。
