例外処理に対する ASP.NET MVC ソリューションの概要

ASP.NET MVC は、非常に拡張性の高い開発フレームワークです。この記事では、その拡張機能を介してこれを EntLib と統合し、完全な例外処理ソリューションを提供します。

EntLib の例外処理アプリケーション ブロックは、構成を通じて例外処理戦略を定義できる優れた例外処理フレームワークです。 ASP.NET MVC は非常に拡張性の高い開発フレームワークです。この記事では、ASP.NET MVC をその拡張機能を通じて EntLib と統合し、完全な例外処理ソリューションを提供します。

1. 基本的な例外処理戦略

まず、私たちのソリューションで採用されている特定の例外処理戦略について説明します:

コントローラーの Action メソッドの実行によってスローされた例外については、指定された構成ポリシーに従います。加工用に。ロギング、例外置換、カプセル化などの一般的な例外処理方法を採用できます。処理された例外については、例外処理ポリシーでスローする必要があると規定されている場合、例外の種類に一致するエラー ページに自動的にリダイレクトされます。 。例外タイプとエラー ビューの間の一致関係を維持します。

処理された例外について、例外処理ポリシーでスローする必要がないことが規定されている場合、現在のアクション操作に一致するエラー処理アクションが実行されます。加工用に。例外処理アクション メソッドは、デフォルトで命名規則「On{Action}Error」を使用し、現在のコンテキストは例外処理アクション メソッドのパラメータにバインドされます。さらに、現在の ModelState のエラー情報を設定します。

ユーザーが対応する例外処理アクションを定義していない場合でも、例外処理には「エラー ページ リダイレクト」メソッドが使用されます。

2. カスタム アクションによる例外の処理

上記で紹介した例外処理ページを読者に深く理解してもらうために、サンプルのデモを行ってみましょう。このインスタンスは、ユーザーのログインをシミュレートするために使用されます。ユーザー名とパスワードの 2 つの属性のみを含むモデル LoginInfoModel を定義します。

  namespace Artech.Mvc.ExceptionHandling.Models
   {
     public class LoginInfo
     {
       [Display(Name ="User Name")]
       [Required(ErrorMessage = "User Name is manadatory!")]
       public string UserName { get; set; }
   
       [Display(Name = "Password")]
      [DataType(DataType.Password)]
      [Required(ErrorMessage = "Password is manadatory!")]
      public string Password { get; set; }
    }
  }

カスタム BaseController のサブクラスである次の AccountController を定義します。 AccountController が構築中に基本クラスのコンストラクターを呼び出すとき、指定されたパラメーターは例外処理戦略の構成名を表します。 SignIn メソッドは「ログイン」操作を表し、OnSignInError はその操作に対応する例外処理操作を表します。 SignIn 操作でスローされた例外が処理され、スローする必要がなくなった場合は、OnSignInError が呼び出され、ModelState に対応するエラー メッセージが設定されます。

  public class AccountController BaseController
   {
     public AccountController()
       base("myPolicy")
     { }
   
     public ActionResult SignIn()
     {
       return View(new LoginInfo());
    }
    [HttpPost]
    public ActionResult SignIn(LoginInfo loginInfo)
    {
      if (!ModelState.IsValid)
      {
        return this.View(new LoginInfo { UserName = loginInfo.UserName });
      }
   
      if (loginInfo.UserName != "Foo")
      {
        throw new InvalidUserNameException();
      }
   
      if (loginInfo.Password != "password")
      {
        throw new UserNamePasswordNotMatchException();
      }
   
      ViewBag.Message = "Authentication Succeeds!";
      return this.View(new LoginInfo { UserName = loginInfo.UserName });
    }
   
    public ActionResult OnSignInError(string userName)
    {
      return this.View(new LoginInfo { UserName = userName });
    }
  }

SignIn 操作メソッドで具体的に定義されている認証ロジックは次のとおりです。ユーザー名が「Foo」でない場合は、InvalidUserNameException 例外がスローされ、パスワードが「password」でない場合は、UserNamePasswordNotMatchException 例外がスローされます。 。 SignIn操作に対応するViewの定義は以下の通りです。

  @model Artech.Mvc.ExceptionHandling.Models.LoginInfo
   @{
     ViewBag.Title = "SignIn";
   }
   @Html.ValidationSummary()
   @if (ViewBag.Messages != null)
   { 
     @ViewBag.Messages
   }
  @using (Html.BeginForm())
  { 
    @Html.EditorForModel()
    <input type="submit" value="SignIn" />
  }

