0Pricing
PHP Academy · 课时

构建简单的 API 客户端

将 cURL 调用封装到可复用的 PHP API 客户端类中。

构建简单的 API 客户端 是 CoddyKit 上的免费 PHP Academy 课时。 这是第 4 节课，共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 PHP Academy 学习路径的一部分，你的进度在网页和 CoddyKit 应用中同步。 PHP Academy 课程共包含 4 节课。

为什么要封装 cURL

专用的应用程序接口客户端类可以集中处理身份验证、基础 URL、错误处理和日志记录，从而避免在整个代码库中重复编写样板代码。

客户端类骨架

一个包含基础 URL 和身份验证令牌的最小应用程序接口客户端。

<?php
class ApiClient {
    public function __construct(
        private string $baseUrl,
        private string $token
    ) {}

    private function request(string $method, string $path, array $data = []): array {
        $ch = curl_init($this->baseUrl.$path);
        curl_setopt_array($ch, [
            CURLOPT_RETURNTRANSFER => true,
            CURLOPT_CUSTOMREQUEST  => $method,
            CURLOPT_HTTPHEADER     => [
                "Authorization: Bearer ".$this->token,
                "Content-Type: application/json",
                "Accept: application/json",
            ],
        ]);
        if (!empty($data)) {
            curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
        }
        $body   = curl_exec($ch);
        $status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
        curl_close($ch);
        if ($status >= 400) throw new RuntimeException("API error $status: $body");
        return json_decode($body, true, 512, JSON_THROW_ON_ERROR);
    }
}

GET 和 POST 方法

请公开便捷方法，让它们委托给私有的 request() 方法。

<?php
public function get(string $path): array {
    return $this->request("GET", $path);
}

public function post(string $path, array $body): array {
    return $this->request("POST", $path, $body);
}

使用客户端

请实例化客户端并调用带类型的方法，而不是直接使用 cURL。

<?php
$client = new ApiClient("https://api.example.com", $apiToken);
$users  = $client->get("/v1/users");
$user   = $client->post("/v1/users", ["name" => "Alice", "email" => "alice@example.com"]);

查询字符串参数

请使用 http_build_query() 构建查询字符串。

<?php
public function get(string $path, array $params = []): array {
    $qs = $params ? "?".http_build_query($params) : "";
    return $this->request("GET", $path.$qs);
}
// Usage:
$users = $client->get("/v1/users", ["page" => 1, "limit" => 20]);

分页辅助工具

请添加一个辅助工具，自动收集分页应用程序接口的所有页面。

<?php
public function paginate(string $path): array {
    $all  = [];
    $page = 1;
    do {
        $res  = $this->get($path, ["page" => $page++]);
        $all  = array_merge($all, $res["data"]);
    } while ($res["has_more"] ?? false);
    return $all;
}

缓存响应

请注入缓存层，以避免重复请求。

<?php
public function getCached(string $path, int $ttl = 60): array {
    $key = "api:".md5($path);
    if (apcu_exists($key)) return apcu_fetch($key);
    $data = $this->get($path);
    apcu_store($key, $data, $ttl);
    return $data;
}

日志记录

请添加 PSR-3 日志记录器，记录每个请求和响应，以便调试。

<?php
public function __construct(
    private string $baseUrl,
    private string $token,
    private ?\Psr\Log\LoggerInterface $logger = null
) {}

测试客户端

在单元测试中，请使用模拟 HTTP 处理器（例如 Guzzle MockHandler）替代 cURL，这样测试就不需要进行真实的网络调用。

Guzzle 作为替代方案

在生产环境中，可以考虑使用 Guzzle（composer require guzzlehttp/guzzle）。它提供中间件、异步请求和完善的应用程序接口。

HTTP_FOUNDATION 选项

Symfony HttpClient（symfony/http-client）是另一个优秀的替代方案，具有简洁的接口和一流的异步支持。

总结

将 cURL 封装到类中可以减少重复，集中处理错误，并使测试更容易。请通过带类型的方法（get、post）提供功能，而不是直接使用原始 HTTP 动词。

快速检查

哪个 PHP 函数可以构建 URL 查询字符串？

常见问题解答

「构建简单的 API 客户端」课时是免费的吗？

是的 — 「构建简单的 API 客户端」的完整文本可在网页上免费阅读。要进行交互式练习（内置代码编辑器和全天候 AI 导师）并解锁 PHP Academy 课程的其余内容，请升级到 CoddyKit PRO。 PHP Academy 课程共包含 4 节课。

「构建简单的 API 客户端」这节课中我会学到什么？

将 cURL 调用封装到可复用的 PHP API 客户端类中。 你通过在浏览器中直接运行的动手代码来练习 PHP Academy，全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 PHP Academy 需要有经验吗？

无需任何先前经验。CoddyKit 上的 PHP Academy 课程适合初学者到高级学习者，你可以从这里开始或从头开始，按照自己的节奏学习。 这是第 4 节课，共 4 节。

「构建简单的 API 客户端」课时需要多长时间？

大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动，所以你能稳步进步，并在网页和应用中从离开的地方继续。

我能在这节 PHP Academy 课中编写并运行代码吗？

能。每节 PHP Academy 课都包含内置代码编辑器，你可以在浏览器中直接编写并运行真实代码，并获得即时 AI 反馈 — 无需本地设置。

此课程中的所有课时

  1. JSON 编码与解码
  2. 使用 cURL 发起 HTTP 请求
  3. 处理 API 响应与错误
  4. 构建简单的 API 客户端
← 返回 PHP Academy