微型项目实践（2）：用测试驱动代码生成

上一篇文章中，我们分析了系统的两个实体类，并且给出了对应的实体XML。今天我们来看看如何根据这个XML进行代码生成。

<?xml version="1.0" encoding="utf-8" ?>
<Entities xmlns="http://it.ouc.edu.cn/EntityDescription/V2">
  <Entity title="日志" name="Blog" module="Blogs">
    <Item title="标题" name="Title" type="text" require="true"/>
    <Item title="内容" name="Content" type="longtext" require="false"/>
    <Item title="所属分类" name="BlogClass" type="entity" entityName="BlogClass" require="false"/>
    <Item title="创建时间" name="CreateDateTime" type="datetime" require="true"/>
    <Item title="更新时间" name="UpdateDateTime" type="datetime" require="true"/>
  </Entity>
  <Entity title="日志分类" name="BlogClass" module="Blogs">
    <Item title="名称" name="Name" type="text" require="true"/>
    <Item title="描述" name="Description" type="text" require="false"/>
  </Entity>
</Entities>

这里我们主要是生成两种最重要的代码，一是数据库的建库脚本，二是实体的CS类。
我们使用测试来驱动代码生成，在项目DongBlog.Test中添加一个新的单元测试：Util.cs。对应的代码如下：

using ...

namespace DongBlog.Test
{
    /// <summary>
    /// 数据库相关的工具方法
    /// </summary>
    [TestClass]
    public class DatabaseUtil
    {
        /// <summary>
        /// 构造建库脚本
        /// </summary>
        [TestMethod, Description("构造建库脚本")]
        public void Util_CreateDatabaseScript()
        {
            var entities = getEntities();
            string sqlText = MsSqlServerScriptBuilder.getSqlScript(entities);

            Debug.WriteLine("");
            Debug.WriteLine("The following is the database creating script:");
            Debug.WriteLine("=============================彪悍的分割线==============================================================================");
            Debug.WriteLine("");
            Debug.WriteLine("");
            Debug.WriteLine(sqlText);
            Debug.WriteLine("");
            Debug.WriteLine("");
            Debug.WriteLine("=============================又见彪悍的分割线==========================================================================");
        }

        private Entity[] getEntities()
        {
            XmlDocument document = new XmlDocument();
            document.Load(Gobal.EntityXmlFileName);
            return EntityXmlParser.ParseXml(document);
        }
    }
}

这个类中定义的个单元测试，并不测试任何功能代码，而是用于生成数据库的建库脚本。VS.Net中似乎没有Make这样的自动化脚本，使用第三方的组件和工具则略显繁琐，而这种单元测试的“歪用”能起到不错的效果。:)

单元测试充当自动化脚本还可以实现很多功能，常用的除了上面的生成数据库脚本外，还有生成实体类代码、生成Linq的外置XML映射文件、填充测试数据、从旧版本系统中导入数据、统计代码行数等，大家可以尽情的发挥想象，呵呵。

回到我们的系统中，使用Debug的方式运行Util_CreateDatabaseScript测试，数据库脚本会写入到Output窗口中（使用快捷键Ctrl+W、O打开）。

if exists (select * from dbo.sysobjects where id = object_id(N'[dbo].[FK_Blog_BlogClass]') and OBJECTPROPERTY(id, N'IsForeignKey') = 1)
ALTER TABLE [dbo].[Blog] DROP CONSTRAINT FK_Blog_BlogClass
GO

if exists (select * from dbo.sysobjects where id = object_id(N'[dbo].[Blog]') and OBJECTPROPERTY(id, N'IsUserTable') = 1)
drop table [dbo].[Blog]
GO

if exists (select * from dbo.sysobjects where id = object_id(N'[dbo].[BlogClass]') and OBJECTPROPERTY(id, N'IsUserTable') = 1)
drop table [dbo].[BlogClass]
GO

CREATE TABLE [dbo].[Blog] (
    [ID] [int] IDENTITY (1, 1)  NOT NULL ,
    [Title] [nvarchar] (255) COLLATE Chinese_PRC_CI_AS NOT NULL ,
    [Content] [text] COLLATE Chinese_PRC_CI_AS ,
    [BlogClassID] [int] ,
    [CreateDateTime] [datetime] NOT NULL ,
    [UpdateDateTime] [datetime] NOT NULL ,
    [TimeStamp] [timestamp] NULL
) ON [PRIMARY]
GO

CREATE TABLE [dbo].[BlogClass] (
    [ID] [int] IDENTITY (1, 1)  NOT NULL ,
    [Name] [nvarchar] (255) COLLATE Chinese_PRC_CI_AS NOT NULL ,
    [Description] [nvarchar] (255) COLLATE Chinese_PRC_CI_AS ,
    [TimeStamp] [timestamp] NULL
) ON [PRIMARY]
GO

ALTER TABLE [dbo].[Blog] WITH NOCHECK ADD
    CONSTRAINT [PK_Blog] PRIMARY KEY  CLUSTERED
    (
        [ID]
    )  ON [PRIMARY]
GO
ALTER TABLE [dbo].[BlogClass] WITH NOCHECK ADD
    CONSTRAINT [PK_BlogClass] PRIMARY KEY  CLUSTERED
    (
        [ID]
    )  ON [PRIMARY]
GO
ALTER TABLE [dbo].[Blog] WITH NOCHECK  ADD
    CONSTRAINT [FK_Blog_BlogClass] FOREIGN KEY
    (
        [BlogClassID]
    ) REFERENCES [dbo].[BlogClass] (
        [ID]
    )
GO

这里数据库脚本的生成借鉴了ROR的一些优点，比如为每个实体添加ID主键和时间戳。另外，实体数据字段类型对应到了具体的数据库类型（bool->bit，text->nvarchar(255)等），而实体间关系对应到表间关系。至于具体的对应规则和生成方式，可以根据项目和所采用数据库的不同进行调整。

自动化的优点就在于，每次我们修改实体XML后，只要重新生成一遍数据库脚本，就可以完成数据库的更新，这点在团队开发中很有用，任何人修改数据库都只需要通知同伴更新一下即可。而在项目每一轮迭代完成、进行发布的时候，也可以方便的获取数据库脚本。

生成器的代码在YD.Data.EntityPrase和YD.Data.DatabaseScriptGenerater这两个命名空间下。很简单，无非是拼字符串而已，大家可以参考一下，根据自己的需要编写自己的生成器（我一直认为编写代码生成工具是程序员的基本功）。

下一篇文章我们将研究怎么生成实体类以及要生成什么样的实体类。

代码下载