在 ASP.NET MVC 中记录原始 HTTP 请求/响应 IIS7

Question

我正在编写一个 Web 服务（使用 ASP.NET MVC），出于支持目的，我们希望能够以尽可能接近原始的在线格式（即包括 HTTP方法、路径、所有标头和正文）存入数据库。

我不确定如何以最少“损坏”的方式获取这些数据。 我可以通过检查 HttpRequest 对象的所有属性并从中构建一个字符串（对于响应也类似）来重新构建我认为请求的样子，但我真的很想掌握通过线路发送的实际请求/响应数据。

我很乐意使用任何拦截机制，例如过滤器、模块等，并且该解决方案可以特定于 IIS7。 但是，我更愿意仅将其保留在托管代码中。

有什么建议吗？

编辑：我注意到HttpRequest有一个SaveAs 方法，可以将请求保存到磁盘，但这会使用无法公开访问的内部辅助方法负载从内部状态重建请求（我不知道为什么这不允许保存到用户提供的流）。 所以看起来我必须尽力从对象中重建请求/响应文本......呻吟。

编辑2：请注意，我说的是整个请求，包括方法、路径、标头等。当前响应仅查看不包含此信息的正文流。

编辑3：没有人阅读这里的问题吗？ 到目前为止有五个答案，但没有一个甚至暗示一种获取整个原始在线请求的方法。 是的，我知道我可以捕获输出流、标头、URL 以及请求对象中的所有内容。 我已经在问题中说过了，请参阅：

我可以通过检查 HttpRequest 对象的所有属性并从中构建一个字符串（对于响应也类似）来重新构建我认为请求的样子，但我真的很想掌握实际的请求/通过线路发送的响应数据。

如果您知道无法检索完整原始数据（包括标头、url、http 方法等），那么了解这一点将会很有用。 同样，如果您知道如何以原始格式获取所有内容（是的，我的意思仍然是包括标头、url、http 方法等），而无需重建它（这就是我所要求的），那么这将非常有用。 但是告诉我可以从 HttpRequest/HttpResponse 对象重建它是没有用的。 我知道。 我已经说过了。

---

请注意：在有人开始说这是一个坏主意，或者会限制可扩展性等之前，我们还将在分布式环境中实现节流、顺序交付和反重放机制，因此需要数据库日志记录反正。 我并不是在寻求讨论这是否是一个好主意，而是在寻找如何实现它。

Answer 1

一定要使用 IHttpModule 并实现 BeginRequest 和 EndRequest 事件。

所有“原始”数据都存在于 HttpRequest 和 HttpResponse 之间，只是不是单一的原始格式。 以下是构建 Fiddler 风格转储所需的部分（大约尽可能接近原始 HTTP）：

request.HttpMethod + " " + request.RawUrl + " " + request.ServerVariables["SERVER_PROTOCOL"]
request.Headers // loop through these "key: value"
request.InputStream // make sure to reset the Position after reading or later reads may fail

对于响应：

"HTTP/1.1 " + response.Status
response.Headers // loop through these "key: value"

请注意，您无法读取响应流，因此您必须添加一个过滤器输出流并捕获副本。

在 BeginRequest 中，您需要添加一个响应过滤器：

HttpResponse response = HttpContext.Current.Response;
OutputFilterStream filter = new OutputFilterStream(response.Filter);
response.Filter = filter;

将 filter 存储在您可以在 EndRequest 处理程序中访问的位置。 我建议在 HttpContext.Items 中。 然后可以在filter.ReadStream()中获取完整的响应数据。

然后使用装饰器模式作为流的包装器来实现OutputFilterStream：

/// <summary>
/// A stream which keeps an in-memory copy as it passes the bytes through
/// </summary>
public class OutputFilterStream : Stream
{
    private readonly Stream InnerStream;
    private readonly MemoryStream CopyStream;

    public OutputFilterStream(Stream inner)
    {
        this.InnerStream = inner;
        this.CopyStream = new MemoryStream();
    }

