PHP中使用cURL的方法-php教程-PHP中文網

PHP中使用cURL的方法

今天，我們將探討 PHP 中的 cURL 擴展，它允許您從程式碼發出 HTTP 請求。

在日常 PHP 開發中，您經常需要與外部網站進行通訊。無論是呼叫第三方 REST API 取得資料還是從外部網站下載資源，您都需要一個可以輕鬆完成的程式庫。

在 PHP 中，您可以使用不同的方法來連接不同類型的伺服器並進行通訊。最簡單的方法之一是使用 file_get_contents 函數讀取遠端檔案。另一方面，也可以使用套接字來實現客戶端與伺服器的通訊。不過，在本文中，我們將透過實際範例詳細討論 cURL 擴充。

cURL 代表客戶端 URL，它是一個允許您使用 URL 語法發送和接收訊息的程式庫。事實上，它利用了 Daniel Stenberg 創建的 libcurl 庫，該庫允許您使用許多不同類型的協定連接到許多不同類型的伺服器並與之通訊。除了 HTTP 和 HTTPS 之外，libcurl 函式庫還支援 FTP、Gopher、Telnet、DICT、File 和 LDAP 等協定。

從下一節開始，我們將透過幾個實際範例來示範如何在 PHP 中使用 cURL 函數。

現實世界的例子

在本節中，我們將建立真實範例來示範 PHP 中的各種 cURL 函數。

如何在 PHP 中使用 cURL 下載檔案

讀取或下載遠端檔案是 cURL 最常見的用例之一。這是透過 cURL GET 請求完成的，我們將在本節中討論該請求。

繼續建立包含以下內容的 curl_read_file.php 檔案。

<?php
$url = 'https://www.example.com';

$curl = curl_init();

curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HEADER, false);

$data = curl_exec($curl);

curl_close($curl);

登入後複製

在上面的範例中，我們使用 cURL 函數來讀取 example.com 網域的主頁。讓我們透過重要的片段來了解它是如何運作的。

首先，我們使用 curl_init 函數來初始化一個新的 cURL 會話。 $curlHandle 變數保存了一個 cURL 句柄，我們可以藉助 curl_setopt 函數來設定 cURL 傳輸的各種選項。

當您使用 cURL 時，您最常使用的函數是 curl_setopt 函數，因為它允許您初始化各種 CURLOPT_* 請求選項。 curl_setopt 函數採用三個參數：cURL 句柄、CURLOPT_XXX 選項以及 CURLOPT_XXX 選項的值。

接下來，我們使用 CURLOPT_URL 選項透過 curl_setopt 函數將請求 URL 設定為 example.com 。此外，我們將 CURLOPT_RETURNTRANSFER 選項設為 TRUE，因為我們希望將回應初始化到 $responseData 變數中。如果我們不將其設定為 TRUE，則回應將直接顯示在螢幕上。最後，我們將 CURLOPT_HEADER 選項設為 FALSE 以跳過輸出中的標頭資訊。

最後，我們使用 curl_exec 函數來執行 cURL 請求。如果一切順利，$responseData 變數應該包含 example.com 主頁的來源程式碼。

如何在 PHP 中使用 cURL 發布資料

在本節中，我們將了解如何使用 cURL 發布資料。

讓我們建立包含以下內容的 curl_post_example.php 檔案。

<?php
$url = '{POST_REST_ENDPOINT}';

$curl = curl_init();

$fields = array(
    'field_name_1' => 'Value 1',
    'field_name_2' => 'Value 2',
    'field_name_3' => 'Value 3'
);

$fields_string = http_build_query($fields);

curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_POST, TRUE);
curl_setopt($curl, CURLOPT_POSTFIELDS, $fields_string);

$data = curl_exec($curl);

curl_close($curl);

登入後複製

在上面的範例中，我們假設需要使用 HTTP POST 方法提交請求。事實上，它的工作原理與使用 POST 方法提交表單類似。

$fields 變數包含我們需要作為 POST 資料提交的值數組。接下來，我們使用 http_build_query 函數來準備 URL 編碼的查詢字串。

