NETCore Web API中使用AOP記錄異常

Question

我有一個正在運行的Web API項目，我想使用記錄器將Web API中的所有控制器記錄到文件中。

[HttpGet]
    [Route("")]
    public IActionResult GetAllDocumentTempates()
    {
        try
        {
            var document = _doumentTemplate.GetLiteDocumentReportTemplates().ToList();
            var result = Mapper.Map<IEnumerable<LiteDocumentReportTemplateViewModel>>(document);
            return Ok(result);
        }
        catch (Exception ex)
        {
            String msgInnerExAndStackTrace = string.Format("{0}; Inner Ex: {1};  Stack Trace: {2}", ex.Message, ex.InnerException, ex.StackTrace);
            ExceptionLoggingService.Instance.WriteLog(string.Format("From frmDelivery.ConditionallyPrint():{0}", msgInnerExAndStackTrace));
            return BadRequest();
        }
    }

This is my ExceptionLoggingService.cs:這是處理所有錯誤並為我記錄文件的服務

public class ExceptionLoggingService: ActionFilterAttribute
{
    // </ Singleton code
    // private fields
    private readonly FileStream _fileStream;
    private readonly StreamWriter _streamWriter;
    private static ExceptionLoggingService _instance;
    // public property
    public static ExceptionLoggingService Instance
    {
        get
        {
            return _instance ?? (_instance = new ExceptionLoggingService());
        }
    }
    //private constructor
    private ExceptionLoggingService()
    {
        _fileStream = File.OpenWrite(GetExecutionFolder() + "\\EasyAsFallingOffA.log");
        _streamWriter = new StreamWriter(_fileStream);
    }
    // <!-- Singleton code

    public void WriteLog(string message)
    {
        if (!HHSConsts.Logging) return;
        StringBuilder formattedMessage = new StringBuilder();
        formattedMessage.AppendLine("Date: " + DateTime.Now.ToString());
        formattedMessage.AppendLine("Message: " + message);
        _streamWriter.WriteLine(formattedMessage.ToString());
        _streamWriter.Flush();
    }
    private string GetExecutionFolder()
    {
        return Path.GetDirectoryName(System.Reflection.Assembly.GetExecutingAssembly().Location);

    }
}

這是我的EasyAsFallingOffA.log文件輸出

日期：2018/6/23 12:02:24消息：來自frmDelivery.ConditionallyPrint（）：未將對象引用設置為對象的實例。 內部Ex ：； 堆棧跟蹤：位於C：\\ Users \\ BABATUNDE \\ Documents \\ Visual Studio 2017 \\ Projects \\ pcm-netcore \\ ProcessFlowManager.Domain \\ Helpers \\ ModelFactory.cs：行1170處的ProcessFlowManager.Domain.Helpers.ModelFactory.Create（CalendarActivity cal） C：\\ Users \\ BABATUNDE \\ Documents \\ Visual Studio 2017 \\ Projects \\ pcm-netcore \\ ProcessFlowManager.Infrastructure \\ LogicImplementations \\ EfCalendarActivity.cs：Line 54中的ProcessFlowManager.Infrastructure.LogicImplementations.EfCalendarActivities.GetCalendarActivity（Int32 id）在ProcessFlowManager.API上的第54行。 C：\\ Users \\ BABATUNDE \\ Documents \\ Visual Studio 2017 \\ Projects \\ pcm-netcore \\ ProcessFlowManager.API \\ Controllers \\ CalendarController.cs：line 79中的Controllers.CalendarController.GetAllGeneratedDcument（Int32 id）

上面的所有代碼一切正常，但是所有這些代碼都是使用重言式實現的，因為我在所有嘗試和捕獲中都進行了重復。 我是AOP的新手，正在尋找一種使用AOP進行此操作的方法，因此我可以在控制器內調用它一次。

Answer 1

經過大量改組，嘗試獲取我的問題的答案后，我已經成功記錄了所有異常，而未使用第三方庫，例如PostSharp，Log4File，Spring等。

ActionFilterAttribute，IExceptionFilter

我能夠解決此問題，並使用以下代碼記錄我的企業項目的所有異常

