6

我正在尝试创建一个通用函数，当给定枚举类型时，它将返回一个对象，当 WebApi 序列化该对象时，它将提供漂亮的 XML/Json 输出。

当序列化为 JSON 时，此方法工作得非常好，但我无法让它与 XML 一起使用。如果我使用 XmlSerializer 或 DataContractSerializer 手动序列化返回的对象，我会得到预期的结果。另一方面，当 WebApi 本身尝试从 HttpRequest 序列化它时，我收到如下错误：

System.Runtime.Serialization.SerializationException

不应使用数据合同名称“优先级：http://schemas.datacontract.org/2004/07/”键入“优先级”。考虑使用 DataContractResolver 或将任何静态未知的类型添加到已知类型列表中 - 例如，通过使用 KnownTypeAttribute 属性或将它们添加到传递给 DataContractSerializer 的已知类型列表中。

我尝试使用 GlobalConfiguration.Configuration.Formatters.XmlFormatter.SetSerializer 为生成的类型设置序列化程序，我知道它可以通过设置断点来工作，但它似乎忽略了它并引发了相同的异常。枚举将由整数支持，并保证每个条目都有唯一的值。这是我用来生成类型并返回它的实例的代码。

public object GetSerializableEnumProxy( Type enumType ) {

    if ( enumType == null ) {
        throw new ArgumentNullException( "enumType" );
    }

    if ( !enumType.IsEnum ) {
        throw new InvalidOperationException();
    }

    AssemblyName assemblyName = new AssemblyName("DataBuilderAssembly");
    AssemblyBuilder assemBuilder = AppDomain.CurrentDomain.DefineDynamicAssembly(assemblyName, AssemblyBuilderAccess.Run);
    ModuleBuilder moduleBuilder = assemBuilder.DefineDynamicModule("DataBuilderModule");
    TypeBuilder typeBuilder = moduleBuilder.DefineType( enumType.Name, TypeAttributes.Class | TypeAttributes.Public );

    // Add the [DataContract] attribute to our generated type
    typeBuilder.SetCustomAttribute(
        new CustomAttributeBuilder( typeof(DataContractAttribute).GetConstructor( Type.EmptyTypes ), new object[] {} )
    );

    CustomAttributeBuilder dataMemberAttributeBuilder = new CustomAttributeBuilder(
        typeof(DataMemberAttribute).GetConstructor(Type.EmptyTypes), new object[] {}
    );

    // For each name in the enum, define a corresponding public int field
    // with the [DataMember] attribute
    foreach ( var value in Enum.GetValues(enumType).Cast<int>() ) {
        var name = Enum.GetName( enumType, value );

        var fb = typeBuilder.DefineField( name, typeof(int), FieldAttributes.Public );

        // Add the [DataMember] attribute to the field
        fb.SetCustomAttribute( dataMemberAttributeBuilder );

        // Set the value of our field to be the corresponding value from the Enum
        fb.SetConstant( value );
    }       

    // Return an instance of our generated type
    return Activator.CreateInstance( typeBuilder.CreateType() );
}

Web API 控制器方法：

private static IEnumerable<Type> RetrievableEnums = new Type[] {
    typeof(Priority), typeof(Status)
};

[GET("enum/{enumName}")]
public HttpResponseMessage GetEnumInformation( string enumName ) {

    Type enumType = RetrievableEnums.SingleOrDefault( type =>
        String.Equals( type.Name, enumName, StringComparison.InvariantCultureIgnoreCase));

    if ( enumType == null ) {
        return Request.CreateErrorResponse( HttpStatusCode.NotFound, "The requested enum could not be retrieved" );
    }

    return Request.CreateResponse( HttpStatusCode.OK, GetSerializableEnumProxy(enumType) );
}

有任何想法吗？

4

1 回答 1

8

我相信这最终是因为您将枚举值作为object- 发送，并且与 Json 格式化程序不同，Web API 的 xml 格式化程序使用DataContractSerializer, 使用（实际上）被序列化的值的编译时类型，而不是运行时类型.

因此，您必须始终确保您尝试序列化的任何派生类型都添加到底层序列化程序的已知类型中。在这种情况下，您有动态枚举（object当然是 ）。

从表面上看，该方法似乎应该可行，但是，我敢打赌，您将动态类型作为第一个参数调用它-如果您将枚举发送为，SetSerializer(type, serializer)则该方法将不起作用-因为它是序列化程序将使用。objectobjectXmlRequestFormatter

这是一个众所周知的问题 -我已将其报告为 codeplex 上的问题（那里有一个很好的示例，它在更简单的场景中演示了该问题）。

XmlMediaTypeFormatter该问题还包括一些用于属性的 C# 代码和(称为)的替换，XmlMediaTypeFormatterEx它为该问题提供了一种解决方案 - 它使用声明性的每个操作方法。用代码中的那个替换XmlMediaTypeFormatter- 使用类似这样的东西（注意这段代码处理了没有定义 XML 格式化程序的情况 - 可能有点毫无意义）：

var configuration = GlobalConfiguration.Configuration;  
var origXmlFormatter = configuration.Formatters.OfType<XmlMediaTypeFormatter>()
                       .SingleOrDefault();

XmlMediaTypeFormatterEx exXmlFormatter = new XmlMediaTypeFormatterEx(origXmlFormatter);

if (origXmlFormatter != null)
{
    configuration.Formatters.Insert(
      configuration.Formatters.IndexOf(origXmlFormatter), exXmlFormatter);
    configuration.Formatters.Remove(origXmlFormatter);
}
else
    configuration.Formatters.Add(exXmlFormatter);

现在，在您想要返回此动态枚举的 API 方法上，您将使用以下内容进行装饰：

[XmlUseReturnedUnstanceType]
public object Get()
{

}

现在，无论您从该Get方法返回什么类型，自定义格式化程序都会启动并DataContractSerializer专门为运行时类型使用 a，而不是object.

这不处理基数的可枚举或字典 - 它变得非常复杂 - 但对于基本的单实例返回值它工作正常。

于 2012-12-17T10:43:47.697 回答