จำเป็นต้องบันทึกคำขอ 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());

นี่คือเอกสารไมโครซอฟท์เต็มรูปแบบสำหรับข้อความ Handlers

มีหลายวิธีในการจัดการการบันทึกคำร้อง / การตอบกลับโดยทั่วไปสำหรับการเรียกใช้เมธอด 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);

        }
    }
}