微型项目实践（6）：Business层代码分析——实体类的生成策略

上一篇中，我们分析了实体类的基类Entity，这一篇中，我们就分析一下基于该类的实体类。

每一个实体类都会有两个文件组成，我们以BlogClass为例，该类包含两个文件：BlogClass.cs和BlogClass.designer.cs，这非常类似VS自己生成的代码，更方便的是，VS还会自动把这两个文件折叠起来，如图。

这两个文件中，BlogClass.designer.cs包含所有的生成代码：成员、属性等，而BlogClass.cs则只包含一个类的定义，供我们填写代码使用。

BlogClass.designer.cs的代码如下。

using System;
using System.Collections.Generic;
using System.Data.Linq;
using System.Linq;
using System.Text;

using DongBlog.Common;

namespace DongBlog.Business.Blogs
{
    /// <summary>
    /// 日志分类
    /// </summary>
    public partial class BlogClass
    {
        #region ID和时间戳

        private int _ID = NEW_ENTITY_ID;
        private byte[] _TimeStamp = new byte[] { };

        /// <summary>
        /// 取得ID
        /// </summary>
        public override int ID
        {
            get { return _ID; }
        }
        /// <summary>
        /// 取得时间戳
        /// </summary>
        public override byte[] TimeStamp
        {
            get { return _TimeStamp; }
        }

        #endregion

        #region 成员

        private string _Name;
        private string _Description;

        #endregion

        #region 属性

        /// <summary>
        /// 取得或设置名称
        /// </summary>
        public string Name
        {
            get { return _Name; }
            set { _Name = value; }
        }
        /// <summary>
        /// 取得或设置描述
        /// </summary>
        public string Description
        {
            get { return _Description; }
            set { _Description = value; }
        }

        #endregion
    }
}

从代码里可以看到，完全就是对实体XML的翻译，需要特别指出的是，其中实现了Entity定义的ID和TimeStamp这两个抽象属性。

BlogClass.cs的代码如下：

using System;
using System.Collections.Generic;
using System.Data.Linq;
using System.Linq;
using System.Text;

using DongBlog.Common;

namespace DongBlog.Business.Blogs
{
    /// <summary>
    /// 日志分类
    /// </summary>
    public partial class BlogClass : Entity<BlogClass>
    {
    }

    /// <summary>
    /// 日志分类的业务外观
    /// </summary>
    public static class BlogClassExtension
    {
    }
}

呃……这个更简单了，完全就是个空的。因为它的用处就是让我们填写自己的代码，现在假设我们有这么一个功能“设置日志分类名称时，如果分类的描述为空，则将分类的描述设置为其名称”，那么我们可以这么干：从BlogClass.desinger.cs文件中，将Name属性的定义Ctrl+X，Ctrl+V过来，然后改改，修改后的代码如下：

using System;
using System.Collections.Generic;
using System.Data.Linq;
using System.Linq;
using System.Text;

using DongBlog.Common;

namespace DongBlog.Business.Blogs
{
    /// <summary>
    /// 日志分类
    /// </summary>
    public partial class BlogClass : Entity<BlogClass>
    {
        /// <summary>
        /// 取得或设置名称
        /// </summary>
        public string Name
        {
            get { return _Name; }
            set
            {
                _Name = value;

                if (string.IsNullOrEmpty(_Description))
                    _Description = value;
            }
        }
    }

    /// <summary>
    /// 日志分类的业务外观
    /// </summary>
    public static class BlogClassExtension
    {
    }
}

这个代码很好理解，值得一提的是，当描述实体的XML修改后，重新生成实体代码时，代码生成器会判断BlogClass.cs中是否包含了Name属性，如果包含了该属性，则在BlogClass.designer.cs中，就不会再生成了。这是自己写代码生成而不用通用代码生成器的好处——我的地盘我做主。:)

另外一个和实体相关的类是Extension类，顾名思义，该类包含的都是对已有类型的扩展方法，利用C#3.0的扩展方法，可以写出非常优雅的代码。例如，我们需要查询某一个分类的所有Blog，给出的是该分类的ID，我们就可以在BlogExtension类中这么写（代码位于\DongBlog.Business\Blogs\Blog.cs）：

/// <summary>
/// 日志的业务外观
/// </summary>
public static class BlogExtension
{
    /// <summary>
    /// 根据日志分类取得日志
    /// </summary>
    /// <param name="query">日志查询</param>
    /// <param name="blogClassID">日志分类ID</param>
    /// <returns>该分类下的日志</returns>
    public static List<Blog> GetBlogsByClassID(this IQueryable<Blog> query, int blogClassID)
    {
        if (query == null)
            throw new ArgumentNullException("query");

        return query
            .Where(b => b.BlogClassID == blogClassID)
            .OrderByDescending(b => b.UpdateDateTime)
            .ToList();
    }
}

上面的查询方法使用Linq实现的，我们还顺手做了一个根据更新时间的排序。有了这个方法，我们以后就可以用这样的方式取得某一个分类的Blog：database.GetDataAccess<Blog>().GetBlogByClassID(1)；该方式以后还会进一步简化为：database.Blogs.GetBlogByClassID(1)。

最后说明一点，以上代码都是可以测试的，因为我们所有的方法都是使用接口作为参数的，所以我们可以用脚手架（Mock类）伪实现相应的接口，以便对不同输入和环境下的代码进行自动化测试，具体方法就不展开了。

下一篇文章我们将分析数据访问的设计与实现。

代码下载