    public string ReadStream()
    {
        lock (this.InnerStream)
        {
            if (this.CopyStream.Length <= 0L ||
                !this.CopyStream.CanRead ||
                !this.CopyStream.CanSeek)
            {
                return String.Empty;
            }

            long pos = this.CopyStream.Position;
            this.CopyStream.Position = 0L;
            try
            {
                return new StreamReader(this.CopyStream).ReadToEnd();
            }
            finally
            {
                try
                {
                    this.CopyStream.Position = pos;
                }
                catch { }
            }
        }
    }


    public override bool CanRead
    {
        get { return this.InnerStream.CanRead; }
    }

    public override bool CanSeek
    {
        get { return this.InnerStream.CanSeek; }
    }

    public override bool CanWrite
    {
        get { return this.InnerStream.CanWrite; }
    }

    public override void Flush()
    {
        this.InnerStream.Flush();
    }

    public override long Length
    {
        get { return this.InnerStream.Length; }
    }

    public override long Position
    {
        get { return this.InnerStream.Position; }
        set { this.CopyStream.Position = this.InnerStream.Position = value; }
    }

    public override int Read(byte[] buffer, int offset, int count)
    {
        return this.InnerStream.Read(buffer, offset, count);
    }

    public override long Seek(long offset, SeekOrigin origin)
    {
        this.CopyStream.Seek(offset, origin);
        return this.InnerStream.Seek(offset, origin);
    }

    public override void SetLength(long value)
    {
        this.CopyStream.SetLength(value);
        this.InnerStream.SetLength(value);
    }

    public override void Write(byte[] buffer, int offset, int count)
    {
        this.CopyStream.Write(buffer, offset, count);
        this.InnerStream.Write(buffer, offset, count);
    }
}

Answer 2

HttpRequest 上的以下扩展方法将创建一个可以粘贴到 fiddler 中并重播的字符串。

namespace System.Web
{
    using System.IO;

    /// <summary>
    /// Extension methods for HTTP Request.
    /// <remarks>
    /// See the HTTP 1.1 specification http://www.w3.org/Protocols/rfc2616/rfc2616.html
    /// for details of implementation decisions.
    /// </remarks>
    /// </summary>
    public static class HttpRequestExtensions
    {
        /// <summary>
        /// Dump the raw http request to a string. 
        /// </summary>
        /// <param name="request">The <see cref="HttpRequest"/> that should be dumped.       </param>
        /// <returns>The raw HTTP request.</returns>
        public static string ToRaw(this HttpRequest request)
        {
            StringWriter writer = new StringWriter();

            WriteStartLine(request, writer);
            WriteHeaders(request, writer);
            WriteBody(request, writer);

            return writer.ToString();
        }

        private static void WriteStartLine(HttpRequest request, StringWriter writer)
        {
            const string SPACE = " ";

            writer.Write(request.HttpMethod);
            writer.Write(SPACE + request.Url);
            writer.WriteLine(SPACE + request.ServerVariables["SERVER_PROTOCOL"]);
        }

        private static void WriteHeaders(HttpRequest request, StringWriter writer)
        {
            foreach (string key in request.Headers.AllKeys)
            {
                writer.WriteLine(string.Format("{0}: {1}", key, request.Headers[key]));
            }

            writer.WriteLine();
        }

        private static void WriteBody(HttpRequest request, StringWriter writer)
        {
            StreamReader reader = new StreamReader(request.InputStream);

            try
            {
                string body = reader.ReadToEnd();
                writer.WriteLine(body);
            }
            finally
            {
                reader.BaseStream.Position = 0;
            }
        }
    }
}

Answer 3

您可以使用 ALL_RAW 服务器变量来获取随请求发送的原始 HTTP 标头，然后您可以照常获取 InputStream：

string originalHeader = HttpHandler.Request.ServerVariables["ALL_RAW"];

