ASP.NET MVC编程——错误处理与日记

ASP.NET MVC的错误处理应考虑到这几个方面：模型绑定期间发生的错误，未能路由到指定操作，针对控制器的错误处理。使用配置文件可以帮助我们处理异常，但是不够灵活和全面；使用HandleErrorAttribute、自定义错误过滤器或重写控制器OnException方法只能解决针对控制器的错误，无法解决模型绑定期间发生的错误，也无法处理404错误，即使将错误过滤器注册为全局过滤器也是如此。有时候需要多种方法配合使用。

在捕获错误的地方，可以将有用的信息记录下来，便于我们查出引起问题的原因和纠正错误。

 

1启用自定义错误

使用这种方式一定要注意将defaultRedirect设置为指定的错误页面，防止黑客探测各种错误情形进而发现系统的额漏洞。

<system.web>
  <customErrors mode="On" defaultRedirect="/error/error2">
    <error statusCode="" redirect="/error/error1" />
  </customErrors>
  <!--其他配置-->
</system.web>

Mode:处理模式，有三种处理模式

• On,启用自定义处理功能，当错误发生时显示自定义错误页
• Off,关闭自定义错误处理功能，当错误发生时显示默认的错误页。
• RemoteOnly，启用自定义错误处理功能，但只针对来自远程机器的请求有效。

defaultRedirect：发生错误时，显示指定错误页。

<error>:根据状态码显示指定的错误页。mode必须为On或RemoteOnly模式，否则不会起作用。

注意：不论defaultRedirect和redirect都配置为指定的路径，例如上述配置中控制器error，控制器操作为error1和error2，相应地错误页为Error1.cshtml和Error2.cshtml。

2针对控制器的错误处理

2.1使用HandleErrorAttribute修饰控制器或操作。

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, Inherited = true, AllowMultiple = true)]
public class HandleErrorAttribute : FilterAttribute, IExceptionFilter
{
        //获取或设置异常的类型。
        public Type ExceptionType { get; set; }
        //获取或设置用于显示异常信息的母版视图
        public string Master { get; set; }
        //获取此特性的唯一标识符。
        public override object TypeId { get; }
        //获取或设置用于显示异常信息的页视图。
        public string View { get; set; }
        //在发生异常时调用。
        //filterContext:操作筛选器上下文
        public virtual void OnException(ExceptionContext filterContext);
}

例：

当发生KeyNotFoundException类型的异常时，显示KeyNotFind视图

[HandleError(ExceptionType=typeof(KeyNotFoundException),View="KeyNotFound")]
public ActionResult Index()
{
    ......
}

还可以使用自定义的错误过滤器，并将其应用到控制器或操作上。

例：

    public class CustomHandleError : HandleErrorAttribute
    {
        public override void OnException(ExceptionContext filterContext)
        {
            if (filterContext==null)
                base.OnException(filterContext);

            //记录日志
            LogError(filterContext.Exception);

            //判断是否启用了自定义错误
            if (filterContext.HttpContext.IsCustomErrorEnabled)
            {
                //将错误设置为已处理
                filterContext.ExceptionHandled = true;
                base.OnException(filterContext);
            }
        }
    }

可以设置全局过滤器，这样对每一个控制器都起作用。

App_Start文件夹下FilterConfig.cs文件中设置全局错误过滤器，过滤器会按照他们注册的顺序执行。但可以通过Order属性指定执行顺序。

例：

public class FilterConfig
{
        public static void RegisterGlobalFilters(GlobalFilterCollection filters)
        {
            filters.Add(new HandleErrorAttribute
            {
                ExceptionType = typeof(KeyNotFoundException),
                View = "KeyNotFound",
                Order =
            });
            filters.Add(new HandleErrorAttribute(),);
        }
}

将自定义错误过滤器设置为全局过滤器：

在App_Start文件夹下FilterConfig.cs文件中

例：

    public class FilterConfig
    {
        public static void RegisterGlobalFilters(GlobalFilterCollection filters)
        {

             //其他过滤器

             filters.Add(new CustomHandleError());
         }
     }

2.2重写控制器OnException方法

注意将错误设置为已处理，不然错误继续抛出，但如果设置了全局错误过滤器，那么即使不标记为已处理，也不要紧，因为错误最终会被全局过滤器捕获并处理。

例：

 public class HomeController : Controller
 {

        //其他控制器操作

        protected override void OnException(ExceptionContext filterContext)
        {
            if (filterContext==null)
                base.OnException(filterContext);

            //记录日志
            LogError(filterContext.Exception);

            //判断是否启用了自定义错误
            if (filterContext.HttpContext.IsCustomErrorEnabled)
            {
                //将错误设置为已处理
                filterContext.ExceptionHandled = true;
                //显示错误页
            this.View("Error").ExecuteResult(this.ControllerContext);
            }
        }
}

或者创建控制器基类

    public class BaseController : Controller
    {
        protected override void OnException(ExceptionContext filterContext)
        {
            //错误日志记录
        }
    }

3全局错误处理

针对模型绑定或路由等过程中抛出的异常我们只能使用全局错误处理策略。

3.1 Global.asax中添加处理异常的代码

例：

    public class MvcApplication : System.Web.HttpApplication
    {
        protected void Application_Start()
        {
            AreaRegistration.RegisterAllAreas();
            FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
            RouteConfig.RegisterRoutes(RouteTable.Routes);
            BundleConfig.RegisterBundles(BundleTable.Bundles);
        }

        protected void Application_Error(object sender, EventArgs e)
        {
            var exception = Server.GetLastError();
            if (exception == null)
            {
                return;
            }

            //异常发生记录日志或发送邮件

            //清除异常
            Server.ClearError();

            //重定向
            Response.Redirect("home/index");
        }
    }

3.2捕获未匹配的路由

在路由注册列表最底端注册路由。

    public class RouteConfig
    {
        public static void RegisterRoutes(RouteCollection routes)
        {
           //其他配置
           routes.MapRoute(
                name: "MatchAll",
                url: "{*anyurl}",
                defaults: new { controller = "Error",action ="Missing" }
                );
         }
     }

定义Error控制器及Missing操作

    public class ErrorController : Controller
    {
        // GET: Error
        public ActionResult Missing()
        {
            HttpContext.Response.StatusCode = ;
            //禁用IIS7默认的错误页，这样才能展示我们指定都的视图
            HttpContext.Response.TrySkipIisCustomErrors = true;

            //也可以在此处记录日志信息

            //要展示的信息
            var model = ......
            return View(model);
        }
     }

需要注意的是，这种方式不一定能处理所有未匹配的情形。

例如：http://localhost/mvcpointapp/home/index1，这个url请求说我home是存在，但是index1操作不存在，上面配置MatchAll路由无法匹配这个url。

可以匹配的情形如：http://localhost/mvcpointapp/v1/home/index/1，这个url能被上面配置的MatchAll路由匹配，所以可以显示Missing视图。

4实践

4.1使用HandleErrorAttribute注意要对<system.web>的<customErrors>节进行设置 。

例如：

控制器为

    public class HomeController : Controller
    {
        [HandleError(ExceptionType = typeof(KeyNotFoundException), View = "Error")]
        public ActionResult Index()
        {
            throw new KeyNotFoundException();
            return View();
        }

        //其他控制操作

      }

<system.web>的<customErrors>节

<customErrors mode="On" defaultRedirect="Error/Error2"></customErrors>

Error.cshtml文件位于Views文件夹下的子文件夹Shared文件夹下

浏览器中输入：http://localhost/mvcpointapp/

结果可以正常显示Error.cshtml页面,同时注意到虽然在customErrors 配置节中指定了defaultRedirect，但还是跳转到Error.cshtml页面。

将<customErrors>的mode设置为Off,则显示经典错误页。

4.2 Application_Error

代码如3.1节所示，控制器如4.1所示，<system.web>的<customErrors>节为<customErrors mode="On" defaultRedirect="Error/Error2"></customErrors>

输入：http://localhost/mvcpointapp/home/index，断点调试，发现错误被HandleError拦截，Global.asax的Application_Error方法没有执行。而当输入：http://localhost/mvcpointapp/home/indexr，Application_Error执行了。

关闭<customErrors>配置节，而不注掉控制器上的HandleErrorAttribute特性，输入：http://localhost/mvcpointapp/home/index，发现Application_Error执行了。

通过上述实践，充分证明HandleErrorAttribute会拦截控制器内抛出的异常，而无法拦截无法找到资源这种异常。

4.3策略

一种常用的拦截错误信息、记录错误日志与显示自定义错误页的策略为：

1）首先配置<system.web>的<customErrors>节，注意务必设置defaultRedirect；并且定义错误控制器及相应的操作和视图。

2）定义基类控制器或自定义错误过滤器，记录异常。对于自定义错误过滤器的情形一般将其注册为全局过滤器。

3）在Global.asax中添加Application_Error方法拦截意想不到的异常并记录异常。

参考：

1.Jess Chadwick/Todd Snyder/Hrusikesh Panda，徐雷/徐扬

译。ASP.NET MVC4 Web编程

2.Jon Galloway/Phil Haack/Brad Wilson/K. Scott Allen，孙远帅/邹权译  ASP.NET MVC4 高级编程（第四版）

3.黄保翕，ASP.NET MVC4开发指南

4.蒋金楠，ASP.NET MVC4框架揭秘

5.https://www.asp.net/mvc

6.Dino Esposito著，潘丽臣译，ASP.NET MVC5编程实战

转载与引用请注明出处。

时间仓促，水平有限，如有不当之处，欢迎指正。