MVVM验证在UWP(MVVM Validation in UWP)

2019-09-29 21:58发布

在上周我一直在试图MVVM模式应用到通用的Windows Plataform,在最典雅的可能的方式,这意味着将固态的原则和一些流行的设计模式。

我一直在试图从这个链接复制此练习: http://www.sullinger.us/blog/2014/7/4/custom-object-validation-in-winrt

另外,链接是为Windows 8的应用程序根据在这个论坛MSDN答案10的应用程序也适用于Windows: https://social.msdn.microsoft.com/Forums/windowsapps/en-US/05690519-1937-4e3b-aa12 -c6ca89e57266 / UWP-什么-是最推荐的方法,对数据验证功能于UWP-Windows的10?论坛= wpdevelop

让我告诉你我的班,这是我的看法我最后的观点:

<Page
x:Class="ValidationTestUWP.MainPage"
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
xmlns:local="using:ValidationTestUWP"
xmlns:conv="using:ValidationTestUWP.Converters"
xmlns:viewmodels="using:ValidationTestUWP.ViewModel"
xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
mc:Ignorable="d">

<Page.DataContext>
    <viewmodels:AccountCreationViewModel/>
</Page.DataContext>

<Page.Resources>
    <conv:ValidationMessageConverter x:Key="ValidationMessageConverter"/>
</Page.Resources>

    <StackPanel Grid.Row="1"
            VerticalAlignment="Center"
            HorizontalAlignment="Center">

    <!-- E-Mail address input -->
    <TextBlock Text="Email"
               Style="{StaticResource TitleTextBlockStyle}" />
    <TextBox x:Name="EmailTextBox"
             Margin="0 5 0 0"
             MinWidth="200"
             Text="{Binding Path=AppUser.Email, Mode=TwoWay, UpdateSourceTrigger=PropertyChanged}"/>

    <!--We now have one more thing to do. We need to update our XAML. 
        The Error TextBlocks will now bind to the ValidationMessages property within the model,
        using an index matching the property they are bound to.-->
    <TextBlock x:Name="EmailValidationErrorTextBlock"
               Text="{Binding AppUser.ValidationMessages[Email], Converter={StaticResource ValidationMessageConverter}}"
               Foreground="Red" />

        <!-- Password input -->
    <TextBlock Text="Password"
               Margin="0 30 0 0"
               Style="{StaticResource TitleTextBlockStyle}"/>
    <TextBox x:Name="PasswordTextBox"
             Margin="0 5 0 0"
             MinWidth="{Binding ElementName=EmailTextBox, Path=MinWidth}"
             Text="{Binding Path=AppUser.ValidationMessages[Password], Converter={StaticResource ValidationMessageConverter}}"/>

    <TextBlock x:Name="PasswordValidationToShortErrorTextBlock"
               Text="{Binding PasswordToShortError}"
               Foreground="Red" />
    <TextBlock x:Name="PasswordValidationToLongErrorTextBlock"
               Text="{Binding PasswordToLongError}"
               Foreground="Red" />

    <!-- Login command button -->
    <Button Content="Create Account"
            Margin="0,10, 0, 0"
            Command="{Binding CreateAccount}"/>
</StackPanel>
</Page>

我的模型最终看起来是这样的:(也是我加入的类注释中这个类的解释。)

public class User : ValidatableBase
{
    private string email = string.Empty;

    public string Email
    {
        get { return email; }
        set
        {
            email = value;
            OnPropertyChanged("Email");
        }
    }

    private string password = string.Empty;

    public string Password
    {
        get { return password; }
        set
        {
            password = value;
            OnPropertyChanged("Password");
        }
    }

    /*Now that we are inheriting from our base class, we need to implement the required Validate() method.
     * In order to keep with the Single-Responsibility-Principle, we will invoke other methods from within
     * the Validate() method. 
     * Since we have to validate multiple properties, we should have each property validation be contained 
     * within it's own method. This makes it easier to test.*/
    public override void Validate()
    {
        ValidatePassword("Password");
        //base.OnPropertyChanged("Password");
        ValidateEmail("Email");
        //base.OnPropertyChanged("Email");

        // Passing in an empty string will cause the ValidatableBase indexer to be hit.
        // This will let the UI refresh it's error bindings.
        base.OnPropertyChanged(string.Empty);
    }