查看： http://msdn.microsoft.com/en-us/library/ms524602%28VS.90%29.aspx

Answer 4

好吧，我正在开发一个项目，并使用请求参数进行了日志记录（也许不是太深）：

看一下：

public class LogAttribute : ActionFilterAttribute
{
    private void Log(string stageName, RouteData routeData, HttpContextBase httpContext)
    {
        //Use the request and route data objects to grab your data
        string userIP = httpContext.Request.UserHostAddress;
        string userName = httpContext.User.Identity.Name;
        string reqType = httpContext.Request.RequestType;
        string reqData = GetRequestData(httpContext);
        string controller = routeData["controller"];
        string action = routeData["action"];

        //TODO:Save data somewhere
    }

    //Aux method to grab request data
    private string GetRequestData(HttpContextBase context)
    {
        StringBuilder sb = new StringBuilder();

        for (int i = 0; i < context.Request.QueryString.Count; i++)
        {
            sb.AppendFormat("Key={0}, Value={1}<br/>", context.Request.QueryString.Keys[i], context.Request.QueryString[i]);
        }

        for (int i = 0; i < context.Request.Form.Count; i++)
        {
            sb.AppendFormat("Key={0}, Value={1}<br/>", context.Request.Form.Keys[i], context.Request.Form[i]);
        }

        return sb.ToString();
    }

您可以装饰控制器类以完全记录它：

[Log]
public class TermoController : Controller {...}

或仅记录一些单独的操作方法

[Log]
public ActionResult LoggedAction(){...}

Answer 5

您需要将其保留在托管代码中有什么原因吗？

值得一提的是，您可以启用 如果您不喜欢重新发明轮子，则在 IIS7 中跟踪日志记录失败。 这会记录标头、请求和响应正文以及许多其他内容。

Answer 6

我采用了 McKAMEY 的方法。 这是我编写的一个模块，可以帮助您入门并希望为您节省一些时间。 显然，您需要使用适合您的东西来插入记录器：

public class CaptureTrafficModule : IHttpModule
{
    public void Init(HttpApplication context)
    {
        context.BeginRequest += new EventHandler(context_BeginRequest);
        context.EndRequest += new EventHandler(context_EndRequest);
    }

    void context_BeginRequest(object sender, EventArgs e)
    {
        HttpApplication app = sender as HttpApplication;

        OutputFilterStream filter = new OutputFilterStream(app.Response.Filter);
        app.Response.Filter = filter;

        StringBuilder request = new StringBuilder();
        request.Append(app.Request.HttpMethod + " " + app.Request.Url);
        request.Append("\n");
        foreach (string key in app.Request.Headers.Keys)
        {
            request.Append(key);
            request.Append(": ");
            request.Append(app.Request.Headers[key]);
            request.Append("\n");
        }
        request.Append("\n");

        byte[] bytes = app.Request.BinaryRead(app.Request.ContentLength);
        if (bytes.Count() > 0)
        {
            request.Append(Encoding.ASCII.GetString(bytes));
        }
        app.Request.InputStream.Position = 0;

        Logger.Debug(request.ToString());
    }

    void context_EndRequest(object sender, EventArgs e)
    {
        HttpApplication app = sender as HttpApplication;
        Logger.Debug(((OutputFilterStream)app.Response.Filter).ReadStream());
    }

    private ILogger _logger;
    public ILogger Logger
    {
        get
        {
            if (_logger == null)
                _logger = new Log4NetLogger();
            return _logger;
        }
    }

    public void Dispose()
    {
        //Does nothing
    }
}

Answer 7

好的，所以看起来答案是“不，你无法获取原始数据，你必须根据解析对象的属性重建请求/响应”。 哦，好吧，我已经完成了重建工作。

Answer 8

使用 IHttpModule：

    namespace Intercepts
{
    class Interceptor : IHttpModule
    {
        private readonly InterceptorEngine engine = new InterceptorEngine();

