过年前的最后一篇博客，决定留给Nancy中的ModelBinding
还是同样的，我们与MVC结合起来，方便理解和对照
先来看看MVC中简单的ModelBinding吧
// POST: Authors/Create
// To protect from overposting attacks, please enable the specific properties you want to bind to, for
// more details see http://go.microsoft.com/fwlink/?LinkId=317598.
[HttpPost]
[ValidateAntiForgeryToken]
public ActionResult Create([Bind(Include = "AuthorId,AuthorName,AuthorGender,AuthorEmail,AuthorAddress,AuthorPhone")] Author author)
{
if (ModelState.IsValid)
{
db.Authors.Add(author);
db.SaveChanges();
return RedirectToAction("Index");
}
return View(author);
}
上面的代码是我用下面类型的控制器生成的一个添加方法，里面就用到了ModelBinding
像这样比较简单的模型绑定，大家应该是很熟悉了吧！
或许已经烂熟于心了。
MVC中关于Model Binding的详细解读可以参见下面的，真的超详细，我就不再展开了
[ASP.NET MVC 小牛之路]15 - Model Binding
ModelBinder——ASP.NET MVC Model绑定的核心
下面就来看看Nancy中的model binding吧。
先来看个具体的例子，我们顺着这个例子来讲解这一块的内容
这个例子我们要用到的引用有Nancy，Nancy.Hosting.Aspnet
我们先来看看它默认的绑定
先建立一个模型Employee
public class Employee
{
public Employee()
{
this.EmployeeNumber = "Num1";
this.EmployeeName = "Catcher8";
this.EmployeeAge = ;
}
public string EmployeeNumber { get; set; }
public string EmployeeName { get; set; }
public int EmployeeAge { get; set; }
public List<string> EmployeeHobby { get; set; }
}
我们在这个模型中，给部分字段设置了默认值。
建立一个视图default.html，用于测试Nancy中默认的ModelBinding
<!DOCTYPE html>
<html>
<head>
<title>default</title>
<meta charset="utf-8" />
</head>
<body>
<form action="/default" method="post">
<label>员工编号</label>
<input type="text" name="EmployeeNumber" /> <br />
<label>员工姓名</label>
<input type="text" name="EmployeeName" /> <br />
<label>员工年龄</label>
<input type="text" name="EmployeeAge" /> <br /> <input type="checkbox" name="EmployeeHobby" value="篮球" />篮球
<input type="checkbox" name="EmployeeHobby" value="足球" />足球
<input type="checkbox" name="EmployeeHobby" value="排球" />排球
<input type="checkbox" name="EmployeeHobby" value="网球" />网球
<br />
<input type="submit" value="提交" />
</form>
</body>
</html>
然后我们建立一个TestModule.cs，在里面演示了各种不同方式下的binding
public class TestModule : NancyModule
{
public TestModule()
{
Get["/default"] = _ =>
{
return View["default"];
};
Post["/default"] = _ =>
{
Employee employee_Empty = new Employee();
//这种写法有问题，应该是 Employee xxx = this.Bind(); 才对！
//因为这里的this.Bind() 是 dynamic 类型，没有直接指明类型
//所以它会提示我们 “找不到此对象的进一步信息”
var employee_Using_Bind = this.Bind(); //这里在bind的时候指明了类型。这个会正常绑定数据。(推荐这种写法)
var employee_Using_BindWithTModel = this.Bind<Employee>();
//这里是将数据绑定到我们实例化的那个employee_Empty对象
//运行到这里之后，会发现employee_Empty的默认值被替换了！！
var employee_Using_BindTo = this.BindTo(employee_Empty);
//与上面的写法等价！
var employee_Using_BindToWithTModel = this.BindTo<Employee>(employee_Empty);
//这个主要是演示“黑名单”的用法，就是绑定数据的时候忽略某几个东西
//这里忽略了EmployeeName和EmployeeAge，所以得到的最终还是我们设置的默认值
var employee_Using_BindAndBlacklistStyle1 = this.Bind<Employee>(e=>e.EmployeeName,e=>e.EmployeeAge);
//与上面的写法等价，演示不同的写法而已！
var employee_Using_BindAndBlacklistStyle2 = this.Bind<Employee>("EmployeeName", "EmployeeAge");
return Response.AsRedirect("/default");
};
}
}
下面来看看运行的结果
我们在表单填下了这些内容，现在我们监视上面的各个值的变化
这几个最终都是一样的效果！！这里说最终，是因为我们的employee_Empty刚实例化时，应该是我们设置的默认值。
employee_Using_BindAndBlacklistStyle1和employee_Using_BindAndBlacklistStyle2是在Bind后面带了参数的，
这些参数就是所谓的黑名单，就是绑定的时候忽略掉。然后结果就是我们设置的默认值Catcher8和18。
至于它为什么这样就能绑定上，我们看了自定义的绑定之后可能会清晰不少。
接下来就是使用自定义的绑定方法：
模型我们还是用刚才的Employee.cs
此处新添加一个视图custom.html，基本和前面的default.html一致，换了个action
<!DOCTYPE html>
<html>
<head>
<title>custom</title>
<meta charset="utf-8" />
</head>
<body>
<form action="/custom" method="post">
<label>员工编号</label>
<input type="text" name="EmployeeNumber" /> <br />
<label>员工姓名</label>
<input type="text" name="EmployeeName" /> <br />
<label>员工年龄</label>
<input type="text" name="EmployeeAge" /> <br />
<input type="checkbox" name="EmployeeHobby" value="篮球" />篮球
<input type="checkbox" name="EmployeeHobby" value="足球" />足球
<input type="checkbox" name="EmployeeHobby" value="排球" />排球
<input type="checkbox" name="EmployeeHobby" value="网球" />网球
<br />
<input type="submit" value="提交" />
</form>
</body>
</html>
至关重要的一步！！！编写我们的ModelBinder，这个ModelBinder要实现IModelBinder这个接口！
public class MyModelBinder : IModelBinder
{
public bool CanBind(Type modelType)
{
return modelType == typeof(Employee);
}
public object Bind(NancyContext context, Type modelType, object instance, BindingConfig configuration, params string[] blackList)
{
var employee = (instance as Employee) ?? new Employee();
employee.EmployeeName = context.Request.Form["EmployeeName"] ?? employee.EmployeeName;
employee.EmployeeNumber = context.Request.Form["EmployeeNumber"] ?? employee.EmployeeNumber;
employee.EmployeeAge = 24;//我们把年龄写死，方便看见差异
employee.EmployeeHobby = ConvertStringToList(context.Request.Form["EmployeeHobby"]) ?? employee.EmployeeHobby;
return employee;
} private List<string> ConvertStringToList(string input)
{
if (string.IsNullOrEmpty(input))
{
return null;
}
var items = input.Split(',');
return items.AsEnumerable().ToList<string>();
}
}
然后在我们的TestModule.cs中添加如下代码
Get["/custom"] = _ =>
{
return View["custom"];
};
Post["/custom"] = x =>
{
//此时就会调用我们自己定义的Binder了
var employee1 = this.Bind<Employee>();
Employee employee2 = this.Bind();
return Response.AsRedirect("/custom");
};
下面看看运行效果
我们还是在表单输入这些内容，同时对employee1和employee2添加监视
清楚的看到，我们自定义的binder生效了，年龄就是我们设定的24！
Nancy中，还有比较方便的是json和xml也同样能绑定。由于这两个很相似，所以这里就只介绍json。
同样的，例子说话！
添加一个json.html视图
<!DOCTYPE html>
<html>
<head>
<title>default</title>
<meta charset="utf-8" /> <script src="../../content/jquery-1.10.2.min.js"></script>
<script type="text/javascript">
$(document).ready(function(){
var dat = "{\"EmployeeName\":\"catcher1234\", \"EmployeeAge\":\"33\"}";
$.ajax({
type: "POST",
url: "/json",
contentType: "application/json",
data: dat,
success: function (data) {
alert("Response:\n" + data);
}
});
});
</script>
</head>
<body>
</body>
</html>
在这里，偷懒了(节省点时间)，我是直接写死了两个值，然后打印出这个employee的相关属性。
还有一点要注意的是。引用的js文件，不想写convention配置就把js放到content文件夹，具体的可参见我前面的bolg Nancy之静态文件处理。
Get["/json"] = _ =>
{
return View["json"];
};
Post["/json"] = _ =>
{
var employee = this.Bind<Employee>();
var sb = new StringBuilder();
sb.AppendLine("绑定的employee的值:");
sb.Append("编号: ");
sb.AppendLine(employee.EmployeeNumber);
sb.Append("姓名: ");
sb.AppendLine(employee.EmployeeName);
sb.Append("年龄: ");
sb.AppendLine(employee.EmployeeAge.ToString());
return sb.ToString();
};
运行看看效果
再来看看我们监视的情况！！
很nice，正是我们想要的结果，编号没有赋值，自动取了默认值！
跟往常一样，简单分析一下这一块的源码。
ModelBinding在Nancy这个项目下面，里面的内容如下：
很明显，我们应该先看看DefaultBinder.cs，因为所有的默认实现，Nancy都会带Default的字样
DefaultBinder实现了IBinder这个接口，这个接口里面就一个东西Bind
/// <summary>
/// Binds incoming request data to a model type
/// </summary>
public interface IBinder
{
/// <summary>
/// Bind to the given model type
/// </summary>
/// <param name="context">Current context</param>
/// <param name="modelType">Model type to bind to</param>
/// <param name="configuration">The <see cref="BindingConfig"/> that should be applied during binding.</param>
/// <param name="blackList">Blacklisted property names</param>
/// <param name="instance">Existing instance of the object</param>
/// <returns>Bound model</returns>
object Bind(NancyContext context, Type modelType, object instance, BindingConfig configuration, params string[] blackList);
}
这就是我们ModelBinding的关键所在！
DefaultBinder里面的实现就是
先判断绑定的类型是不是数组集合，是的话，一种处理策略，不是的话，另一种处理策略，
在里面的判断中还有一个重要的概念是Binding Configuration。因为这个Configuration可以修改我们绑定的行为
这里我直接截了官网文档的图来展示
BodyOnly设置为true的时候，一旦主体被绑定，binder就会立刻停止。
IgnoreErrors为false时，就不会在继续进行绑定，为true时就会继续绑定，默认值是false。
Overwrite为ture时，允许binder去覆盖我们设置的那些默认值，为false时，就是不允许，默认值是true！
DefaultBinder里面有个GetDataFields的私有方法
private IDictionary<string, string> GetDataFields(NancyContext context)
{
var dictionaries = new IDictionary<string, string>[]
{
ConvertDynamicDictionary(context.Request.Form),
ConvertDynamicDictionary(context.Request.Query),
ConvertDynamicDictionary(context.Parameters)
};
return dictionaries.Merge();
}
从中我们可以看出，它处理绑定的时候用到了字典，包含了表单的数据、url的参数，这点与mvc里面的基本一致！
所以我们在写页面的时候，我们只要把表单元素的name属性设置为对应的字段名就可以，同样的，这个在mvc中也一致
下面看看ITypeConverter这个接口
public interface ITypeConverter
{
bool CanConvertTo(Type destinationType, BindingContext context); object Convert(string input, Type destinationType, BindingContext context);
}
这个接口提供了一种转换类型的方法
CanConvertTo 是判断是否能转化为目的类型，
Nancy默认的Converters包含了Collection、DateTime、Fallback和Numeric
当然，有了这个接口，我们可以实现更多的拓展，怎么用着方便怎么来！
当然不能忘了我们自定义模型绑定用到的接口 IModelBinder
public interface IModelBinder : IBinder
{
bool CanBind(Type modelType);
}
IModerBinder这个接口除了自己定义的CanBind方法外，还继承了IBinder这个接口，所以我们自定义ModelBinder的时候只需要
实现这个接口就可以了。作用就是绑定数据到相应的模型中。
最后就讲讲“黑名单”的内容！
“黑名单”的实现，还用到了DynamicModelBinderAdapter这个东西，但最为主要的是
DefaultBinder里面的CreateBindingContext这个私有方法！
private BindingContext CreateBindingContext(NancyContext context, Type modelType, object instance, BindingConfig configuration, IEnumerable<string> blackList, Type genericType)
{
return new BindingContext
{
Configuration = configuration,
Context = context,
DestinationType = modelType,
Model = CreateModel(modelType, genericType, instance),
ValidModelBindingMembers = GetBindingMembers(modelType, genericType, blackList).ToList(),
RequestData = this.GetDataFields(context),
GenericType = genericType,
TypeConverters = this.typeConverters.Concat(this.defaults.DefaultTypeConverters),
};
}
从中我们可以看到GetBindingMembers用到了blackList，再看看这个方法
private static IEnumerable<BindingMemberInfo> GetBindingMembers(Type modelType, Type genericType, IEnumerable<string> blackList)
{
var blackListHash = new HashSet<string>(blackList, StringComparer.Ordinal); return BindingMemberInfo.Collect(genericType ?? modelType)
.Where(member => !blackListHash.Contains(member.Name));
}
看到这个，行了，基本就懂了！
member => !blackListHash.Contains(member.Name)
这个表达式就是起到了真正的过滤作用啦！！！
ModelBinding就讲到这里了。
最后献上本次的代码示例：
https://github.com/hwqdt/Demos/tree/master/src/NancyDemoForModelBinding