語言

IWsdlExportExtension 介面

定義

定義端點或合約行為,能匯出自訂元資料。

public interface class IWsdlExportExtension
public interface IWsdlExportExtension
type IWsdlExportExtension = interface
Public Interface IWsdlExportExtension
衍生

範例

以下程式碼範例展示了 IWsdlExportExtension 一個,將自訂文件屬性加入 WSDL 檔案,作為 WSDL 註解。

public void ExportContract(WsdlExporter exporter, WsdlContractConversionContext context)
{
Console.WriteLine("Inside ExportContract");
if (context.Contract != null)
{
    // Inside this block it is the contract-level comment attribute.
    // This.Text returns the string for the contract attribute.
    // Set the doc element; if this isn't done first, there is no XmlElement in the
    // DocumentElement property.
    context.WsdlPortType.Documentation = string.Empty;
    // Contract comments.
    XmlDocument owner = context.WsdlPortType.DocumentationElement.OwnerDocument;
    XmlElement summaryElement = Formatter.CreateSummaryElement(owner, this.Text);
    context.WsdlPortType.DocumentationElement.AppendChild(summaryElement);

    foreach (OperationDescription op in context.Contract.Operations)
    {
        Operation operation = context.GetOperation(op);
        object[] opAttrs = op.SyncMethod.GetCustomAttributes(typeof(WsdlDocumentationAttribute), false);
        if (opAttrs.Length == 1)
        {
            string opComment = ((WsdlDocumentationAttribute)opAttrs[0]).Text;

            // This.Text returns the string for the operation-level attributes.
            // Set the doc element; if this isn't done first, there is no XmlElement in the
            // DocumentElement property.
            operation.Documentation = String.Empty;

            // Operation C# triple comments.
            XmlDocument opOwner = operation.DocumentationElement.OwnerDocument;
            XmlElement newSummaryElement = Formatter.CreateSummaryElement(opOwner, opComment);
            operation.DocumentationElement.AppendChild(newSummaryElement);

            // Get returns information
            ParameterInfo returnValue = op.SyncMethod.ReturnParameter;
            object[] returnAttrs = returnValue.GetCustomAttributes(typeof(WsdlParameterDocumentationAttribute), false);
            if (returnAttrs.Length == 1)
            {
                // <returns>text.</returns>
                XmlElement returnsElement =
                  Formatter.CreateReturnsElement(
                    opOwner,
                    ((WsdlParameterDocumentationAttribute)returnAttrs[0]).ParamComment
                  );
                operation.DocumentationElement.AppendChild(returnsElement);
            }

            // Get parameter information.
            ParameterInfo[] args = op.SyncMethod.GetParameters();
            for (int i = 0; i < args.Length; i++)
            {
                object[] docAttrs
                  = args[i].GetCustomAttributes(typeof(WsdlParameterDocumentationAttribute), false);
                if (docAttrs.Length != 0)
                {
                    // <param name="Int1">Text.</param>
                    XmlElement newParamElement = opOwner.CreateElement("param");
                    XmlAttribute paramName = opOwner.CreateAttribute("name");
                    paramName.Value = args[i].Name;
                    newParamElement.InnerText
                      = ((WsdlParameterDocumentationAttribute)docAttrs[0]).ParamComment;
                    newParamElement.Attributes.Append(paramName);
                    operation.DocumentationElement.AppendChild(newParamElement);
                }
            }
        }
    }
}

備註

若要修改並擴充由WsdlExporter物件匯出的網路服務描述語言(WSDL),請在端點、合約或操作行為(實作 IWsdlExportExtension、 IContractBehavior或 IEndpointBehavior的物件)上實作介面IOperationBehavior,並將行為加入 Behaviors、 Behaviors或 Behaviors 屬性中。 此外,你也可以 IWsdlExportExtension 在 BindingElement.

IWsdlExportExtension 即使 Windows Communication Foundation(WCF)會將自訂綁定政策斷言匯出到 WSDL 內的適當元素,但 卻無法匯出自訂政策斷言。 如果你想匯出自訂政策斷言,就實作這個 IPolicyExportExtension 介面。

元資料發佈流程從呼叫 WsdlExporter.ExportEndpoints 開始,呼叫再 WsdlExporter.ExportEndpoint 呼叫每個端點。

端點的匯出方式是先匯出其合約。匯出合約時,會 System.ServiceModel.Description.WsdlExporter 呼叫 IWsdlExportExtension.ExportContract 合約上所有 IWsdlExportExtension 實作的方法,以及該合約的操作行為。 使用通配符動作的操作不會匯出到元資料中,因此 IWsdlExportExtension 這些操作的操作行為實作不會匯出。

合約出口後,港口與約束文件會被出口,並附加出口政策表達。

ExportContract與 ExportEndpoint 方法均提供存取權限WsdlExporter,使IWsdlExportExtension實作能透過屬性Errors報告可恢復的錯誤與警告。 兩種方法中傳遞的上下文物件,提供從匯出的 WSDL 元素到物件ContractDescription屬性ServiceEndpoint的便利映射。

如果實 IWsdlExportExtension 作在匯出時拋出例外,產生的元資料會處於不一致狀態,該 WsdlExporter 物件應該被丟棄。

Note

自訂匯出擴充功能必須在內建序列化器填入服務描述後執行。

方法

名稱 Description
ExportContract(WsdlExporter, WsdlContractConversionContext)

將自訂的 Web Services Description Language(WSDL)元素寫入合約產生的 WSDL。

ExportEndpoint(WsdlExporter, WsdlEndpointConversionContext)

將自訂的 Web Services Description Language(WSDL)元素寫入產生的端點 WSDL。

適用於