        #region IHttpModule Members

        void IHttpModule.Dispose()
        {
        }

        void IHttpModule.Init(HttpApplication application)
        {
            application.EndRequest += new EventHandler(engine.Application_EndRequest);
        }
        #endregion
    }
}

    class InterceptorEngine
    {       
        internal void Application_EndRequest(object sender, EventArgs e)
        {
            HttpApplication application = (HttpApplication)sender;

            HttpResponse response = application.Context.Response;
            ProcessResponse(response.OutputStream);
        }

        private void ProcessResponse(Stream stream)
        {
            Log("Hello");
            StreamReader sr = new StreamReader(stream);
            string content = sr.ReadToEnd();
            Log(content);
        }

        private void Log(string line)
        {
            Debugger.Log(0, null, String.Format("{0}\n", line));
        }
    }

Answer 9

如果偶尔使用，为了绕过困境，像下面这样简单的东西怎么样？

Public Function GetRawRequest() As String
    Dim str As String = ""
    Dim path As String = "C:\Temp\REQUEST_STREAM\A.txt"
    System.Web.HttpContext.Current.Request.SaveAs(path, True)
    str = System.IO.File.ReadAllText(path)
    Return str
End Function

Answer 10

您可以在 DelegatingHandler 中完成此操作，而无需使用 .NET 4.5 中其他答案中提到的 OutputFilter，使用 Stream.CopyToAsync() 函数。

我不确定细节，但它不会触发您尝试直接读取响应流时发生的所有不好的事情。

例子：

public class LoggingHandler : DelegatingHandler
{
    protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
    {
        DoLoggingWithRequest(request);
        var response = await base.SendAsync(request, cancellationToken);
        await DoLoggingWithResponse(response);
        return response;
    }

    private async Task DologgingWithResponse(HttpResponseMessage response) {
        var stream = new MemoryStream();
        await response.Content.CopyToAsync(stream).ConfigureAwait(false);     
        DoLoggingWithResponseContent(Encoding.UTF8.GetString(stream.ToArray()));

        // The rest of this call, the implementation of the above method, 
        // and DoLoggingWithRequest is left as an exercise for the reader.
    }
}

Answer 11

MVC 之前的 HttpRequest 和 HttpResponse 曾经有一个 GetInputStream() 和 GetOutputStream() 可用于此目的目的。 还没有研究过 MVC 中的那些部分，所以我不确定它们是否可用，但可能是一个想法:)

Answer 12

我知道它不是托管代码，但我会建议使用 ISAPI 过滤器。 自从我有幸维护自己的 ISAPI 以来已经有几年了，但据我记得，无论是在 ASP.Net 完成它之前还是之后，您都可以访问所有这些东西。

http://msdn.microsoft.com/en-us/library/ms524610。 aspx

如果 HTTPModule 不足以满足您的需要，那么我认为没有任何托管方法可以按所需的详细程度执行此操作。 虽然这样做会很痛苦。

Answer 13

我同意其他人的观点，使用 IHttpModule。 看看这个问题的答案，它的作用与您所问的几乎相同。 它记录请求和响应，但没有标头。

如何跟踪 ScriptService WebService 请求？

Answer 14

最好在应用程序之外执行此操作。 您可以设置反向代理来执行类似的操作（以及更多操作）。 反向代理基本上是位于服务器机房中的 Web 服务器，位于 Web 服务器和客户端之间。 请参阅http://en.wikipedia.org/wiki/Reverse_proxy

Answer 15

同意 FigmentEngine 的观点，IHttpModule 似乎是可行的方法。

查看httpworkerrequest、readentitybody 和GetPreloadedEntityBody。

要获取 httpworkerrequest，您需要执行以下操作：

(HttpWorkerRequest)inApp.Context.GetType().GetProperty("WorkerRequest", bindingFlags).GetValue(inApp.Context, null);

其中 inApp 是 httpapplication 对象。