接下來，我們將 CURLOPT_POST 選項設為 TRUE 以將請求方法設定為 HTTP POST。此外，我們需要使用 CURLOPT_POSTFIELDS 選項來設定我們要隨請求一起提交的 POST 資料。

最後，我們使用 curl_exec 函數來執行 cURL 請求。這樣就可以發出cURL POST請求了。

如何在 PHP 中使用 cURL 發布 JSON 資料

通常，您需要在 cURL POST 請求中提交 JSON 資料。在本部分中，我們將了解如何在 cURL 請求中使用 POST 方法提交 JSON 資料。

由於這是一個 POST 請求，我們來修改上一節討論的範例。繼續建立包含以下內容的 curl_post_json.php 檔案。

<?php
$url = '{POST_REST_ENDPOINT}';

$curl = curl_init();

$fields = array(
    'field_name_1' => 'Value 1',
    'field_name_2' => 'Value 2',
    'field_name_3' => 'Value 3'
);

$json_string = json_encode($fields);

curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_POST, TRUE);
curl_setopt($curl, CURLOPT_POSTFIELDS, $json_string);
curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type:application/json'));
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true );

$data = curl_exec($curl);

curl_close($curl);

登入後複製

儘管它看起來與上一節中的範例類似，但重要的是我們使用 json_encode 函數從 $fields 陣列建立 JSON 字串。

接下来，我们使用 CURLOPT_HTTPHEADER 选项将 Content-Type 标头设置为 application/json 以通知 API 服务器我们正在发送 JSON 数据。 Content-Type 标头对于以不同格式发布数据非常有用。例如，如果您想发送 XML 数据，则必须将 Content-Type 标头设置为 application/xml。

除此之外，它与常规 POST 请求几乎相同。所以这样一来，就可以通过设置适当的 Content-Type header 来发布不同类型的数据。如果您不设置 Content-Type 标头，它将使用 application/x-www-form-urlencoded 作为默认值。

如何在 PHP 中使用 cURL 上传文件

在本节中，我们将讨论如何使用 cURL 上传文件。

让我们创建包含以下内容的 curl_post_file.php 文件。

<?php
$url = '{POST_REST_ENDPOINT}';

$curl = curl_init();

if (function_exists('curl_file_create')) {
  $fileAttachment = curl_file_create('/absolute/path/to/file/');
} else {
  $fileAttachment = '@' . realpath('/absolute/path/to/file/');
}

$fields = array(
    'field_name_1' => 'Value 1',
    'field_name_2' => 'Value 2',
    'field_name_3' => 'Value 3',
    'uploaded_file' => $fileAttachment
);

curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_POST, TRUE);
curl_setopt($curl, CURLOPT_POSTFIELDS, $fields);
curl_setopt($curl, CURLOPT_RETURNTRANSFER,1);

$data = curl_exec($curl);

curl_close($curl);

登入後複製

当你要上传文件时，你需要首先创建一个 CURLFile 对象。从 PHP 5.5+ 开始，创建它相当容易，因为您只需要使用 curl_file_create 函数来创建 CURLFile 对象。 curl_file_create 函数的第一个参数是要上传的文件的绝对路径。

如果您仍在使用较旧的 PHP 版本（不推荐），我们已使用后备 '@' 。 realpath('/absolute/path/to/file/') 语法创建文件链接。

最后，我们将 Content-Type 标头设置为 multipart/form-data，因为它将是一个多部分表单 POST 请求。除此之外，这是一个例行的 cURL POST 请求。

到目前为止，我们已经了解了 PHP 中经常使用的几种不同的 cURL 方法。在下一节中，我们将了解如何使用 Guzzle 库，它使您在 PHP 中处理 HTTP 请求时变得更加轻松。

什么是 Guzzle HTTP 客户端？

根据官方文档：

Guzzle 是一个 PHP HTTP 客户端，可以轻松发送 HTTP 请求，并且可以轻松地与 Web 服务集成。

让我们快速了解一下使用 Guzzle 相对于 cURL PHP 函数的优势：

适用于不同类型数据的简单界面
支持同步和异步请求
支持 cURL、套接字和 PHP 流
符合 PSR-7
还有更多

