FluentValidation在C# WPF中的應用

来源:https://www.cnblogs.com/lsq6/archive/2019/11/19/fluentvalidation-csharp-wpf.html
-Advertisement-
Play Games

FluentValidation在C# WPF中應用，支持嵌套屬性驗證。 ...


 

一、簡介

介紹FluentValidation的文章不少，零度編程的介紹我引用下：FluentValidation 是一個基於 .NET 開發的驗證框架，開源免費，而且優雅，支持鏈式操作，易於理解，功能完善，還是可與 MVC5、WebApi2 和 ASP.NET CORE 深度集成，組件內提供十幾種常用驗證器，可擴展性好，支持自定義驗證器，支持本地化多語言。

其實它也可以用於WPF屬性驗證，本文主要也是講解該組件在WPF中的使用，FluentValidation官網是： https://fluentvalidation.net/ 。

二、本文需要實現的功能

提供WPF界面輸入驗證，採用MVVM方式，需要以下功能：

  1. 能驗證ViewModel中定義的簡單屬性；
  2. 能驗證ViewModel中定義的複雜屬性，比如對象屬性的子屬性，如VM有個學生屬性Student,需要驗證他的姓名、年齡等；
  3. 能簡單提供兩種驗證樣式；
  4. 沒有了，就是前面3點…

先看實現效果圖：

FluentValidation在C# WPF中的應用

三、調研中遇到的問題

簡單屬性：驗證ViewModel的普通屬性比較簡單，可以參考FluentValidation官網：鏈接 ，或者國外holymoo大神的代碼： UserValidator.cs 。

複雜屬性：我遇到的問題是，怎麼驗證ViewModel中對象屬性的子屬性？見第二個功能描述，FluentValidation的官網有Complex Properties的例子，但是我試了沒效果，貼上官方源碼截圖：

FluentValidation在C# WPF中的應用

最後我Google到這篇文章，根據該鏈接代碼，ViewModel和子屬性都實現IDataErrorInfo介面，即可實現複雜屬性驗證，文章中沒有具體實現，但靈感是從這來的，就不具體說該鏈接代碼了，有興趣可以點擊鏈接閱讀，下麵貼上代碼。

四、開發步驟

4.1、創建工程、引入庫

創建.Net Core WPF模板解決方案（.Net Framework模板也行）：WpfFluentValidation，引入Nuget包FluentValidation(8.5.1)。

4.2、創建測試實體類學生：Student.cs

此類用作ViewModel中的複雜屬性使用，學生類包含3個屬性：名字、年齡、郵政編碼。此實體需要繼承IDataErrorInfo介面，觸發FluentValidation必須的。

using System.ComponentModel;
using System.Linq;
using WpfFluentValidation.Validators;

namespace WpfFluentValidation.Models
{
    /// <summary>
    /// 學生實體
    /// 繼承BaseClasss,即繼承屬性變化介面INotifyPropertyChanged
    /// 實現IDataErrorInfo介面，用於FluentValidation驗證，必須實現此介面
    /// </summary>
    public class Student : BaseClass, IDataErrorInfo
    {
        private string name;
        public string Name
        {
            get { return name; }
            set
            {
                if (value != name)
                {
                    name = value;
                    OnPropertyChanged(nameof(Name));
                }
            }
        }
        private int age;
        public int Age
        {
            get { return age; }
            set
            {
                if (value != age)
                {
                    age = value;
                    OnPropertyChanged(nameof(Age));
                }
            }
        }
        private string zip;
        public string Zip
        {
            get { return zip; }
            set
            {
                if (value != zip)
                {
                    zip = value;
                    OnPropertyChanged(nameof(Zip));
                }
            }
        }

        public string Error { get; set; }

        public string this[string columnName]
        {
            get
            {
                if (validator == null)
                {
                    validator = new StudentValidator();
                }
                var firstOrDefault = validator.Validate(this)
                    .Errors.FirstOrDefault(lol => lol.PropertyName == columnName);
                return firstOrDefault?.ErrorMessage;
            }
        }

        private StudentValidator validator { get; set; }
    }
}

4.3、創建學生驗證器：StudentValidator.cs

驗證屬性的寫法有兩種：

  1. 可以在實體屬性上方添加特性（本文不作特別說明，百度文章介紹很多）；
  2. 通過代碼的形式添加，如下方，創建一個驗證器類，繼承自AbstractValidator，在此驗證器構造函數中寫規則驗證屬性，方便管理。

本文使用第二種，見下方學生驗證器代碼：

using FluentValidation;
using System.Text.RegularExpressions;
using WpfFluentValidation.Models;

