如何:使用单向和请求-答复协定访问 WCF 服务

下面的过程描述了如何访问一个 Windows Communication Foundation (WCF) 服务,该服务定义一个单向协定和一个请求-答复协定,并且未使用双工通信模式。

定义服务

  1. 声明服务协定。要成为单向的操作必须在 OperationContractAttribute 中将 IsOneWay 设置为 true。下面的代码声明具有 AddSubtractMultiplyDivide 的单向操作的 IOneWayCalculator 协定。它还定义称为 SayHello 的请求响应操作。

        [ServiceContract(Namespace = "http://Microsoft.ServiceModel.Samples")]
        public interface IOneWayCalculator
        {
            [OperationContract(IsOneWay = true)]
            void Add(double n1, double n2);
            [OperationContract(IsOneWay = true)]
            void Subtract(double n1, double n2);
            [OperationContract(IsOneWay = true)]
            void Multiply(double n1, double n2);
            [OperationContract(IsOneWay = true)]
            void Divide(double n1, double n2);
            [OperationContract]
            string SayHello(string name);
        }
    
  2. 实现服务协定。下面的代码实现 IOnewayCalculator 接口。

    [ServiceBehavior(ConcurrencyMode = ConcurrencyMode.Multiple, InstanceContextMode = InstanceContextMode.PerCall)]
    public class CalculatorService : IOneWayCalculator
    {
        public void Add(double n1, double n2)
        {
           double result = n1 + n2;
           Console.WriteLine("Add({0},{1}) = {2} ", n1, n2, result);
        }
    
        public void Subtract(double n1, double n2)
        {
           double result = n1 - n2;
           Console.WriteLine("Subtract({0},{1}) = {2}", n1, n2, result);
        }
    
        public void Multiply(double n1, double n2)
        {
            double result = n1 * n2;
            Console.WriteLine("Multiply({0},{1}) = {2}", n1, n2, result);
        }
    
        public void Divide(double n1, double n2)
        {
            double result = n1 / n2;
            Console.WriteLine("Divide({0},{1}) = {2}", n1, n2, result);
        }
    
        public string SayHello(string name)
        {
            Console.WriteLine("SayHello({0})", name);
            return "Hello " + name;
        }
    }
    
  3. 在控制台应用程序中承载服务。下面的代码演示如何承载服务。

    // Host the service within this EXE console application.
    public static void Main()
    {
       // Define the base address for the service.
       Uri baseAddress = new Uri("https://localhost:8000/servicemodelsamples/service");
    
       // Create a ServiceHost for the CalculatorService type and provide the base address.
       using (ServiceHost serviceHost = new ServiceHost(typeof(CalculatorService), baseAddress))
       {
            // Add an endpoint using the IOneWayCalculator contract and the WSHttpBinding
            serviceHost.AddServiceEndpoint(typeof(IOneWayCalculator), new WSHttpBinding(), "");
    
          // Turn on the metadata behavior, this allows svcutil to get metadata for the service.
          ServiceMetadataBehavior smb = (ServiceMetadataBehavior) serviceHost.Description.Behaviors.Find<ServiceMetadataBehavior>();
          if (smb == null)
          {
                smb = new ServiceMetadataBehavior();
                smb.HttpGetEnabled = true;
                serviceHost.Description.Behaviors.Add(smb);
          }
    
          // Open the ServiceHostBase 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();
        }
    }
    

