前言
曾经尝试过很多DotNet下的ORM工具(只是DotNet2.0下的),有IBatis.Net, NHibernate, MyGeneration doodads, Microsoft EntLib, SubSonic等,觉得最简单的要数
doodads,最好用的当属
SubSonic。
因此在
AppBox项目中,我毫不犹疑的选择SubSonic作为ORM工具。为了兼容dotnet2.0的程序,我们不会使用最新的SubSonic3.0版本,而是使用SubSonic2.2版本。 因为2.2版本已经有两年左右的稳定时间,所以应该不会出现大的BUG并且很容易在网上找到问题的解决办法。
约定优先于配置
这是一条由 Ruby On Rails 发扬广大的编程规则,SubSonic也
非常重视这条规则,并在创建数据库表时有一些有用的约定:
1. 每个表都应该包含如下四个列(不是必需的),这样在使用SubSonic的创建和更新函数时可以方便的修改这些字段:
- CreatedOn (datetime)
- CreatedBy (nvarchar(50))
- ModifiedOn (datetime)
- ModifiedBy (nvarchar(50))
2. 如果你想使用
逻辑删除,可以增加列:Deleted (bit)
这样当你调用数据库表映射类的静态方法 Delete 时,SubSonic会首先判断此表是否存在Deleted字段,如果存在则设为true。否则,则调用 Destory 函数,即是永久删除。
3. 对表名和列名的约定。
- 表名为单数形式
- 列名不要包含保留字(比如system,string等)
- 列名不要和表名相同
那么如何在Asp.net2.0 WebApplication项目中使用SubSonic,我想大概有如下几个步骤:
- 创建数据库和表
- 配置Web.config
- 通过sonic.exe连接数据库,生成所有的映射类
- 使用映射类对数据库进行CRUD
创建数据库和表
首先我们再SqlServer2005中新建一个数据库AppBox,然后创建用户表:
![Subsonic配置与使用](http://img.e-com-net.com/image/product/fc00b66da2744715b82f152f5f06f052.png)
可以看到,我们遵守了SubSonic的约定增加了CreatedOn,CreatedBy,ModifiedOn,ModifiedBy。不过没有使用逻辑删除。
配置Web.config
<configSections>
<section name="SubSonicService" type="SubSonic.SubSonicSection, SubSonic"/>
</configSections>
<connectionStrings>
<clear/>
<add name="Default" connectionString="Password=sa;Persist Security Info=True;User ID=sa;Initial Catalog=AppBox;Data Source=."/>
</connectionStrings>
<SubSonicService defaultProvider="Default">
<providers>
<clear/>
<add name="Default" type="SubSonic.SqlDataProvider, SubSonic" connectionStringName="Default" generatedNamespace="AppBox"/>
</providers>
</SubSonicService>
我们在connectionStrings 配置节中执行了数据库连接字符串(名称为Default),并在SubSonicService配置节中指定connectionStringName为Default,这就为SubSonic指定了数据库连接。
通过 generatedNamespace="AppBox" 是为下一步做准备,让代码自动生成的映射类拥有 AppBox 的命名空间。
通过sonic.exe生成所有的映射类
把下面一行命令保存为批处理文件(比如generate.bat),双击运行即可生成所有的数据库映射类代码(以后表有改动,只需重新执行一次这个命令即可)。
.\library\subsonic\sonic\sonic.exe generate /config .\ /out .\Business\Subsonic
这个命令中:
- /config .\
执行使用当前目录下的 Web.config 中的SubSonicService建立数据库连接。所以此generate.bat应该和Web.config在同一目录。
- /out .\Business\Subsonic
指定输出目录为当前目录下Business目录下的SubSonic子目录。
我们看一下生成的文件:
![Subsonic配置与使用](http://img.e-com-net.com/image/product/a6413c8557bb4377b0a2a729db0733ca.png)
其实我们没有必须管这些都是什么文件,我们只需要知道调用方法就可以了。你可以在
Working with ActiveRecord 和
Working with the Query Tool 阅读到整个项目中使用到的 99% 的调用方法。
相信我,真的很简单。
使用SubSonic
这里只举一个查询用户的例子,更多的使用方法可以参考上面给出的链接。
string userName = tbxUserName.Text.Trim();
string password = tbxPassword.Text.Trim();
XUser user = new Select().From<XUser>()
.Where(XUser.NameColumn).IsEqualTo(userName)
.And(XUser.EnabledColumn).IsEqualTo(true)
.ExecuteSingle<XUser>();
如果你想运行本章中使用的代码,可以从 http://appbox.codeplex.com/SourceControl/ListDownloadableCommits.aspx 下载全部源代码。