在第一篇中,我讲解了我们要做智能查询的原因,以及基本的解决方案设计。从这篇开始我们开始讲解它的实现过程。
其实在写这一系列文章之初,我其实是想由底至上去讲解,但是我又整理了一遍代码才发现,其实如果不了解最表面的东西,也是不太好深入的。
所以我们的第二篇文章就来讲一下我们这个智能查询框架中最浅,但也是使用最频繁的部分,也就是Model。
首先我们的Entity 或者说数据库的结构如下:
另外如下面代码,我们有一个用于传递name=value对,及查询谓词的model:
public
ActionResult Index(QueryModel model)
{
using (var db = new DbEntities())
{
var list = db.Users.Where(model).ToList();
return View(list);
}
}
{
using (var db = new DbEntities())
{
var list = db.Users.Where(model).ToList();
return View(list);
}
}
我命名之为QueryModel。它由Action的参数传入,再传入EF的Where扩展方法,它是构建Lambda表达式的原型,上面是我们的一个通用的查询Action的代码。
而QueryModel的代码为:
QueryModel的唯一一个属性Items,是一个ConditionItem的集合,它里面存着所有的查询条件。而ConditionItem里面的属性:
- Field表示要查询的目标属性的名称,我们的设定它是支持子属性查询的,例如 “Profile.MyUser.Id”。
- Method则是当前使用的谓词,它是QueryMethod的一个枚举值。
- OrGroup是一个字符串,是一个OrGroup的多个表达式将会以Or操作符进行关联,然后再And。
- Prefix是一个分类的前缀,我们假定一个Action可能处理多个查询条件组的时候为了分开这些查询条件而加的属性。
- Value则是这个表达试的值。
而我们在页面上类似:
<
form
action
=""
method
="post"
>
姓名: < input id ="Name" name ="[Like]Name" type ="text" value ="" />
Email: < input id ="Email" name ="[Equal]Email" type ="text" value ="" />< br />
Id: < input id ="Id" name ="[Equal]Id" type ="text" value ="" />
生日: < input id ="Birthday" name ="[Equal]Birthday" type ="text" value ="" />< br />
< input type ="submit" value ="查询" />
</ form >
姓名: < input id ="Name" name ="[Like]Name" type ="text" value ="" />
Email: < input id ="Email" name ="[Equal]Email" type ="text" value ="" />< br />
Id: < input id ="Id" name ="[Equal]Id" type ="text" value ="" />
生日: < input id ="Birthday" name ="[Equal]Birthday" type ="text" value ="" />< br />
< input type ="submit" value ="查询" />
</ form >
这样的表单,我们提交到服务器端,我们要进行ASP.NET MVC 中IModelBinder的转换,要将querystring 或 postdata中的KeyValuePair转换为我们的ConditionItem。
当然,我们除了谓词Method之外,还有Prefix以及OrGroup要从客户端提交过来所以我们就要制定一个规则,我们约定:
- 中括号[]中的为查询谓词
- 小括号()中的为前缀Prefix
- 大括号{}中的为OrGroup
我们可以通过以下IModelBinder的实现将Request.QueryString或Request.Form中的值转换到QueryModel中:
public
class
SearchModelBinder : IModelBinder
{
public object BindModel(ControllerContext controllerContext, ModelBindingContext bindingContext)
{
var model = (QueryModel)(bindingContext.Model ?? new QueryModel());
var dict = controllerContext.HttpContext.Request.Params;
var keys = dict.AllKeys.Where(c => c.StartsWith( " [ " )); // 我们认为只有[开头的为需要处理的
if (keys.Count() != 0 )
{
foreach (var key in keys)
{
if ( ! key.StartsWith( " [ " )) continue ;
var val = dict[key];
// 处理无值的情况
if ( string .IsNullOrEmpty(val)) continue ;
AddSearchItem(model, key, val);
}
}
return model;
}
/// <summary>
/// 将一组key=value添加入QueryModel.Items
/// </summary>
/// <param name="model"> QueryModel </param>
/// <param name="key"> 当前项的HtmlName </param>
/// <param name="val"> 当前项的值 </param>
public static void AddSearchItem(QueryModel model, string key, string val)
{
string field = "" , prefix = "" , orGroup = "" , method = "" ;
var keywords = key.Split( ' ] ' , ' ) ' , ' } ' );
// 将Html中的name分割为我们想要的几个部分
foreach (var keyword in keywords)
{
if (Char.IsLetterOrDigit(keyword[ 0 ])) field = keyword;
var last = keyword.Substring( 1 );
if (keyword[ 0 ] == ' ( ' ) prefix = last;
if (keyword[ 0 ] == ' [ ' ) method = last;
if (keyword[ 0 ] == ' { ' ) orGroup = last;
}
if ( string .IsNullOrEmpty(method)) return ;
if ( ! string .IsNullOrEmpty(field))
{
var item = new ConditionItem
{
Field = field,
Value = val.Trim(),
Prefix = prefix,
OrGroup = orGroup,
Method = (QueryMethod) Enum.Parse( typeof (QueryMethod), method)
};
model.Items.Add(item);
}
}
}
{
public object BindModel(ControllerContext controllerContext, ModelBindingContext bindingContext)
{
var model = (QueryModel)(bindingContext.Model ?? new QueryModel());
var dict = controllerContext.HttpContext.Request.Params;
var keys = dict.AllKeys.Where(c => c.StartsWith( " [ " )); // 我们认为只有[开头的为需要处理的
if (keys.Count() != 0 )
{
foreach (var key in keys)
{
if ( ! key.StartsWith( " [ " )) continue ;
var val = dict[key];
// 处理无值的情况
if ( string .IsNullOrEmpty(val)) continue ;
AddSearchItem(model, key, val);
}
}
return model;
}
/// <summary>
/// 将一组key=value添加入QueryModel.Items
/// </summary>
/// <param name="model"> QueryModel </param>
/// <param name="key"> 当前项的HtmlName </param>
/// <param name="val"> 当前项的值 </param>
public static void AddSearchItem(QueryModel model, string key, string val)
{
string field = "" , prefix = "" , orGroup = "" , method = "" ;
var keywords = key.Split( ' ] ' , ' ) ' , ' } ' );
// 将Html中的name分割为我们想要的几个部分
foreach (var keyword in keywords)
{
if (Char.IsLetterOrDigit(keyword[ 0 ])) field = keyword;
var last = keyword.Substring( 1 );
if (keyword[ 0 ] == ' ( ' ) prefix = last;
if (keyword[ 0 ] == ' [ ' ) method = last;
if (keyword[ 0 ] == ' { ' ) orGroup = last;
}
if ( string .IsNullOrEmpty(method)) return ;
if ( ! string .IsNullOrEmpty(field))
{
var item = new ConditionItem
{
Field = field,
Value = val.Trim(),
Prefix = prefix,
OrGroup = orGroup,
Method = (QueryMethod) Enum.Parse( typeof (QueryMethod), method)
};
model.Items.Add(item);
}
}
}
当然我们还要在Global.asax中添加:
ModelBinders.Binders.Add(
typeof
(QueryModel),
new
SearchModelBinder());
这样我们就可以在Action中获取到相应的查询条件了: