Asp.net MVC 中的自定义 DateTime 模型绑定器

Question

我想为 DateTime 类型编写自己的模型绑定程序。首先，我想编写一个可以附加到我的模型属性的新属性，例如：

[DateTimeFormat("d.M.yyyy")]
public DateTime Birth { get; set,}

这是简单的部分。但活页夹部分有点困难。我想为 DateTime 类型添加一个新的模型绑定器。我可以

• 实现 IModelBinder 接口并编写自己的 BindModel() 方法
• ，继承自 DefaultModelBinder 并覆盖 BindModel() 我的模型

有一个如上所示的属性（Birth）。因此，当模型尝试将请求数据绑定到此属性时，我的模型绑定器的 BindModel(controllerContext, BindingContext) 会被调用。一切都好，但是。 如何从控制器/绑定上下文获取属性，以正确解析我的日期？如何获取属性 Birth 的 PropertyDeciptor？

编辑

由于关注点分离，我的模型类是在一个不（也不应该）引用 System.Web.MVC 程序集的程序集中定义的。此处禁止设置自定义绑定（类似于 Scott Hanselman 的示例）属性。

Answer 1

您可以使用 IModelBinder 更改默认模型绑定器以使用用户区域性

public class DateTimeBinder : IModelBinder
{
    public object BindModel(ControllerContext controllerContext, ModelBindingContext bindingContext)
    {
        var value = bindingContext.ValueProvider.GetValue(bindingContext.ModelName);
        bindingContext.ModelState.SetModelValue(bindingContext.ModelName, value);

        return value.ConvertTo(typeof(DateTime), CultureInfo.CurrentCulture);
    }
}

public class NullableDateTimeBinder : IModelBinder
{
    public object BindModel(ControllerContext controllerContext, ModelBindingContext bindingContext)
    {
        var value = bindingContext.ValueProvider.GetValue(bindingContext.ModelName);
        bindingContext.ModelState.SetModelValue(bindingContext.ModelName, value);

        return value == null
            ? null 
            : value.ConvertTo(typeof(DateTime), CultureInfo.CurrentCulture);
    }
}

，并在 Global.Asax 中将以下内容添加到 Application_Start()：

ModelBinders.Binders.Add(typeof(DateTime), new DateTimeBinder());
ModelBinders.Binders.Add(typeof(DateTime?), new NullableDateTimeBinder());

阅读更多信息 这个优秀的博客，描述了为什么 Mvc 框架团队向所有用户实施默认文化。

Answer 2

我自己也遇到了这个非常大的问题，经过几个小时的尝试和失败，我得到了一个像你问的那样的可行解决方案。

首先，由于仅在属性上拥有绑定器是不可能的，因此您必须实现完整的 ModelBinder。由于您不希望绑定所有单个属性，而只希望绑定您关心的属性，因此您可以从 DefaultModelBinder 继承，然后绑定单个属性：

public class DateFiexedCultureModelBinder : DefaultModelBinder
{
    protected override void BindProperty(ControllerContext controllerContext, ModelBindingContext bindingContext, System.ComponentModel.PropertyDescriptor propertyDescriptor)
    {
        if (propertyDescriptor.PropertyType == typeof(DateTime?))
        {
            try
            {
                var model = bindingContext.Model;
                PropertyInfo property = model.GetType().GetProperty(propertyDescriptor.Name);

                var value = bindingContext.ValueProvider.GetValue(propertyDescriptor.Name);

                if (value != null)
                {
                    System.Globalization.CultureInfo cultureinfo = new System.Globalization.CultureInfo("it-CH");
                    var date = DateTime.Parse(value.AttemptedValue, cultureinfo);
                    property.SetValue(model, date, null);
                }
            }
            catch
            {
                //If something wrong, validation should take care
            }
        }
        else
        {
            base.BindProperty(controllerContext, bindingContext, propertyDescriptor);
        }
    }
}

在我的示例中，我正在使用固定区域性解析日期，但您想要做的是可能的。您应该创建一个 CustomAttribute （如 DateTimeFormatAttribute）并将其放在您的属性上：

[DateTimeFormat("d.M.yyyy")]
public DateTime Birth { get; set,}

现在，在 BindProperty 方法中，您可以使用 DateTimeFormatAttribute 查找属性，而不是查找 DateTime 属性，获取您在构造函数中指定的格式，然后解析DateTime.ParseExact 的日期

