微型项目实践（12）：查询与显示

上一篇中，我们分析了页面中的控件和数据绑定中的扩展方法，今天我们看数据的查询和显示。其中，数据的查询属于业务逻辑层（Business），而显示属于UI层。

假设我们要根据以下两个条件进行查询：

1. 日志分类（ID）
2. 发布时间（范围）

两者为“AND”的关系，则查询可以通过通过扩展IQueryable<Blog>类实现，该功能定义在BlogExtension类中（位于DongBlog.Business\Blogs\Blog.cs文件中），代码如下：

/// <summary>
/// 根据日志分类取得日志
/// </summary>
/// <param name="query">日志查询</param>
/// <param name="blogClassID">日志分类ID</param>
/// <param name="createDataTimeStart">日志发表的起始时间</param>
/// <param name="createDataTimeEnd">日志发表的结束时间</param>
/// <returns>该分类下的日志</returns>
public static List<Blog> GetBlogsBy(this IQueryable<Blog> query,
          int? blogClassID, DateTime? createDataTimeStart, DateTime? createDataTimeEnd)
{
    if (query == null)
        throw new ArgumentNullException("query");

    var q = query.AsQueryable();

    if (blogClassID.HasValue)
        q = q.Where(b => b.BlogClassID == blogClassID.Value);
    if (createDataTimeStart.HasValue)
        q = q.Where(b => b.CreateDateTime > createDataTimeStart.Value);
    if (createDataTimeEnd.HasValue)
        q = q.Where(b => b.CreateDateTime < createDataTimeEnd.Value);

    return q
        .OrderByDescending(b => b.CreateDateTime)
        .ToList();
}

这段代码充分运用了Linq面向对象的方法进行数据库的查询，表间关联使用类的引用表示，最终会由Linq2SQL翻译为SQL语句。这种方法可以完成非常复杂的查询，在我们团队目前的项目中，最多的在一次查询中涉及五个表，几十个字段条件，条件还包括等于，大于、小于、属于，相似等多种情况。

这段代码虽然实现了查询功能，不过存在几个问题：第一，CreateDataTimeStart和CreateDataTimeEnd应该是一个表示范围的整体；第二，函数的参数随着查询条件的增加会变得越来越臃肿；第三，没有考虑分页。我们重构一下以上代码，解决这些问题。

在重构之前，还有一个要注意的是：重构的安全网——测试。在这个系统中，由于规模很小，没有实现完整的测试。但是所有的代码都是可以（并且容易）测试的，比如上面这个查询函数，可以通过实现用于测试的IQueryable<Blog>实现自动化测试。

我们先来重构第一个问题，抽取CreateDataTimeStart和CreateDataTimeEnd作为一个类，称之为TimeRange，放在Common层中，代码如下：

using ...

namespace DongBlog.Common
{
    /// <summary>
    /// 表示一个时间段
    /// </summary>
    public class TimeRange
    {

        /// <summary>
        /// 取得或设置起始时间
        /// </summary>
        public DateTime? StartTime { get; set; }

        /// <summary>
        /// 取得或设置终止时间
        /// </summary>
        public DateTime? EndTime { get; set; }

        /// <summary>
        /// 构造一个时间段
        /// </summary>
        public TimeRange() { }
        /// <summary>
        /// 构造一个时间段
        /// </summary>
        /// <param name="startTime">起始时间</param>
        /// <param name="endTime">终止时间</param>
        public TimeRange(DateTime startTime, DateTime endTime)
        {
            this.StartTime = startTime;
            this.EndTime = endTime;
        }
    }
}

然后GetBlogs函数可以重构为：

public static List<Blog> GetBlogsBy(
             this IQueryable<Blog> query, int? blogClassID, TimeRange createDateTime)
{
    if (query == null)
        throw new ArgumentNullException("query");

    var q = query.AsQueryable();

    if (blogClassID.HasValue)
        q = q.Where(b => b.BlogClassID == blogClassID.Value);

    if (createDateTime != null)
    {
        if (createDateTime.StartTime.HasValue)
            q = q.Where(b => b.CreateDateTime > createDateTime.StartTime.Value);
        if (createDateTime.EndTime.HasValue)
            q = q.Where(b => b.CreateDateTime < createDateTime.EndTime.Value);
    }

    return q
        .OrderByDescending(b => b.CreateDateTime)
        .ToList();
}

