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

https://stackoverflow.com/questions/1329138

19-09-2019
|

Вопрос

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

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

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

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

Теперь я нашел " .обходные пути для оператора nameof() в C#:типизированная привязка к данным" это также хорошая отправная точка для поиска решения.

Если вы готовы использовать постпроцессор после компиляции вашего кода, notifypropertyweaver - механизм уведомления на это стоит посмотреть.

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

Решение

Спасибо Оливеру за то, что помог мне начать, теперь у меня есть решение, которое поддерживает рефакторинг и является типобезопасным.Это также позволило мне реализовать 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);
        }
    }
}

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

Другие советы

Оператор nameof был реализован в C # 6.0 с .NET 4.6 и VS2015 в июле 2015 года.Следующее по-прежнему актуально для C# < 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), это весьма полезно (по крайней мере, для меня), но ваш код по-прежнему небезопасен для ввода.Вы могли бы расширить имя метода вторым аргументом типа, который определяет возвращаемое значение функции, что ограничивало бы тип свойства.

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

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

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

Фреймворк 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 через самородок, который также предоставляет этот атрибут.

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

Фактическая механика может быть немного неприглядной, но она все равно будет типобезопасной и примерно равной производительности необработанного 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);
        }
    }
}

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

Объявите DataTemplate с типом данных = PersonViewModel и ключом (напримерШаблон пользователя)
Вырежьте весь PersonView xaml и вставьте его в шаблон данных (который в идеале может находиться просто в верхней части PersonView.

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

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

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

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

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

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

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

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

Да, Иэн, это именно те проблемы, которые возникают при привязке данных, основанных на именных строках.Вы просили создать шаблон дизайна.Я разработал шаблон 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

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

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

Лицензировано под: CC-BY-SA с атрибуция

Не связан с StackOverflow