总而言之，当您想使用不同的方法进行 HTTP 调用时，它是最好的库之一。在本节中，我们将讨论如何安装 Guzzle，然后通过几个快速示例来演示该库的强大功能！

如何安装 Guzzle 库

官方文档建议您使用Composer来安装Guzzle。让我们运行以下命令在您的项目中安装 Guzzle。

$composer require guzzlehttp/guzzle:^7.0
./composer.json has been created
Loading composer repositories with package information
Updating dependencies (including require-dev)
Package operations: 6 installs, 0 updates, 0 removals
  - Installing psr/http-message (1.0.1): Loading from cache
  - Installing psr/http-client (1.0.1): Loading from cache
  - Installing ralouphie/getallheaders (3.0.3): Loading from cache
  - Installing guzzlehttp/psr7 (1.7.0): Loading from cache
  - Installing guzzlehttp/promises (1.4.1): Loading from cache
  - Installing guzzlehttp/guzzle (7.2.0): Loading from cache
guzzlehttp/psr7 suggests installing laminas/laminas-httphandlerrunner (Emit PSR-7 responses)
guzzlehttp/guzzle suggests installing psr/log (Required for using the Log middleware)
Writing lock file
Generating autoload files

登入後複製

安装后，您需要使用 Composer 的自动加载器，如以下代码片段所示。

require 'vendor/autoload.php';

登入後複製

这样，您就可以使用 Guzzle 了！

如何使用 Guzzle 发出 GET 请求

在本节中，我们将了解如何使用 Guzzle 发送 GET 请求。

我们将修改之前讨论的示例，因为它将帮助您了解如何将现有的 cURL PHP 代码转换为基于 Guzzle 的实现。

让我们看一下修改后的示例。

<?php
require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();
$response = $client->get('https://example.com');

$responseContents = $response->getBody();

登入後複製

是不是很简单呢？我们创建了 \GuzzleHttp\Client 类的实例，并将其分配给 $client 变量。现在，您可以访问 \GuzzleHttp\Client 类提供的大量实用方法。

在我们的例子中，我们需要使用 GET 方法获取内容，因此我们使用了 \GuzzleHttp\Client 类的 get 方法，它将返回 GuzzleHttp\Psr7\Response 对象。 GuzzleHttp\Psr7\Response 对象提供了各种方法，如 getStatusCode、getBody、getReasonPhrase 等。我们使用 getBody 方法来获取响应正文内容。

这就是您如何使用 Guzzle 执行 HTTP GET 请求。

如何使用 Guzzle 发出 POST 请求

在本节中，我们将了解如何使用 Guzzle 执行 HTTP POST 请求。

我们将修改我们在前面部分中讨论过的 curl_post_example.php 示例。使用 Guzzle 修改后的代码如下所示。

<?php
require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();
$options = [
    'form_params' => [
        "field_name_1" => "Value 1",
        "field_name_2" => "Value 2",
        "field_name_3" => "Value 3",
    ]
];

$response = $client->post("{POST_REST_ENDPOINT}", $options);
$responseContents = $response->getBody();
?>

登入後複製

由于这是一个 POST 请求，因此我们需要传递 $options 数组作为 post 方法的第二个参数。在我们的示例中，它包含我们需要作为 POST 数据提交的表单数据。

如果您想知道如何发送 JSON 数据，只需将 form_params 键更改为 json，数据就会以 JSON 形式发送！

此外，如果您想随请求一起发送任何 HTTP 标头，您可以使用 headers 键来完成，如以下代码片段所示。

...
...
$headers = array(
    'Content-Type'   => 'application/json'
);
$options = [
    'form_params' => [
            "field_name_1" => "Value 1",
            "field_name_2" => "Value 2",
            "field_name_3" => "Value 3",
    ],
    ‘headers’ => $headers
];
...
...

登入後複製

事实上，Guzzle 库为每种方法提供了很多配置选项。此外，做同一件事有多种方法，所以我鼓励您详细探索它，我相信它会很有趣！

这是对 Guzzle 库以及 PHP cURL 函数的快速介绍。