访问服务

  1. 通过下面的命令行,使用元数据交换终结点地址运行 ServiceModel 元数据实用工具 (Svcutil.exe) 为服务创建客户端类:Svcutil https://localhost:8000/ServiceServiceModel 元数据实用工具 (Svcutil.exe) 将生成一组接口和类,如下面的示例代码所示。

    [System.CodeDom.Compiler.GeneratedCodeAttribute("System.ServiceModel", "3.0.0.0")]
    [System.ServiceModel.ServiceContractAttribute(Namespace="http://Microsoft.ServiceModel.Samples", ConfigurationName="IOneWayCalculator")]
    public interface IOneWayCalculator
    {
    
        [System.ServiceModel.OperationContractAttribute(IsOneWay=true, Action="http://Microsoft.ServiceModel.Samples/IOneWayCalculator/Add")]
        void Add(double n1, double n2);
    
        [System.ServiceModel.OperationContractAttribute(IsOneWay=true, Action="http://Microsoft.ServiceModel.Samples/IOneWayCalculator/Subtract")]
        void Subtract(double n1, double n2);
    
        [System.ServiceModel.OperationContractAttribute(IsOneWay=true, Action="http://Microsoft.ServiceModel.Samples/IOneWayCalculator/Multiply")]
        void Multiply(double n1, double n2);
    
        [System.ServiceModel.OperationContractAttribute(IsOneWay=true, Action="http://Microsoft.ServiceModel.Samples/IOneWayCalculator/Divide")]
        void Divide(double n1, double n2);
    
        [System.ServiceModel.OperationContractAttribute(Action="http://Microsoft.ServiceModel.Samples/IOneWayCalculator/SayHello", ReplyAction="http://Microsoft.ServiceModel.Samples/IOneWayCalculator/SayHelloResponse")]
        string SayHello(string name);
    }
    
    [System.CodeDom.Compiler.GeneratedCodeAttribute("System.ServiceModel", "3.0.0.0")]
    public interface IOneWayCalculatorChannel : IOneWayCalculator, System.ServiceModel.IClientChannel
    {
    }
    
    [System.Diagnostics.DebuggerStepThroughAttribute()]
    [System.CodeDom.Compiler.GeneratedCodeAttribute("System.ServiceModel", "3.0.0.0")]
    public partial class OneWayCalculatorClient : System.ServiceModel.ClientBase<IOneWayCalculator>, IOneWayCalculator
    {
    
        public OneWayCalculatorClient()
        {
        }
    
        public OneWayCalculatorClient(string endpointConfigurationName) : 
                base(endpointConfigurationName)
        {
        }
    
        public OneWayCalculatorClient(string endpointConfigurationName, string remoteAddress) : 
                base(endpointConfigurationName, remoteAddress)
        {
        }
    
        public OneWayCalculatorClient(string endpointConfigurationName, System.ServiceModel.EndpointAddress remoteAddress) : 
                base(endpointConfigurationName, remoteAddress)
        {
        }
    
        public OneWayCalculatorClient(System.ServiceModel.Channels.Binding binding, System.ServiceModel.EndpointAddress remoteAddress) : 
                base(binding, remoteAddress)
        {
        }
    
        public void Add(double n1, double n2)
        {
            base.Channel.Add(n1, n2);
        }
    
        public void Subtract(double n1, double n2)
        {
            base.Channel.Subtract(n1, n2);
        }
    
        public void Multiply(double n1, double n2)
        {
            base.Channel.Multiply(n1, n2);
        }
    
        public void Divide(double n1, double n2)
        {
            base.Channel.Divide(n1, n2);
        }
    
        public string SayHello(string name)
        {
            return base.Channel.SayHello(name);
        }
    }
    

    请注意,在 IOneWayCalculator 接口中,单向服务操作已将 IsOneWay 属性设置为 true,请求-答复服务操作已将属性设置为默认值 false。此外,请注意 OneWayCalculatorClient 类。这是将用于调用服务的类。

  2. 创建客户端对象。

    // Create a client
    WSHttpBinding binding = new WSHttpBinding();
    EndpointAddress epAddress = new EndpointAddress("https://localhost:8000/servicemodelsamples/service");
    OneWayCalculatorClient client = new OneWayCalculatorClient(binding, epAddress);
    
  3. 调用服务操作。

    // Call the Add service operation.
    double value1 = 100.00D;
    double value2 = 15.99D;
    client.Add(value1, value2);
    Console.WriteLine("Add({0},{1})", value1, value2);
    
    // Call the Subtract service operation.
    value1 = 145.00D;
    value2 = 76.54D;
    client.Subtract(value1, value2);
    Console.WriteLine("Subtract({0},{1})", value1, value2);
    
    // Call the Multiply service operation.
    value1 = 9.00D;
    value2 = 81.25D;
    client.Multiply(value1, value2);
    Console.WriteLine("Multiply({0},{1})", value1, value2);
    
    // Call the Divide service operation.
    value1 = 22.00D;
    value2 = 7.00D;
    client.Divide(value1, value2);
    Console.WriteLine("Divide({0},{1})", value1, value2);
    
    // Call the SayHello service operation
    string name = "World";
    string response = client.SayHello(name);
    Console.WriteLine("SayHello([0])", name);
    Console.WriteLine("SayHello() returned: " + response);
    
  4. 关闭客户端,以便关闭连接并清理资源。

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

示例

下面列出了本主题中使用的完整代码。

// Service.cs
using System;
using System.Configuration;
using System.ServiceModel;
using System.ServiceModel.Description;