public class LatestErrorHandler : ActionFilterAttribute, IExceptionFilter
{
    private const string FILE_NAME = "Exception.log";
    private const string TRACE_FILE = "TraceLog.log";
    public Type _exceptionType;
    FileStream _fileStream;
    StreamWriter _streamWriter;
    IHostingEnvironment host;
    public LatestErrorHandler(Type exceptionType)
    {
       // _fileStream = File.OpenWrite(host.ContentRootPath + "\\wale.log");
        //_streamWriter = new StreamWriter(_fileStream);
        //_fileStream.Close();
        _exceptionType = exceptionType;
    }


    public override void OnActionExecuting(ActionExecutingContext context)
    {
        base.OnActionExecuting(context);
        using (FileStream fs=new FileStream(TRACE_FILE, FileMode.Append, FileAccess.Write))
        {
            using (BinaryWriter rite=new BinaryWriter(fs))
            {
                if (context.HttpContext.Response==null)
                {
                    string con = "No log";
                    rite.Write(con);
                }
                else
                {
                    Controller exValue = (Controller)context.Controller;
                    ControllerContext control = (ControllerContext)exValue.ControllerContext;
                    ///HttpMethodActionConstraint http = (HttpMethodActionConstraint)control.ActionDescriptor.ActionConstraints.;

                    rite.Write(
                                 "  Date Exception Occurred" + DateTime.Now.ToString() +
                                 "  Route " 
                                 +control.RouteData.DataTokens.Values
                                 +context.RouteData.Routers
                                 //+control.ActionDescriptor.ActionConstraints+ ":"+ http.HttpMethods
                                 + context.RouteData.Values.Keys
                                 + control.ActionDescriptor.ActionName
                                 +context.ActionDescriptor.RouteValues.Values+
                                 "  Parameter"
                                 + context.ActionDescriptor.Parameters 
                                 +context.ActionDescriptor.Properties+
                                 "  Controller" 
                                 + control.ActionDescriptor.ControllerName

                                           );
                }
            }
        }


    }





    public void OnException(ExceptionContext context)
    {
        var cont= context.Exception;
        //var contInner = context.Exception.InnerException;
        using (FileStream fs = new FileStream(FILE_NAME, FileMode.OpenOrCreate, FileAccess.ReadWrite))
        {
            using (BinaryWriter rite = new BinaryWriter(fs))
          {
                // context.Result actionResult = new context.Result();

                if (context.HttpContext.Response == null)
                {
                    string con = "no errroer  ";
                    rite.Write(con);
                }
                else
                {

                    rite.Write(
                        "Date Exception Occurred" + DateTime.Now.ToString() +
                        " Exceptions" + "Message: " + cont.Message +
                        " InnerException" + cont.InnerException +
                        " StackTrace" + cont.StackTrace+
                        "Response" + context.HttpContext.Response.StatusCode
                    );




                }

            }

        }

    }






    public override void OnActionExecuted(ActionExecutedContext context)
    {

        base.OnActionExecuted(context);
        var cont = context.Exception;
        //var contInner = context.Exception.InnerException;
        using (FileStream fs = new FileStream(FILE_NAME, FileMode.Append, FileAccess.Write))
        {
            using (BinaryWriter rite=new BinaryWriter(fs))
            {
                // context.Result actionResult = new context.Result();
               var type =  context.Result.GetType().Name;   //context.Result

                if(type == "BadRequestObjectResult" )
                {

                    BadRequestObjectResult cont2 = (BadRequestObjectResult)context.Result;


                    Exception exValue = (Exception) cont2.Value;
                    if (exValue.InnerException==null)
                    {
                        rite.Write(
                              "\n  Date Exception Occurred  " + DateTime.Now.ToString() +
                              "\n  Exceptions" + "Message: " + cont2.Value +
                             // "\n  InnerException  " + exValue.InnerException +
                              "\n  Message    " + exValue.Message +
                              "\n  StackTrace  " + exValue.StackTrace
                       //"Response" + context.HttpContext.Response.StatusCode
                       );
                    }
                    else
                    {
                        rite.Write(
                               "\n  Date Exception Occurred  " + DateTime.Now.ToString() +
                               "\n  Exceptions" + "Message: " + cont2.Value +
                               "\n  InnerException  " + exValue.InnerException +
                               "\n  Message    " + exValue.Message +
                               "\n  StackTrace  " + exValue.StackTrace
                        //"Response" + context.HttpContext.Response.StatusCode
                        );
                    }


                }






                else
                {
                    // log details without error.





                }

            }

        }

    }



}

