Вопрос по asp.net-mvc, xml, json, json.net, actionresult – Как передать XML как POST в ActionResult в ASP MVC .NET

10

Я пытаюсь предоставить простой RESTful API для моего проекта ASP MVC. У меня не будет контроля над клиентами этого API, они будут передавать XML через метод POST, который будет содержать информацию, необходимую для выполнения некоторых действий на стороне сервера, и предоставлять XML с результатом действия. У меня нет проблем с отправкой обратно XML, проблема в получении XML через POST. Я видел несколько примеров JSON, но так как я не буду контролировать своих клиентов (это может быть даже телнет с моей точки зрения), я не думаю, что JSON будет работать. Я прав?

Я видел примеры, когда клиенты просто создают правильный формат формы как часть тела запроса, а затем ASP анализирует сообщение, и данные доступны как FormCollection (? Param1 = value1 & amp; param2 = value2 & amp;; и т. Д.). Тем не менее, я хочу передать чистый XML как часть тела сообщения.

Спасибо за вашу помощь,

Ваш Ответ

7   ответов
3

IMO лучший способ сделать это - написать собственный поставщик значений, это фабрика, которая обрабатывает сопоставление запроса со словарем форм. Вы просто наследуете от ValueProviderFactory и обрабатываете запрос, если он имеет тип & # x201C; text / xml & # x201D; или & # x201C; application / xml. & # x201D;

Больше информации:

Фил Хаак

Мой блог

MSDN

protected override void OnApplicationStarted()
{
    AreaRegistration.RegisterAllAreas();

    RegisterRoutes(RouteTable.Routes);

    ValueProviderFactories.Factories.Add(new JsonValueProviderFactory());
    ValueProviderFactories.Factories.Add(new XmlValueProviderFactory());
}

XmlValueProviderFactory

using System;
using System.Collections.Generic;
using System.Globalization;
using System.Web.Mvc;
using System.Xml;
using System.Xml.Linq;

public class XmlValueProviderFactory : ValueProviderFactory
{

    public override IValueProvider GetValueProvider(ControllerContext controllerContext)
    {
        var deserializedXml = GetDeserializedXml(controllerContext);

        if (deserializedXml == null) return null;

        var backingStore = new Dictionary<string, object>(StringComparer.OrdinalIgnoreCase);

        AddToBackingStore(backingStore, string.Empty, deserializedXml.Root);

        return new DictionaryValueProvider<object>(backingStore, CultureInfo.CurrentCulture);

    }

    private static void AddToBackingStore(Dictionary<string, object> backingStore, string prefix, XElement xmlDoc)
    {
        // Check the keys to see if this is an array or an object
        var uniqueElements = new List<String>();
        var totalElments = 0;
        foreach (XElement element in xmlDoc.Elements())
        {
            if (!uniqueElements.Contains(element.Name.LocalName))
                uniqueElements.Add(element.Name.LocalName);
            totalElments++;
        }

        var isArray = (uniqueElements.Count == 1 && totalElments > 1);


        // Add the elements to the backing store
        var elementCount = 0;
        foreach (XElement element in xmlDoc.Elements())
        {
            if (element.HasElements)
            {
                if (isArray)
                    AddToBackingStore(backingStore, MakeArrayKey(prefix, elementCount), element);
                else
                    AddToBackingStore(backingStore, MakePropertyKey(prefix, element.Name.LocalName), element);
            }
            else
            {
                backingStore.Add(MakePropertyKey(prefix, element.Name.LocalName), element.Value);
            }
            elementCount++;
        }
    }


    private static string MakeArrayKey(string prefix, int index)
    {
        return prefix + "[" + index.ToString(CultureInfo.InvariantCulture) + "]";
    }

    private static string MakePropertyKey(string prefix, string propertyName)
    {
        if (!string.IsNullOrEmpty(prefix))
            return prefix + "." + propertyName;
        return propertyName;
    }