我希望这有帮助，我花了很长时间才找到这个解决方案。一旦我知道如何搜索它，实际上很容易获得这个解决方案:(

Answer 3

我认为您不应该将特定于区域设置的属性放在模型上。

此问题的另外两个可能的解决方案是：

• 让您的页面将日期从特定于区域设置的格式音译为通用格式，例如 JavaScript 中的 yyyy-mm-dd。 （可以工作，但需要 JavaScript。）
• 编写一个模型绑定器，在解析日期时考虑当前的 UI 区域性。

要回答您的实际问题，获取自定义属性（对于 MVC 2）的方法是 编写 AssociatedMetadataProvider.

Answer 4

对于 ASP.NET Core，您可以使用以下自定义模型绑定器。
下面给出了一个示例模型。

public class MyModel
{        
    public string UserName { get; set; }

    [BindProperty(BinderType = typeof(CustomDateTimeBinder))]
    public DateTime Date1 { get; set; }

    [BindProperty(BinderType = typeof(CustomDateTimeBinder))]
    public DateTime? Date2 { get; set; }
} 

日期时间值的自定义绑定器。它需要格式 dd/MM/yyyy。

public class CustomDateTimeBinder : IModelBinder
{
    public Task BindModelAsync(ModelBindingContext bindingContext)
    {
        if (bindingContext == null)
        {
            throw new ArgumentNullException(nameof(bindingContext));
        }

        var modelName = bindingContext.ModelName;

        var valueProviderResult = bindingContext.ValueProvider.GetValue(modelName);

        if (valueProviderResult == ValueProviderResult.None)
        {
            return Task.CompletedTask;
        }

        bindingContext.ModelState.SetModelValue(modelName, valueProviderResult);

        var value = valueProviderResult.FirstValue;

        if (string.IsNullOrEmpty(value))
        {
            return Task.CompletedTask;
        }

        if (!DateTime.TryParseExact(value, "dd/MM/yyyy", CultureInfo.InvariantCulture, DateTimeStyles.None, out var dateTime))
        {
            var fieldName = string.Join(" ", Regex.Split(modelName, @"(?<!^)(?=[A-Z])"));
            bindingContext.ModelState.TryAddModelError(
                modelName, $"{fieldName} is invalid.");

            return Task.CompletedTask;
        }


        bindingContext.Result = ModelBindingResult.Success(dateTime);
        return Task.CompletedTask;
    }
}

Answer 5

您可以像这样实现自定义 DateTime Binder，但您必须注意实际客户端请求中假定的区域性和值。您是否可以在 en-US 中获得像 mm/dd/yyyy 这样的日期，并希望将其转换为系统文化 en-GB（类似于 dd/mm/yyyy）或固定文化（就像我们一样），然后您必须先解析它并使用静态外观 Convert 来更改它的行为。

    public class DateTimeModelBinder : IModelBinder
    {
        public object BindModel(ControllerContext controllerContext, ModelBindingContext bindingContext)
        {
            var valueResult = bindingContext.ValueProvider
                              .GetValue(bindingContext.ModelName);
            var modelState = new ModelState {Value = valueResult};

            var resDateTime = new DateTime();

            if (valueResult == null) return null;

            if ((bindingContext.ModelType == typeof(DateTime)|| 
                bindingContext.ModelType == typeof(DateTime?)))
            {
                if (bindingContext.ModelName != "Version")
                {
                    try
                    {
                        resDateTime =
                            Convert.ToDateTime(
                                DateTime.Parse(valueResult.AttemptedValue, valueResult.Culture,
                                    DateTimeStyles.AdjustToUniversal).ToUniversalTime(), CultureInfo.InvariantCulture);
                    }
                    catch (Exception e)
                    {
                        modelState.Errors.Add(EnterpriseLibraryHelper.HandleDataLayerException(e));
                    }
                }
                else
                {
                    resDateTime =
                        Convert.ToDateTime(
                            DateTime.Parse(valueResult.AttemptedValue, valueResult.Culture), CultureInfo.InvariantCulture);
                }
            }
            bindingContext.ModelState.Add(bindingContext.ModelName, modelState);
            return resDateTime;
        }
    }

不管怎样，无状态应用程序中依赖于文化的 DateTime 解析可能会很残酷……特别是当您在 javascript 客户端和向后使用 JSON 时。