分析
要做一个基于数据库的应用程序我们有大量的重复劳动要去做建表写增删改查的SQL语句写与数据库表对应的实体类写执行SQL的c#代码写添加修改列表详细页面等等这些活动都是围绕着一个个都数据表来开展的在NET领域有很多的OR Mapping的方案但好多方案用起来好用但原理很复杂而且性能也不好把握所以我们可以做一个轻型的ORM方案有了ORM框架根据数据表写c#实体类这些劳动其实也可以写一个代码生成器来帮我们生成甚至代码生成器还能帮我们生成一些界面的代码我们大概需要解决如下问题
我们要有一个通用的数据库操作帮助类类似微软的DAAB但最好能支持多种数据库
我们要有一个使用简单的orm框架能方便的用c#代码来进行数据库存取操作而且要尽量保证性能比如使用参数化查询
我们要有一个代码生成器帮助我们解决一些重复性劳动比如生成实体类生成调用存储过程的c#代码等
围绕这个问题我们一一来展开
一通用的数据库吃操作帮助类
ADONET 为我们访问数据库提供了一套与具体数据库无关的模型其核心类是DbProviderFactory它遵循了Provider模式就是把对各种数据库的操作抽象出一个Provider再由各种数据库去写与具体数据库相关的Provider然后通过配置在运行时方便的切换数据库而尽量少的不修改业务逻辑层的代码业务逻辑层依赖的是抽象的Provider这也是典型的依赖倒置就是说业务逻辑说我需要哪些接口我依赖这些接口而让别人去实现这些接口在运行的时候再去加载调用实现这些接口的具体类
为了提高性能减少SQLSERVER执行计划的重编译我们尽量使用参数化的查询而一个固定的语句或者存储过程它的ADONET参数是固定的所以我们可以把这些参数缓存起来避免每次执行SQL语句都创新新的参数对象另外oledb的 provider的参数是不能命名的所以给参数赋值要按顺序赋值
为了使用方便我们为执行SQL语句提供如下的API
public SystemDataDataSet SqlExecuteDateSet(string sql string[] paramters params object[] values)
public SystemDataDataTable SqlExecuteDateTable(string sql string[] paramters params object[] values)
public int SqlExecuteNonQuery(string sql string[] paramters params object[] values)
public SystemDataCommonDbDataReader SqlExecuteReader(string sql string[] paramters params object[] values)
public object SqlExecuteScalar(string sql string[] paramters params object[] values)
当然为了支持存储过程的执行以及数据库事务还需要提供相关的重载的API大概的使用示例（面向SQLSERVER）如下
DbHelper dbhelper = new DbHelper();
string sql = delete from Citys where CityId = @id;
using (DatabaseTrans trans = new DatabaseTrans(dbhelper))
{
try
{
dbhelperSqlExecuteNonQuery(trans sql new string[] { @id } );
dbhelperSqlExecuteNonQuery(trans sql new string[] { @id } );
transCommit();
OutPut(ok);
}
catch (Exception)
{
transRollBack();
OutPut(no ok);
}
}
二通用的ORM框架
先看如下的代码
//添加
xxxCase xxxCase = new xxxCase();
xxxCaseTitle = abc;
xxxCaseContent = 呵呵;
xxxCaseCaseFrom = CaseFrom客服投诉;
xxxCasePostUser = huhao;
xxxCaseCreateTime = DateTimeNow;
xxxCaseCaseType = CaseType生产环境查询;
xxxCasePriority = CasePriority中;
xxxCaseReleationServices = aaabbb;
xxxCaseReleationClient = cccddd;
EntityBaseInsert(xxxCase);
//修改
xxxCaseClearInnerData();
xxxCaseCaseId = ;
xxxCaseTitle = 嘿嘿;
EntityBaseUpdate(xxxCase);
//删除
xxxCaseClearInnerData();
xxxCaseCaseId = ;
EntityBaseDelete(xxxCase);
//复杂条件查询查询大于昨天的客服投诉或者wawa关闭的问题
WhereCondition condition = new WhereCondition(
xxxCaseCaseFromColNameSqlOperatorEqual (short)CaseFrom客服投诉)
And(
new WhereCondition(xxxCaseCreateTimeColName SqlOperatorGreaterThan
DateTimeNowAddDays()))
Group()
Or(
new WhereCondition(xxxCaseCloseUserColName SqlOperatorEqual wawa));
IList<xxxCase> list = EntityBaseSelect<xxxCase>(
new string[] {Title PostUser} condition);
foreach (xxxCase item in list)
{
ConsoleWriteLine({}{}itemTitleitemPostUser);
}
ConsoleReadKey();
上面的代码是以面向对象（请忽略那些关于贫血模型的讨论说上面的代码不够OO上面的代码至少相对的面向对象而且看起来很直观）的方式去执行一些业务这应该比到处写SQL语句要强很多吧而且如果这些操作内部使用的仍然是参数化查询而不是拼sql字符串的话
性能也不会很差（请忽略具体语句是否能使用索引的讨论那得具体分析）
我们看一下EntityBaseInsert方法的实现逻辑很简单明了其他的UpdateDeleteSelect也是类似的思路
private static DbHelper _db = new DbHelper();
public static void Insert(EntityBase entity) {
string sql = GetInsertSql(entity);
string[] parameters = GetParameters(entityInnerData);
object[] parameterValues = GetParameterValuess(entityInnerData);
_dbSqlExecuteNonQuery(sql parameters parameterValues);
}
private static string GetInsertSql(EntityBase entity) {
int len = entityInnerDataCount;
StringBuilder sql = new StringBuilder();
sqlAppendFormat(INSERT INTO [{}]\r\n entityTableName);
sqlAppend((\r\n);
for (int i = ; i < len; i++) {
if (i != len )
sqlAppendFormat([{}] entityInnerData[i]Key);
else
sqlAppendFormat([{}] entityInnerData[i]Key);
}
sqlAppend()\r\n);
sqlAppend(VALUES(\r\n);
for (int i = ; i < len; i++) {
if (i != len )
sqlAppendFormat(@{} entityInnerData[i]Key);
else
sqlAppendFormat(@{} entityInnerData[i]Key);
}
sqlAppend()\r\n);
return sqlToString();
}
private static string[] GetParameters(IList<DbCommonClass<string object>> items) {
int len = itemsCount;
List<string> parameters = new List<string>();
for (int i = ; i < len; i++) {
parametersAdd(stringFormat(@{} items[i]Key));
}
return parametersToArray();
}
private static object[] GetParameterValuess(List<DbCommonClass<string object>> items) {
int len = itemsCount;
List<object> parameters = new List<object>();
for (int i = ; i < len; i++) {
parametersAdd(items[i]Value);
}
return parametersToArray();
}
当然Select方法稍微复杂一些因为我们要考虑复杂的Where字句Top字句OrderBy字句等我们为Where字句建立了一个WhereCondition对象来方便的用c#代码来描述SQL的where语句但是为了实现简单我们不去实现表连接复杂的子语句等支持（我个人认为向NBear等框架做的过于强大了）
三代码生成器
ADONET的各种数据库实现都有获取某个数据库Schema的API其中最重要的是SqlConnectionGetSchema(SqlClientMetaDataCollectionNamesTables)和SqlCommandExecuteReader( CommandBehaviorKeyInfo | CommandBehaviorCloseConnection)方法有了这两个方法我们可以枚举一个数据库的所有表及某个表的所有字段及每个字段的类型长度可否为空是否为主键是否为标识列等信息有了这些元数据我们再根据一个模板就可以生成特定格式的代码了而且我们需要新增加一种代码生成的格式的话只需添加一个模板就可以了这样的代码生成器还有扩展性而不是一个写死的针对特定框架的代码生成器
为了脱离对特定数据库的依赖我们建立一个代码生成器的元数据模型如下
public class CodeModel
{
public string ClassName;
public string TableName;
public string Descript;
public string Namespace;
public string PkColName;
public List<CodeProperty> Properties;
}
public class CodeProperty
{
public string DbColName;
public int? DbLength;
public bool DbAllowNull
public SqlDbType DbType;
public string DbTypeStr;
public bool DbIsIdentity;
public bool DbIsPk;
public string Descript;
public string PropertyName;
public SystemType CSharpType;
public string CSharpTypeStr;
public bool UiAllowEmpty;
public bool UiIsShowOn;
public long? UiMaxCheck;
public long? UiMinCheck;
public string UiRegxCheck;
}
得到元数据后剩下的就是读取模板然后替换字符串了
比如实体类的模板如下
using System;
using SystemCollectionsGeneric;
using WawaSoftCommon;
namespace $modelnamespace$ {
public class $modelclassname$ : EntityBase {
$foreachprop$
public const string $propproperty$ColName = $propdbcolname$;
$endforeach$
private static readonly List<string> _Cols = new List<string>();
static $modelclassname$()
{
$foreachprop$
_ColsAdd($propproperty$ColName);
$endforeach$
}
public $modelclassname$() {
_tableName = $modeltablename$;
_PkName = $modelpkcolname$;
}
$foreachprop$
private $propcsharptype$ $propproperty$;
$endforeach$
$foreachprop$
public $propcsharptype$ $propproperty$ {
get { return $propproperty$; }
set {
$propproperty$ = value;
AddInnerData($propproperty$ value);
}
}
$endforeach$
protected override IList<string> Cols
{
get { return _Cols; }
}
public override void ConvertToEntity(IEnumerable<DbCommonClass<string object>> items) {
foreach (DbCommonClass<string object> item in items) {
switch (itemKey) {
$foreachprop$
case $propproperty$ColName:
$propproperty$ = ($propcsharptype$)itemValue;
break;
$endforeach$
}
}
}
}
}
生成的实体类如下
using System;
using SystemCollectionsGeneric;
using WawaSoftCommon;
namespace Entities {
public class User : EntityBase {
public const string UserIdColName = UserId;
public const string UsernameColName = Username;
public const string NameColName = Name;
public const string PasswordColName = Password;
public const string CreateTimeColName = CreateTime;
public const string IsAdminColName = IsAdmin;
private static readonly List<string> _Cols = new List<string>();
static User() {
_ColsAdd(UserIdColName);
_ColsAdd(UsernameColName);
_ColsAdd(NameColName);
_ColsAdd(PasswordColName);
_ColsAdd(CreateTimeColName);
_ColsAdd(IsAdminColName);
}
public User() {
_tableName = User;
_PkName = UserId;
}
private Nullable<Int> userid;
private String username;
private String name;
private String password;
private Nullable<DateTime> createtime;
private Nullable<Boolean> isadmin;
public Nullable<Int> UserId {
get { return userid; }
set {
userid = value;
AddInnerData(userid value);
}
}
public String Username {
get { return username; }
set {
username = value;
AddInnerData(username value);
}
}
public String Name {
get { return name; }
set {
name = value;
AddInnerData(name value);
}
}
public String Password {
get { return password; }
set {
password = value;
AddInnerData(password value);
}
}
public Nullable<DateTime> CreateTime {
get { return createtime; }
set {
createtime = value;
AddInnerData(createtime value);
}
}
public Nullable<Boolean> IsAdmin {
get { return isadmin; }
set {
isadmin = value;
AddInnerData(isadmin value);
}
}
protected override IList<string> Cols {
get { return _Cols; }
}
public override void ConvertToEntity(IEnumerable<DbCommonClass<string object>> items) {
foreach (DbCommonClass<string object> item in items) {
switch (itemKey) {
case UserIdColName:
userid = (Nullable<Int>)itemValue;
break;
case UsernameColName:
username = (String)itemValue;
break;
case NameColName:
name = (String)itemValue;
break;
case PasswordColName:
password = (String)itemValue;
break;
case CreateTimeColName:
if (itemValue != DBNullValue)
createtime = (Nullable<DateTime>)itemValue;
break;
case IsAdminColName:
if (itemValue != DBNullValue)
isadmin = (Nullable<Boolean>)itemValue;
break;
}
}
}
}
}
小结
解决了以上几个问题再开发数据库应用应该会提高不少效率
