如何在Web API中构建自定义格式化程序的默认格式化程序?

时间:2015-01-15 00:07:39

标签: c# asp.net asp.net-web-api

我正在研究.NET 4和Web API 2中的项目,将文件上载字段添加到已实现的控制器中。我发现默认情况下Web API不支持multipart / form-data POST请求,我需要编写自己的formatter类来处理它们。细

理想情况下,我想要做的是使用现有格式化程序填充模型,然后在返回对象之前添加文件数据。此文件上载字段附加到六个单独的模型,所有模型都非常复杂(包含类,枚举,指南等列表的类)。我遇到了一些障碍......

我尝试使用the source code for FormUrlEncodedMediaTypeFormatter.cs手动实现它。我发现它构造了每个字段的KeyValue对列表(我可以很容易地做到),然后使用FormUrlEncodedJson.Parse()解析它们。我无法使用FormUrlEncodedJson,因为它(由于某种原因?)标记为Internal

我开始实现自己的解析器,但当我遇到第50行时,我心里想:我必须做错了什么。 必须以某种方式用现有的Formatters填充对象,对吧?他们当然不希望我们为每一个模型编写一个新的格式化程序,或者更糟糕的是,编写我们自己更脆弱的FormUrlEncodedJson.Parse()版本?

我在这里缺少什么?我很难过。

// Multipart/form-data formatter adapted from: 
// http://stackoverflow.com/questions/17924655/how-create-multipartformformatter-for-asp-net-4-5-web-api
public class MultipartFormFormatter : FormUrlEncodedMediaTypeFormatter
{
    private const string StringMultipartMediaType = "multipart/form-data";
    //private const string StringApplicationMediaType = "application/octet-stream";

    public MultipartFormFormatter()
    {
        this.SupportedMediaTypes.Add(new MediaTypeHeaderValue(StringMultipartMediaType));
        //this.SupportedMediaTypes.Add(new MediaTypeHeaderValue(StringApplicationMediaType));
    }

    public override bool CanReadType(Type type)
    {
        return true;
    }

    public override bool CanWriteType(Type type)
    {
        return false;
    }

    public override async Task<object> ReadFromStreamAsync(Type type, Stream readStream, HttpContent content, IFormatterLogger formatterLogger)
    {
        var parts = await content.ReadAsMultipartAsync();
        var obj = Activator.CreateInstance(type);
        var propertiesFromObj = obj.GetType().GetRuntimeProperties().ToList();

        // *****
        // * Populate obj using FormUrlEncodedJson.Parse()? How do I do this?
        // *****

        foreach (var property in propertiesFromObj.Where(x => x.PropertyType == typeof(AttachedDocument)))
        {
            var file = parts.Contents.FirstOrDefault(x => x.Headers.ContentDisposition.Name.Contains(property.Name));

            if (file == null || file.Headers.ContentLength <= 0) continue;

            try
            {
                var fileModel = new AttachedDocument()
                {
                    ServerFilePath = ReadToTempFile(file.ReadAsStreamAsync().Result),
                };
                property.SetValue(obj, fileModel);
            }
            catch (Exception e)
            {
                // TODO: proper error handling
            }
        }

        return obj;
    }

    /// <summary>
    /// Reads a file from the stream and writes it to a temporary directory
    /// </summary>
    /// <param name="input"></param>
    /// <returns>The path of the written temporary file</returns>
    private string ReadToTempFile(Stream input)
    {
        var fileName = Path.GetTempFileName();
        var fileInfo = new FileInfo(fileName);
        fileInfo.Attributes = FileAttributes.Temporary;

        var buffer = new byte[16 * 1024];
        using (var writer = File.OpenWrite(fileName))
        {
            int read;
            while ((read = input.Read(buffer, 0, buffer.Length)) > 0)
            {
                writer.Write(buffer, 0, read);
            }
        }

        return fileName;
    }
}
编辑:经过太多时间的咀嚼之后,我得出的结论是,我想做的事情基本上是不可能的。在与老板交谈之后,我们决定最好的选择是制作一个接受文件的第二个控制器,然后将其与其余表格数据相关联,并将责任放在前面 - 最终开发人员要做更多的工作来支持这种情况。

我对Web API的设计人员非常失望,因为这样一个常见的用例如此困难(如果可能的话!)就可以了。

1 个答案:

答案 0 :(得分:0)

它确实支持MultiPart / FormPost数据:

所有关于使用Web API控制器的HttpContext,并且在请求中您将填充文件集合,并且当数据也被发布时,您可以访问数据。

下面是我用来上传个人资料图片和数据对象的示例:

[Route("UploadUserImage", Name = "UploadUserImage")]
[HttpPost]
public async Task<dynamic> PostUploadUserImage(UserInfo userInformation)
{
    foreach (string fileKey in HttpContext.Current.Request.Files.Keys)
    {
        HttpPostedFile file = HttpContext.Current.Request.Files[fileKey];
        if (file.ContentLength <= 0)
            continue; //Skip unused file controls.

        //The resizing settings can specify any of 30 commands.. See http://imageresizing.net for details.
        //Destination paths can have variables like <guid> and <ext>, or
        //even a santizied version of the original filename, like <filename:A-Za-z0-9>
        ImageResizer.ImageJob i = new ImageResizer.ImageJob(file, "~/image-uploads/<guid>.<ext>", new ImageResizer.ResizeSettings(
                    "width=2000;height=2000;format=jpg;mode=max"));
        i.CreateParentDirectory = true; //Auto-create the uploads directory.
        i.Build();

        var fileNameArray = i.FinalPath.Split(@"\".ToCharArray());
        var fileName = fileNameArray[fileNameArray.Length - 1];

        userInformation.profilePictureUrl = String.Format("/services/image-uploads/{0}",fileName);

        return userInformation;
    }
    return null;
}