    private XDocument GetDeserializedXml(ControllerContext controllerContext)
    {
        var contentType = controllerContext.HttpContext.Request.ContentType;
        if (!contentType.StartsWith("text/xml", StringComparison.OrdinalIgnoreCase) &&
            !contentType.StartsWith("application/xml", StringComparison.OrdinalIgnoreCase))
            return null;

        XDocument xml;
        try
        {
            var xmlReader = new XmlTextReader(controllerContext.HttpContext.Request.InputStream);
            xml = XDocument.Load(xmlReader);
        }
        catch (Exception)
        {
            return null;
        }

        if (xml.FirstNode == null)//no xml.
            return null;

        return xml;
    }
}
9

@Freddy - понравился ваш подход и улучшил его с помощью следующего кода для упрощения потокового чтения:

    public override void OnActionExecuting(ActionExecutingContext filterContext)
    {
        HttpContextBase httpContext = filterContext.HttpContext;
        if (!httpContext.IsPostNotification)
        {
            throw new InvalidOperationException("Only POST messages allowed on this resource");
        }

        Stream httpBodyStream = httpContext.Request.InputStream;
        if (httpBodyStream.Length > int.MaxValue)
        {
            throw new ArgumentException("HTTP InputStream too large.");
        }

        StreamReader reader = new StreamReader(httpBodyStream, Encoding.UTF8);
        string xmlBody = reader.ReadToEnd();
        reader.Close();

        filterContext.ActionParameters["message"] = xmlBody;

        // Sends XML Data To Model so it could be available on the ActionResult
        base.OnActionExecuting(filterContext);
    }

Затем в контроллере вы можете получить доступ к XML в виде строки:

[RestAPIAttribute]    
public ActionResult MyActionResult(string message)    
{         

}
Как вы отображаете / читаете XML?
Это параметр сообщения действия, показанного выше.
7

Это может быть достигнуто с помощью ActionFilterAttribute. Фильтры действий в основном пересекают запрос до или после результата действия. Поэтому я только что создал атрибут фильтра настраиваемого действия для результата действия POST. Вот что я сделал:

public class RestAPIAttribute : ActionFilterAttribute
{
    public override void OnActionExecuting(ActionExecutingContext filterContext)
    {
        HttpContextBase httpContext = filterContext.HttpContext;
        if (!httpContext.IsPostNotification)
        {
            throw new InvalidOperationException("Only POST messages allowed on this resource");
        }
        Stream httpBodyStream = httpContext.Request.InputStream;

        if (httpBodyStream.Length > int.MaxValue)
        {
            throw new ArgumentException("HTTP InputStream too large.");
        }

        int streamLength = Convert.ToInt32(httpBodyStream.Length);
        byte[] byteArray = new byte[streamLength];
        const int startAt = 0;

        /*
         * Copies the stream into a byte array
         */
        httpBodyStream.Read(byteArray, startAt, streamLength);

        /*
         * Convert the byte array into a string
         */
        StringBuilder sb = new StringBuilder();
        for (int i = 0; i < streamLength; i++)
        {
            sb.Append(Convert.ToChar(byteArray[i]));
        }

        string xmlBody = sb.ToString();

        //Sends XML Data To Model so it could be available on the ActionResult

        base.OnActionExecuting(filterContext);
    }
}

Затем на методе результата действия на вашем контроллере вы должны сделать что-то вроде этого:

    [RestAPIAttribute]
    public ActionResult MyActionResult()
    {
        //Gets XML Data From Model and do whatever you want to do with it
    }

Надеюсь, что это поможет кому-то еще, если вы думаете, что есть более изящные способы сделать это, дайте мне знать.

Я не понимаю, где модель определена в этом примере. Может кто-нибудь объяснить?
Преобразование байтового массива в строку действительно выглядит неэффективным ...System.Text.Encoding.UTF8.GetString(byteArray) могло быть лучше.
@Freddy Как вы получаете доступ к XML из запроса?
Ответ @Demodave, bowerm лучше иллюстрирует, как получить XML, используяActionParameters["message"] = xmlBodyкоторый, кажется, отсутствует в ответе Фредди
3

