关于WCF引用方式之WCF服务寄宿控制台

Posted 2020-10-21 烟雨楼台^浮云往事

1.创建解决方案WCFService

依次添加四个项目，如上图，Client和Hosting为控制台应用程序，Service和Service.Interface均为类库。

2.引用关系

Service.Interface：定义服务契约(Service Contract)接口，引用WCF核心库System.ServiceModel.dll;

Service：定义服务的项目，由于需要实现具体的服务，而服务契约在Service.Interface中，所以要引用Service.Interface项目;

Hosting：服务宿主的控制台程序，需要引用Service.Interface和Service项目，同时还要引用System.ServiceModel.dll类库：

Client：一个控制台应用程序的客户端，需要引用Service.ServiceModel类库。

Service.Interface：

服务契约抽象了服务的所有操作，一般契约为接口形式存在。

  [ServiceContract(Name = "CalculatorService", Namespace = "Listen.Fly")]
    public interface ICalculator
    {
        [OperationContract]
        double Add(double x, double y);

        [OperationContract]
        double Subtract(double x, double y);

        [OperationContract]
        double Multiply(double x, double y);

        [OperationContract]
        double Divide(double x, double y);
    }

通过使用System.ServiceModel.ContractAttribute特性来标识接口为服务契约，同时可以在特性中指定契约的Name和Namespace。通过ContractAttribute特性标识为契约后的接口的方法并不能自动成为服务操作，WCF采用的是显示选择策略，所以我们要在对应的服务操作上添加OperationContractAttribute特性。

Service：

在Service项目中添加类CalculatorService类，并实现自ICalculator接口，并将服务操作(加减乘除四个方法)代码补全。

  public class CalculatorService : ICalculator
    {
        public double Add(double x, double y)
        {
            return x + y;
        }

        public double Subtract(double x, double y)
        {
            return x - y;
        }

        public double Multiply(double x, double y)
        {
            return x * y;
        }

        public double Divide(double x, double y)
        {
            return x / y;
        }
    }

 Hosting：

WCF服务需要一个运行着的宿主进程，服务寄宿就是给服务指定一个宿主的过程。WCF采用基于终结点(EndPoint)的通信手段。终结点有地址(Address)，绑定(Binding)和契约(Contract)三部分组成，三要素也可以记作：EndPoint=ABC。

一个终结点包含了通信所必须的所有信息，具体如下:
Address:地址决定了服务的位置，解决了寻址的问题；
Binding:绑定实现了通信的所有细节，包括网络传输，消息编码，以及其他为实现某种功能(比如传输安全，可靠消息传输，事务等)对消息进行的相应处理。WCF中具有一系列的系统定义绑定，比如BasicHttpBinding，WSHttpBinding和NetTcpBinding等；
Contract:契约是对服务操作的抽象，也是对消息交换模式以及消息结构的定义。

服务寄宿的目的是开启一个进程，为WCF服务提供一个运行环境，并为服务添加一个或者多个终结点，然后暴漏给服务消费者。

