您现在访问的是微软AZURE全球版技术文档网站,若需要访问由世纪互联运营的MICROSOFT AZURE中国区技术文档网站,请访问 https://docs.azure.cn.

如何通过 PHP 使用服务总线队列

本文介绍如何创建 PHP 应用程序,用于向/从服务总线队列发送/接收消息。

重要

截至 2021 年 2 月,适用于 PHP 的 Azure SDK 已进入停用阶段,不再受到 Microsoft 的正式支持。 有关详细信息,请参阅 GitHub 上的此公告。 本文将很快停用。

先决条件

  1. Azure 订阅。 若要完成本教程,需要一个 Azure 帐户。 可以激活 MSDN 订户权益注册免费帐户
  2. 如果没有可使用的队列,请遵循使用 Azure 门户创建服务总线队列一文来创建队列。
    1. 阅读服务总线 队列 的快速 概述

    2. 创建一个服务总线 命名空间

    3. 获取 连接字符串

      备注

      在本文中,你将使用 PHP 在服务总线命名空间中创建一个队列。

  3. Azure SDK for PHP

创建 PHP 应用程序

创建访问 Azure Blob 服务的 PHP 应用程序的唯一要求是从代码内引用用于 PHP 的 Azure SDK 中的类。 可以使用任何开发工具或记事本创建应用程序。

备注

PHP 安装还必须已安装并启用 OpenSSL 扩展

在本指南中,将使用服务功能,这些功能可从 PHP 应用程序中本地调用,或通过在 Azure Web 角色、辅助角色或网站中运行的代码调用。

获取 Azure 客户端库

通过 Composer 安装

  1. 在项目的根目录中创建一个名为 composer.json 的文件并向其添加以下代码:

    {
      "require": {
        "microsoft/windowsazure": "*"
      }
    }
    
  2. composer.phar 下载到项目根目录中。

  3. 打开命令提示符并在项目根目录中执行以下命令

    php composer.phar install
    

配置应用程序以使用服务总线

若要使用服务总线队列 API,请执行以下操作:

  1. 使用 require_once 语句引用 autoloader 文件。
  2. 引用所用的任意类。

下面的示例演示了如何包括 autoloader 文件并引用 ServicesBuilder 类。

备注

本示例(以及本文中的其他示例)假定你已通过 Composer 安装了用于 Azure 的 PHP 客户端库。 如果已手动安装这些库或将其作为 PEAR 包安装,则必须引用 WindowsAzure.php autoloader 文件。

require_once 'vendor/autoload.php';
use WindowsAzure\Common\ServicesBuilder;

在以下示例中, require_once 语句将始终显示,但只会引用执行该示例所需的类。

设置服务总线连接

若要实例化服务总线客户端,必须先设置采用以下格式的有效连接字符串:

Endpoint=[yourEndpoint];SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=[Primary Key]

其中,Endpoint 的格式通常为 [yourNamespace].servicebus.windows.net

若要创建任何 Azure 服务客户端,必须使用 ServicesBuilder 类。 方法:

  • 将连接字符串直接传递给它。
  • 使用 CloudConfigurationManager (CCM) 检查多个外部源以获取连接字符串:
    • 默认情况下,它附带了对一个外部源的支持 - 环境变量
    • 可通过扩展 ConnectionStringSource 类来添加新源

在此处列出的示例中,将直接传递连接字符串。

require_once 'vendor/autoload.php';

use WindowsAzure\Common\ServicesBuilder;

$connectionString = "Endpoint=[yourEndpoint];SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=[Primary Key]";

$serviceBusRestProxy = ServicesBuilder::getInstance()->createServiceBusService($connectionString);

创建队列

可以通过 ServiceBusRestProxy 类对服务总线队列执行管理操作。 ServiceBusRestProxy 对象是通过 ServicesBuilder::createServiceBusService 工厂方法构造的,包含一个适当的连接字符串,该字符串封装了令牌权限以对它进行管理。

以下示例演示了如何实例化 ServiceBusRestProxy 并调用 ServiceBusRestProxy->createQueue 以在 MySBNamespace 服务命名空间内创建名为 myqueue 的队列:

require_once 'vendor/autoload.php';

use WindowsAzure\Common\ServicesBuilder;
use WindowsAzure\Common\ServiceException;
use WindowsAzure\ServiceBus\Models\QueueInfo;

// Create Service Bus REST proxy.
$serviceBusRestProxy = ServicesBuilder::getInstance()->createServiceBusService($connectionString);

try    {
    $queueInfo = new QueueInfo("myqueue");

    // Create queue.
    $serviceBusRestProxy->createQueue($queueInfo);
}
catch(ServiceException $e){
    // Handle exception based on error codes and messages.
    // Error codes and messages are here: 
    // https://docs.microsoft.com/rest/api/storageservices/Common-REST-API-Error-Codes
    $code = $e->getCode();
    $error_message = $e->getMessage();
    echo $code.": ".$error_message."<br />";
}

备注

可以对 ServiceBusRestProxy 对象使用 listQueues 方法,以检查具有指定名称的队列是否已位于命名空间中。

向队列发送消息

要将消息发送到服务总线队列,应用程序应调用 ServiceBusRestProxy->sendQueueMessage 方法。 下面的代码演示了如何将消息发送到先前在 MySBNamespace 服务命名空间内创建的 myqueue 队列。

require_once 'vendor/autoload.php';

use WindowsAzure\Common\ServicesBuilder;
use WindowsAzure\Common\ServiceException;
use WindowsAzure\ServiceBus\Models\BrokeredMessage;

