Откорректируйте MVC 4 WebApi XmlSerializer, чтобы потерять имяSpace
Я работаю над MVC WebAPI, который использует EF с классами POCO для хранения.
Я хочу избавиться от пространства имен из XML, так что конечные точки будут возвращать и принимать объекты xml без него. (json работает просто отлично)
<ACCOUNT xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Platform.Services.AccountService.Data">
<id>22</id>
<City i:nil="true"/>
<Country i:nil="true"/>
<Email>[email protected]</Email>
<Phone i:nil="true"/> ...
Я бы хотел, чтобы это работало
<ACCOUNT>
<id>22</id>
<City i:nil="true"/>
<Country i:nil="true"/>
<Email>[email protected]</Email>
<Phone i:nil="true"/> ...
Надеюсь, нам не нужно украшать POCO кучей атрибутов.
Я установил тестовое решение для этого, и действительно, эти методы поражены (должна быть какая-то другая проблема в моей системе). В любом случае - результат, который я получаю с помощью этих решений, таков:
<ArrayOfAccount>
<Account>
<id>22</id>
<name>TestAcc</name>
<parentid xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance" d3p1:nil="true"/>
<status_id xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance" d3p1:nil="true"/>
<Email>[email protected]</Email>
</Account>
</ArrayOfAccount>
Избавилась от схемы сверху, но свойства теперь перепутаны:(
Здесь ссылка на образец проекта
Ответы
Ответ 1
Этот ответ здесь находится на отметке Удалить пространство имен в XML из веб-API ASP.NET.\
Если вы не хотите украшать свой POCO, используйте 1-й вариант:
config.Formatters.XmlFormatter.UseXmlSerializer = true;
Если вы используете вариант 2, вам может потребоваться добавить ссылку на System.Runtime.Serialization
Предполагая, что сообщение вроде этого с помощью Accept set correct:
GET http://ANY OLD SERVER/api/foos/5
Accept: application/xml
контроллер
using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Runtime.Serialization;
using System.Web.Http;
namespace CutomXmlFormater.Controllers
{
//[DataContract(Namespace = "")]
public class Foo
{
//[DataMember]
public string Bar { get; set; }
}
public class FoosController : ApiController
{
// GET api/foos/5
public Foo Get(int id)
{
return new Foo() { Bar = "Test" };
}
}
}
Конфигурация (App_Start/WebApiConfig)
//(Use this is you don't go the data contact and model annotation route)
config.Formatters.XmlFormatter.UseXmlSerializer = true;
Результат
Либо (с аннотацией и контактом данных):
<Foo xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><Bar>Test</Bar></Foo>
Или (с помощью маршрута последователя XML):
<Foo xmlns:i="http://www.w3.org/2001/XMLSchema-instance"><Bar>Test</Bar></Foo>
Ответ 2
Возможно, вы могли бы попробовать:
Замените стандартный XmlFormatter по умолчанию:
GlobalConfiguration.Configuration.Formatters.Add(new CustomXmlFormatter());
GlobalConfiguration.Configuration.Formatters.Remove(GlobalConfiguration.Configuration.Formatters.XmlFormatter);
И импортируйте его с помощью XmlSerializer, указав пустое пространство имен во время сериализации, например:
public CustomXmlFormatter()
{
SupportedMediaTypes.Add(new MediaTypeHeaderValue("application/xml"));
SupportedMediaTypes.Add(new MediaTypeHeaderValue("text/xml"));
Encoding = new UTF8Encoding(false, true);
}
protected override bool CanReadType(Type type)
{
if (type == (Type)null)
throw new ArgumentNullException("type");
if (type == typeof(IKeyValueModel))
return false;
return true;
}
protected override bool CanWriteType(Type type)
{
return true;
}
protected override Task OnReadFromStreamAsync(Type type, Stream stream, HttpContentHeaders contentHeaders, FormatterContext formatterContext)
{
return Task.Factory.StartNew(() =>
{
using (var streamReader = new StreamReader(stream, Encoding))
{
var serializer = new XmlSerializer(type);
return serializer.Deserialize(streamReader);
}
});
}
protected override Task OnWriteToStreamAsync(Type type, object value, Stream stream, HttpContentHeaders contentHeaders, FormatterContext formatterContext, System.Net.TransportContext transportContext)
{
var serializer = new XmlSerializer(type);
return Task.Factory.StartNew(() =>
{
using (var streamWriter = new StreamWriter(stream, Encoding))
{
XmlSerializerNamespaces ns = new XmlSerializerNamespaces();
ns.Add("", "");
serializer.Serialize(streamWriter, value, ns);
}
});
}
}
Пользовательский XML-сериализатор был украден из здесь и как таковой непроверен.
Это должно сериализовать объекты без записи пространства имен. Я не уверен, что он будет работать OOTB для десериализации, вам, возможно, придется поэкспериментировать с XmlSerializer.Deserialize()
перегрузкой, которая предоставляет события, и обрабатывать UnknownElement или событие UnknownNode.
Ответ 3
Прошло некоторое время с тех пор, как я перепутал MVC 4, но в итоге мы заменили форматировщик по умолчанию на XmlSerializer следующим образом:
protected void Application_Start()
{
AreaRegistration.RegisterAllAreas();
FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
RouteConfig.RegisterRoutes(RouteTable.Routes);
BundleConfig.RegisterBundles(BundleTable.Bundles);
GlobalConfiguration.Configuration.Formatters.JsonFormatter.SerializerSettings = GetSerializeSettings();
GlobalConfiguration.Configuration.Formatters.XmlFormatter.UseXmlSerializer = true;
}
internal JsonSerializerSettings GetSerializeSettings()
{
return new JsonSerializerSettings
{
Formatting = Formatting.Indented,
ContractResolver = new CamelCasePropertyNamesContractResolver(),
Converters = new List<JsonConverter> { new IsoDateTimeConverter() }
};
}
Это может помочь... Я знаю, что мы также настроили имена свойств, используя атрибуты в POCOs, которые, как вы сказали, вы не хотите делать, но это потому, что мы хотели, чтобы они были на верблюжьей основе.
Ответ 4
Я настроил Бориса на MVC Webapi 5.
Используйте один из следующих заголовков http, чтобы сделать результат с помощью CustomFormatter:
accept: application/xml
accept: text/xml
WebApiConfig.cs:
public static class WebApiConfig
{
public static void Register(HttpConfiguration config)
{
config.Routes.MapHttpRoute(
name: "DefaultApi",
routeTemplate: "{controller}/{id}",
defaults: new { id = RouteParameter.Optional }
);
GlobalConfiguration.Configuration.Formatters.Add(new CustomXmlFormatter());
GlobalConfiguration.Configuration.Formatters.Remove(GlobalConfiguration.Configuration.Formatters.XmlFormatter);
}
}
CustomXmlFormatter.cs:
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Net.Http.Formatting;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using System.Web;
using System.Xml.Serialization;
namespace Custom.Formatter
{
public class CustomXmlFormatter: MediaTypeFormatter
{
private UTF8Encoding encoder;
public NotificationXmlFormatter()
{
SupportedMediaTypes.Add(new MediaTypeHeaderValue("application/xml"));
SupportedMediaTypes.Add(new MediaTypeHeaderValue("text/xml"));
encoder = new UTF8Encoding(false, true);
}
public override bool CanReadType(Type type)
{
if (type == (Type)null)
throw new ArgumentNullException("type");
//Type filtering
if (type == typeof(SendEmailMessageResponse) || type == typeof(SendSmsMessageResponse))
return true;
else
return false;
}
public override bool CanWriteType(Type type)
{
return true;
}
public override Task<object> ReadFromStreamAsync(Type type, Stream stream, HttpContent content, IFormatterLogger formatterLogger)
{
return Task.Factory.StartNew(() =>
{
using (var streamReader = new StreamReader(stream, encoder))
{
var serializer = new XmlSerializer(type);
return serializer.Deserialize(streamReader);
}
});
}
public override Task WriteToStreamAsync(Type type, object value, Stream stream, HttpContent content, TransportContext transportContext)
{
var serializer = new XmlSerializer(type);
return Task.Factory.StartNew(() =>
{
using (var streamWriter = new StreamWriter(stream, encoder))
{
XmlSerializerNamespaces ns = new XmlSerializerNamespaces();
ns.Add("", "");
serializer.Serialize(streamWriter, value, ns);
}
});
}
}
}