namespace WpfFluentValidation.Validators
{
    public class StudentValidator : AbstractValidator<Student>
    {
        public StudentValidator()
        {
            RuleFor(vm => vm.Name)
                    .NotEmpty()
                    .WithMessage("請輸入學生姓名！")
                .Length(5, 30)
                .WithMessage("學生姓名長度限制在5到30個字元之間！");

            RuleFor(vm => vm.Age)
                .GreaterThanOrEqualTo(0)
                .WithMessage("學生年齡為整數！")
                .ExclusiveBetween(10, 150)
                .WithMessage($"請正確輸入學生年齡(10-150)");

            RuleFor(vm => vm.Zip)
                .NotEmpty()
                .WithMessage("郵政編碼不能為空！")
                .Must(BeAValidZip)
                .WithMessage("郵政編碼由六位數字組成。");
        }

        private static bool BeAValidZip(string zip)
        {
            if (!string.IsNullOrEmpty(zip))
            {
                var regex = new Regex(@"\d{6}");
                return regex.IsMatch(zip);
            }
            return false;
        }
    }
}

4.4、 創建ViewModel類：StudentViewModel.cs

StudentViewModel與Student實體類結構類似，都需要實現IDataErrorInfo介面，該類由一個簡單的string屬性(Title)和一個複雜的Student對象屬性(CurrentStudent)組成，代碼如下：

using System;
using System.ComponentModel;
using System.Linq;
using WpfFluentValidation.Models;
using WpfFluentValidation.Validators;

namespace WpfFluentValidation.ViewModels
{
    /// <summary>
    /// 視圖ViewModel
    /// 繼承BaseClasss,即繼承屬性變化介面INotifyPropertyChanged
    /// 實現IDataErrorInfo介面，用於FluentValidation驗證，必須實現此介面
    /// </summary>
    public class StudentViewModel : BaseClass, IDataErrorInfo
    {
        private string title;
        public string Title
        {
            get { return title; }
            set
            {
                if (value != title)
                {
                    title = value;
                    OnPropertyChanged(nameof(Title));
                }
            }
        }

        private Student currentStudent;
        public Student CurrentStudent
        {
            get { return currentStudent; }
            set
            {
                if (value != currentStudent)
                {
                    currentStudent = value;
                    OnPropertyChanged(nameof(CurrentStudent));
                }
            }
        }

        public StudentViewModel()
        {
            CurrentStudent = new Student()
            {
                Name = "李剛的兒",
                Age = 23
            };
        }


        public string this[string columnName]
        {
            get
            {
                if (validator == null)
                {
                    validator = new ViewModelValidator();
                }
                var firstOrDefault = validator.Validate(this)
                    .Errors.FirstOrDefault(lol => lol.PropertyName == columnName);
                return firstOrDefault?.ErrorMessage;
            }
        }
        public string Error
        {
            get
            {
                var results = validator.Validate(this);
                if (results != null && results.Errors.Any())
                {
                    var errors = string.Join(Environment.NewLine, results.Errors.Select(x => x.ErrorMessage).ToArray());
                    return errors;
                }

                return string.Empty;
            }
        }

        private ViewModelValidator validator;
    }
}

仔細看上方代碼，對比Student.cs，重寫自IDataErrorInfo的Error屬性定義有所不同。Student.cs對Error基本未做修改，而StudentViewModel.cs有變化，get器中驗證屬性（簡單屬性Title和複雜屬性CurrentStudent），返回錯誤提示字元串，誒，CurrentStudent的驗證器怎麼生效的？有興趣的大佬可以研究FluentValidation庫源碼一探究竟，我沒有深究。

4.5 StudentViewModel的驗證器ViewModelValidator.cs

ViewModel的驗證器，相比Student的驗證器StudentValidator，就簡單的多了，因為只需要編寫驗證一個簡單屬性Title的代碼。而複雜屬性CurrentStudent的驗證器StudentValidator，將被WPF屬性系統自動調用，即在StudentViewModel的索引器this[string columnName]和Error屬性中調用，界面觸發規則時自動調用，具體是什麼機制我沒有仔細研究，有興趣的大佬可以研究源碼。

using FluentValidation;
using WpfFluentValidation.ViewModels;

namespace WpfFluentValidation.Validators
{
    public class ViewModelValidator:AbstractValidator<StudentViewModel>
    {
        public ViewModelValidator()
        {
            RuleFor(vm => vm.Title)
                .NotEmpty()
                .WithMessage("標題長度不能為空！")
                .Length(5, 30)
                .WithMessage("標題長度限制在5到30個字元之間！");
        }
    }
}

4.6 輔助類BaseClass.cs

簡單封裝INotifyPropertyChanged介面