AccountControllerの初期化時に指定する例外処理ポリシー「myPolicy」は以下の構成で定義されています。 SignIn 操作メソッドによってスローされる InvalidUserNameException および UserNamePasswordNotMatchException を特に処理します。ErrorMessageSettingHandler はカスタム例外ハンドラーであり、エラー メッセージを設定するためにのみ使用されます。次のコード スニペットに示すように、上記の 2 種類の例外がスローされた場合、最終的なエラー メッセージは「ユーザー名が存在しません!」および「ユーザー名がパスワードと一致しません!」として指定されます。

  <exceptionHandling>
    <exceptionPolicies>
     <add name="myPolicy">
      <exceptionTypes>
       <add name="InvalidUserNameException" 
          type="Artech.Mvc.ExceptionHandling.Models.InvalidUserNameException, Artech.Mvc.ExceptionHandling"
         postHandlingAction="None">
        <exceptionHandlers>
         <add name="ErrorMessageSettingHandler"
           type="Artech.Mvc.ExceptionHandling.ErrorMessageSettingHandler, Artech.Mvc.ExceptionHandling"
           errorMessage="User name does not exist!"/>
       </exceptionHandlers>
      </add>
      <add name="UserNamePasswordNotMatchException" 
          type="Artech.Mvc.ExceptionHandling.Models.UserNamePasswordNotMatchException, Artech.Mvc.ExceptionHandling"
         postHandlingAction="None">
       <exceptionHandlers>
        <add name="ErrorMessageSettingHandler"
           type="Artech.Mvc.ExceptionHandling.ErrorMessageSettingHandler, Artech.Mvc.ExceptionHandling"
           errorMessage="User name does not match password!"/>
       </exceptionHandlers>
      </add>     
     </exceptionTypes>
    </add>
   </exceptionPolicies>
  </exceptionHandling>

次に、ルート マッピングを通じて AccountController と Sign をデフォルトのコントローラーとアクションとして設定した後、アプリケーションを起動します。間違ったユーザー名と間違ったパスワードを入力すると、Validationsummary に対応するエラー メッセージが自動的に表示されます。

3. 設定されたエラー ビューによる例外の処理

上記の設定では、InvalidUserNameException と UserNamePasswordNotMatchException の 2 つの例外タイプの設定ポリシーが PostHandlingAction 属性を「None」に設定します。 no 元の例外と処理された例外を再スローします。ここで、このプロパティを「ThrowNewException」に設定します。これは、処理された例外を再スローすることを意味します。

  <exceptionHandling>
    <exceptionPolicies>
     <add name="myPolicy">
      <exceptionTypes>
       <add name="InvalidUserNameException" type="Artech.Mvc.ExceptionHandling.Models.InvalidUserNameException, Artech.Mvc.ExceptionHandling"
         postHandlingAction="ThrowNewException">
       ...
       <add name="UserNamePasswordNotMatchException" type="Artech.Mvc.ExceptionHandling.Models.UserNamePasswordNotMatchException, Artech.Mvc.ExceptionHandling"
         postHandlingAction="ThrowNewException">
       ...
      </add>     
     </exceptionTypes>
    </add>
   </exceptionPolicies>
  </exceptionHandling>

上記の例外処理戦略に従って、この場合、例外処理に「エラー ページ」メソッドを使用します。 HandleErrorAttribute も同様の方法で処理され、次のような構成を通じて定義される例外タイプとエラー ビューの間の一致関係がサポートされます。ここでの例外の種類は、処理後に再スローされる例外であることに注意してください。

  <artech.exceptionHandling>
    <add exceptionType="Artech.Mvc.ExceptionHandling.Models.InvalidUserNameException, Artech.Mvc.ExceptionHandling"
       errorView="InvalideUserNameError"/>
    <add exceptionType="Artech.Mvc.ExceptionHandling.Models.UserNamePasswordNotMatchException, Artech.Mvc.ExceptionHandling"
       errorView="UserNamePasswordNotMatchError"/>
   </artech.exceptionHandling>

上記の構成に示すように、InvalidUserNameException と UserNamePasswordNotMatchException の 2 つの例外タイプ (それぞれ「InvalideUserNameError」と「UserNamePasswordNotMatchError」) に対して異なるエラー ビューを定義しました。詳細な定義は次のとおりです。

  @{
     Layout = null;
   }
   <!DOCTYPE html>
   <html>
   <head>
     <title>Error</title>
   </head>
   <body>
    <p style="colorRed; font-weightbold">Sorry,the user name you specify does not exist!</p>
  </body>
  </html>
   
  @{
    Layout = null;
  }
  <!DOCTYPE html>
  <html>
  <head>
    <title>Error</title>
  </head>
  <body>
    <p style="colorRed; font-weightbold">Sorry, The password does not match the given user name!</p>
  </body>
  </html>