    /*Here we just invoke a ValidatePassword and ValidateEmail method. 
     * When we are done, we notify any observers that the entire object has changed by not specifying a property name
     * in the call to OnPropertyChanged. 
     * This lets the observers (in this case, the View) know its bindings need to be refreshed.*/
    private IValidationMessage ValidateEmail(string property)
    {
        const string emailAddressEmptyError = "Email address can not be blank.";
        if (string.IsNullOrEmpty(this.Email))
        {
            var msg = new ValidationErrorMessage(emailAddressEmptyError);
            return msg;
        }

        return null;
    }

    private IValidationMessage ValidatePassword(string property)
    {
        const string passwordToShortError = "Password must a minimum of 8 characters in length.";
        const string passwordToLongError = "Password must not exceed 16 characters in length.";
        if (this.Password.Length < 8)
        {
            var msg = new ValidationErrorMessage(passwordToShortError);
            return msg;
        }
        if (this.Password.Length > 16)
        {
            var msg = new ValidationErrorMessage(passwordToLongError);
            return msg;
        }

        return null;
    }

这是我的视图模型:

/*View Model 
 * 
 * Next, we need to revise our View Model.
 * We will delete all of the error properties within it, along with the INotifyPropertyChanged implementation.
 * We will only need the AppUser property and the ICommand implementation.*/
public class AccountCreationViewModel
{
    public AccountCreationViewModel()
    {
        this.AppUser = new User();
        CreateAccount = new MyCommand(CreateUserAccount);
    }

    private User appUser;

    public event EventHandler CanExecuteChanged = delegate { };
    public MyCommand CreateAccount { get; set; }

    public User AppUser
    {
        get { return appUser; }
        set
        {
            appUser = value;
        }
    }

    private void CreateUserAccount()
    {
        AppUser.Validate();

        if (AppUser.HasValidationMessageType<ValidationErrorMessage>())
        {
            return;
        }
        // Create the user
        // ......
    }

    /*Now, when you run the app and enter an invalid Email or Password,
     * the UI will automatically inform you of the validation errors when you press the Create Account button. 
     * If you ever need to add more Email validation (such as the proper email format) 
     * or more Password validation (such as not allowing specific characters) you can do so without needing
     * to modify your View Model or your View.
     * 
     * If you need to add a whole new property to the Model, with validation, you can. You don't need to modify
     * your View Model, you only need to add a TextBlock to the View to display the validation.*/
}

此外,我已经应用了RelayCommand模式:

public class MyCommand : ICommand
{
    Action _TargetExecuteMethod;
    Func<bool> _TargetCanExecuteMethod;

    public MyCommand(Action executeMethod)
    {
        _TargetExecuteMethod = executeMethod;
    }

    public MyCommand(Action executeMethod, Func<bool> canExecuteMethod)
    {
        _TargetExecuteMethod = executeMethod;
        _TargetCanExecuteMethod = canExecuteMethod;
    }

    public void RaiseCanExecuteChanged()
    {
        CanExecuteChanged?.Invoke(this, EventArgs.Empty);
    }

    /*Beware - should use weak references if command instance lifetime 
    is longer than lifetime of UI objects that get hooked up to command*/
    // Prism commands solve this in their implementation public event 
    public event EventHandler CanExecuteChanged = delegate { };

    public bool CanExecute(object parameter)
    {
        if (_TargetCanExecuteMethod != null)
            return _TargetCanExecuteMethod();

        if (_TargetExecuteMethod != null)
            return true;

        return false;
    }

