Как сделать тип привязки данных безопасным и поддерживать рефакторинг

Когда я хочу привязать элемент управления к свойству моего объекта, я должен указать имя свойства как строку. Это не очень хорошо, потому что:

  • Если свойство удалено или переименован, я не получаю компилятор предупреждение.
  • Если переименовать свойство с инструментом рефакторинга, это вероятно, привязка данных не будет обновлено.
  • Я не получаю ошибку до тех пор, пока время выполнения, если тип свойства неправильно, например. привязка целого к выбор даты.

Есть ли шаблон дизайна, который обходит это, но все еще имеет простоту использования привязки данных?

(Это проблема в WinForm, Asp.net и WPF и, скорее всего, много других систем)

Теперь я нашел "обходные пути для оператора nameof() в С#: типы данных databinding", который также имеет хорошую отправную точку для решения.

Если вы захотите использовать постпроцессор после компиляции кода, notifypropertyweaver стоит посмотреть.

Кто-нибудь знает о хорошем решении для WPF, когда привязки выполняются в XML, а не в С#?

ОТВЕТЫ

Ответ 1

Спасибо Oliver за то, что вы меня начали. Теперь у меня есть решение, которое поддерживает рефакторинг и безопасно. Он также позволяет мне реализовать INotifyPropertyChanged, чтобы он справлялся с переименованием свойств.

Его использование выглядит следующим образом:

checkBoxCanEdit.Bind(c => c.Checked, person, p => p.UserCanEdit);
textBoxName.BindEnabled(person, p => p.UserCanEdit);
checkBoxEmployed.BindEnabled(person, p => p.UserCanEdit);
trackBarAge.BindEnabled(person, p => p.UserCanEdit);

textBoxName.Bind(c => c.Text, person, d => d.Name);
checkBoxEmployed.Bind(c => c.Checked, person, d => d.Employed);
trackBarAge.Bind(c => c.Value, person, d => d.Age);

labelName.BindLabelText(person, p => p.Name);
labelEmployed.BindLabelText(person, p => p.Employed);
labelAge.BindLabelText(person, p => p.Age);

Класс person показывает, как реализовать INotifyPropertyChanged безопасным способом (или см. этот ответ для другого довольно приятного способа реализации INotifyPropertyChanged, ActiveSharp - Автоматический INotifyPropertyChanged также выглядит хорошо):

public class Person : INotifyPropertyChanged
{
   private bool _employed;
   public bool Employed
   {
      get { return _employed; }
      set
      {
         _employed = value;
         OnPropertyChanged(() => c.Employed);
      }
   }

   // etc

   private void OnPropertyChanged(Expression<Func<object>> property)
   {
      if (PropertyChanged != null)
      {
         PropertyChanged(this, 
             new PropertyChangedEventArgs(BindingHelper.Name(property)));
      }
   }

   public event PropertyChangedEventHandler PropertyChanged;
}

У класса помощника по связыванию WinForms есть мясо, в котором все это работает:

namespace TypeSafeBinding
{
    public static class BindingHelper
    {
        private static string GetMemberName(Expression expression)
        {
            // The nameof operator was implemented in C# 6.0 with .NET 4.6
            // and VS2015 in July 2015. 
            // The following is still valid for C# < 6.0

            switch (expression.NodeType)
            {
                case ExpressionType.MemberAccess:
                    var memberExpression = (MemberExpression) expression;
                    var supername = GetMemberName(memberExpression.Expression);
                    if (String.IsNullOrEmpty(supername)) return memberExpression.Member.Name;
                    return String.Concat(supername, '.', memberExpression.Member.Name);
                case ExpressionType.Call:
                    var callExpression = (MethodCallExpression) expression;
                    return callExpression.Method.Name;
                case ExpressionType.Convert:
                    var unaryExpression = (UnaryExpression) expression;
                    return GetMemberName(unaryExpression.Operand);
                case ExpressionType.Parameter:
                case ExpressionType.Constant: //Change
                    return String.Empty;
                default:
                    throw new ArgumentException("The expression is not a member access or method call expression");
            }
        }

