标准终结点的用法

项目
06/08/2023

StandardEndpoints 示例演示如何在服务配置文件中使用标准终结点。通过标准终结点，用户可以使用单个属性来描述地址、绑定和协定组合以及与其关联的附加属性，从而简化终结点定义。此示例演示如何定义和实现自定义标准终结点，以及如何在终结点中定义特定属性。

示例详细信息

可以通过指定地址、绑定和协定这三个参数来指定服务终结点。可以提供的其他参数包括行为配置、标头、侦听 URI 等。在某些情况下，任何或所有地址、绑定和协定具有无法更改的值。因此，可以使用标准终结点。这类终结点包括元数据交换终结点和发现终结点。标准终结点还允许配置服务终结点，而不必提供固定性质的信息或创建其自己的标准终结点，从而提高了可用性，例如通过提供一组合理的默认值，从而降低配置文件的详细级别，来提高可用性。

此示例由两个项目组成：定义两个标准终结点的服务以及与该服务通信的客户端。下面的示例演示如何为配置文件中的服务定义标准终结点。

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <system.serviceModel>
    <extensions>
      <endpointExtensions>
        <add name="customEndpoint" type="Microsoft.Samples.StandardEndpoints.CustomEndpointCollectionElement, service" />
      </endpointExtensions>
    </extensions>
    <services>
      <service name="Microsoft.Samples.StandardEndpoints.CalculatorService">
        <endpoint address="http://localhost:8000/Samples/Service.svc/customEndpoint" contract="Microsoft.Samples.StandardEndpoints.ICalculator" kind="customEndpoint" />
        <endpoint kind="mexEndpoint" />
      </service>
    </services>
    <behaviors>
      <serviceBehaviors>
        <behavior>
          <serviceMetadata httpGetEnabled="True"/>
        </behavior>
      </serviceBehaviors>
    </behaviors>
    <standardEndpoints>
      <customEndpoint>
        <standardEndpoint property="True" />
      </customEndpoint>
    </standardEndpoints>
  </system.serviceModel>
</configuration>

为服务定义的第一个终结点的类型为 customEndpoint，其定义在 <standardEndpoints> 节中，其中为属性 property 提供了值 true。这是使用新属性自定义终结点的情况。第二个终结点对应于元数据终结点，其中地址、绑定和协定的值是固定的。

若要定义标准终结点元素，必须创建从 StandardEndpointElement 派生的类。在此示例中，已定义了 CustomEndpointElement 类，如下面的示例所示。

public class CustomEndpointElement : StandardEndpointElement
{
    public bool Property
    {
        get { return (bool)base["property"]; }
        set { base["property"] = value; }
    }

    protected override ConfigurationPropertyCollection Properties
    {
        get
        {
            ConfigurationPropertyCollection properties = base.Properties;
            properties.Add(new ConfigurationProperty("property", typeof(bool), false, ConfigurationPropertyOptions.None));
            return properties;
        }
    }

    protected override Type EndpointType
    {
        get { return typeof(CustomEndpoint); }
    }

    protected override ServiceEndpoint CreateServiceEndpoint(ContractDescription contract)
    {
        return new CustomEndpoint();
    }

    protected override void OnApplyConfiguration(ServiceEndpoint endpoint, ServiceEndpointElement serviceEndpointElement)
    {
        CustomEndpoint customEndpoint = (CustomEndpoint)endpoint;
        customEndpoint.Property = this.Property;
    }

    protected override void OnApplyConfiguration(ServiceEndpoint endpoint, ChannelEndpointElement channelEndpointElement)
    {
        CustomEndpoint customEndpoint = (CustomEndpoint)endpoint;
        customEndpoint.Property = this.Property;
    }

    protected override void OnInitializeAndValidate(ServiceEndpointElement serviceEndpointElement)
    {
    }

    protected override void OnInitializeAndValidate(ChannelEndpointElement channelEndpointElement)
    {
    }
}

在 CreateServiceEndpoint 函数中，创建了一个 CustomEndpoint 对象。其定义如下面的示例所示：

public class CustomEndpoint : ServiceEndpoint
{
    public CustomEndpoint()
        : this(string.Empty)
    {
    }

    public CustomEndpoint(string address)
        : this(address, ContractDescription.GetContract(typeof(ICalculator)))
    {
    }

    public CustomEndpoint(string address, ContractDescription contract)
        : base(contract)
    {
        this.Binding = new BasicHttpBinding();
        this.IsSystemEndpoint = false;
    }

    public bool Property
    {
        get;
        set;
    }
}

若要在服务与客户端之间执行通信，需要在客户端中创建对服务的服务引用。当生成和执行示例时，服务会执行，且客户端与之进行通信。请注意，每次对服务进行更改时，都应更新服务引用。

使用此示例

使用 Visual Studio 打开 StandardEndpoints.sln 文件。
使多个项目可以启动。
1. 在“解决方案资源管理器”中，右击标准终结点解决方案，然后选择“属性”。
2. 在“通用属性”中，选择“启动项目”，然后单击“多启动项目”。
3. 将服务项目移动至列表开头，将“操作”设置为“启动”。
4. 将客户端项目移动至服务项目之后，也将“操作”设置为“启动”。
  
  这指定客户端项目在服务项目之后执行。
若要运行解决方案，请按 F5。

备注

如果这些步骤不起作用，则通过以下步骤来确保已正确设置环境：

请确保已执行 Windows Communication Foundation 示例的一次性安装过程。
要生成解决方案，请按照生成 Windows Communication Foundation 示例中的说明进行操作。
要使用单机配置或多台计算机配置运行示例，请按照运行 Windows Communication Foundation 示例中的说明进行操作。

通过

标准终结点的用法

示例详细信息

使用此示例

其他资源