为什么Web API请求的主体只读一次?

时间:2012-10-22 22:50:06

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

我的目标是使用AuthorizationFilter或DelegatingHandler对Web API请求进行身份验证。我想在几个地方寻找客户端ID和身份验证令牌,包括请求正文。起初看起来这很容易,我可以做这样的事情

var task = _message.Content.ReadAsAsync<Credentials>();

task.Wait();

if (task.Result != null)
{
    // check if credentials are valid
}

问题是HttpContent只能读取一次。如果我在处理程序或过滤器中执行此操作,则在我的操作方法中无法使用该内容。我在StackOverflow上找到了一些答案,就像这个:Read HttpContent in WebApi controller解释它是故意这样的,但他们没有说明为什么。这似乎是一个非常严重的限制,阻止我在过滤器或处理程序中使用任何很酷的Web API内容解析代码。

这是技术限制吗?它是否试图阻止我做一件我没看到的非常糟糕的事情(?)?

死后:

我看了一下菲利普建议的来源。 ReadAsStreamAsync返回内部流,如果流支持,那么没有什么能阻止你调用Seek 。在我的测试中,如果我调用ReadAsAsync,那么就这样做了:

message.Content.ReadAsStreamAsync().ContinueWith(t => t.Result.Seek(0, SeekOrigin.Begin)).Wait();

自动模型绑定过程在点击我的动作方法时可以正常工作。我没有使用它,我选择了更直接的东西:

var buffer = new MemoryStream(_message.Content.ReadAsByteArrayAsync().WaitFor());
var formatters = _message.GetConfiguration().Formatters;
var reader = formatters.FindReader(typeof(Credentials), _message.Content.Headers.ContentType);
var credentials = reader.ReadFromStreamAsync(typeof(Credentials), buffer, _message.Content, null).WaitFor() as Credentials;

使用扩展方法(我在.NET 4.0中没有await关键字)

public static class TaskExtensions
{
    public static T WaitFor<T>(this Task<T> task)
    {
        task.Wait();
        if (task.IsCanceled) { throw new ApplicationException(); }
        if (task.IsFaulted) { throw task.Exception; }
        return task.Result;
    }
}

最后一个问题,HttpContent有一个硬编码的最大缓冲区大小:

internal const int DefaultMaxBufferSize = 65536;

因此,如果您的内容大于此值,则在尝试调用ReadAsByteArrayAsync之前,需要手动调用较大的LoadIntoBufferAsync。

2 个答案:

答案 0 :(得分:24)

你指出的答案并不完全准确。

您可以随时读取字符串(ReadAsStringAsync)或字节[](ReadAsByteArrayAsync),因为它们会在内部缓冲请求。

例如下面的虚拟处理程序:

public class MyHandler : DelegatingHandler
{
    protected override async System.Threading.Tasks.Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, System.Threading.CancellationToken cancellationToken)
    {
        var body = await request.Content.ReadAsStringAsync();
        //deserialize from string i.e. using JSON.NET

        return base.SendAsync(request, cancellationToken);
    }
}

同样适用于byte []:

public class MessageHandler : DelegatingHandler
{
    protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
    {
        var requestMessage = await request.Content.ReadAsByteArrayAsync();
        //do something with requestMessage - but you will have to deserialize from byte[]

        return base.SendAsync(request, cancellationToken);
    }
}

每个发布的内容在到达控制器时都不会为空。

答案 1 :(得分:2)

我将clientId和身份验证密钥放在标头中而不是内容中。

您可以根据需要多次阅读它们!