using System.ComponentModel;

namespace WpfFluentValidation
{
    public class BaseClass : INotifyPropertyChanged
    {
        public event PropertyChangedEventHandler PropertyChanged;
        protected virtual void OnPropertyChanged(string propertyName)
        {
            PropertyChangedEventHandler handler = PropertyChanged;
            if (handler != null)
            {
                handler(this, new PropertyChangedEventArgs(propertyName));
            }
        }
    }
}

4.7 、視圖StudentView.xaml

用戶直接接觸的視圖文件來了，比較簡單，提供簡單屬性標題(Title)、複雜屬性學生姓名(CurrentStudent.Name)、學生年齡( CurrentStudent .Age)、學生郵政編碼( CurrentStudent .Zip)驗證，xaml代碼如下：

<UserControl x:Class="WpfFluentValidation.Views.StudentView"
             xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
             xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" 
             xmlns:d="http://schemas.microsoft.com/expression/blend/2008" 
             xmlns:local="clr-namespace:WpfFluentValidation.Views"
             xmlns:vm="clr-namespace:WpfFluentValidation.ViewModels"
             mc:Ignorable="d" 
             d:DesignHeight="450" d:DesignWidth="800">
    <UserControl.DataContext>
        <vm:StudentViewModel/>
    </UserControl.DataContext>
    <Grid>
        <Grid.RowDefinitions>
            <RowDefinition Height="Auto"/>
            <RowDefinition Height="Auto"/>
            <RowDefinition Height="*"/>
        </Grid.RowDefinitions>

        <GroupBox Header="ViewModel直接屬性驗證">
            <StackPanel Orientation="Horizontal">
                <Label Content="標題："/>
                <TextBox Text="{Binding Title, UpdateSourceTrigger=PropertyChanged,ValidatesOnDataErrors=True}"
                         Style="{StaticResource ErrorStyle1}"/>
            </StackPanel>
        </GroupBox>
        <GroupBox Header="ViewModel對象屬性CurrentStudent的屬性驗證" Grid.Row="1">
            <StackPanel>
                <StackPanel Orientation="Horizontal">
                    <Label Content="姓名："/>
                    <TextBox Text="{Binding CurrentStudent.Name, UpdateSourceTrigger=PropertyChanged,ValidatesOnDataErrors=True}"
                         Style="{StaticResource ErrorStyle2}"/>
                </StackPanel>
                <StackPanel Orientation="Horizontal">
                    <Label Content="年齡："/>
                    <TextBox Text="{Binding CurrentStudent.Age, UpdateSourceTrigger=PropertyChanged,ValidatesOnDataErrors=True}"
                         Style="{StaticResource ErrorStyle2}"/>
                </StackPanel>
                <StackPanel Orientation="Horizontal">
                    <Label Content="郵編：" />
                    <TextBox Text="{Binding CurrentStudent.Zip, UpdateSourceTrigger=PropertyChanged,ValidatesOnDataErrors=True}"
                         Style="{StaticResource ErrorStyle2}"/>
                </StackPanel>
            </StackPanel>
        </GroupBox>
    </Grid>
</UserControl>

4.8 、錯誤提示樣式

本文提供了兩種樣式，具體效果見前面的截圖，代碼如下：

<Application x:Class="WpfFluentValidation.App"
             xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
             xmlns:local="clr-namespace:WpfFluentValidation"
             StartupUri="MainWindow.xaml">
    <Application.Resources>
        <Style TargetType="StackPanel">
            <Setter Property="Margin" Value="0 5"/>
        </Style>
        <!--第一種錯誤樣式，紅色邊框-->
        <Style TargetType="{x:Type TextBox}" x:Key="ErrorStyle1">
            <Setter Property="Width" Value="200"/>
            <Setter Property="Validation.ErrorTemplate">
                <Setter.Value>
                    <ControlTemplate>
                        <DockPanel>
                            <Grid DockPanel.Dock="Right" Width="16" Height="16"
                            VerticalAlignment="Center" Margin="3 0 0 0">
                                <Ellipse Width="16" Height="16" Fill="Red"/>
                                <Ellipse Width="3" Height="8" 
                                VerticalAlignment="Top" HorizontalAlignment="Center" 
                                Margin="0 2 0 0" Fill="White"/>
                                <Ellipse Width="2" Height="2" VerticalAlignment="Bottom" 
                                HorizontalAlignment="Center" Margin="0 0 0 2" 
                                Fill="White"/>
                            </Grid>
                            <Border BorderBrush="Red" BorderThickness="2" CornerRadius="2">
                                <AdornedElementPlaceholder/>
                            </Border>
                        </DockPanel>
                    </ControlTemplate>
                </Setter.Value>
            </Setter>
            <Style.Triggers>
                <Trigger Property="Validation.HasError" Value="true">
                    <Setter Property="ToolTip" Value="{Binding RelativeSource=
                            {x:Static RelativeSource.Self}, 
                            Path=(Validation.Errors)[0].ErrorContent}"/>
                </Trigger>
            </Style.Triggers>
        </Style>

        <!--第二種錯誤樣式，右鍵文字提示-->
        <Style TargetType="{x:Type TextBox}" x:Key="ErrorStyle2">
            <Setter Property="Width" Value="200"/>
            <Setter Property="Validation.ErrorTemplate">
                <Setter.Value>
                    <ControlTemplate>
                        <StackPanel Orientation="Horizontal">
                            <AdornedElementPlaceholder x:Name="textBox"/>
                            <TextBlock Margin="10" Text="{Binding [0].ErrorContent}" Foreground="Red"/>
                        </StackPanel>
                    </ControlTemplate>
                </Setter.Value>
            </Setter>
            <Style.Triggers>
                <Trigger Property="Validation.HasError" Value="true">
                    <Setter Property="ToolTip" Value="{Binding RelativeSource=
                    {x:Static RelativeSource.Self}, 
                    Path=(Validation.Errors)[0].ErrorContent}"/>
                </Trigger>
            </Style.Triggers>
        </Style>
    </Application.Resources>