namespace Microsoft.ServiceModel.Samples
{
    // Define a service contract. 
    [ServiceContract(Namespace = "http://Microsoft.ServiceModel.Samples")]
    public interface IOneWayCalculator
    {
        [OperationContract(IsOneWay = true)]
        void Add(double n1, double n2);
        [OperationContract(IsOneWay = true)]
        void Subtract(double n1, double n2);
        [OperationContract(IsOneWay = true)]
        void Multiply(double n1, double n2);
        [OperationContract(IsOneWay = true)]
        void Divide(double n1, double n2);
        [OperationContract]
        string SayHello(string name);
    }
   
    // Service class which implements the service contract.
    // Added code to write output to the console window
    [ServiceBehavior(ConcurrencyMode = ConcurrencyMode.Multiple, InstanceContextMode = InstanceContextMode.PerCall)]
    public class CalculatorService : IOneWayCalculator
    {
        public void Add(double n1, double n2)
        {
            double result = n1 + n2;
            Console.WriteLine("Add({0},{1}) = {2} ", n1, n2, result);
        }

        public void Subtract(double n1, double n2)
        {
            double result = n1 - n2;
            Console.WriteLine("Subtract({0},{1}) = {2}", n1, n2, result);
        }

        public void Multiply(double n1, double n2)
        {
            double result = n1 * n2;
            Console.WriteLine("Multiply({0},{1}) = {2}", n1, n2, result);
        }

        public void Divide(double n1, double n2)
        {
            double result = n1 / n2;
            Console.WriteLine("Divide({0},{1}) = {2}", n1, n2, result);
        }

        public string SayHello(string name)
        {
            Console.WriteLine("SayHello({0})", name);
            return "Hello " + name;
        }



        // Host the service within this EXE console application.
        public static void Main()
        {
            // Define the base address for the service.
            Uri baseAddress = new Uri("https://localhost:8000/servicemodelsamples/service");

            // Create a ServiceHost for the CalculatorService type and provide the base address.
            using (ServiceHost serviceHost = new ServiceHost(typeof(CalculatorService), baseAddress))
            {
                // Add an endpoint using the IOneWayCalculator contract and the WSHttpBinding
                serviceHost.AddServiceEndpoint(typeof(IOneWayCalculator), new WSHttpBinding(), "");

                // Turn on the metadata behavior, this allows svcutil to get metadata for the service.
                ServiceMetadataBehavior smb = (ServiceMetadataBehavior) serviceHost.Description.Behaviors.Find<ServiceMetadataBehavior>();
                if (smb == null)
                {
                    smb = new ServiceMetadataBehavior();
                    smb.HttpGetEnabled = true;
                    serviceHost.Description.Behaviors.Add(smb);
                }

                // Open the ServiceHostBase 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();
            }
        }
    }
}

// client.cs
using System;
using System.ServiceModel;

namespace Microsoft.ServiceModel.Samples
{
    //The service contract is defined in generatedClient.cs, generated from the service by the svcutil tool.

    //Client implementation code.
    class Client
    {
        static void Main()
        {
            // Create a client
            WSHttpBinding binding = new WSHttpBinding();
            EndpointAddress epAddress = new EndpointAddress("https://localhost:8000/servicemodelsamples/service");
            OneWayCalculatorClient client = new OneWayCalculatorClient(binding, epAddress);

            // Call the Add service operation.
            double value1 = 100.00D;
            double value2 = 15.99D;
            client.Add(value1, value2);
            Console.WriteLine("Add({0},{1})", value1, value2);

            // Call the Subtract service operation.
            value1 = 145.00D;
            value2 = 76.54D;
            client.Subtract(value1, value2);
            Console.WriteLine("Subtract({0},{1})", value1, value2);

            // Call the Multiply service operation.
            value1 = 9.00D;
            value2 = 81.25D;
            client.Multiply(value1, value2);
            Console.WriteLine("Multiply({0},{1})", value1, value2);

            // Call the Divide service operation.
            value1 = 22.00D;
            value2 = 7.00D;
            client.Divide(value1, value2);
            Console.WriteLine("Divide({0},{1})", value1, value2);

            // Call the SayHello service operation
            string name = "World";
            string response = client.SayHello(name);
            Console.WriteLine("SayHello([0])", name);
            Console.WriteLine("SayHello() returned: " + response);
            //Closing the client gracefully closes the connection and cleans up resources
            client.Close();


        }
    }
}

另请参见

概念

One-Way Services