方案改进：直接通过User Control生成HTML
2008-07-14 13:24 by 老赵, 41618 visits对于使用User Control生成HTML的方式，大家应该已经比较熟悉了，老赵也曾经写过一篇文章（《技巧：使用User Control做HTML生成》）来描述这个做法。使用User Control进行HTML生成最大的好处就是将表现（Presentation）逻辑集中在一处，并且能够让前台开发人员使用传统的方式参与到页面开发中来。在其他方面，使用User Control生成HTML的做法直接使用了ASP.NET WebForms引擎，在开发时能够利用到ASP.NET的各种优秀实践。
在“我的衣橱”中大量使用了这种生成HTML的做法。不过当项目达到一定规模之后，这个方法的不足之处也慢慢地体现了出来。就拿《技巧：使用User Control做HTML生成》作为例子来讲，除了显示上必要的Comments.aspx页面和Comments.ascx控件之外，还有一个额外的GetComments.ashx进行客户端与服务器端之间的通信。不过问题就出在这里，当此类做法越来越多时，项目中就会出现大量的此类ashx文件。冗余代码的增加降低了代码的可维护性，试想如果我们需要在某个控件上增加一个额外的属性，就需要去Handler那里编写对应的逻辑。虽不算是繁重的工作，但是如果能解决这个问题，无疑是一个锦上添花的做法。
如果要避免大量Handler的出现，必然需要找到这些Handler的共同之处。这一点并不困难，因为每个Handler的逻辑的确大同小异：
- 使用ViewManager加载User Control
- 从QueryString或Form中获取参数，并设置对应属性
- 使用ViewManager生成HTML代码，并使用Response.Write输出
写一个统一的Handler来将User Control转化为HTML是一件轻而易举的事情。不过因为有第2步，我们就必须应对为不同控件赋不同值的情况。这种“描述性”的内容即是该控件的“元数据（metadata）”，而说到“元数据”各位应该就能很快想到自定义属性（Custom Attribute）这个.NET特有的事物。因此我们的解决方案也使用这种方式来对控件的属性进行“描述”，且看该属性的定义：
public enum UserControlRenderingPropertySource
{
Form,
QueryString
}
[AttributeUsage(AttributeTargets.Property, AllowMultiple = true, Inherited = true)]
public class UserControlRenderingPropertyAttribute : Attribute
{
public string Key { get; set; }
public UserControlRenderingPropertySource Source { get; set; }
}
这个自定义属性只能标记在属性上，而它的作用是定义这个属性值的来源（是Query String还是Form）与集合中的键名。而我们的实现还会根据属性上标记的DefaultValueAttribute为属性设定默认值。定义了Custom Attrubte之后，我们就可以编写这个统一的Handler了。为了在客户端“隐藏”直接请求ascx文件的事实，我们只响应对扩展名为“ucr”的请求：
public class UserControlRenderingHandler : IHttpHandler
{
public void ProcessRequest(HttpContext context)
{
string appRelativePath = context.Request.AppRelativeCurrentExecutionFilePath;
string controlPath = appRelativePath.ToLower().Replace(".ucr", ".ascx");
var viewManager = new ViewManager<UserControl>();
var control = viewManager.LoadViewControl(controlPath);
SetPropertyValues(control, context);
context.Response.ContentType = "text/html";
context.Response.Write(viewManager.RenderView(control));
}
}
上面代码中的SetPropertyValues方法便是为User Control实例的属性赋值：
private static void SetPropertyValues(UserControl control, HttpContext context)
{
var metadata = GetMetadata(control.GetType());
foreach (var property in metadata.Keys)
{
object value = GetValue(metadata[property], context) ?? GetDefaultValue(property);
if (value != null)
{
property.SetValue(control, Convert.ChangeType(value, property.PropertyType), null);
}
}
}
SetPropertyValues方法中会调用三个方法：GetMetadata，GetValue和GetDefaultValue。GetMetadata方法会得到关于这个control的元数据，为PropertyInfo - List<UserControlRenderingPropertyAttribute>的键值对（即Dictionary）。然后将metadata传入GetValue方法，以获取由UserControlRenderingPropertyAttribute标记的值。如果GetValue方法返回null，则调用GetDefaultValue方法获取标记在该属性上DefaultValueAttribute。以下就将其余代码附上，没有技术含量，但做一参考：
至此，UserControlRenderingHandler完成了。不过在真正使用时，还需要进行一些配置。例如，您需要在IIS的ISAPI Mapping中将“.ucr”与aspnet_isapi.dll进行映射，并且在web.config中将*.ucr与UserControlRenderingHandler关联起来。当然，对User Control的属性进行标记是必须的。例如还是《技巧：使用User Control做HTML生成》一文中的例子：
public partial class Comments : System.Web.UI.UserControl
{
protected override void OnPreRender(EventArgs e)
{
// ...
}
[UserControlRenderingProperty(Key = "page", Source = UserControlRenderingPropertySource.QueryString)]
public int PageIndex { get; set; }
[DefaultValue(10)]
public int PageSize { get; set; }
// ...
}
然后，在客户端代码中只要根据路径发起请求即可，UserControlRenderingHandler会在服务器端完成余下的工作。
<script type="text/javascript" language="javascript">
function getComments(pageIndex)
{
new Ajax.Updater(
"comments",
"/Controls/Comments.ucr?page=" + pageIndex + "&t=" + new Date(),
{ method: "get" });
return false; // IE only
}
</script>
不过，这就够了吗？对于一个例子来说，这已经足够了，不过要在产品环境中使用很可能还略显不够。例如，如果只让用户访问到特定的User Control，或者只有特定权限的用户才能访问，又该如何对UserControlRenderingHandler进行改造呢？相信您了解上述做法之后，这点要求对您一定不成问题。
沙发
先顶再看
老赵好久不发问啦