</Application>

五、 介紹完畢

碼農就是這樣，文章基本貼代碼，哈哈。

6、源碼同步

本文代碼已同步gitee: https://gitee.com/lsq6/FluentValidationForWpf

github： https://github.com/dotnet9/FluentValidationForWPF

CSDN： https://download.csdn.net/download/HenryMoore/11984265

版權聲明：本文為Dotnet9的博客博主「沙漠盡頭的狼」的原創文章，遵循 CC 4.0 BY-SA 版權協議，轉載請附上原文出處鏈接及本聲明。

原文鏈接：https://dotnet9.com/?p=853


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • python跳出多重迴圈的方法
    方法1：自定義異常 方法2：將迴圈封裝為函數，return 方法3：用for...else...語句 方法3解釋： （1）break能跳出某一重迴圈（該重迴圈的本次及剩餘次數都不再執行），但並不能跳出該重迴圈的其他外重迴圈。 例如，最內第3重迴圈break之後，程式返回第2重迴圈繼續執行第2重的下一 ...
  • 在python函數中預設參數的一些坑
    一、預設參數 python為了簡化函數的調用，提供了預設參數機制： 這樣在調用pow函數時，就可以省略最後一個參數不寫： 在定義有預設參數的函數時，需要註意以下： 必選參數必須在前面，預設參數在後； 設置何種參數為預設參數？一般來說，將參數值變化小的設置為預設參數。 python標準庫實踐 pyth ...
  • php中命名空間namespace和use
    對於面向對象編程而言,命名空間namespace和use的概念非常重要. 1.根命名空間是反斜線 \ ,有點類似linux中的根目錄 / 的那種感覺,但使用var_dump()函數列印時其實是空字元串 1 var_dump(lxx_namespace); 2 //string(0) "" 2.而對於 ...
  • 用PHP實現一個簡易版文件上傳功能（超詳細講解）
    1. php簡化版的圖片上傳（沒有各種驗證） 1 2 3 4 <form action="" enctype="multipart/form-data" method="post" > 請選擇需要上傳的文件：<input type="file" name="upfile" /><br> <input ...
  • Go-for迴圈
    一.第一種情況(死迴圈) 二.第二種情況(類似while 條件) 五.break 與continue 和 ,break停止迴圈,continue跳出本層迴圈 ...
  • Python 對列表嵌套的數據進行排序
    利用sorted(iterable[, key][, reverse]) key：指定一個接收一個參數的函數，這個函數用於從每個元素中提取一個用於比較的關鍵字，預設值為None（直接比較元素） reverse：排序規則，reverse = True 降序 ， reverse = False 升序（默 ...
  • Java描述設計模式(20)：命令模式
    本文源碼： "GitHub·點這裡" || "GitEE·點這裡" 一、生活場景 1、場景描述 智能電腦的品牌越來越多，由此誕生了一款電腦控制的APP，萬能遙控器，用戶在使用遙控器的時候，可以切換為自家電視的品牌，然後對電視進行控制。 2、代碼實現 二、命令模式 1、基礎概念 命令模式屬於對象的行為 ...
  • GO-邏輯判斷(if,else if,else,switch)
    一.if邏輯判斷 二.switch 方式一 方式二 關鍵字fallthrough的使用 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類