自定义datacontract / datamember名称

时间:2009-07-13 11:05:10

标签: wcf datacontract datamember

我有以下问题。客户请求以下列格式返回数据的Web服务:

<status>
 <name1>Some name</name1>
 ...
</status>

但是当发生错误时,他们希望收到以下消息:

<status>
 <error>Error description</error>
</status>

我使用WCF创建了一个Web服务,为了满足要求,我定义了以下服务合同:


    [ServiceContract]
    public interface IPatronStatus
    {
        [OperationContract]
        [ServiceKnownType("GetKnownTypes", typeof(KnownTypesProvider))]
        [WebGet(UriTemplate = "/service/status?user={unilogin}")]
        StatusData GetPatronStatus(string unilogin);
    }

还定义了以下基类:


    [DataContract(Name="status")]
    public class StatusData
    {

    }

两个来自不同的班级:


public class PatronStatusData : StatusData
{
        private string _name;
        [DataMember(Name = "name1", Order = 0)]
        public string Name
        {
            get { return _name; }
            set { _name = value; }
        } 
...
}


public class UniLoginNotFoundError : StatusData 
    {
        public UniLoginNotFoundError()
        { }

        private string _description = "UniLoginNotFoundError";
        [DataMember(Name = "error", Order = 0)]
        public string Description
        {
            get 
            {
                return _description;
            }

        }
    }

问题在于,当我从Web服务中提取数据时,将忽略数据协定名称(“status”)和数据成员的名称,并使用类型和属性的名称。

是否可以使用客户名称?

2 个答案:

答案 0 :(得分:8)

你应该使用DataContract(Name =“Something”)来装饰UniLoginNotFoundError和PatronStatusData以使其工作。但是不允许您为它们设置相同的名称(“状态”)。 在您的特定情况下,我最好使用单个类,将未使用的属性设置为null。

[DataContract(Name="status")]
public class StatusData
{
    private string _name;
    private string _errorDescription = null;


    [DataMember(Name = "name1", Order = 0, EmitDefaultValue=false)]
    public string Name
    {
        get { return _name; }
        set { _name = value; }
    }


    [DataMember(Name = "error", Order = 1, EmitDefaultValue=false)]
    public string Description
    {
        get{ return _errorDescription ;}
        set {_errorDescription =value ;}
    }
...
}

答案 1 :(得分:0)

一般来说,想要对通过序列化数据合同生成的XML进行过多控制是错误的。这是XML Serializer的陷阱。以一般术语定义合同,让客户只使用结果,这通常很简单。