WCF,XmlRoot和可选参数

时间:2010-02-05 15:04:14

标签: wcf xml-deserialization xmlroot

我有一个WCF服务,不能使用DataContracts,因为我需要更多地控制收到并发送到此服务的XML。因此,我使用XmlRoot和XmlElement ...我现在遇到的问题是我的类接收xml被反序列化并且序列化响应都需要具有相同的根名称,并且当我尝试设置时这两个类都包含:

[XmlRoot(ElementName = "myRoot")] 

我收到一条错误消息,指出已经使用了根名称。有一个简单的解决方法吗?我尝试将我的响应类放在一个单独的命名空间中,但似乎没有用。

如果我的响应类中没有设置某些变量被序列化,那么我不会将它们序列化并在响应中返回...是否有一个选项我缺少这样做...我能够使用DataContract执行此操作,但无法使用XmlElements

来解决这个问题

1 个答案:

答案 0 :(得分:0)

实现此目的的一种方法是拦截XML响应,并在反序列化之前将根元素名称更改为唯一的名称。使用自定义IClientMessageFormatter和操作的关联属性可以非常轻松地完成此操作。

我刚刚写了这个,所以“湿漆”和所有,但这是看起来像:

/// <summary>
/// An operation attribute that changes the XML root name in responses
/// </summary>
/// <example>
///     
/// [ServiceContract]
/// [XmlSerializerFormat]
/// public interface IRedBlueServiceApi
/// {
///     [OperationContract]
///     [WebGet(...)]
///     [XmlChangeRoot("RedResponse")]
///     RedResponse GetRed();
///
///     [OperationContract]
///     [WebGet(...)]
///     [XmlChangeRoot("BlueResponse")]
///     BlueResponse GetBlue();
/// }
/// 
/// [XmlRoot("RedResponse")]
/// public class RedResponse 
/// {...}
/// 
/// [XmlRoot("BlueResponse")]
/// public class BlueResponse 
/// {...}
/// </example>
[DefaultProperty("NewRootElementName")]
public class XmlChangeRootAttribute : Attribute, IOperationBehavior
{
    public XmlChangeRootAttribute(string newRootElementName)
    {
        NewRootElementName = newRootElementName;
    }

    public string NewRootElementName { get; set; }

    #region IOperationBehavior Members

    public void ApplyClientBehavior(OperationDescription operationDescription, ClientOperation clientOperation)
    {
        // Inject our xml root changer into the client request/response pipeline
        clientOperation.Formatter = new XmlRootChangeFormatter(clientOperation.Formatter, NewRootElementName);
    }

    #endregion

    #region Unrelated Overrides

    public void ApplyDispatchBehavior(OperationDescription operationDescription, DispatchOperation dispatchOperation)
    {
    }

    public void AddBindingParameters(OperationDescription operationDescription,
                                     BindingParameterCollection bindingParameters)
    {
    }

    public void Validate(OperationDescription operationDescription)
    {
    }

    #endregion
}

/// <summary>
/// A simple wrapper around an existing IClientMessageFormatter
/// that alters the XML root name before passing it along
/// </summary>
public class XmlRootChangeFormatter : IClientMessageFormatter
{
    private readonly IClientMessageFormatter _innerFormatter;
    private readonly string _newRootElementName;

    public XmlRootChangeFormatter(IClientMessageFormatter innerFormatter, string newRootElementName)
    {
        if (innerFormatter == null)
            throw new ArgumentNullException("innerFormatter");

        if (String.IsNullOrEmpty(newRootElementName))
            throw new ArgumentException("newRootElementName is null or empty");

        _innerFormatter = innerFormatter;
        _newRootElementName = newRootElementName;
    }

    #region IClientMessageFormatter Members

    public Message SerializeRequest(MessageVersion messageVersion, object[] parameters)
    {
        return _innerFormatter.SerializeRequest(messageVersion, parameters);
    }

    public object DeserializeReply(Message message, object[] parameters)
    {
        if (!message.IsEmpty)
        {
            var doc = XDocument.Load(message.GetReaderAtBodyContents());

            if (doc.Root == null)
                throw new SerializationException("Could not find root in WCF messasge " + message);

            // Change the root element name 
            doc.Root.Name = _newRootElementName;

            // Create a new 'duplicate' message with the modified XML
            var modifiedReply = Message.CreateMessage(message.Version, null, doc.CreateReader());
            modifiedReply.Headers.CopyHeadersFrom(message.Headers);
            modifiedReply.Properties.CopyProperties(message.Properties);

            message = modifiedReply;
        }

        return _innerFormatter.DeserializeReply(message, parameters);
    }

    #endregion
}