如何解决“呈现控件时出错”的问题

在制作控件的时候容易遇到“呈现控件时出错”“发生了未处理的异常。未将对象引用设置到对象的实例。”这样的错误，如下图：(也有可能仅仅只是因为未设置runat="server"标签而导致该错误，请先检查该项。)

但是在编译时/运行时也都是没有错误的。

分析

如图所示的情况我们称之为“设计时”以区别于“编译时”/“运行时”。

设计时：在ASP.NET环境中也就是当我们在Visual Studio中使用网页设计器进行编辑的时候。直接的理解就是在ASPX页面切换到“设计”的时候。

编译时：直接的理解就是当你进行编译的时候，通常这个时候的错误是由类型检查，参数匹配等显式可直接通过语法约束所限制的错误。

运行时：直接的理解就是当你进行预览/运行的时候。通常这个时候的错误则是由具体的异常，逻辑错误所组成的。

让我们分析控件在设计时的表现，我们的控件在设计时的时候，VS智能地模拟输出控件在运行时的样貌，控件的呈现通过了一定顺序的方法，并最终形成了当前输出。按照标准，我们应该是在Render或RenderContents中对控件进行了输出的操作(事实上其他也是可以，但我们通常也不那么做，或者说更多的“呈现控件时出错”的异常主要来自于Render或RenderContents)。

从错误的提示“未将对象引用设置到对象的实例。”从这一句话来看，也就是说，有一个或者以上的对象的实例在没有赋初值的情况下就被使用了。

让我们窥视一下我们的代码：

protected override void RenderContents(HtmlTextWriter writer)
{
    UpButton.Text = Page.Server.HtmlDecode(UpButton.Text);
    DownButton.Text = Page.Server.HtmlDecode(DownButton.Text);
    base.RenderContents(writer);
}

因为该控件在设计的时候需要有一个向上的按钮和一个向下的按钮，分别需要用两个特殊的标点符号向上和向下，而这两个符号需要通过设置如下所示的代码编号才可以正确地被浏览器呈现：

private string upButtonText = "∧";
private string downButtonText = "∨";

而这两个符号在呈现前却会被页面进行一个HtmlEncode方法编译后再输出，而这两个特殊的标志却只能通过直接输出的方式进行呈现，也就是说在HtmlEncode之后只能将该特殊标志以文本的形式输出∧ ∨而不会输出向上和向下的箭头。这时候我们需要引入它的反向方法Page.Server.HtmlDecode进行解码，注意到这里我们使用了Page实例，该实例只有在页面真实存在的情况下才为非空，否则后续的操作将是对null的操作，而这样的操作将会显示“未将对象引用设置到对象的实例。”这样的错误。

设计时：我们刚才提到了，设计时仅仅只是模拟页面呈现的过程，而页面事实上是不存在的。因此在这个时候Page对象的实例将为空，后续的调用将引发异常。

假设说我们只有这个方法用于处理当前所需要的行为，那么我们在调用Page的时候必将导致null的对象并致使后续操作发生异常。这个时候我们引入“设计模式”这个概念(非DesignPattern而是DesignMode)，DesignMode是由Control类的一个受保护的(protected)属性，它获取一个值，用以指示该组件当前是否处于设计模式。这里的设计模式也就相当于设计时的概念。

因此我们可以将代码改造为如下形式：

protected override void RenderContents(HtmlTextWriter writer)
{
    if (!DesignMode)
    {
        UpButton.Text = Page.Server.HtmlDecode(UpButton.Text);
        DownButton.Text = Page.Server.HtmlDecode(DownButton.Text);
    }
    base.RenderContents(writer);
}

这样只有在非设计时的时候，我们才引入Page对象的实例，因此设计时的异常将迎刃而解。

总结

因此在设计控件的时候，特别是在考虑控件呈现的时候，为了避免类似异常的发生，我们应该考虑该控件在设计时能够获取足够的资源，对于未能获取资源的项，我们应该显式将其区分（如上代码中使用DesignMode来判断是否为设计时要执行的代码）。

扩展

刚才我们所见到的情形可以归结为在设计时无法引用具体实例所导致的异常，类似该异常的还会有数据库/文件系统读取、变量未附初值、调用了类似Page的属性如Session，Page.Request.QueryString等。在页面设计的时候由于以上部分方案特别是调用到Page的相关方法的由于页面总是会存在，因此我们不会经常看到它们出异常，在设计控件的时候我们更应该注意。