README

此项目提供了一套PHP客户端库，使得访问Microsoft™ Azure服务总线（队列和主题）变得简单。

功能

• 服务总线
  • 队列：创建、列出和删除队列；发送、接收、解锁和删除消息
  • 主题：创建、列出和删除主题；创建、列出和删除订阅；发送、接收、解锁和删除消息；创建、列出和删除规则

入门

下载源代码

要从我们的存储库获取源代码，请在您的项目根目录中输入以下命令：

git clone https://FlaschenpostSE@dev.azure.com/FlaschenpostSE/PHP/_git/azurelib
cd ./azurelib

注意

解决依赖关系的推荐方法是使用 Composer 包管理器 安装它们。

通过Composer安装

• 在您项目的根目录中创建一个名为 composer.json 的文件，并将其添加以下代码：

  {
      "require": {
          "flaschenpost/azurelib": "^0.5"
      }
  }

• 在您的项目根目录中下载 composer.phar。

• 打开命令提示符，并在您的项目根目录中执行以下操作：

  php composer.phar install
  

  注意

  在Windows上，您还需要将Git可执行文件添加到您的PATH环境变量中。

用法

入门

在使用库调用任何Microsoft Azure API之前，必须执行以下四个基本步骤。

• 首先，包含自动加载脚本

  require_once "vendor/autoload.php";

• 包含您将使用的命名空间。

  要创建任何Microsoft Azure服务客户端，您需要使用 ServicesBuilder 类

  use WindowsAzure\Common\ServicesBuilder;

  要处理异常，您需要

  use WindowsAzure\Common\ServiceException;

• 要实例化服务客户端，您还需要一个有效的连接字符串。其格式为

  • 要访问实时存储服务（表、Blob、队列）

    DefaultEndpointsProtocol=[http|https];AccountName=[yourAccount];AccountKey=[yourKey]
    

  • 要访问服务总线

    Endpoint=[yourEndpoint];SharedSecretIssuer=[yourWrapAuthenticationName];SharedSecretValue=[yourWrapPassword]
    

    其中端点通常为 https://[yourNamespace].servicebus.windows.net 格式。

• 实例化一个 "REST代理" - 给定服务的可用调用的包装器。

• • 对于服务总线

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

服务总线队列

当前的PHP服务总线API仅支持ACS连接字符串。目前，您需要使用PowerShell创建新的ACS服务总线命名空间。首先，确保您已安装Azure PowerShell，然后在PowerShell命令提示符下运行

Add-AzureAccount # this will sign you in
New-AzureSBNamespace -CreateACSNamespace $true -Name 'mytestbusname' -Location 'West US' -NamespaceType 'Messaging'

如果成功，您将在PowerShell输出中获取连接字符串。如果您使用它时遇到连接错误，并且连接字符串看起来像 Endpoint=sb://...，则将其更改为 Endpoint=https://...

创建队列

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

  // Create queue.
  $serviceBusRestProxy->createQueue($queueInfo);
} catch(ServiceException $e){
  $code = $e->getCode();
  $error_message = $e->getMessage();
  echo $code.": ".$error_message."<br />";
}

错误代码和消息

发送消息

要将消息发送到服务总线队列，您的应用程序将调用 ServiceBusRestProxy->sendQueueMessage 方法。发送到（和从）服务总线队列的消息是 BrokeredMessage 类的实例。

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

  // Send message.
  $serviceBusRestProxy->sendQueueMessage("myqueue", $message);
} catch(ServiceException $e){
  $code = $e->getCode();
  $error_message = $e->getMessage();
  echo $code.": ".$error_message."<br />";
}

接收消息

从队列接收消息的主要方法是使用 ServiceBusRestProxy->receiveQueueMessage 方法。消息可以以两种不同的模式接收： ReceiveAndDelete（在读取时标记消息为已消费）和 PeekLock（锁定消息一段时间，但不删除）。

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

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

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

  // *** Process message here ***

  // Delete message.
  $serviceBusRestProxy->deleteMessage($message);
} catch(ServiceException $e){
  $code = $e->getCode();
  $error_message = $e->getMessage();
  echo $code.": ".$error_message."<br />";
}

服务总线主题

创建主题

try {
  // Create topic.
  $topicInfo = new TopicInfo("mytopic");
  $serviceBusRestProxy->createTopic($topicInfo);
} catch(ServiceException $e){
  $code = $e->getCode();
  $error_message = $e->getMessage();
  echo $code.": ".$error_message."<br />";
}

创建带有默认（MatchAll）筛选器的订阅

try {
  // Create subscription.
  $subscriptionInfo = new SubscriptionInfo("mysubscription");
  $serviceBusRestProxy->createSubscription("mytopic", $subscriptionInfo);
} catch(ServiceException $e){
  $code = $e->getCode();
  $error_message = $e->getMessage();
  echo $code.": ".$error_message."<br />";
}

向主题发送消息

发送到服务总线主题的消息是BrokeredMessage类的实例。

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

  // Send message.
  $serviceBusRestProxy->sendTopicMessage("mytopic", $message);
} catch(ServiceException $e){
  $code = $e->getCode();
  $error_message = $e->getMessage();
  echo $code.": ".$error_message."<br />";
}

从主题接收消息

从订阅接收消息的主要方法是使用ServiceBusRestProxy->receiveSubscriptionMessage方法。接收到的消息可以在两种不同的模式下工作：默认的ReceiveAndDelete和类似于服务总线队列的PeekLock。

以下示例演示了如何使用默认模式（ReceiveAndDelete模式）接收和处理消息。

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

  // Get message.
  $message = $serviceBusRestProxy->receiveSubscriptionMessage("mytopic",
                                "mysubscription",
                                $options);
  echo "Body: ".$message->getBody()."<br />";
  echo "MessageID: ".$message->getMessageId()."<br />";
} catch(ServiceException $e){
  $code = $e->getCode();
  $error_message = $e->getMessage();
  echo $code.": ".$error_message."<br />";
}

了解更多

微软Azure PHP开发者中心

本项目已采用微软开源行为准则。有关更多信息，请参阅行为准则常见问题解答，或通过opencode@microsoft.com联系以提出任何额外的问题或意见。