现在我们按照上面的方式运行我们的程序，在分别输入错误的用户名和密码的情况下会自动显现相应的错误页面。

四、自定义ActionInvoker：ExceptionActionInvoker

对于上述的两种不同的异常处理方式最终是通过自定义的ActionInvoker来实现的，我们将其命名为ExceptionActionInvoker。如下面的代码片断所式，ExceptionActionInvoker直接继承自ControllerActionInvoker。属性ExceptionPolicy是一个基于指定的异常策略名称创建的ExceptionPolicyImpl 对象，用于针对EntLib进行的异常处理。而属性GetErrorView是一个用于获得作为错误页面的ViewResult对象的委托。整个异常处理的核心定义在InvokeAction方法中，该方法中指定的handleErrorActionName参数代表的是“异常处理操作名称”，整个方法就是按照上述的异常处理策略实现的。

  using System;
   using System.Collections.Generic;
   using System.Linq;
   using System.Web;
   using System.Web.Mvc;
   using Artech.Mvc.ExceptionHandling.Configuration;
   using Microsoft.Practices.EnterpriseLibrary.Common.Configuration;
   using Microsoft.Practices.EnterpriseLibrary.ExceptionHandling;
   namespace Artech.Mvc.ExceptionHandling
  {
    public class ExceptionActionInvoker ControllerActionInvoker
    {
      protected ExceptionHandlingSettings ExceptionHandlingSettings{get; private set;}
      protected virtual Func<string, HandleErrorInfo, ViewResult> GetErrorView { get; private set; }
      public ExceptionPolicyImpl ExceptionPolicy { get; private set; }
      public ExceptionActionInvoker(string exceptionPolicy,Func<string, HandleErrorInfo, ViewResult> getErrorView)
      {
        this.ExceptionPolicy = EnterpriseLibraryContainer.Current.GetInstance<ExceptionPolicyImpl>(exceptionPolicy);
        this.GetErrorView = getErrorView;
        this.ExceptionHandlingSettings = ExceptionHandlingSettings.GetSection();
      }
   
      public override bool InvokeAction(ControllerContext controllerContext, string handleErrorActionName)
      {
        ExceptionContext exceptionContext = controllerContext as ExceptionContext;
        if (null == exceptionContext)
        {
          throw new ArgumentException("The controllerContext must be ExceptionContext!", "controllerContext");
        }
        try
        {
          exceptionContext.ExceptionHandled = true;
          if (this.ExceptionPolicy.HandleException(exceptionContext.Exception))
          {
            HandleRethrownException(exceptionContext);
          }
          else
          {
            if (ExceptionHandlingContext.Current.Errors.Count == 0)
            {
              ExceptionHandlingContext.Current.Errors.Add(exceptionContext.Exception.Message);
            }
            ControllerDescriptor controllerDescriptor = this.GetControllerDescriptor(exceptionContext);
            ActionDescriptor handleErrorAction = FindAction(exceptionContext, controllerDescriptor, handleErrorActionName);
            if (null != handleErrorAction)
            {
              IDictionary<string, object> parameters = GetParameterValues(controllerContext, handleErrorAction);
              exceptionContext.Result = this.InvokeActionMethod(exceptionContext, handleErrorAction, parameters);
            }
            else
            {
              HandleRethrownException(exceptionContext);
            }
          }
          return true;
        }
        catch (Exception ex)
        {
          exceptionContext.Exception = ex;
          HandleRethrownException(exceptionContext);
          return true;
        }
      }
      protected virtual void HandleRethrownException(ExceptionContext exceptionContext)
      {
        string errorViewName = this.GetErrorViewName(exceptionContext.Exception.GetType());
        string controllerName = (string)exceptionContext.RouteData.GetRequiredString("controller");
        string action = (string)exceptionContext.RouteData.GetRequiredString("action");
        HandleErrorInfo handleErrorInfo = new HandleErrorInfo(exceptionContext.Exception, controllerName, action);
        exceptionContext.Result = this.GetErrorView(errorViewName, handleErrorInfo);
      }
      protected string GetErrorViewName(Type exceptionType)
      {
        ExceptionErrorViewElement element = ExceptionHandlingSettings.ExceptionErrorViews
          .Cast<ExceptionErrorViewElement>().FirstOrDefault(el=>el.ExceptionType == exceptionType);
        if(null != element)
        {
          return element.ErrorView;
        }
        if(null== element && null != exceptionType.BaseType!= null)
        {
          return GetErrorViewName(exceptionType.BaseType);
        }
        else
        {
          return "Error";
        }
      }
    }
  }

