Drupal 9调用外部API：GuzzleHttp代码位置及最优方案咨询

一、Guzzle代码的合适放置位置 #

Drupal 9已内置GuzzleHttp，无需额外安装，直接通过Drupal服务容器获取客户端实例即可。以下是几种常见的代码存放场景：

1. 自定义模块的服务类（推荐） #

将API调用逻辑封装为独立服务，便于复用、测试和维护：

• 在自定义模块的services.yml中定义服务：

services:
  my_module.api_client:
    class: Drupal\my_module\Service\ApiClient
    arguments: ['@http_client']

• 创建src/Service/ApiClient.php实现服务：

<?php

namespace Drupal\my_module\Service;

use GuzzleHttp\ClientInterface;

class ApiClient {
  protected $httpClient;

  public function __construct(ClientInterface $http_client) {
    $this->httpClient = $http_client;
  }

  public function fetchExternalData($api_url) {
    try {
      $response = $this->httpClient->request('GET', $api_url);
      return json_decode($response->getBody()->getContents(), TRUE);
    }
    catch (\Exception $e) {
      \Drupal::logger('my_module')->error('API请求失败: @message', ['@message' => $e->getMessage()]);
      return NULL;
    }
  }
}

• 在需要调用的场景（如控制器、钩子）中注入该服务即可使用。

2. 自定义控制器 #

若仅需在特定页面展示API数据，可直接写在控制器内：

<?php

namespace Drupal\my_module\Controller;

use Drupal\Core\Controller\ControllerBase;
use GuzzleHttp\ClientInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

class ApiDataController extends ControllerBase {
  protected $httpClient;

  public function __construct(ClientInterface $http_client) {
    $this->httpClient = $http_client;
  }

  public static function create(ContainerInterface $container) {
    return new static($container->get('http_client'));
  }

  public function content() {
    $response = $this->httpClient->request('GET', 'https://api.example.com/data');
    $data = json_decode($response->getBody()->getContents(), TRUE);
    return [
      '#markup' => '<pre>' . print_r($data, TRUE) . '</pre>',
    ];
  }
}

3. 钩子函数（适合简单一次性调用） #

简单的定时拉取等场景，可放在模块的钩子中，比如hook_cron()：

function my_module_cron() {
  $client = \Drupal::httpClient();
  try {
    $response = $client->request('GET', 'https://api.example.com/updates');
    // 处理返回数据（如存储到数据库）
  }
  catch (\Exception $e) {
    \Drupal::logger('my_module')->error('Cron API请求失败: @message', ['@message' => $e->getMessage()]);
  }
}

4. 队列插件（异步处理耗时请求） #

如果API调用耗时较长，建议放到队列中异步执行，避免阻塞请求：
创建src/Plugin/QueueWorker/ApiFetchWorker.php：

<?php

namespace Drupal\my_module\Plugin\QueueWorker;

use Drupal\Core\Queue\QueueWorkerBase;
use GuzzleHttp\ClientInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * 异步拉取API数据的队列工作者.
 *
 * @QueueWorker(
 *   id = "api_fetch_worker",
 *   title = @Translation("API数据拉取"),
 *   cron = {"time" = 60}
 * )
 */
class ApiFetchWorker extends QueueWorkerBase {
  protected $httpClient;

  public function __construct(array $configuration, $plugin_id, $plugin_definition, ClientInterface $http_client) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->httpClient = $http_client;
  }

  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static(
      $configuration,
      $plugin_id,
      $plugin_definition,
      $container->get('http_client')
    );
  }

  public function processItem($data) {
    try {
      $response = $this->httpClient->request('GET', $data['api_url']);
      // 处理并存储数据
    }
    catch (\Exception $e) {
      \Drupal::logger('my_module')->error('队列API请求失败: @message', ['@message' => $e->getMessage()]);
    }
  }
}

二、更优解决方案 #

1. 优先使用Drupal的http_client服务 #

不要手动实例化Guzzle客户端，Drupal的http_client已配置默认超时、代理等参数，且支持依赖注入，符合Drupal编码规范。

2. Feeds模块批量同步数据 #

若需定期将外部API数据同步到Drupal实体（如节点、用户），Feeds模块是更高效的选择。它支持自定义数据源插件，自带调度、增量更新功能，无需自行编写复杂同步逻辑。

3. REST模块客户端功能 #

Drupal的REST模块提供REST客户端能力，可通过配置方式调用外部API，结合rest_resource插件，能快速实现API数据的获取与处理，适合无需复杂自定义逻辑的场景。

4. 添加缓存策略 #

针对不频繁更新的API数据，添加缓存避免重复调用：

use Drupal\Core\Cache\CacheBackendInterface;

// 在服务中注入缓存后端
public function __construct(ClientInterface $http_client, CacheBackendInterface $cache_backend) {
  $this->httpClient = $http_client;
  $this->cacheBackend = $cache_backend;
}

public function fetchExternalData($api_url) {
  $cache_id = 'my_module_api_data:' . md5($api_url);
  if ($cache = $this->cacheBackend->get($cache_id)) {
    return $cache->data;
  }

  $response = $this->httpClient->request('GET', $api_url);
  $data = json_decode($response->getBody()->getContents(), TRUE);
  
  // 缓存1小时
  $this->cacheBackend->set($cache_id, $data, time() + 3600);
  return $data;
}

5. 完善异常处理与日志 #

所有API调用必须包含异常捕获，记录请求URL、错误码、错误信息等详细日志，便于排查问题。

内容的提问来源于stack exchange，提问作者chakavak