.NET MVC 的自定义模型属性别名绑定的使用

1、最近在研究ASP.NET MVC 模型绑定，发现DefaultModelBinder 有一个弊端，就是无法实现对浏览器请求参数的自定义，最初的想法是想为实体模型的属性设置特性（Attribute），然后通过取得设置的特性值对属性进行赋值，研究了好久 MVC 源码之后发现可以通过重写DefaultModelBinder 的BindProperty 方法可以达到预期的目的。ASP.NET MVC 中有一个自定义模型绑定特性CustomModelBinderAttribute，打算通过重写CustomModelBinderAttribute来对实体属性进行出来，实现如下：AttributeUsage

2、Attribute(AttributeTargets.Class|AttributeTargets.Struct|AttributeTargets.Enum|AttributeTargets.Interface|AttributeTargets.Parameter, AllowMultiple = false,Inherited = false)public abstract class CustomModelBinderAttribute : Attribute但是由于CustomModelBinderAttribute 不支持对属性设置特性，所以只好继承Attribute 类重新写一个特性

3、，代码如下：/ / 表示一个调用自定义模型联编程序的特性。/ AttributeUsage(ValidTargets, AllowMultiple = false, Inherited = false)public class PropertyModelBinderAttribute : Attribute/ / 指定此属性可以应用特性的应用程序元素。/ internal const AttributeTargets ValidTargets = AttributeTargets.Field | AttributeTargets.Enum | AttributeTargets.Property

4、 | AttributeTargets.Parameter;/ / 声明属性名称。/ private string _propertyName = string.Empty;/ / 获取或设置属性别名。/ public string PropertyNameget return _propertyName; / / 使用指定的属性别名。/ / 指定的属性别名。public PropertyModelBinderAttribute(string propertyName)_propertyName = propertyName;/ / 检索关联的模型联编程序。/ / 对实现 System.Web

5、.Mvc.IModelBinder 接口的对象的引用。public IModelBinder GetBinder()return new PropertyModelBinder();这样就可以在实体模型的属性上设置别名了。/ / 表示一个城市筛选实体对象模型。/ ModelBinder(typeof(PropertyModelBinder)public class CityFilteringModel : BaseEntityModel/ / 获取或设置城市英文名称。/ public string CityEnglishName get; set; / / 获取或设置城市编号。/ Proper

6、tyModelBinder(cid)public int CityId get; set; / / 获取或设置城市名称。/ PropertyModelBinder(cname)public string CityName get; set; 最后听过重写DefaultModelBinder 的BindProperty 和SetProperty 方法就可以对模型绑定的属性实现自定义了。/ / 将浏览器请求映射到数据对象。/ public class PropertyModelBinder : DefaultModelBinder/ / 初始化 类的新实例。/ public PropertyMod

7、elBinder()/ / 使用指定的控制器上下文和绑定上下文来绑定模型。/ / 运行控制器的上下文。/ 绑定模型的上下文。/ 已绑定的对象。public override object BindModel(ControllerContext controllerContext, ModelBindingContext bindingContext)var model = base.BindModel(controllerContext, bindingContext);if (model is BaseEntiryModel) (BaseEntiryModel)model).BindMode

8、l(controllerContext, bindingContext);return model;/ / 使用指定的控制器上下文、绑定上下文、属性描述符和属性联编程序来返回属性值。/ / 运行控制器的上下文。/ 绑定模型的上下文。/ 要访问的属性的描述符。/ 一个对象，提供用于绑定属性的方式。/ 一个对象，表示属性值。protected override object GetPropertyValue(ControllerContext controllerContext, ModelBindingContext bindingContext, System.ComponentModel.P

9、ropertyDescriptor propertyDescriptor, IModelBinder propertyBinder)var value = base.GetPropertyValue(controllerContext, bindingContext, propertyDescriptor, propertyBinder);return value;/ / 使用指定的控制器上下文、绑定上下文和指定的属性描述符来绑定指定的属性。/ / 运行控制器的上下文。/ 绑定模型的上下文。/ 描述要绑定的属性。protected override void BindProperty(Cont

10、rollerContext controllerContext, ModelBindingContext bindingContext, PropertyDescriptor propertyDescriptor)string fullPropertyKey = CreateSubPropertyName(bindingContext.ModelName, propertyDescriptor.Name);object propertyValue = null;if (propertyDescriptor.Attributestypeof(PropertyModelBinderAttribut

11、e) != null)var attribute = (PropertyModelBinderAttribute)propertyDescriptor.Attributestypeof(PropertyModelBinderAttribute);string propertyName = attribute.PropertyName;var valueResult = bindingContext.ValueProvider.GetValue(propertyName);if (valueResult != null)propertyValue = valueResult.AttemptedV