    public void Execute(object parameter)
    {
        /*This sintax use the null*/
        _TargetExecuteMethod?.Invoke();
    }
}

这是有趣的开始,我就为大家介绍ValidatableBase在博客我向您前面创建:

public abstract class ValidatableBase : IValidatable, INotifyPropertyChanged
{
    /*Our initial class contains the Dictionary that will hold our validation messages. 
     * Next, we implement the read-only property required by our interface.*/
    private Dictionary<string, List<IValidationMessage>> _validationMessages = 
        new Dictionary<string, List<IValidationMessage>>();

    /*The call to OnPropertyChanged will let the UI know that this collection has changed. 
     * This in most cases won't be used since the collection is read-only, but since it is going in to a base class,
     * we want to provide support for that.*/
    public Dictionary<string, List<IValidationMessage>> ValidationMessages
    {
        get { return _validationMessages; }
        set
        {
            _validationMessages = value;
            OnPropertyChanged("ValidationMessages");
        }
    }

    public event PropertyChangedEventHandler PropertyChanged = delegate { };

    /*our base class implements the INotifyPropertyChanged method, 
     * so we will remove it from our model and put the implementation in to our base class.*/
    public void OnPropertyChanged(string propertyName)
    {
        PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));
    }

    /*In this method, we check if the collection contains a Key matching the property supplied.
     * If it does, then we check it's values to see if any of them match the Type specified in < T>.
     * This lets you do something like
     * 
     * HasValidationMessageType< ValidationErrorMessage>("Email");
     * 
     * to check if the model has a validation error on the email property.*/
    public bool HasValidationMessageType<T>(string property = "")
    {
        if (string.IsNullOrEmpty(property))
        {
            bool result = _validationMessages.Values.Any(collection =>
                collection.Any(msg => msg is T));
            return result;
        }

        return _validationMessages.ContainsKey(property);
    }

    /*In this method we create a new collection if the key doesn't exist yet,
     * we then double check to ensure this validation message does not already exist in the collection.
     * If not, we add it.*/
    public void AddValidationMessage(IValidationMessage message, string property = "")
    {
        if (string.IsNullOrEmpty(property))
        {
            return;
        }

        // If the key does not exist, then we create one.
        if (!_validationMessages.ContainsKey(property))
        {
            _validationMessages[property] = new List<IValidationMessage>();
        }

        if (_validationMessages[property].Any(msg => msg.Message.Equals(message.Message) || msg == message))
        {
            return;
        }

        _validationMessages[property].Add(message);
    }

    /*Here we just check if there is any message for the supplied Key and remove it.
     * At the moment, this does not do any Type checking to see if there is more 
     * than one Type of object (Warning and Error) in the collection with the same message.
     * The method just removes the first thing it finds and calls it good.*/
    public void RemoveValidationMessage(string message, string property = "")
    {
        if (string.IsNullOrEmpty(property))
        {
            return;
        }

        if (!_validationMessages.ContainsKey(property))
        {
            return;
        }

        if (_validationMessages[property].Any(msg => msg.Message.Equals(message)))
        {
            // Remove the error from the key's collection.
            _validationMessages[property].Remove(
                _validationMessages[property].FirstOrDefault(msg => msg.Message.Equals(message)));
        }
    }

    /*We just check if a key exists that matches the property name and then clear out its messages contents
     * and remove the key from the Dictionary.*/
    public void RemoveValidationMessages(string property = "")
    {
        if (string.IsNullOrEmpty(property))
        {
            return;
        }

        if (!_validationMessages.ContainsKey(property))
        {
            return;
        }

        _validationMessages[property].Clear();
        _validationMessages.Remove(property);
    }

    /*Finally, we finish implementing the interface by building the ValidateProperty method.
     * In this method, we just invoke the delegate we are provided, and accept a IValidationMessage object in return.
     * If the return value is not null, then we add it to the ValidationMessages collection.
     * If it is null, then we can assume that the validation passed and there are no issues.
     * Since that is the case, we remove it from the validation collection.*/
    public IValidationMessage ValidateProperty(Func<string, IValidationMessage> validationDelegate,
        string failureMessage, string propertyName = "")
    {
        IValidationMessage result = validationDelegate(failureMessage);
        if (result != null)
        {
            this.AddValidationMessage(result, propertyName);
        }
        else
        {
            this.RemoveValidationMessage(failureMessage, propertyName);
        }

        return result;
    }

    /*We have satisfied the requirements of the IValidatable interface, but there is one more method
     * we need to add to the base class. This will let us group all of our property validations in to a single call.
     * 
     * We mark it as abstract, since the base class has nothing to validate, 
     * and we want to force any object that inherits from the base class to implement the method. 
     * If you don't want to do this, you can opt out of in your code. Not everyone needs to have this feature,
     * thus the reason why it was left out of the interface.*/
    public abstract void Validate();
}