对月第二和第三个问题，我们利用前面提到的Common层的Query相关类一并解决。添加BlogQueryInformation类，代码如下：

/// <summary>
/// 日志查询信息
/// </summary>
public class BlogQueryInformation : QueryInformation
{
    /// <summary>
    /// 取得或设置日志分类ID
    /// </summary>
    public int? BlogClassID { get; set; }
    /// <summary>
    /// 取得或设置日志发表时间
    /// </summary>
    public TimeRange CreateDateTime { get; set; }
}

这样，就可以把GetBlogs方法重构如下：

public static QueryResult<Blog> GetBlogsBy(
           this IQueryable<Blog> query, BlogQueryInformation queryInfo)
{
    if (query == null)
        throw new ArgumentNullException("query");
    if (queryInfo == null)
        throw new ArgumentNullException("queryInfo");

    var q = query.AsQueryable();

    if (queryInfo.BlogClassID.HasValue)
        q = q.Where(b => b.BlogClassID == queryInfo.BlogClassID.Value);

    if (queryInfo.CreateDateTime != null)
    {
        if (queryInfo.CreateDateTime.StartTime.HasValue)
            q = q.Where(b => b.CreateDateTime > queryInfo.CreateDateTime.StartTime.Value);
        if (queryInfo.CreateDateTime.EndTime.HasValue)
            q = q.Where(b => b.CreateDateTime < queryInfo.CreateDateTime.EndTime.Value);
    }

    var resultList = q.OrderByDescending(b => b.CreateDateTime)
        .Skip(queryInfo.Begin).Take(queryInfo.Limit)
        .ToList();

    return new QueryResult<Blog>(resultList, q.Count());
}

最后两句代码实现了分页功能。以后添加新的查询条件时，只需要修改BlogQueryInformation和GetBlogs方法就可以了，函数的签名不需要修改。

然后我们看页面的调用，Default页面中，负责显示的代码如下：

protected void Page_Load(object sender, EventArgs e)
{
    if (!IsPostBack)
        display();
}

private void display()
{
    var pageCountHelper = new PageCountHelper(this, "篇");
    var queryInfo = new BlogQueryInformation();

    queryInfo.BlogClassID = getBlogClassID();
    queryInfo.CreateDateTime = getCreateDateTime();
    queryInfo.Begin = pageCountHelper.CurrentPageCount
                 * pageCountHelper.RecordPerPage;
    queryInfo.Limit = pageCountHelper.RecordPerPage;

    var result = Database.Blogs.GetBlogsBy(queryInfo);
    ListView_BlogList.DataSource = result.ResultList;
    LiteralPageCount.Text = pageCountHelper.GetPageCountHtml(result.Total);

    DataBind();
}
private TimeRange getCreateDateTime()
{
    var createDateTime = new TimeRange();
    return TimeRange.TryPrase(Request["CreateDateTime"], createDateTime) ?
                 createDateTime : null;
}
private int? getBlogClassID()
{
    var blogClassIDString = Request["BlogClassID"];
    return String.IsNullOrEmpty(blogClassIDString) ?
               null : new Nullable<int>(Convert.ToInt32(blogClassIDString));
}

即：构造查询条件 -> 调用业务逻辑层（这里是GetBlogs方法）进行查询 -> 显示查询结果。其中用到了PageCountHelper这个辅助类，负责处理页面的分页，原理很简单，无非是拼Html，细节可以参考代码。

Master页面中，用于显示日志分类的ListView也使用这种方法实现数据绑定。至此，日志显示、根据日志分类的简单筛选和分页都已经实现了，最后我们得到了如下效果：

其中的测试数据，使用测试（InitialTestData）填充。

代码下载