.NET 4.5 XmlSerializer,xsi:nillable属性和字符串值的问题

时间:2015-01-30 17:14:43

标签: c# oracle soap xmlserializer

StackOverflow的重要人物,请听我的请求:

我正在编写.NET 4.5库代码以与Oracle SalesCloud服务进行通信,并且我在C#对象上具有空字符串值的SOAP请求时遇到问题。

属性的XSD指定如下:

<xsd:element minOccurs="0" name="OneOfTheStringProperties" nillable="true" type="xsd:string" />

使用&#34;添加服务参考...&#34; VS2013中的实用程序并在我更新除OneOfTheStringProperties之外的其他内容时写入请求,输出为

<OneOfTheStringProperties xsi:nil="true></OneOfTheStringProperties>

在服务器端,这会导致两个问题。首先,由于也以这种方式指定了只读属性,因此服务器拒绝整个请求。其次,这意味着我可能会无意中消除我想要保留的值(除非我每次都发回每个属性......效率低下且编码很难。)

我的Google-fu在这方面很弱,而且我不想深入编写自定义XmlSerializer(以及随之而来的所有测试/边缘情况),除非它是最好的路由。

到目前为止,我能找到的最好的是遵循[Property] Specified模式。这样做,对于每个可用的字符串属性意味着我必须将以下内容添加到Reference.cs

中的定义
[System.Xml.Serialization.XmlIgnoreAttribute()]
public bool OneOfTheStringPropertiesSpecified 
{
    get { return !String.IsNullOrEmpty(OneOfTheStringProperties); }
    set { }
}

它有很多输入,但是它有效,并且SOAP消息的日志跟踪是正确的。

我希望就三种途径之一提供建议:

  1. 配置开关,特定的XmlSerializer覆盖或某些其他修复将阻止空字符串的.NET 4.5 XmlSerializer输出

  2. 类似于同样的秘密配方将会推出&#34;正确的&#34; XML,例如<OneOfTheStringProperties xsi:nil="true" />

  3. 创建扩展(或现有VS2013扩展)的目标教程,允许我右键单击字符串属性并插入以下模式:

    [System.Xml.Serialization.XmlIgnoreAttribute()]
    public bool [$StringProperty]Specified 
    {
        get { return !String.isNullOrEmpty([$StringProperty]); }
        set { }
    }
    
  4. 我也对任何其他建议持开放态度。如果只是使用正确的搜索条件(显然,我不是),那么也会非常感激。

    为了促进这一要求,知识的守护者,我提供了这个sacrificial goat

    添加澄清

    为了确保,我不是在寻找一键魔术子弹。作为一名开发人员,尤其是那些在基础结构经常因需求而发生变化的团队中工作的人,我知道需要做很多工作才能保证工作。

    我正在寻找的是每次我必须对结构进行刷新时的工作量的合理减少(对于其他人来说,是一个简化的配方来实现同样的事情。)例如,使用*指定表示为给定示例键入大约165个以上的字符。对于包含45个字符串字段的合同,这意味着我必须在每次模型更改时输入 7,425个字符 - 并且这对于一个服务对象来说是这样的!大约有10个字符串20个服务对象可供抢夺。

    右键单击的想法会将其减少到45次右键单击操作......更好。

    放在课堂上的自定义属性会更好,因为每次刷新只需要完成一次。

    理想情况下,app.config中的运行时设置将是一劳永逸的 - 并不是第一次实现的难度,因为它进入了库。

    我认为真正的答案是比一个近7500个字符/类更好的地方,可能不如简单的app.config设置好,但它要么在那里,要么我相信它可以制作。

2 个答案:

答案 0 :(得分:3)

这不是完美的解决方案,但是在45右键单击行中,您可以使用T4 Text Template在与生成的Web服务代码分开的分部类声明中生成XXXSpecified属性。

然后是单击右键 - &gt;运行自定义工具以在更新服务引用时重新生成XXXSpecified代码。

这是一个示例模板,它为给定命名空间中的类的所有字符串属性生成代码:

<#@ template debug="false" hostspecific="false" language="C#" #>
<#@ assembly name="System.Core" #>
<#@ assembly name="$(SolutionDir)<Path to assembly containing service objects>" #>
<#@ import namespace="System.Linq" #>
<#@ import namespace="System.Text" #>
<#@ import namespace="System.Collections.Generic" #>
<#@ import namespace="System.Reflection" #>
<#@ output extension=".cs" #>

<#
    string serviceObjectNamespace = "<Namespace containing service objects>";
#>

namespace <#= serviceObjectNamespace #> {

<#
        foreach (Type type in AppDomain.CurrentDomain.GetAssemblies()
                       .SelectMany(t => t.GetTypes())
                       .Where(t => t.IsClass && t.Namespace == serviceObjectNamespace)) {

        var properties = type.GetProperties().Where(p => p.PropertyType == typeof(string));
        if (properties.Count() > 0) {
#>

    public partial class <#= type.Name #> {

    <#
        foreach (PropertyInfo prop in properties) {
    #>

        [System.Xml.Serialization.XmlIgnoreAttribute()]
        public bool <#= prop.Name#>Specified 
        {
            get { return <#= prop.Name#> != null; }
            set { }
        }

    <#
        } 
    #>

    }

<#
    } }
#>

}

答案 1 :(得分:3)

以下是如何向WCF客户端添加自定义行为,可用于检查邮件并跳过属性。

