会话和队列

项目
05/10/2023

会话示例演示如何通过消息队列 (MSMQ) 传输来发送和接收排队通信中的一组相关消息。本示例使用 netMsmqBinding 绑定。此服务是自承载控制台应用程序，通过它可以观察服务接收排队消息。

注意

本主题的最后介绍了此示例的设置过程和生成说明。

在排队通信中，客户端使用队列与服务进行通信。更确切地说，客户端向队列发送消息。服务从队列接收消息。因此不必同时运行服务和客户端便可使用队列进行通信。

有时，客户端会发送在组中相关的一组消息。如果必须同时或按指定顺序处理消息，则可以使用队列将这些消息分为一组，以便由单一的接收应用程序进行处理。这对于一组服务器上有多个接收应用程序的情况尤其重要，并且有必要确保一组消息由同一个接收应用程序来处理。排队的会话是一种用于发送和接收必须同时处理的一组相关消息的机制。排队的会话需要一个展示此模式的事务。

在该示例中，客户端向服务发送多则消息，作为单一事务范围中的会话的一部分。

服务协定是 IOrderTaker，它定义了适合与队列一起使用的单向服务。在以下示例代码中显示的协定中使用的 SessionMode 表明消息是会话的一部分。

[ServiceContract(Namespace = "http://Microsoft.ServiceModel.Samples", SessionMode=SessionMode.Required)]
public interface IOrderTaker
{
    [OperationContract(IsOneWay = true)]
    void OpenPurchaseOrder(string customerId);

    [OperationContract(IsOneWay = true)]
    void AddProductLineItem(string productId, int quantity);

    [OperationContract(IsOneWay = true)]
    void EndPurchaseOrder();
}

该服务按如下方式定义服务操作：第一个操作在事务中登记，但不会自动完成事务。后续操作也在同一个事务中登记，但也不自动完成事务。会话中的最后一个操作自动完成该事务。因此，对服务协定中的若干个操作调用使用了同一个事务。如果其中任何一个操作引发异常，则事务将回滚，并且会话将返回到队列中。成功完成最后一个操作后，事务即已提交。服务使用 PerSession 作为 InstanceContextMode，以便在服务的同一个实例上的会话中接收所有消息。

[ServiceBehavior(InstanceContextMode=InstanceContextMode.PerSession)]
public class OrderTakerService : IOrderTaker
{
    PurchaseOrder po;

    [OperationBehavior(TransactionScopeRequired = true,
                                 TransactionAutoComplete = false)]
    public void OpenPurchaseOrder(string customerId)
    {
        Console.WriteLine("Creating purchase order");
        po = new PurchaseOrder(customerId);
    }

    [OperationBehavior(TransactionScopeRequired = true,
                                  TransactionAutoComplete = false)]
    public void AddProductLineItem(string productId, int quantity)
    {
        po.AddProductLineItem(productId, quantity);
        Console.WriteLine("Product " + productId + " quantity " +
                            quantity + " added to purchase order");
    }

    [OperationBehavior(TransactionScopeRequired = true,
                                  TransactionAutoComplete = true)]
    public void EndPurchaseOrder()
    {
       Console.WriteLine("Purchase Order Completed");
       Console.WriteLine();
       Console.WriteLine(po.ToString());
    }
}

服务是自承载服务。使用 MSMQ 传输时，必须提前创建所使用的队列。可以手动或通过代码完成此操作。在此示例中，服务包含 System.Messaging 代码，以检查队列是否存在并在必要时创建队列。使用 AppSettings 类从配置文件中读取队列名称。

// Host the service within this EXE console application.
public static void Main()
{
    // Get MSMQ queue name from app settings in configuration.
    string queueName = ConfigurationManager.AppSettings["queueName"];

    // Create the transacted MSMQ queue if necessary.
    if (!MessageQueue.Exists(queueName))
        MessageQueue.Create(queueName, true);

    // Create a ServiceHost for the OrderTakerService type.
    using (ServiceHost serviceHost = new ServiceHost(typeof(OrderTakerService)))
    {
        // Open the ServiceHost to create listeners and start listening for messages.
        serviceHost.Open();

        // The service can now be accessed.
        Console.WriteLine("The service is ready.");
        Console.WriteLine("Press <ENTER> to terminate service.");
        Console.WriteLine();
        Console.ReadLine();

        // Close the ServiceHost to shutdown the service.
        serviceHost.Close();
    }
}

MSMQ 队列名称是在配置文件的 appSettings 节中指定的。服务终结点是在配置文件的 system.serviceModel 节中定义的，它指定了 netMsmqBinding 绑定。

<appSettings>
  <!-- Use appSetting to configure MSMQ queue name. -->
  <add key="queueName" value=".\private$\ServiceModelSamplesSession" />
</appSettings>

<system.serviceModel>
  <services>
    <service name="Microsoft.ServiceModel.Samples.OrderTakerService"
        behaviorConfiguration="CalculatorServiceBehavior">
      ...
      <!-- Define NetMsmqEndpoint -->
      <endpoint address="net.msmq://localhost/private/ServiceModelSamplesSession"
                binding="netMsmqBinding"
                contract="Microsoft.ServiceModel.Samples.IOrderTaker" />
      ...
    </service>
  </services>
  ...
