修改Drupal 8用户登录API响应 - Axelerant

Drupal 8 提供了强大的 REST API 功能，允许开发者通过 REST 接口访问站点的端点资源，其中包括用户登录端点的 REST 版本。默认情况下，当用户通过该端点登录时，Drupal 会返回一个标准的响应。然而，在某些场景下，我们可能需要对响应内容进行自定义处理，以满足特定需求。本文将详细介绍如何修改 Drupal 8 用户登录 API 的默认响应。

示例场景

在实际开发中，我们可能需要在用户登录的响应中添加额外的信息。例如，假设我们在用户配置文件中新增了一个字段（如名字或年龄），并希望将这些字段的数据包含在登录 API 的响应中。

默认技术实现

在开始修改响应之前，我们需要了解 Drupal 8 的默认实现逻辑。与其他页面类似，用户登录页面的实现从路由开始。以下是相关的路由文件配置：

• Drupal 的 /user 路由同时支持 HTML 和 REST 格式的登录请求。
• 区分这两种请求的关键在于 URL 中是否包含 ?_format=json 参数。

当请求 URL 包含 ?_format=json 时，系统会调用 REST 控制器来处理登录请求。默认情况下，该控制器会返回一个标准的 JSON 响应。为了实现自定义响应，我们需要对该控制器进行扩展和修改。

扩展控制器

由于 Drupal 8 基于面向对象编程（OOP）范式，我们可以通过扩展核心控制器来实现自定义功能。以下是具体步骤：

1. 创建自定义模块

   使用 Drupal Console 工具生成模块的样板代码。例如，我们可以创建一个名为 rest_login_addons 的模块。

2. 扩展核心控制器

   在模块目录下创建自定义控制器文件，例如 rest_login_addons/src/Controller。在自定义控制器中，我们需要重写登录方法。具体实现如下：

   • 调用父类的登录方法以获取默认响应数据。
   • 使用序列化器服务对响应数据进行反序列化。
   • 根据用户 ID 加载用户实体，并获取自定义字段的数据（如年龄）。
   • 将自定义字段数据添加到响应中，并重新序列化后返回。

   注意：序列化器服务是通过依赖注入的方式包含在核心控制器中的。了解依赖注入的实现方式有助于更好地理解这一过程。

使用事件订阅器修改路由

尽管我们已经完成了自定义控制器的开发，但默认路由仍然指向旧的核心控制器。为了解决这个问题，我们需要通过事件订阅器来替换默认的控制器。以下是具体步骤：

1. 创建服务定义文件

   在模块目录下创建 rest_login_addons.services.yml 文件，并在其中定义服务类。

2. 实现路由订阅器类

   创建一个服务类，并扩展 RouteSubscriberBase 类。在该类中，指定自定义控制器的名称和方法，以替换默认的控制器。

3. 清除缓存

   完成上述步骤后，清除缓存以确保路由系统的更改生效。

完成这些操作后，访问 /user/login?_format=json 时，响应中将包含新增的字段数据。例如，新增的年龄字段值将显示在响应中。

结论

通过结合服务、路由和控制器，我们可以轻松地自定义 Drupal 8 用户登录 API 的响应内容。这种方法不仅可以用来添加字段，还可以用于修改响应消息、状态码等。得益于 Drupal 8 的 OOP 设计，我们能够以更少的代码实现功能扩展，从而提高开发效率。

原文链接: https://www.axelerant.com/blog/modify-response-drupal8-user-login-api-endpoint