Hosting的代码如下：

      using (ServiceHost host = new ServiceHost(typeof(CalculatorService)))
            {
                host.AddServiceEndpoint(
                    typeof(ICalculator),
                    new WSHttpBinding(),
                    "http://127.0.0.1:1111/CalculatorService");
                if (host.Description.Behaviors.Find() == null)
                {
                    ServiceMetadataBehavior behavior = new ServiceMetadataBehavior();
                    behavior.HttpGetEnabled = true;
                    behavior.HttpGetUrl = new Uri("http://127.0.0.1:1111/CalculatorService/metadata");
                    host.Description.Behaviors.Add(behavior);
                }
                host.Opened += delegate
                    {
                        Console.Write("CalculatorService已经启动，按任意键终止服务");
                    };
                host.Open();
                Console.Read();
            }

 WCF的寄宿通过System.ServiceModel.ServiceHost对象来完成，我们代码中基于服务类型(typeof(CalculatorService))创建了ServiceHost对象。添加了基于WSHttpBinding绑定的终结点，服务契约类型为typeof(ICalculator)，地址为"http://127.0.0.1:1111/CalculatorService"(此处的地址可以随意指定)。
  WCF中客户端和服务端是松耦合的，客户端只需要知道WCF服务的基本描述，而不需知道服务的具体实现，就可以完成调用。WCF服务的描述通过元数据(Metadata)的形式发布出来，WCF中的元数据通过一个特殊的服务行为ServiceMetadataBehavior来实现。
  在上述代码中我们为ServiceHost添加了ServiceMetadataBehavior这样一个服务行为，并采用基于HTTP-GET的元数据获取方式，并且通过ServiceMetadataBehavior的HttpGetUrl属性指定元数据的发布地址(当前地址为http://127.0.0.1:1111/CalculatorService/metadata)。在服务启动之后，访问该地址可以看到元数据，即为XML返回数据的页面。(也就是和我们通常点击svc文件中的链接看到的结果是一样的)

上面的代码实在是不太好记住，不过通常我们也不会这么做，可以将这些配置的过程放在config文件中去：

<</span>configuration>
  <</span>startup>
    <</span>supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5" />
  </</span>startup>
  <</span>system.serviceModel>
    <</span>behaviors>
      <</span>serviceBehaviors>
        <</span>behavior name="metadataBehavior">
          <</span>serviceMetadata httpGetEnabled="true"   httpGetUrl="http://127.0.0.1:1111/CalculatorService/metadata"/>
        </</span>behavior>
      </</span>serviceBehaviors>
    </</span>behaviors>
    <</span>services>
      <</span>service name="Service.CalculatorService" behaviorConfiguration="metadataBehavior">
        <</span>endpoint address="http://127.0.0.1:1111/CalculatorService" binding="wsHttpBinding" 
                            contract="Service.Interface.ICalculator"></</span>endpoint>
      </</span>service>
    </</span>services>
  </</span>system.serviceModel>
</</span>configuration>

打开Hosting项目中的app.config，添加上述代码即可。xml中的标签的意思和我们创建ServiceHost过程基本是一致的。

如果使用了配置文件的方式，我们的代码可以更简单，Hosting代码修改如下：

     using (ServiceHost host = new ServiceHost(typeof(CalculatorService)))
            {
                host.Opened += delegate
        　　  {
              Console.Write("CalculatorService已经启动，按任意键终止服务");
          　　};
                host.Open();
                Console.Read();
            }

Client：

契约也定义了，服务也实现了，宿主也写好了，还剩下最后一步调用服务，运行Hosting.exe(debug目录下的哦，如果运行失败，那么请用管理员身份运行)，然后看到如下界面：

然后在Client中添加对服务的引用：

在地址中输入我们配置的url，单击Go即可找到发布的WCF(必须要一直运行着Hosting.exe)，可以在Namespace修改为自定义的命名空间，点击OK即可成功添加WCF。添加成功之后，被客户端调用的契约接口CalculatorService会被生成出来。客户端之所以会被命名为CalculatorService，是因为我们在ICalculator接口的特性中设置Name为CalculatorService。CalculatorService是与定义在Service.Interface项目中ICalculator接口等效的契约接口。但是我们在客户端使用则是一个CalculatorServiceClient(当然不同的WCF名称不一样，但是都是以Client结尾)，CalculatorServiceClient的基类为System.ServiceModel.ClientBase。CalculatorServiceClient同样实现了契约接口CalculatorService，并通过从基类继承的Channel属性调用相对应的方法。

使用如下：

     using (CalculatorServiceClient proxy = new CalculatorServiceClient())
            {
                Console.WriteLine("x+y={2} when x={0} and y={1}", 1, 2, proxy.Add(1, 2));
                Console.WriteLine("x-y={2} when x={0} and y={1}", 10, 2, proxy.Subtract(10, 2));
                Console.WriteLine("x*y={2} when x={0} and y={1}", 10, 2, proxy.Multiply(10, 2));
                Console.WriteLine("x/y={2} when x={0} and y={1}", 10, 2, proxy.Divide(10, 2));
                Console.Read();
            }

很简单吧，只需定义一个xxClient对象，然后调用其对应的方法即可，当然我们现在使用的是同步的，每个方法都有对应的异步方法。比如Add对应的异步方法就是AddAsync，如果使用异步方法则要给xxClient添加对应的回调函数。
      客户端通过服务代理对象进行服务调用，上述代码中的通过添加服务引用自动创建生成的、继承自ClientBase的类型对象进行服务调用。实际上还有另外一种实现方法，通过System.ServiceModel.ChannelFactory直接创建服务代理对象。WCF采用基于契约的服务调用方法，从上述代码中可以看到，VS在添加服务引用的过程中，会在客户端创建一个与服务等效的服务契约接口。由于服务端和客户端都在同一个解决方案，因此可以让服务端和客户端引用相同的契约。

客户端使用第二种方法也就是ChannelFactory形式创建代理对象，删除掉之前添加的WCF的引用，然后添加对Service.Interface项目的引用(注：如果客户端是Silverlight应用程序可能会提示无法添加，因为Silverlight应用程序只能添加Silverlight应用程序或者Silverlight类库)，然后修改代码如下：

      using (ChannelFactory channelFactory = new ChannelFactory(
                new WSHttpBinding(),
                "http://127.0.0.1:1111/CalculatorService"))
            {
                ICalculator proxy = channelFactory.CreateChannel();
                Console.WriteLine("x+y={2} when x={0} and y={1}", 1, 2, proxy.Add(1, 2));
                Console.WriteLine("x-y={2} when x={0} and y={1}", 10, 2, proxy.Subtract(10, 2));
                Console.WriteLine("x*y={2} when x={0} and y={1}", 10, 2, proxy.Multiply(10, 2));
                Console.WriteLine("x/y={2} when x={0} and y={1}", 10, 2, proxy.Divide(10, 2));
            }

 终结点是WCF进行通信的唯一方式，ChannelFactory本质上是通过指定的终结点创建用于进行服务调用的服务代理。上述嗲吗中，在创建ChannelFactory的时候在构造函数中指定了终结点的ABC三要素，其中地址和绑定则通过参数指定，契约提现在ChannelFactory的泛型参数上。不过一般我们也不会这么做，聪明的你猜到了，还是通过配置文件来进行，没错，配置如下：

<</span>configuration>
  <</span>system.serviceModel>
    <</span>client>
      <</span>endpoint
        name="CalculatorService"
        address="http://127.0.0.1:1111/CalculatorService"
        binding="wsHttpBinding"
        contract="Service.Interface.ICalculator"  />
    </</span>client>
  </</span>system.serviceModel>
</</span>configuration>

在配置文件中添加了endpoint，同样还是指定了address地址、binding绑定、以及契约constract和代码创建的过程一致哦。

代码修改如下：

  using (ChannelFactory channelFactory = new ChannelFactory("CalculatorService"))
            {
                ICalculator proxy = channelFactory.CreateChannel();
                Console.WriteLine("x+y={2} when x={0} and y={1}", 1, 2, proxy.Add(1, 2));
                Console.WriteLine("x-y={2} when x={0} and y={1}", 10, 2, proxy.Subtract(10, 2));
                Console.WriteLine("x*y={2} when x={0} and y={1}", 10, 2, proxy.Multiply(10, 2));
                Console.WriteLine("x/y={2} when x={0} and y={1}", 10, 2, proxy.Divide(10, 2));
            }

可以看到，唯一的区别就是在对ChannelFactory实例化的时候，使用配置文件中endpoint的name属性替代了之前的Binding和地址。

 注：上述代码中如果是非添加服务引用的方式进行创建Client，那么在运行Client的时候，请确保Hosting.exe已经正常启动。