Необходимо зарегистрировать тело запроса и ответа asp.net webapi 2 в базе данных

Я использую Microsoft Asp.net WebApi2, размещенный на IIS. Я очень просто хотел бы регистрировать тело запроса (XML или JSON) и тело ответа для каждого сообщения.

Нет ничего особенного ни в этом проекте, ни в контроллере, обрабатывающем пост. Меня не интересует использование фреймворков для ведения журналов, таких как nLog, elmah, log4net, или встроенных функций трассировки веб-API, если в этом нет необходимости.

Я просто хочу знать, где разместить мой код ведения журнала и как получить фактический JSON или XML из входящего и исходящего запроса и ответа.

Мой метод сообщения контроллера:

public HttpResponseMessage Post([FromBody])Employee employee)
{
   if (ModelState.IsValid)
   {
      // insert employee into to the database
   }

}

Я бы порекомендовал использовать DelegatingHandler. Тогда вам не нужно будет беспокоиться о коде журналирования в ваших контроллерах.

public class LogRequestAndResponseHandler : DelegatingHandler
{
    protected override async Task<HttpResponseMessage> SendAsync(
        HttpRequestMessage request, CancellationToken cancellationToken)
    {
        if (request.Content != null)
        {
            // log request body
            string requestBody = await request.Content.ReadAsStringAsync();
            Trace.WriteLine(requestBody);
        }
        // let other handlers process the request
        var result = await base.SendAsync(request, cancellationToken);

        if (result.Content != null)
        {
            // once response body is ready, log it
            var responseBody = await result.Content.ReadAsStringAsync();
            Trace.WriteLine(responseBody);
        }

        return result;
    }
}

Просто замените Trace.WriteLineсвоим кодом регистрации и зарегистрируйте обработчик WebApiConfigследующим образом:

config.MessageHandlers.Add(new LogRequestAndResponseHandler());

Вот полная документация Microsoft для обработчиков сообщений .

Существует несколько подходов к общей обработке ведения журнала запросов / ответов для каждого вызова метода WebAPI:

1. ActionFilterAttribute: Можно написать собственные ActionFilterAttributeи украсить методы контроллера / действия, чтобы включить ведение журнала.

   Против: вам нужно украсить каждый контроллер / методы (вы все равно можете сделать это на базовом контроллере, но все же это не решает сквозные проблемы.

2. Переопределите BaseControllerи обработайте там ведение журнала.

   Против: Мы ожидаем / заставляем контроллеры наследовать от настраиваемого базового контроллера.

3. Использование DelegatingHandler.

   Преимущество: мы не касаемся здесь контроллера / метода с помощью этого подхода. Делегирующий обработчик находится изолированно и аккуратно обрабатывает ведение журнала запросов / ответов.

Для получения более подробной статьи обратитесь к http://weblogs.asp.net/fredriknormen/log-message-request-and-response-in-asp-net-webapi .

Один из возможных вариантов - создать фильтр действий и украсить им свой WebApiController / ApiMethod.

Атрибут фильтра

public class MyFilterAttribute : System.Web.Http.Filters.ActionFilterAttribute
    {
        public override void OnActionExecuting(HttpActionContext actionContext)
        {
            if (actionContext.Request.Method == HttpMethod.Post)
            {
                var postData = actionContext.ActionArguments;
                //do logging here
            }
        }
    }

Контроллер WebApi

[MyFilterAttribute]
public class ValuesController : ApiController{..}

или

[MyFilterAttribute]
public void Post([FromBody]string value){..}

Надеюсь это поможет.

Получить доступ к сообщению запроса просто. Ваш базовый классApiController содержит .Requestсвойство , которое, как следует из названия, содержит запрос в проанализированной форме. Вы просто проверяете его на предмет того, что вы хотите зарегистрировать, и передаете это своему объекту ведения журнала, каким бы он ни был. Этот код вы можете поместить в начало вашего действия, если вам нужно сделать это для одного или нескольких.

Если вам нужно сделать это для всех действий (все означает нечто большее, чем управляемая горстка), тогда вы можете переопределить .ExecuteAsyncметод для захвата каждого вызова действия для вашего контроллера.

public override Task<HttpResponseMessage> ExecuteAsync(
    HttpControllerContext controllerContext,
    CancellationToken cancellationToken
)
{
    // Do logging here using controllerContext.Request
    return base.ExecuteAsync(controllerContext, cancellationToken);
}

Кажется, это довольно старый поток, но вам нужно поделиться другим решением.

Вы можете добавить этот метод в свой файл global.asax, который будет запускаться каждый раз после завершения HTTP-запроса.

void Application_EndRequest(Object Sender, EventArgs e)
    {
        var request = (Sender as HttpApplication).Request;
        var response = (Sender as HttpApplication).Response;

        if (request.HttpMethod == "POST" || request.HttpMethod == "PUT")
        {


            byte[] bytes = request.BinaryRead(request.TotalBytes);
            string body = Encoding.UTF7.GetString(bytes);
            if (!String.IsNullOrEmpty(body))
            {


                // Do your logic here (Save in DB, Log in IIS etc.)
            }
        }
    }

Это действительно старая тема, но я потратил много времени (поискал в Интернете), чтобы сделать это, поэтому я просто опубликую здесь свое решение.

Концепция

1. Переопределите ExecuteAsync метода APicontroller для отслеживания входящего запроса, в своем решении я создаю Base_ApiController в качестве родительского элемента для контроллеров API моего проекта.
2. Используйте System.Web.Http.Filters.ActionFilterAttribute для отслеживания исходящего ответа контроллера api
3. *** (Дополнительно) *** Используйте System.Web.Http.Filters.ExceptionFilterAttribute для записи в журнал при возникновении исключения.

1. MyController.cs

    [APIExceptionFilter]  // use 3.
    [APIActionFilter]     // use 2.
    public class Base_APIController : ApiController
    {
        public   bool  IsLogInbound
        {
            get
            { return   ConfigurationManager.AppSettings["LogInboundRequest"] =="Y"? true:false ;     }
        }
        /// <summary>
        /// for logging exception
        /// </summary>
        /// <param name="controllerContext"></param>
        /// <param name="cancellationToken"></param>
        /// <returns></returns>
        public override Task<HttpResponseMessage> ExecuteAsync(
         HttpControllerContext controllerContext,
         CancellationToken cancellationToken
         )
        {
            // Do logging here using controllerContext.Request
            // I don't know why calling the code below make content not null Kanit P.
            var content = controllerContext.Request.Content.ReadAsStringAsync().Result.ToString(); // keep request json content
             // Do your own logging!
            if (IsLogInbound)
            {
                try
                {
                    ErrLog.Insert(ErrLog.type.InboundRequest, controllerContext.Request,
                         controllerContext.Request.RequestUri.AbsoluteUri
                         , content);
                }
                catch (Exception e) { }
            }

            // will not log err when go to wrong controller's action (error here but not go to APIExceptionFilter)
            var t = base.ExecuteAsync(controllerContext, cancellationToken);
            if (!t.Result.IsSuccessStatusCode)
            { 
            }
            return t;

        }

2. APIActionFilter.cs

    public class APIActionFilter : System.Web.Http.Filters.ActionFilterAttribute
    {
        public bool LogOutboundRequest
        {
            get
            { return ConfigurationManager.AppSettings["LogInboundRequest"] == "Y" ? true : false; }
        }

        public override void OnActionExecuted(HttpActionExecutedContext actionExecutedContext)
        {
            try {

                var returndata = actionExecutedContext.Response.Content.ReadAsStringAsync().Result.ToString(); 
             //keep Json response content
             // Do your own logging!
                if (LogOutboundRequest)
                {
                    ErrLog.Insert(ErrLog.type.OutboundResponse, actionExecutedContext.Response.Headers,
                       actionExecutedContext.ActionContext.ControllerContext.ControllerDescriptor.ControllerName
                      + "/"
                      + actionExecutedContext.ActionContext.ActionDescriptor.ActionName
                      , returndata );
                }
            } catch (Exception e) {

            }
     

        } 
    }
}

3. APIExceptionFilter.cs

    public class APIExceptionFilter : ExceptionFilterAttribute
    {
    public bool IsLogErr
    {
        get
        { return ConfigurationManager.AppSettings["LogExceptionRequest"] == "Y" ? true : false; }
    }


    public override void OnException(HttpActionExecutedContext context)
    {
        try
        { 
            //Do your own logging!
            if (IsLogErr)
            {
                ErrLog.Insert(ErrLog.type.APIFilterException, context.Request,
                    context.ActionContext.ControllerContext.ControllerDescriptor.ControllerName
                    + "/"
                    + context.ActionContext.ActionDescriptor.ActionName
                    , context.Exception.ToString() + context.Exception.StackTrace);
            }
        }catch(Exception e){

        }

        if (context.Exception is NotImplementedException)
        {
            context.Response = new HttpResponseMessage(HttpStatusCode.NotImplemented);
        }
        else {
            context.Response = new HttpResponseMessage(HttpStatusCode.InternalServerError);

        }
    }
}