// Create Service Bus REST proxy.
$serviceBusRestProxy = ServicesBuilder::getInstance()->createServiceBusService($connectionString);

try    {
    // Create message.
    $message = new BrokeredMessage();
    $message->setBody("my message");

    // Send message.
    $serviceBusRestProxy->sendQueueMessage("myqueue", $message);
}
catch(ServiceException $e){
    // Handle exception based on error codes and messages.
    // Error codes and messages are here: 
    // https://docs.microsoft.com/rest/api/storageservices/Common-REST-API-Error-Codes
    $code = $e->getCode();
    $error_message = $e->getMessage();
    echo $code.": ".$error_message."<br />";
}

发送到服务总线队列(以及从服务总线队列收到)的消息是 BrokeredMessage 类的实例。 BrokeredMessage 对象包含一组标准方法和用来保存特定于应用程序的自定义属性的属性,以及大量的任意应用程序数据。

服务总线队列在标准层中支持的最大消息大小为 256 KB,在高级层中则为 100 MB。 标头最大大小为 64 KB,其中包括标准和自定义应用程序属性。 一个队列中包含的消息数量不受限制,但消息的总大小受限制。 队列大小的上限为 5 GB。

从队列接收消息

从队列接收消息的最佳方法是使用 ServiceBusRestProxy->receiveQueueMessage 方法。 可在两种不同的模式下接收消息:ReceiveAndDeletePeekLockPeekLock 是默认设置。

使用 ReceiveAndDelete 模式时,接收是一项单步操作,即当服务总线接收到队列中某条消息的读取请求时,它会将该消息标记为“已使用”并将其返回给应用程序。 ReceiveAndDelete 模式是最简单的模式,最适合在发生故障时应用程序允许不处理消息的情况。 为了理解这一点,可以考虑这样一种情形:使用方发出接收请求,但在处理该请求前发生了崩溃。 由于服务总线会将消息标记为“已使用”,因此当应用程序重启并重新开始使用消息时,它会遗漏在发生崩溃前使用的消息。

在默认的 PeekLock 模式下,接收消息会变成一个双阶段操作,这将能够支持不能允许丢失消息的应用程序。 当 Service Bus 收到请求时,它会找到要使用的下一个消息,将其锁定以防其他使用方接收它,并将该消息返回给应用程序。 应用程序完成消息处理(或可靠地存储消息以供日后处理)后,它会将收到的消息传递到 ServiceBusRestProxy->deleteMessage,从而完成接收过程的第二阶段。 当服务总线发现 deleteMessage 调用时,它会将消息标记为“已使用”并将其从队列中删除。

以下示例演示了如何使用 PeekLock 模式(默认模式)接收和处理消息。

require_once 'vendor/autoload.php';

use WindowsAzure\Common\ServicesBuilder;
use WindowsAzure\Common\ServiceException;
use WindowsAzure\ServiceBus\Models\ReceiveMessageOptions;

// Create Service Bus REST proxy.
$serviceBusRestProxy = ServicesBuilder::getInstance()->createServiceBusService($connectionString);

try    {
    // Set the receive mode to PeekLock (default is ReceiveAndDelete).
    $options = new ReceiveMessageOptions();
    $options->setPeekLock();

    // Receive message.
    $message = $serviceBusRestProxy->receiveQueueMessage("myqueue", $options);
    echo "Body: ".$message->getBody()."<br />";
    echo "MessageID: ".$message->getMessageId()."<br />";

    /*---------------------------
        Process message here.
    ----------------------------*/

    // Delete message. Not necessary if peek lock is not set.
    echo "Message deleted.<br />";
    $serviceBusRestProxy->deleteMessage($message);
}
catch(ServiceException $e){
    // Handle exception based on error codes and messages.
    // Error codes and messages are here:
    // https://docs.microsoft.com/rest/api/storageservices/Common-REST-API-Error-Codes
    $code = $e->getCode();
    $error_message = $e->getMessage();
    echo $code.": ".$error_message."<br />";
}

如何处理应用程序崩溃和不可读消息

Service Bus 提供了相关功能来帮助你轻松地从应用程序错误或消息处理问题中恢复。 如果接收方应用程序出于某种原因无法处理消息,它可以对收到的消息调用 unlockMessage 方法(而不是 deleteMessage 方法)。 这会导致 Service Bus 解锁队列中的消息并使其能够重新被同一个正在使用的应用程序或其他正在使用的应用程序接收。

还存在与队列中已锁定的消息相关联的超时,并且如果应用程序未能在锁定超时到期之前处理消息(例如,如果应用程序崩溃),服务总线则将自动解锁该消息,使它可以再次被接收。

如果在处理消息之后,发出 deleteMessage 请求之前,应用程序发生崩溃,则在应用程序重启时会将该消息重新传送给它。 此情况通常称作 至少处理一次,即每条消息将至少被处理一次,但在某些情况下,同一消息可能会被重新传送。 如果某个场景不允许重复处理,则建议向应用程序添加其他逻辑来处理重复消息传送。 这通常可以通过使用消息的 getMessageId 方法来实现,消息在多次传送尝试中保持不变。

备注

可以使用服务总线资源管理器管理服务总线资源。 服务总线资源管理器允许用户连接到服务总线命名空间并以一种简单的方式管理消息传送实体。 该工具提供高级功能,如导入/导出功能或用于对主题、队列、订阅、中继服务、通知中心和事件中心进行测试的功能。

后续步骤

现在,已了解服务总线队列的基础知识,请参阅队列、主题和订阅 以获取更多信息。

有关详细信息,另请访问 PHP 开发人员中心