繁体   English   中英

WCF消息:如何删除SOAP Header元素?

[英]WCF message:How to remove the SOAP Header element?

我尝试从WCF消息中删除整个SOAP标头,只想离开信封体。 任何人都可以告诉我怎么做到这一点?

像这样创建一个WCF消息:

**string response = "Hello World!";
Message msg = Message.CreateMessage(MessageVersion.Soap11, "*", new TextBodyWriter(response));
msg.Headers.Clear();**

发送SOAP消息将是:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header />
  <s:Body>
    <Binary>Hello World!</Binary>
  </s:Body>
</s:Envelope>

但我不想要SOAP头元素,我只需要包络体。如何从WCF消息中删除头元素?

选项1:使用bacicHttpBinding,它不会向标题添加内容(未配置安全性时)

选项2:实现自定义的mesaage编码器并在那里剥离标题。 在此之前的任何地方都有可能wcf会添加标题。 在此处查看示例编码

这个问题很棘手:让我们一步一步来看

一些背景

Message类在其ToString()方法中写入其标头。 然后ToString()调用一个内部重载ToString(XmlDictionaryWriter writer) ,然后开始编写:

// System.ServiceModel.Channels.Message
internal void ToString(XmlDictionaryWriter writer)
{
    if (this.IsDisposed)
    {
        throw TraceUtility.ThrowHelperError(this.CreateMessageDisposedException(), this);
    }
    if (this.Version.Envelope != EnvelopeVersion.None)
    {
        this.WriteStartEnvelope(writer);
        this.WriteStartHeaders(writer);
        MessageHeaders headers = this.Headers;
        for (int i = 0; i < headers.Count; i++)
        {
            headers.WriteHeader(i, writer);
        }
        writer.WriteEndElement();
        MessageDictionary arg_60_0 = XD.MessageDictionary;
        this.WriteStartBody(writer);
    }
    this.BodyToString(writer);
    if (this.Version.Envelope != EnvelopeVersion.None)
    {
        writer.WriteEndElement();
        writer.WriteEndElement();
    }
}

this.WriteStartHeaders(writer); 无论标头数量多少,代码都会写入标头标签。 它在for循环之后由writer.WriteEndElement()匹配。 writer.WriteEndElement() 必须与正在写入的标头标记匹配,否则Xml文档将无效。

因此,我们无法覆盖虚拟方法来摆脱标头: WriteStartHeaders调用虚拟方法OnWriteStartHeaders但标签关闭会阻止关闭它。 我们必须更改整个ToString()方法以删除任何与头相关的结构,以达到:

- write start of envelope
- write start of body
- write body
- write end of body
- write end of envelope

解决方案

在上面的伪代码中,除了“写体”部分外,我们可以控制所有内容。 初始ToString(XmlDictionaryWriter writer)中调用的所有方法都是公共的,但BodyToString除外。 所以我们需要通过反思或任何适合您需求的方法来调用它。 编写没有标题的消息只会变成:

private void ProcessMessage(Message msg, XmlDictionaryWriter writer)
{
    msg.WriteStartEnvelope(writer); // start of envelope
    msg.WriteStartBody(writer); // start of body

    var bodyToStringMethod = msg.GetType()
        .GetMethod("BodyToString", BindingFlags.Instance | BindingFlags.NonPublic);
    bodyToStringMethod.Invoke(msg, new object[] {writer}); // write body

    writer.WriteEndElement(); // write end of body
    writer.WriteEndElement(); // write end of envelope
}

现在我们有了一种方法来获取没有标题的消息内容。 但是如何调用这种方法呢?

我们只希望没有标题的消息作为字符串

好的,我们不需要关心覆盖ToString()方法,然后调用该消息的初始写入。 只需在程序中创建一个方法,该方法接受一个Message和一个XmlDictionaryWriter并调用它来获取没有标题的消息。

我们希望ToString()方法返回没有标头的消息

这个有点复杂。 我们不能轻易地从Message类继承,因为我们需要从System.ServiceModel程序集中提取大量依赖项。 我不会在这个答案中去那里。

我们可以做的是使用一些框架的功能来创建围绕现有对象的代理 ,并拦截对原始对象的一些调用以替换/增强其行为:我习惯使用Castle Dynamic代理,所以让我们使用它。

我们想拦截ToString()方法,所以我们围绕我们正在使用的Message对象创建一个代理,并添加一个拦截器来用我们的实现替换MessageToString方法:

var msg = Message.CreateMessage(MessageVersion.Soap11, "*");
msg.Headers.Clear();

var proxyGenerator = new Castle.DynamicProxy.ProxyGenerator();
var proxiedMessage = proxyGenerator.CreateClassProxyWithTarget(msg, new ProxyGenerationOptions(),
    new ToStringInterceptor());

ToStringInterceptor需要做与初始ToString()方法几乎相同的事情,但是我们将使用上面定义的ProcessMessage方法:

public class ToStringInterceptor : IInterceptor
{
    public void Intercept(IInvocation invocation)
    {
        if (invocation.Method.Name != "ToString")
        {
            invocation.Proceed();
        }
        else
        {
            var result = string.Empty;
            var msg = invocation.InvocationTarget as Message;

            StringWriter stringWriter = new StringWriter(CultureInfo.InvariantCulture);
            XmlDictionaryWriter xmlDictionaryWriter =
                XmlDictionaryWriter.CreateDictionaryWriter(new XmlTextWriter(stringWriter));

            try
            {
                ProcessMessage(msg, xmlDictionaryWriter);
                xmlDictionaryWriter.Flush();
                result = stringWriter.ToString();
            }
            catch (XmlException ex)
            {
                result = "ErrorMessage";
            }
            invocation.ReturnValue = result;
        }
    }

    private void ProcessMessage(Message msg, XmlDictionaryWriter writer)
    {
        // same method as above
    }
}

我们在这里:调用消息的ToString()方法现在将返回一个没有标题的信封。 我们可以将消息传递给框架的其他部分并且知道它应该主要工作:对Message的一些内部管道的直接调用仍然可以产生初始输出但是缺少完全重新实现我们无法控制它。

注意事项

  • 这是删除我找到的标题的最短方法。 编写器中的头序列化不是仅在一个虚函数中处理的事实是一个大问题。 代码不会给你太多的蠕动空间。
  • 此实现不使用与MessageEncodingFallbackAwareXmlTextWriterToString()的原始实现中使用的XmlWriter相同的XmlWriter 这个类在System.ServiceModel中是内部的,将它拉出来留给读者作为练习。 因此,输出稍有不同,因为xml没有使用我使用的简单XmlTextWriter格式化。
  • 拦截器可以简单地解析从初始ToString()调用返回的xml,并在让值冒泡之前删除头节点。 这是另一种可行的解决方案

原始代码

public class ToStringInterceptor : IInterceptor
{
    public void Intercept(IInvocation invocation)
    {
        if (invocation.Method.Name != "ToString")
        {
            invocation.Proceed();
        }
        else
        {
            var result = string.Empty;
            var msg = invocation.InvocationTarget as Message;

            StringWriter stringWriter = new StringWriter(CultureInfo.InvariantCulture);
            XmlDictionaryWriter xmlDictionaryWriter =
                XmlDictionaryWriter.CreateDictionaryWriter(new XmlTextWriter(stringWriter));

            try
            {
                ProcessMessage(msg, xmlDictionaryWriter);
                xmlDictionaryWriter.Flush();
                result = stringWriter.ToString();
            }
            catch (XmlException ex)
            {
                result = "ErrorMessage";
            }
            invocation.ReturnValue = result;
        }
    }

    private void ProcessMessage(Message msg, XmlDictionaryWriter writer)
    {
        msg.WriteStartEnvelope(writer);
        msg.WriteStartBody(writer);

        var bodyToStringMethod = msg.GetType()
            .GetMethod("BodyToString", BindingFlags.Instance | BindingFlags.NonPublic);
        bodyToStringMethod.Invoke(msg, new object[] { writer });

        writer.WriteEndElement();
        writer.WriteEndElement();
    }
}

internal class Program
{
    private static void Main(string[] args)
    {
        var msg = Message.CreateMessage(MessageVersion.Soap11, "*");
        msg.Headers.Clear();

        var proxyGenerator = new Castle.DynamicProxy.ProxyGenerator();
        var proxiedMessage = proxyGenerator.CreateClassProxyWithTarget(msg, new ProxyGenerationOptions(),
            new ToStringInterceptor());

        var initialResult = msg.ToString();
        var proxiedResult = proxiedMessage.ToString();

        Console.WriteLine("Initial result");
        Console.WriteLine(initialResult);
        Console.WriteLine();
        Console.WriteLine("Proxied result");
        Console.WriteLine(proxiedResult);

        Console.ReadLine();
    }
}

我没有你的XmlBodyWriter,但你可以使用数据合同序列化程序或你的xml body writer但是诀窍是使用msg.WriteBody。 这将省略标题

var response = "Hello";            
Message msg = Message.CreateMessage(MessageVersion.Soap11, "*",response, new DataContractSerializer(response.GetType()));
msg.Headers.Clear();
var sb = new StringBuilder();
var xmlWriter = new XmlTextWriter(new StringWriter(sb));
msg.WriteBody(xmlWriter);

应该是这样的:

XmlDocument xml = new XmlDocument();
xml.LoadXml(myXmlString); // suppose that myXmlString contains "<Body>...</Body>"

XmlNodeList xnList = xml.SelectNodes("/Envelope/Body");
foreach (XmlNode xn in xnList)
{
  string binary1 = xn["Binary1"].InnerText;
  string binary2 = xn["Binary2"].InnerText;
  Console.WriteLine("Binary: {0} {1}", binary1 , binary2);
}

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM