Asp.net webapi 2 isteğini ve yanıt gövdesini bir veritabanına kaydetmeniz gerekiyor

Question 1

IIS üzerinde barındırılan Microsoft Asp.net WebApi2 kullanıyorum. Çok basit bir şekilde istek gövdesini (XML veya JSON) ve her gönderi için yanıt gövdesini günlüğe kaydetmek istiyorum.

Bu proje veya gönderiyi işleyen denetleyici hakkında özel bir şey yok. Gerekli olmadıkça nLog, elmah, log4net gibi günlük çerçevelerini veya web API'sinin yerleşik izleme özelliklerini kullanmakla ilgilenmiyorum.

Sadece günlük kodumu nereye koyacağımı ve gelen ve giden istek ve yanıttan gerçek JSON veya XML'i nasıl alacağımı bilmek istiyorum.

Denetleyici gönderi yöntemim:

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

}

Question 2

Bir DelegatingHandler. O zaman denetleyicilerinizdeki herhangi bir kayıt kodu hakkında endişelenmenize gerek kalmaz.

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.WriteLineGünlük kodunuzla değiştirin ve işleyiciyi şu şekilde kaydedin WebApiConfig:

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

İleti İşleyicileri için eksiksiz Microsoft belgeleri burada .

Question 3

Her WebAPI yöntemi çağrısı için İstek / Yanıt günlüğünü genel olarak işlemek için birden çok yaklaşım vardır:

ActionFilterAttribute: ActionFilterAttributeGünlük kaydını etkinleştirmek için denetleyici / eylem yöntemlerini özel olarak yazabilir ve dekore edebilir .

Eksileri: Her denetleyiciyi / yöntemi dekore etmeniz gerekiyor (yine de bunu temel denetleyicide yapabilirsiniz, ancak yine de kesişen endişeleri gidermiyor.
BaseControllerOrada günlük kaydını geçersiz kılın ve işleyin.

Eksileri: Denetleyicilerin özel bir temel denetleyiciden miras almasını bekliyoruz / zorluyoruz.
Kullanarak DelegatingHandler.

Avantaj: Burada bu yaklaşımla denetleyiciye / yönteme dokunmuyoruz. Temsilci işleyici izole bir şekilde oturur ve istek / yanıt günlük kaydını incelikle işler.

Daha ayrıntılı makale için bu http://weblogs.asp.net/fredriknormen/log-message-request-and-response-in-asp-net-webapi'ye bakın .

Question 4

Sahip olduğunuz seçeneklerden biri, bir eylem filtresi oluşturmak ve WebApiController / ApiMethod'unuzu onunla süslemektir.

Filtreleme Özelliği

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 denetleyicisi

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

veya

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

Bu yardımcı olur umarım.

Question 5

İstek mesajına erişim kolaydır. Sizin taban sınıfı,ApiController içerdiği .Requestözelliği adından da anlaşılacağı gibi, çözümlü formda isteği içeren,. Günlüğe kaydetmek istediğiniz her şeyi inceleyin ve hangisi olursa olsun, kayıt tesisinize iletin. Bu kodu, sadece bir veya bir avuç için yapmanız gerekiyorsa, eyleminizin başlangıcına koyabilirsiniz.

Bunu tüm eylemlerde yapmanız gerekiyorsa (tümü yönetilebilir bir avuçtan fazlası anlamına gelir), yapabileceğiniz şey, .ExecuteAsyncdenetleyiciniz için her eylem çağrısını yakalamak için yöntemi geçersiz kılmaktır.

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

Question 6

Bu oldukça eski bir konu gibi görünüyor, ancak başka bir çözümü paylaşıyor.

HTTP isteği sona erdikten sonra her tetiklenecek olan global.asax dosyanıza bu yöntemi ekleyebilirsiniz.

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.)
            }
        }
    }

Question 7

Bu gerçekten eski bir konu ama bunları yapmak için çok zaman harcadım (internette arama yaptım), bu yüzden çözümümü burada yayınlayacağım.

Konsept

Inbound talebini izlemek için APicontroller yönteminin ExecuteAsync değerini geçersiz kıl, çözümümde Base_ApiController'ı projemin API denetleyicilerinin üst öğesi olarak oluşturuyorum.
API denetleyicisinin Giden yanıtını izlemek için System.Web.Http.Filters.ActionFilterAttribute kullanın
*** (Ek) *** İstisna oluştuğunda günlüğe kaydetmek için System.Web.Http.Filters.ExceptionFilterAttribute kullanın.

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

        }
    }
}