Почему они не могут передать XML как строку в форме сообщения?

Пример:

public ActionResult SendMeXml(string xml)
{
  //Parse into a XDocument or something else if you want, and return whatever you want.
  XDocument xmlDocument = XDocument.Parse(xml);

  return View();
}

Вы можете создать форму сообщения и отправить ее в одном поле формы.

Ваш клиент должен знать, по какому URL он будет отправлять запрос, так что не так уж и сложно сказать ему, какое поле формы использовать.
В этом случае клиент (ы) должен знать, как сервер будет обрабатывать запрос. Это не будет XML, это будет форма с вводимым текстом, который содержит XML. Это не будет RESTful решение. Freddy
Там не должно быть никаких форм, просто обычный XML. Речь идет не о том, какое поле формы использовать. Freddy
Тогда может быть что-то вроде этого:aleembawany.com/2009/03/27/…  Хотя, похоже, у вас уже есть что-то подобное. :)
2

Мне нравится ответ от @Freddy и улучшение от @Bowerm. Это сжато и сохраняет формат основанных на форме действий.

Но проверка IsPostNotification не будет работать в производственном коде. Он не проверяет HTTP-глагол, как кажется из сообщения об ошибке, и удаляется из контекста HTTP, когда для флага отладки компиляции установлено значение false. Это объясняется здесь: HttpContext.IsPostNotification - false, если отладка компиляции - false

Я надеюсь, что это спасет кого-то на 1/2 дня отладки маршрутов из-за этой проблемы. Вот решение без этой проверки:

public class XmlApiAttribute : ActionFilterAttribute
{
    public override void OnActionExecuting(ActionExecutingContext filterContext)
    {
        HttpContextBase httpContext = filterContext.HttpContext;
        // Note: for release code IsPostNotification stripped away, so don't check it!
        // https://stackoverflow.com/questions/28877619/httpcontext-ispostnotification-is-false-when-compilation-debug-is-false            

        Stream httpBodyStream = httpContext.Request.InputStream;
        if (httpBodyStream.Length > int.MaxValue)
        {
            throw new ArgumentException("HTTP InputStream too large.");
        }

        StreamReader reader = new StreamReader(httpBodyStream, Encoding.UTF8);
        string xmlBody = reader.ReadToEnd();
        reader.Close();

        filterContext.ActionParameters["xmlDoc"] = xmlBody;

        // Sends XML Data To Model so it could be available on the ActionResult
        base.OnActionExecuting(filterContext);
    }
}
...
public class MyXmlController 
{ ...
    [XmlApiAttribute]
    public JsonResult PostXml(string xmlDoc)
    {
...
люблю этот ответ. работал отлично
1

Ницца!,

Какой объект я получил в моем методе контроллера для управления Xml?

Я использую этот способ:

На actionFilter я заполняю модель:

        .
        .

        string xmlBody = sb.ToString();

        filterContext.Controller.ViewData.Model = xmlBody;

И на моем методе контроллера я получаю Модель как:

        string xmlUserResult = ViewData.Model as string;

        XmlSerializer ser = new XmlSerializer(typeof(UserDTO));
        StringReader stringReader = new StringReader(xmlUserResult);
        XmlTextReader xmlReader = new XmlTextReader(stringReader);
        UserDTO userToUpdate = ser.Deserialize(xmlReader) as UserDTO;
        xmlReader.Close();
        stringReader.Close();

Это правильная реализация?

Благодарю.

3

Я знаю, что вы можете создать собственную фабрику провайдеров значений. Это позволит вам также проверить свои модели, когда они будут опубликованы, прежде чем пытаться их сохранить.Фил Хаак В блоге есть JSON-версия этой же концепции. Единственная проблема заключается в том, что я не знаю, как реализовать такую же вещь для XML.

Похожие вопросы