12、alue;elseif (!bindingContext.ValueProvider.ContainsPrefix(fullPropertyKey)return;/ call into the propertys model binderIModelBinder propertyBinder = Binders.GetBinder(propertyDescriptor.PropertyType);object originalPropertyValue = propertyDescriptor.GetValue(bindingContext.Model);ModelMetadata prope

13、rtyMetadata = bindingContext.PropertyMetadatapropertyDescriptor.Name;propertyMetadata.Model = originalPropertyValue;ModelBindingContext innerBindingContext = new ModelBindingContext()ModelMetadata = propertyMetadata,ModelName = fullPropertyKey,ModelState = bindingContext.ModelState,ValueProvider = b

14、indingContext.ValueProvider;object newPropertyValue = GetPropertyValue(controllerContext, innerBindingContext, propertyDescriptor, propertyBinder);if (newPropertyValue = null)newPropertyValue = propertyValue;propertyMetadata.Model = newPropertyValue;/ validationModelState modelState = bindingContext

15、.ModelStatefullPropertyKey;if (modelState = null | modelState.Errors.Count = 0)if (OnPropertyValidating(controllerContext, bindingContext, propertyDescriptor, newPropertyValue)SetProperty(controllerContext, bindingContext, propertyDescriptor, newPropertyValue);OnPropertyValidated(controllerContext,

16、bindingContext, propertyDescriptor, newPropertyValue);elseSetProperty(controllerContext, bindingContext, propertyDescriptor, newPropertyValue);/ Convert FormatExceptions (type conversion failures) into InvalidValue messagesforeach (ModelError error in modelState.Errors.Where(err = String.IsNullOrEmp

17、ty(err.ErrorMessage) & err.Exception != null).ToList()for (Exception exception = error.Exception; exception != null; exception = exception.InnerException)/ We only consider known type of exception and do not make too aggressive changes hereif (exception is FormatException | exception is OverflowExce

18、ption)string displayName = propertyMetadata.GetDisplayName();string errorMessageTemplate = GetValueInvalidResource(controllerContext);string errorMessage = String.Format(CultureInfo.CurrentCulture, errorMessageTemplate, modelState.Value.AttemptedValue, displayName);modelState.Errors.Remove(error);mo

19、delState.Errors.Add(errorMessage);break;/base.BindProperty(controllerContext, bindingContext, propertyDescriptor);/ / 使用指定的控制器上下文、绑定上下文和属性值来设置指定的属性。/ / 运行控制器的上下文。/ 绑定模型的上下文。/ 描述要绑定的属性。/ 为属性设置的值。protected override void SetProperty(ControllerContext controllerContext, ModelBindingContext bindingContex

20、t, PropertyDescriptor propertyDescriptor, object value)ModelMetadata propertyMetadata = bindingContext.PropertyMetadatapropertyDescriptor.Name;propertyMetadata.Model = value;string modelStateKey = CreateSubPropertyName(bindingContext.ModelName, propertyMetadata.PropertyName);if (value = null & bindi

21、ngContext.ModelState.IsValidField(modelStateKey)ModelValidator requiredValidator = ModelValidatorProviders.Providers.GetValidators(propertyMetadata, controllerContext).Where(v = v.IsRequired).FirstOrDefault();if (requiredValidator != null)foreach (ModelValidationResult validationResult in requiredVa

22、lidator.Validate(bindingContext.Model)bindingContext.ModelState.AddModelError(modelStateKey, validationResult.Message);bool isNullValueOnNonNullableType = value = null & !TypeAllowsNullValue(propertyDescriptor.PropertyType);if (!propertyDescriptor.IsReadOnly & !isNullValueOnNonNullableType)tryvar ty

23、peValue = Convert.ChangeType(value, propertyDescriptor.PropertyType, CultureInfo.InvariantCulture);propertyDescriptor.SetValue(bindingContext.Model, typeValue);catch (Exception ex)if (bindingContext.ModelState.IsValidField(modelStateKey)bindingContext.ModelState.AddModelError(modelStateKey, ex);if (

24、isNullValueOnNonNullableType & bindingContext.ModelState.IsValidField(modelStateKey)bindingContext.ModelState.AddModelError(modelStateKey, GetValueRequiredResource(controllerContext);/ / 使用指定的控制器上下文和绑定上下文来返回模型的属性。/ / 运行控制器的上下文。/ 绑定模型的上下文。/ 属性描述符的集合。protected override PropertyDescriptorCollection Get

25、ModelProperties(ControllerContext controllerContext, ModelBindingContext bindingContext)bindingContext.PropertyFilter = new Predicate(pred);var values = base.GetModelProperties(controllerContext, bindingContext);return values;/ / 获取属性筛选器的判定对象。/ / 属性筛选器的属性。/ 一个布尔值。protected bool pred(string target)re

26、turn true;#region Private ./ / 类型允许空值。/ / 指定的类型。/ 若类型值为空，则返回 true，否则返回 false。private static bool TypeAllowsNullValue(Type type)return (!type.IsValueType | IsNullableValueType(type);/ / 是可为空值类型。/ / 指定的类型。/ 若类型值为空，则返回 true，否则返回 false。private static bool IsNullableValueType(Type type)return Nullable.GetUnderlyingType(type) != null;/ / 获取价值无效的资源。/ / / private static string GetValueInvalidResource(ControllerContext controllerCont