在此類中，我使用了面向方面的編程（AOP）來成功地將所有異常記錄到我所有控制器中的文件中。

 [LatestErrorHandler(typeof(ExceptionContext))]
//[CustomLoggingAttirbute]
[Produces("application/json")]
[Route("api/Calendar")]
public class CalendarController : Controller
{
      ICalendarActivities calendarActivities;

    IHostingEnvironment IHostingEnvironment;

    string projectFolder = "";
    string fileRootPath = "";

    // private string projectRootFolder;
    public CalendarController(ICalendarActivities _calendarActivities)
    {
        calendarActivities = _calendarActivities;
    }

    [HttpGet]
    [Route("")]

    public IActionResult GetAllCalenderReportList()
    {
        try
        {
            var calendars = calendarActivities.GetCalendarActivities();
            var result = AutoMapper.Mapper.Map<IEnumerable<LiteCalendarViewModel>>(calendars);
            return Ok(result);
        }
        catch (Exception ex)

        {
            //string msginnerexandstacktrace = string.Format("{0}; inner ex: {1};  stack trace: {2}", ex.Message, ex.InnerException, ex.StackTrace);
            //ExceptionLoggingService.Instance.WriteLog(string.Format("from frmdelivery.conditionallyprint():{0}", msginnerexandstacktrace));
            return BadRequest(ex);
        }
    }

這是我的輸出

日期發生日期7/2/2018 5:13:18 PM Exceptions消息：System.NullReferenceException：對象引用未設置為對象的實例。 在ProcessFlowManager.Infrastructure的C：\\ Users \\ BABATUNDE \\ Documents \\ Visual Studio 2017 \\ Projects \\ pcm-netcore \\ ProcessFlowManager.Domain \\ Helpers \\ ModelFactory.cs：行1170處的ProcessFlowManager.Domain.Helpers.ModelFactory.Create（CalendarActivity cal） .LogicImplementations.EfCalendarActivities.GetCalendarActivity（Int32 id）在C：\\ Users \\ BABATUNDE \\ Documents \\ Visual Studio 2017 \\ Projects \\ pcm-netcore \\ ProcessFlowManager.Infrastructure \\ LogicImplementations \\ EfCalendarActivities.cs：Line 48在ProcessFlowManager.API.Controllers.CalendarController .GetAllGeneratedDcument（Int32 id）在C：\\ Users \\ BABATUNDE \\ Documents \\ Visual Studio 2017 \\ Projects \\ pcm-netcore \\ ProcessFlowManager.API \\ Controllers \\ CalendarController.cs：line 83 InnerException
消息對象引用未設置為對象的實例。 在C：\\ Users \\ BABATUNDE \\ Documents \\ Visual Studio 2017 \\ Projects \\ pcm-netcore \\ ProcessFlowManager.Domain \\ Helpers \\ ModelFactory.cs：line 1170中的ProcessFlowManager.Domain.Helpers.ModelFactory.Create（CalendarActivity cal）處的StackTrace

Answer 2

您可以使用此鏈接開始： 使用C＃和PostSharp進行面向方面的編程

或者這： 在方法執行之前和之后的注入行為

第一級 ：

1）使用命名為LoggingAspect的項目添加類

2）繼承OnMethodBoundaryAspect

3）so OnEntry，OnSuccess，OnExit，OnException的實現

像下面的代碼：

    [PSerializable]
   public class LoggingAspect : OnMethodBoundaryAspect
   {

     public override void OnEntry(MethodExecutionArgs args)
     {
        Console.WriteLine("The {0} method has been entered.", args.Method.Name);
     }

     public override void OnSuccess(MethodExecutionArgs args)
     {
       Console.WriteLine("The {0} method executed successfully.", args.Method.Name);
     }

     public override void OnExit(MethodExecutionArgs args)
     {
        Console.WriteLine("The {0} method has exited.", args.Method.Name);
     }     

     public override void OnException(MethodExecutionArgs args)
     {
        Console.WriteLine("An exception was thrown in {0}.", args.Method.Name);
     }

    }

  static class Program
  {
      [LoggingAspect]
      static void Main()
      {
         Console.WriteLine("Hello, world.");
      }
   }

輸出：

     The Main method has been entered.
     Hello, world.
     The Main method executed successfully.
     The Main method has exited.