最后这是我的界面:

//The first thing I did was created an interface that all models needing validation would be required to implement. 
public interface IValidatable
{
    /*This is a read-only property, that will contain all of our validation messages. 
     * The property has a Key typed to a string, which will be the Models property name. 
     * The value is a collection of IValidationMessage objects (We will discuss what the IValidationMessage is later).
     * The idea being that for each property in the model, we can store more than 1 error.*/
    Dictionary<string, List<IValidationMessage>> ValidationMessages { get; }

    /*This method is used to add a validation message to the ValidationMessages collection.
     * The property will be assigned as the Key, with the message being added as the value.*/
    void AddValidationMessage(IValidationMessage message, string property = "");

    /*Just like we can add a validation message, we will provide ourselves with the ability to remove it.*/
    void RemoveValidationMessage(string message, string property = "");

    /*We can use this method to completely clear out all validation messages in one shot for a single property.*/
    void RemoveValidationMessages(string property = "");

    /*This method will return true if the object has validation messages matching <T> and false if it does not.*/
    bool HasValidationMessageType<T>(string property = "");

    /*This method can be called to actually perform validation on a property within the object and 
     * build the collection of errors. The arguments require a method delegate that returns an IValidationMessage object.
     * This is how the validation becomes reusable. Each individual object can pass in a method delegate that performs
     * the actual validation. The IValidatable implementation will take the results and determine if it must go in to
     * the ValidationMessages collection or not.*/
    IValidationMessage ValidateProperty(Func<string, IValidationMessage> validationDelegate, 
        string failureMessage,
        string propertyName = "");
}

/*The idea with this, is that we can create objects that implement this interface,
 * but containing different types of messages. For instance, in this post, we will create a ValidationErrorMessage
 * and a ValidationWarningMessage. You could go on and create any kind of messaging you want and use it
 * for binding to the View.*/
public interface IValidationMessage
{
    string Message { get; }
}

这是我的转换器:

/*The idea with this, is that we can create objects that implement this interface,
 * but containing different types of messages. For instance, in this post, we will create a ValidationErrorMessage
 * and a ValidationWarningMessage. You could go on and create any kind of messaging you want and use it
 * for binding to the View.*/
public interface IValidationMessage
{
    string Message { get; }
}

最后我ValidationErrorMessages:

 /*Before we end the post, I will show you two implementations of the IValidationMessage.
 * They both do the same thing, but are Typed differently so that you can segregate your messages by Type.
 * This gives more flexibility that using an Enum.
 * 
 * First is the Error validation message.*/
public class ValidationErrorMessage : IValidationMessage
{
    public ValidationErrorMessage() : this(string.Empty)
    { }

    public ValidationErrorMessage(string message)
    {
        this.Message = message;
    }

    public string Message { get; private set; }
}

现在,每当我像这样运行的代码在萨林杰博客中所示的示例代码时,我得到一个例外:

System.Reflection.TargetInvocationException:“与此错误代码相关联的文本无法被发现。

我使用VS2017我想MVVM模式应用到验证在UWP,当然我可以在我的视图模型的每一个领域做验证,但它意味着我将不得不写验证了我创建的每个视图,并尽可能我看到在这个例子中,这能救我吨代码。

有谁知道什么是错的代码?

我不想使用像MVVM Light或MVVM交叉或棱镜工具,这纯粹是UWP定制MVVM。

Answer 1:

好了最后,我是能够使此代码的工作,它有一定的修复,但我能理解它,并解决它在我自己的,我出版我的答案之前,因为我对这个问题的两个答案,我会喜欢道歉社会,我没有想寻求帮助,让你可以为我做的,它不是我的本意,如果它看起来像,我很抱歉,我会尽力听起来不那么需要的人。

那么到了解决方案:

我已经公布了代码的主要问题是在抽象方法验证,因为你得写自己的验证每个字段,也这是你控制添加和删除错误信息,所以我写了一个validate方法是这样一:

public override void Validate()
    {
        RemoveValidationMessages("Password");
        RemoveValidationMessages("Email");
        AddValidationMessage(ValidatePassword("Password"), "Password");
        AddValidationMessage(ValidateEmail("Email"), "Email");

        // Passing in an empty string will cause the ValidatableBase indexer to be hit.
        // This will let the UI refresh it's error bindings.
        base.OnPropertyChanged(string.Empty);
    }

正如你可以看到我一直开始方法删除所有信息,使我们不加一次消息的更多,因为addvalidation消息犯规让你重复相同的错误消息。 然后我们使用我们使用自定义的验证密码或电子邮件方式的方法中的AddValidationMessageMethod让他们返回的消息在这里所以每次加入我们的自定义方法是我的问题,我返回null给我留言转换器被触发它扔了例外,我显示了在我的问题。 因此,为了解决这个问题,而不是返回空当文本框有一些文字,我回到ValidationErrorMessages类的这样的方法空构造:

private IValidationMessage ValidateEmail(string property)
    {
        const string emailAddressEmptyError = "Email address can not be blank.";
        if (string.IsNullOrEmpty(this.Email))
        {
            var msg = new ValidationErrorMessage(emailAddressEmptyError);
            return msg;
        }

        return new ValidationErrorMessage();
    }

    private IValidationMessage ValidatePassword(string property)
    {
        const string passwordToShortError = "Password must a minimum of 8 characters in length.";
        const string passwordToLongError = "Password must not exceed 16 characters in length.";
        if (this.Password.Length < 8)
        {
            var msg = new ValidationErrorMessage(passwordToShortError);
            return msg;
        }
        if (this.Password.Length > 16)
        {
            var msg = new ValidationErrorMessage(passwordToLongError);
            return msg;
        }

        return new ValidationErrorMessage();
    }

这解决引发异常的问题。 同时,你可以离开这个方法返回null,但你必须要修改的转换器使得它检查IValidationMessages征集空值。

它是这样的:

 public object Convert(object value, Type targetType, object parameter, string language)
    {
        if (!(value is IEnumerable<IValidationMessage>))
        {
            return string.Empty;
        }

        var collection = value as IEnumerable<IValidationMessage>;
        if (!collection.Any())
        {
            return string.Empty;
        }

        if (collection.FirstOrDefault() == null)
        {
           return string.Empty;
        }           

        return collection.FirstOrDefault().Message;
    }

这样我们就可以更新我们的错误消息领域,现在的人,你可以有UWP工作MVVM验证工作模式。 具有高度可测试,可维护,可扩展的应用程序。

希望能为那些在UWP挖掘这个解决方案的帮助。 也有一些伟大的文章从不同的来源,你可以尝试萨林杰博客这是我正在采用的做法,但也Wintellect的有一篇文章我会在这里分享链接: http://www.wintellect.com/devcenter/jlikness /简单验证与- MVVM换窗户,商店的应用程序

这也为UWP工作,我测试过,但你得工作多一点。 和杰里尼克松对UWP验证一个伟大的文章太多,他的模型的方式更优雅比萨林杰这是链接尼克松验证: http://blog.jerrynixon.com/2014/07/lets-code-handling-validation-在-your.html

而他在这里拥有源代码: http://xaml.codeplex.com/SourceControl/latest#Blog/201406-Validation/App10/Common/ModelBase.cs

也希望这种帮助别人。 如有任何问题,我会很乐意帮助你。



文章来源: MVVM Validation in UWP