</system.serviceModel>

客户端创建事务范围。会话中的所有消息都将发送到该事务范围中的队列，使其被视为一个原子单元，其中的所有消息都将成功或失败。通过调用 Complete 提交事务。

//Create a transaction scope.
using (TransactionScope scope = new TransactionScope(TransactionScopeOption.Required))
{
    // Create a client with given client endpoint configuration.
    OrderTakerClient client = new OrderTakerClient("OrderTakerEndpoint");
    // Open a purchase order.
    client.OpenPurchaseOrder("somecustomer.com");
    Console.WriteLine("Purchase Order created");

    // Add product line items.
    Console.WriteLine("Adding 10 quantities of blue widget");
    client.AddProductLineItem("Blue Widget", 10);

    Console.WriteLine("Adding 23 quantities of red widget");
    client.AddProductLineItem("Red Widget", 23);

    // Close the purchase order.
    Console.WriteLine("Closing the purchase order");
    client.EndPurchaseOrder();

    //Closing the client gracefully closes the connection and cleans up resources.
    client.Close();

    // Complete the transaction.
    scope.Complete();
}

注意

只能对会话中的所有消息使用单一事务，并且必须在提交事务之前发送会话中的所有消息。关闭客户端将关闭会话。因此，必须在完成事务之前关闭客户端，以便向队列发送会话中的所有消息。

运行示例时，客户端和服务活动将显示在服务和客户端控制台窗口中。您可以看到服务从客户端接收消息。在每个控制台窗口中按 Enter 可以关闭服务和客户端。由于队列正在使用中，因此不必同时启动和运行客户端和服务。可以先运行客户端，再将其关闭，然后启动服务，这样服务仍然会收到客户端的消息。

在客户端上。

Purchase Order created
Adding 10 quantities of blue widget
Adding 23 quantities of red widget
Closing the purchase order

Press <ENTER> to terminate client.

在服务上。

The service is ready.
Press <ENTER> to terminate service.

Creating purchase order
Product Blue Widget quantity 10 added to purchase order
Product Red Widget quantity 23 added to purchase order
Purchase Order Completed

Purchase Order: 7c86fef0-2306-4c51-80e6-bcabcc1a6e5e
        Customer: somecustomer.com
        OrderDetails
                Order LineItem: 10 of Blue Widget @unit price: $2985
                Order LineItem: 23 of Red Widget @unit price: $156
        Total cost of this order: $33438
        Order status: Pending

设置、生成和运行示例

请确保已执行 Windows Communication Foundation 示例的一次性安装过程。
要生成 C#、C++ 或 Visual Basic .NET 版本的解决方案，请按照生成 Windows Communication Foundation 示例中的说明进行操作。
要使用单机配置或跨计算机配置来运行示例，请按照运行 Windows Communication Foundation 示例中的说明进行操作。

默认情况下使用 NetMsmqBinding 启用传输安全。 MSMQ 传输安全有两个相关的属性，即 MsmqAuthenticationMode 和 MsmqProtectionLevel.。默认情况下，身份验证模式设置为 Windows，保护级别设置为 Sign。为了使 MSMQ 提供身份验证和签名功能，MSMQ 必须是域的一部分，并且必须安装 MSMQ 的 Active Directory 集成选项。如果在未满足这些条件的计算机上运行此示例，将会收到错误。

在加入到工作组的计算机上运行此示例

如果您的计算机不是域成员或尚未安装 Active Directory 集成，请将身份验证模式和保护级别设置为 None 以关闭传输安全性，如下面的示例配置所示。

<system.serviceModel>
  <services>
    <service name="Microsoft.ServiceModel.Samples.OrderTakerService"
             behaviorConfiguration="OrderTakerServiceBehavior">
      <host>
        <baseAddresses>
          <add baseAddress=
         "http://localhost:8000/ServiceModelSamples/service"/>
        </baseAddresses>
      </host>
      <!-- Define NetMsmqEndpoint -->
      <endpoint
          address=
        "net.msmq://localhost/private/ServiceModelSamplesSession"
          binding="netMsmqBinding"
          bindingConfiguration="Binding1"
       contract="Microsoft.ServiceModel.Samples.IOrderTaker" />
      <!-- The mex endpoint is exposed at-->
      <!--http://localhost:8000/ServiceModelSamples/service/mex. -->
      <endpoint address="mex"
                binding="mexHttpBinding"
                contract="IMetadataExchange" />
    </service>
  </services>

  <bindings>
    <netMsmqBinding>
      <binding name="Binding1">
        <security mode="None" />
      </binding>
    </netMsmqBinding>
  </bindings>

    <behaviors>
      <serviceBehaviors>
        <behavior name="OrderTakerServiceBehavior">
          <serviceMetadata httpGetEnabled="True"/>
        </behavior>
      </serviceBehaviors>
    </behaviors>

  </system.serviceModel>

确保在运行示例前更改服务器和客户端上的配置。

注意

将安全模式设置为 None 等效于将 MsmqAuthenticationMode、MsmqProtectionLevel 和 Message 安全设置为 None。

通过

会话和队列

设置、生成和运行示例

在加入到工作组的计算机上运行此示例

其他资源