Использовать промежуточное ПО OWIN или делегирующий MessgaeHandler для регистрации запросов / ответов API?

В моих старых не OWIN API я использую MessageHanlder для регистрации всех запросов HttpRequest и HttpResponses. Вот MessageHandler:

public class MessageHandler : DelegatingHandler
{
    private static readonly ILog RequestApiLogger = LogManager.GetLogger("RequestApiPacketLogger");
    private static readonly ILog ResponseApiLogger = LogManager.GetLogger("ResponseApiPacketLogger");

    protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
    {
        var correlationId = Guid.NewGuid();

        RequestApiLogger.LogHttpRequest(request, correlationId);

        return await base.SendAsync(request, cancellationToken).ContinueWith(
            task =>
            {
                var response = task.Result;
                response.Headers.Add("http-tracking-id", correlationId.ToString("D"));
                ResponseApiLogger.LogHttpResponse(response, correlationId);
                return response;

            }, cancellationToken);
    }
}

Тем не менее, в моих новых проектах я мог написать собственное промежуточное ПО OWIN, чтобы сделать что-то подобное, используя OwinContext, например:

//use an alias for the OWIN AppFunc
using AppFunc = Func<IDictionary<string, object>, Task>;

public class LoggingMiddleware
{
    private readonly AppFunc _next;

    public LoggingMiddleware(AppFunc next)
    {
        _next = next;
    }

    public async Task Invoke(IDictionary<string, object> environment)
    {
        IOwinContext context = new OwinContext(environment);

        // Get the identity 
        var identity = (context.Request.User != null && context.Request.User.Identity.IsAuthenticated)
            ? context.Request.User.Identity.Name
            : "(anonymous)";

        // Buffer the request (body is a string, we can use this to log the request later
        var requestBody = new StreamReader(context.Request.Body).ReadToEnd();
        var requestData = Encoding.UTF8.GetBytes(requestBody);
        context.Request.Body = new MemoryStream(requestData);

        var apiPacket = new ApiPacket
        {
            CallerIdentity = identity,
            Request = requestBody,
            RequestLength = context.Request.Body.Length
        };

        // Buffer the response
        var responseBuffer = new MemoryStream();
        var responseStream = context.Response.Body;
        context.Response.Body = responseBuffer;

        // add the "http-tracking-id" response header so the user can correlate back to this entry
        var responseHeaders = (IDictionary<string, string[]>)environment["owin.ResponseHeaders"];
        responseHeaders["http-tracking-id"] = new[] { apiPacket.TrackingId.ToString("d") };

        await _next.Invoke(environment);

        responseBuffer.Seek(0, SeekOrigin.Begin);
        var reader = new StreamReader(responseBuffer);
        apiPacket.Response = await reader.ReadToEndAsync();
        apiPacket.ResponseLength = context.Response.ContentLength ?? 0;

        WriteRequestHeaders(context.Request, apiPacket);
        WriteResponseHeaders(context.Response, apiPacket);

        // You need to do this so that the response we buffered is flushed out to the client application.
        responseBuffer.Seek(0, SeekOrigin.Begin);
        await responseBuffer.CopyToAsync(responseStream);

        //TODO: persist the ApiPacket in the database
    }

    private static void WriteRequestHeaders(IOwinRequest request, ApiPacket packet)
    {
        packet.Verb = request.Method;
        packet.RequestUri = request.Uri;
        packet.RequestHeaders = "{\r\n" + string.Join(Environment.NewLine, request.Headers.Select(kv => "\t" + kv.Key + "=" + string.Join(",", kv.Value))) + "\r\n}";
    }

    private static void WriteResponseHeaders(IOwinResponse response, ApiPacket packet)
    {
        packet.StatusCode = response.StatusCode;
        packet.ReasonPhrase = response.ReasonPhrase;
        packet.ResponseHeaders = "{\r\n" + string.Join(Environment.NewLine, response.Headers.Select(kv => "\t" + kv.Key + "=" + string.Join(",", kv.Value))) + "\r\n}";
    }
}

Я использую log4net для записи информации в базу данных SQL2012. Оба пути достигают моей цели. Тем не менее, я ищу причину использовать один метод над другим. Должен ли я использовать пользовательское промежуточное ПО OWIN ИЛИ MessageHandler и почему? Заранее спасибо.

Источник

2 ответа

Решение

Похоже, я буду использовать промежуточное программное обеспечение OWIN. Я обнаружил, что внутри MessageHandler Принципал. Идентичность еще не решена. Например, если я поставлю точки останова в своем обработчике сообщений, конструкторе контроллера API и в методе API, это то, что я вижу (по порядку).

Использование обработчика сообщений

  1. В MessageHandler> Principal.IIdentity еще не решена.
  2. В конструкторе контроллера API> Principal.IIDentity еще не решена.
  3. В методе GET контроллера API, Principal.IIdentity окончательно разрешается.

Таким образом, я не могу вытащить и зарегистрировать идентификатор авторизованного пользователя в MessageHandler.

Однако, при использовании промежуточного программного обеспечения OWIN, Principal.IIdentity IS разрешается там, так что я могу записать userId в свою таблицу журналов в этот момент. Вот почему я решил использовать промежуточное программное обеспечение.

Возможно, кто-то может дать некоторую ясность относительно того, когда IIDentity установлен в проекте API.

Источник

Так как у вас уже есть MessageHandler реализации, я бы порекомендовал использовать это, пока у вас не будет другой причины.

Тем не менее, с моей головы есть одна веская причина перенести регистрацию в OwinMiddleware будет, если у вас есть другие OwinMiddleware Компоненты, которые требуют (или выиграют от), что функциональность регистрации (при условии, что вы используете WebApi посредством чего MessageHandlers будет работать после того, как все OwinMiddleware в запросе-конвейере).

Источник
Другие вопросы по тегам