        public static string Name<T, T2>(Expression<Func<T, T2>> expression)
        {
            return GetMemberName(expression.Body);
        }

        //NEW
        public static string Name<T>(Expression<Func<T>> expression)
        {
           return GetMemberName(expression.Body);
        }

        public static void Bind<TC, TD, TP>(this TC control, Expression<Func<TC, TP>> controlProperty, TD dataSource, Expression<Func<TD, TP>> dataMember) where TC : Control
        {
            control.DataBindings.Add(Name(controlProperty), dataSource, Name(dataMember));
        }

        public static void BindLabelText<T>(this Label control, T dataObject, Expression<Func<T, object>> dataMember)
        {
            // as this is way one any type of property is ok
            control.DataBindings.Add("Text", dataObject, Name(dataMember));
        }

        public static void BindEnabled<T>(this Control control, T dataObject, Expression<Func<T, bool>> dataMember)
        {       
           control.Bind(c => c.Enabled, dataObject, dataMember);
        }
    }
}

Это использует много нового в С# 3.5 и показывает только то, что возможно. Теперь, если бы у нас были гигиенические макросы lisp программист может перестать называть нас гражданами второго сорта)

Ответ 2

Оператор nameof был реализован в С# 6.0 с .NET 4.6 и VS2015 в июле 2015 года. Для С# < 6,0

Чтобы избежать строк, содержащих имена свойств, я написал простой класс, используя деревья выражений, чтобы вернуть имя члена:

using System;
using System.Linq.Expressions;
using System.Reflection;

public static class Member
{
    private static string GetMemberName(Expression expression)
    {
        switch (expression.NodeType)
        {
            case ExpressionType.MemberAccess:
                var memberExpression = (MemberExpression) expression;
                var supername = GetMemberName(memberExpression.Expression);

                if (String.IsNullOrEmpty(supername))
                    return memberExpression.Member.Name;

                return String.Concat(supername, '.', memberExpression.Member.Name);

            case ExpressionType.Call:
                var callExpression = (MethodCallExpression) expression;
                return callExpression.Method.Name;

            case ExpressionType.Convert:
                var unaryExpression = (UnaryExpression) expression;
                return GetMemberName(unaryExpression.Operand);

            case ExpressionType.Parameter:
                return String.Empty;

            default:
                throw new ArgumentException("The expression is not a member access or method call expression");
        }
    }

    public static string Name<T>(Expression<Func<T, object>> expression)
    {
        return GetMemberName(expression.Body);
    }

    public static string Name<T>(Expression<Action<T>> expression)
    {
        return GetMemberName(expression.Body);
    }
}

Вы можете использовать этот класс следующим образом. Даже если вы можете использовать его только в коде (а не в XAML), это очень полезно (по крайней мере для меня), но ваш код по-прежнему не является типичным. Вы можете расширить метод Name со вторым аргументом типа, который определяет возвращаемое значение функции, которое ограничивало бы тип свойства.

var name = Member.Name<MyClass>(x => x.MyProperty); // name == "MyProperty"

До сих пор я не нашел ничего, что позволило бы решить проблему привязки данных.

С наилучшими пожеланиями

Ответ 3

Framework 4.5 предоставляет нам CallerMemberNameAttribute, что делает передачу имени свойства в виде ненужной строки:

private string m_myProperty;
public string MyProperty
{
    get { return m_myProperty; }
    set
    {
        m_myProperty = value;
        OnPropertyChanged();
    }
}

private void OnPropertyChanged([CallerMemberName] string propertyName = "none passed")
{
    // ... do stuff here ...
}

Если вы работаете над Framework 4.0 с KB2468871, вы можете установить пакет совместимости Microsoft BCL с помощью nuget, который также предоставляет этот атрибут.

Ответ 4

В этой статье возникают некоторые хорошие вопросы об эффективности этого подхода. Вы можете улучшить эти недостатки, преобразовывая выражение в строку как часть какой-либо статической инициализации.