五、自定义Controller：BaseController

ExceptionActionInvoker最终在我们自定义的Controller基类BaseController中被调用的。ExceptionActionInvoker对象在构造函数中被初始化，并在重写的OnException方法中被调用。

  using System;
   using System.Web.Mvc;
   namespace Artech.Mvc.ExceptionHandling
   {
     public abstract class BaseController Controller
     {
       public BaseController(string exceptionPolicy)
       {
         Func<string, HandleErrorInfo, ViewResult> getErrorView = (viewName, handleErrorInfo) => this.View(viewName, handleErrorInfo);
        this.ExceptionActionInvoker = new ExceptionActionInvoker(exceptionPolicy,getErrorView);
      }
      public BaseController(ExceptionActionInvoker actionInvoker)
      {
        this.ExceptionActionInvoker = actionInvoker;
      }
   
      public virtual ExceptionActionInvoker ExceptionActionInvoker { get; private set; }
   
      protected virtual string GetHandleErrorActionName(string actionName)
      {
        return string.Format("On{0}Error", actionName);
      }
   
      protected override void OnException(ExceptionContext filterContext)
      {
        using (ExceptionHandlingContextScope contextScope = new ExceptionHandlingContextScope(filterContext))
        {
          string actionName = RouteData.GetRequiredString("action");
          string handleErrorActionName = this.GetHandleErrorActionName(actionName);
          this.ExceptionActionInvoker.InvokeAction(filterContext, handleErrorActionName);
          foreach (var error in ExceptionHandlingContext.Current.Errors)
          {
            ModelState.AddModelError(Guid.NewGuid().ToString() ,error.ErrorMessage);
          }
        }
      }
    }
  }

值得一提的是：整个OnException方法中的操作都在一个ExceptionHandlingContextScope中进行的。顾名思义， 我们通过ExceptionHandlingContextScope为ExceptionHandlingContext创建了一个范围。ExceptionHandlingContext定义如下，我们可以通过它获得当前的ExceptionContext和ModelErrorCollection，而静态属性Current返回当前的ExceptionHandlingContext对象。

  public class ExceptionHandlingContext
   {
     [ThreadStatic]
     private static ExceptionHandlingContext current;
   
     public ExceptionContext ExceptionContext { get; private set; }
     public ModelErrorCollection Errors { get; private set; }
   
     public ExceptionHandlingContext(ExceptionContext exceptionContext)
    {
      this.ExceptionContext = exceptionContext;
      this.Errors = new ModelErrorCollection();
    }
    public static ExceptionHandlingContext Current
    {
      get { return current; }
      set { current = value; }
    }
  }

在BaseController的OnException方法中，当执行了ExceptionActionInvoker的InvokeAction之后，我们会将当前ExceptionHandlingContext的ModelError转移到当前的ModelState中。这就是为什么我们会通过ValidationSummary显示错误信息的原因。对于我们的例子来说，错误消息的指定是通过如下所示的ErrorMessageSettingHandler 实现的，而它仅仅将指定的错误消息添加到当前ExceptionHandlingContext的Errors属性集合中而已。

  [ConfigurationElementType(typeof(ErrorMessageSettingHandlerData))]
   public class ErrorMessageSettingHandler IExceptionHandler
   {
     public string ErrorMessage { get; private set; }
     public ErrorMessageSettingHandler(string errorMessage)
     {
       thisErrorMessage = errorMessage;
     }
     public Exception HandleException(Exception exception, Guid handlingInstanceId)
    {
      if (null == ExceptionHandlingContextCurrent)
      {
        throw new InvalidOperationException("");
      }
   
      if (stringIsNullOrEmpty(thisErrorMessage))
      {
        ExceptionHandlingContextCurrentErrorsAdd(exceptionMessage);
      }
      else
      {
        ExceptionHandlingContextCurrentErrorsAdd(thisErrorMessage);
      }
      return exception;
    }
  }

以上が例外処理に対する ASP.NET MVC ソリューションの概要の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。