这是以下各项的组合:

完整代码:

void Main()
{
    var endpoint = new Uri("http://somewhere/");

    var behaviours = new List<IEndpointBehavior>()
    {
        new SkipConfiguredPropertiesBehaviour(),
    };

    var channel = Create<IRemoteService>(endpoint, GetBinding(endpoint), behaviours);
    channel.SendData(new Data()
    {
        SendThis = "This should appear in the HTTP request.",
        DoNotSendThis = "This should not appear in the HTTP request.",
    });
}

[ServiceContract]
public interface IRemoteService
{
    [OperationContract]
    int SendData(Data d);
}

public class Data
{
    public string SendThis { get; set; }
    public string DoNotSendThis { get; set; }
}

public class SkipConfiguredPropertiesBehaviour : IEndpointBehavior
{
   public void AddBindingParameters(
        ServiceEndpoint endpoint,
        BindingParameterCollection bindingParameters)
    {
    }

    public void ApplyClientBehavior(
        ServiceEndpoint endpoint, 
        ClientRuntime clientRuntime)
    {
        clientRuntime.MessageInspectors.Add(new SkipConfiguredPropertiesInspector());
    }

    public void ApplyDispatchBehavior(
        ServiceEndpoint endpoint, 
        EndpointDispatcher endpointDispatcher)
    {
    }

    public void Validate(
        ServiceEndpoint endpoint)
    {
    }
}

public class SkipConfiguredPropertiesInspector : IClientMessageInspector
{
    public void AfterReceiveReply(
        ref Message reply, 
        object correlationState)
    {
        Console.WriteLine("Received the following reply: '{0}'", reply.ToString());
    }

    public object BeforeSendRequest(
        ref Message request, 
        IClientChannel channel)
    {     
        Console.WriteLine("Was going to send the following request: '{0}'", request.ToString());

        request = TransformMessage(request);

        return null;
    }

    private Message TransformMessage(Message oldMessage)
    {
        Message newMessage = null;
        MessageBuffer msgbuf = oldMessage.CreateBufferedCopy(int.MaxValue);
        XPathNavigator nav = msgbuf.CreateNavigator();

        //load the old message into xmldocument
        var ms = new MemoryStream();
        using(var xw = XmlWriter.Create(ms))
        {
            nav.WriteSubtree(xw);
            xw.Flush();
            xw.Close();
        }

        ms.Position = 0;
        XDocument xdoc = XDocument.Load(XmlReader.Create(ms));

        //perform transformation
        var elementsToRemove = xdoc.Descendants().Where(d => d.Name.LocalName.Equals("DoNotSendThis")).ToArray();

        foreach(var e in elementsToRemove)
        {
            e.Remove();
        }

        // have a cheeky read...
        StreamReader sr = new StreamReader(ms);
        Console.WriteLine("We're really going to write out: " + xdoc.ToString());

        //create the new message           
        newMessage = Message.CreateMessage(xdoc.CreateReader(), int.MaxValue, oldMessage.Version);

        return newMessage;
    }    
}

 public static T Create<T>(Uri endpoint, Binding binding, List<IEndpointBehavior> behaviors = null)
{
    var factory = new ChannelFactory<T>(binding);

    if (behaviors != null)
    {
        behaviors.ForEach(factory.Endpoint.Behaviors.Add);
    }

    return factory.CreateChannel(new EndpointAddress(endpoint));
}

public static BasicHttpBinding GetBinding(Uri uri)
{
    var binding = new BasicHttpBinding()
    {
        MaxBufferPoolSize = 524288000, // 10MB
        MaxReceivedMessageSize = 524288000,
        MaxBufferSize = 524288000,
        MessageEncoding = WSMessageEncoding.Text,
        TransferMode = TransferMode.Buffered,
        Security = new BasicHttpSecurity()
        {
            Mode = uri.Scheme == "http" ? BasicHttpSecurityMode.None : BasicHttpSecurityMode.Transport,
        }
    };

    return binding;
}

这是LinqPad脚本的链接:http://share.linqpad.net/kgg8st.linq

如果你运行它,输出将是:

Was going to send the following request: '<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header>
    <Action s:mustUnderstand="1" xmlns="http://schemas.microsoft.com/ws/2005/05/addressing/none">http://tempuri.org/IRemoteService/SendData</Action>
  </s:Header>
  <s:Body>
    <SendData xmlns="http://tempuri.org/">
      <d xmlns:d4p1="http://schemas.datacontract.org/2004/07/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <d4p1:DoNotSendThis>This should not appear in the HTTP request.</d4p1:DoNotSendThis>
        <d4p1:SendThis>This should appear in the HTTP request.</d4p1:SendThis>
      </d>
    </SendData>
  </s:Body>
</s:Envelope>'
We're really going to write out: <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header>
    <Action a:mustUnderstand="1" xmlns="http://schemas.microsoft.com/ws/2005/05/addressing/none" xmlns:a="http://schemas.xmlsoap.org/soap/envelope/">http://tempuri.org/IRemoteService/SendData</Action>
  </s:Header>
  <s:Body>
    <SendData xmlns="http://tempuri.org/">
      <d xmlns:a="http://schemas.datacontract.org/2004/07/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <a:SendThis>This should appear in the HTTP request.</a:SendThis>
      </d>
    </SendData>
  </s:Body>
</s:Envelope>