为ASP.NET MVC开发一些常用插件（三）——Repeater

      最近看到园子里有朋友在翻译一些关于ASP.NET MVC的文章，很是不错，饶有兴趣看了下原作者的博客（http://weblogs.asp.net/stephenwalther），看到其中有两篇写关于GridView的，方才想起来自己曾经也抽空写过这方面的控件（http://www.hereur.cn/SiChuanEarthquake.xhtml/LoveWall 下方的Table就是用这个扩展方法做的），思路大体一致，不过同样作为其中一种HtmlHelper扩展出来的方法，stephenwalther的方法和我第一个版本的差不多，但是正如他说的，有很多缺点，后来我也在使用中确实发现了这些问题，又改进了一下，觉得对于那些不需要太复杂逻辑的情况，还是挺实用的，发出来与大家分享。

同样是替代传统的”header+ foreach + footer ”的方法，我做了两个扩展方法，分别是Repeater和GridView，因为Repeater相对简单和基础，用于轻量级的情况。这里先把Repeater发上来。

首先明确一下这个Repeater的功能：

1、能够根据需要自由转换<div>,<table>,<ul>标签等格式，也可不套用任何格式。并且当使用Table时，可以随意指定其每行显示的单元格数，当最后一行有零头时，自动填充剩余的空单元格。

2、能够在方法中完成自定义header和footer的工作（类似这些“庞杂”的工作应该说是在MVC中催生出Repeater、GridView等插件的主要动因），让整个Repeater在WebForm中一样达到“一体化”，而不再是这样的局面：

<ul>

<% foreach (var item in collection){%>

<li><%= item %></li>     

<% } %>

</ul>

想象一下在包含thead，tbody的table中将更加复杂。当然这样的形势并不是一无是处的，对于美工等前台控制，这些直白的表达方式更加利于我们的操作和控制。所以必须说明的一点是：当需要对其进行很复杂的操作的时候，不要滥用这些扩展方法，否则会给维护带来很多不便。

为了达到上面说的第一点，我们先建一个枚举类型，用于指定使用哪种格式：

（包含在MvcTool/RepeaterExtension.cs中）

       

public enum RepeaterMode
        {
            /**//// <summary>
            /// 不自动加任何多于标记，等同于foreach。但header和footer仍然有效
             /// </summary>
            None = 0,
            Table,
            Div,
            Ul
        }

然后我们来建一个RepeaterExtension类，用于在aspx页面的HtmlHelper方法中扩展这个Repeater：

（也包含在MvcTool/RepeaterExtension.cs中）

       

public class SingleRepeater : IDisposable
        {
           …
        }

        /**//// <summary>
        /// Repeater
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="helper"></param>
        /// <param name="dataSource">数据源</param>
        /// <param name="header">第一个单项循环开始之前的内容</param>
        /// <param name="itemTempletes">单项内容</param>
        /// <param name="separatorTemplate">每次循环分隔内容（Table慎用）</param>
        /// <param name="footer">最后一个单项循环结束之后的内容</param>
        /// <param name="repeaterMode">repeater模式</param>
        /// <param name="colCount">每行烈数（只在repeaterMode为Table时有效）</param>
        /// <param name="htmlAttributes">标签属性</param>
        /// <returns></returns>
        public static string Repeater<T>(this HtmlHelper helper, IEnumerable<T> dataSource,
            string header, Expression<Func<T, string>> itemTempletes, Expression<Func<T, string>> separatorTemplate, string footer,

            RepeaterMode repeaterMode, int colCount, object htmlAttributes)
        {
            …
        }

RepeaterExtension 主要包含了两个方法：SingleRepeater()和Repeater<T>()，因为里面具体实现的代码比较长，这里省略了，大家可以在下面提供的下载中察看MvcTool/RepeaterExtension.cs文件。对于SingleRepeater()大家可能会有点疑问：是否需要存在？是否需要继承IDisposable？我这里就此简要说明一下用意：目前的这些代码中，无论是SingleRepeater()还是继承IDisposable的行为，都是可以被简化并且整合到Repeater<T>()方法中的，这里这么做是为了给页面表现形式留有一个升级的余地，比如在using()中书写等等（为了更好的对页面进行控制）。

public enum RepeaterMode这个枚举大家也可以根据自己的需要扩展，比如<ol>等等。

下面我们来一下aspx如何使用：

<%= Html.Repeater(ViewData.Model.UserInfo,//数据源
    "",//header
    z=> string.Format("{0} ，年龄：{1}", z.UserName,z.Age),//item模板，为了在页面得到数据的完全控制，必须返回string类型
    z=> "",//间隔
    "",//footer
    RepeaterExtension.RepeaterMode.Ul,//重复的方式（table,div,ul）
    0,//如果使用Table，则指定其显示的列数
    null//最外层标签的属性，object类型
    ) %>

其中RepeaterExtension.RepeaterMode.Ul用于指定这个Repeater的展现方式为Ul/Li。

         我们来看看实际输出的效果：

UL(即上述代码输出)：

Table形式（5列）：

不使用任何格式（header为“[”，footer为“]”，间隔为“|”）：


代码下载：/Files/szw/MVCRepeater.rar

PS：这个Repeater扩展对输出内容较为简单的代码能起到很好的提高开发效率的作用，不光在MVC能用，在WebForm里面也是可以的。同时其中的一些思想和参数用法，也是对接下来要讲的GridView的一个基础和热身。下一篇：为ASP.NET MVC开发一些常用插件（四）——GridView。