Потрібно увійти до бази даних бази даних 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та прикрасити контролер / методи дій, щоб увімкнути ведення журналу.

   Con: Вам потрібно прикрасити кожен контролер / методи (все-таки це можна зробити на базовому контролері, але все ще він не стосується наскрізних проблем.

2. Замініть BaseControllerта обробіть лісозаготівлю там.

   Con: Ми очікуємо / змушуємо контролерів успадкувати від користувацького базового контролера.

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);

        }
    }
}