Фактическая механика может быть немного неприглядной, но она по-прежнему будет безопасна по типу и примерно равна производительности сырой INotifyPropertyChanged.

Что-то вроде этого:

public class DummyViewModel : ViewModelBase
{
    private class DummyViewModelPropertyInfo
    {
        internal readonly string Dummy;

        internal DummyViewModelPropertyInfo(DummyViewModel model)
        {
            Dummy = BindingHelper.Name(() => model.Dummy);
        }
    }

    private static DummyViewModelPropertyInfo _propertyInfo;
    private DummyViewModelPropertyInfo PropertyInfo
    {
        get { return _propertyInfo ?? (_propertyInfo = new DummyViewModelPropertyInfo(this)); }
    }

    private string _dummyProperty;
    public string Dummy
    {
        get
        {
            return this._dummyProperty;
        }
        set
        {
            this._dummyProperty = value;
            OnPropertyChanged(PropertyInfo.Dummy);
        }
    }
}

Ответ 5

Один из способов получить обратную связь, если ваши привязки разбиты, заключается в создании DataTemplate и объявлении его DataType типом ViewModel, который он связывает, например. если у вас есть PersonView и PersonViewModel, вы бы сделали следующее:

  • Объявить DataTemplate с помощью DataType = PersonViewModel и ключа (например, PersonTemplate)

  • Вырезать все PersonView xaml и вставить его в шаблон данных (который идеально может быть только в верхней части PersonView.

3a. Создайте ContentControl и установите ContentTemplate = PersonTemplate и привяжите его содержимое к PersonViewModel.

3b. Другой вариант - не давать ключ к DataTemplate и не устанавливать ContentTemplate ContentControl. В этом случае WPF будет определять, какой DataTemplate использовать, поскольку он знает, к какому типу объекта вы привязываетесь. Он будет искать дерево и найти ваш DataTemplate, и поскольку он соответствует типу привязки, он автоматически применит его как ContentTemplate.

В конечном итоге вы получаете тот же вид, что и раньше, но поскольку вы сопоставили DataTemplate с базовым типом DataType, такие инструменты, как Resharper, могут дать вам обратную связь (через идентификаторы цвета - параметры Resharper-Options-Settings-Color Identifiers), чтобы привязки сломаны или нет.

Вы по-прежнему не получите предупреждения компилятора, но можете визуально проверить наличие сломанных привязок, что лучше, чем проверять назад и вперед между вашим представлением и viewmodel.

Еще одно преимущество этой дополнительной информации, которую вы даете, заключается в том, что она также может использоваться при переименовании рефакторинга. Насколько я помню, Resharper может автоматически переименовывать привязки при вводе DataTemplates, когда изменено имя свойства ViewModel и наоборот.

Ответ 6

1.Если свойство удалено или переименовано, я не получаю предупреждение о компиляторе.

2.Если переименовать свойство с помощью инструмента рефакторинга, вероятно, привязка данных не будет обновлена.

3. Я не получаю ошибку до выполнения, если тип свойства неверен, например. связывая целое число с выбором даты.

Да, Ian, это именно те проблемы, которые связаны с привязкой данных, основанной на имени. Вы попросили шаблон дизайна. Я разработал шаблон Type-Safe View Model (TVM), который является конкрецией части View Model модели Model-View-ViewModel (MVVM). Он основан на привязке к типу, аналогичном вашему собственному ответу. Я только что опубликовал решение для WPF:

http://www.codeproject.com/Articles/450688/Enhanced-MVVM-Design-w-Type-Safe-View-Models-TVM

Ответ 7

x: bind (также называемый "скомпилированные привязки данных" ) для XAML (универсальное приложение) в Windows 10 и Windows Phone 10 может решить эту проблему, см. https://channel9.msdn.com/Events/Build/2015/3-635

Я не могу найти он-лайн документы для него, но не приложил много усилий, поскольку это то, что я не буду использовать в течение некоторого времени. Однако этот ответ должен быть полезным указателем на других людей.