asp.net webapi 2リクエストとレスポンスの本文をデータベースに記録する必要がある

IISでホストされているMicrosoft Asp.net WebApi2を使用しています。非常に単純に、各投稿の要求本文（XMLまたはJSON）と応答本文をログに記録します。

このプロジェクトや投稿を処理するコントローラーについて特別なことは何もありません。必要がない限り、nLog、elmah、log4netなどのロギングフレームワーク、またはWeb 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を参照してください。

オプションの1つは、アクションフィルターを作成し、それで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プロパティを名の通り、、、解析された形での要求が含まれています。記録しようとしているものを調べて、ロギング機能に渡すだけです。このコードは、1つまたは少数の操作で実行する必要がある場合に、アクションの最初に配置できます。

すべてのアクションでそれを実行する必要がある場合（すべては管理可能な一握り以上のものを意味します）、.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. インバウンド要求を追跡するためにAPicontrollerメソッドのExecuteAsyncをオーバーライドします。私のソリューションでは、プロジェクトのAPIコントローラーの親としてBase_ApiControllerを作成します。
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);

        }
    }
}