https://github.com/dotnet9/fluentvalidationforwpf
FluentValidation在C# WPF中的应用，同步博文见：https://codewf.com/2019/11/Uses-fluent-validation-in-WPF
https://github.com/dotnet9/fluentvalidationforwpf
Last synced: 3 months ago
JSON representation
FluentValidation在C# WPF中的应用，同步博文见：https://codewf.com/2019/11/Uses-fluent-validation-in-WPF
- Host: GitHub
- URL: https://github.com/dotnet9/fluentvalidationforwpf
- Owner: dotnet9
- License: other
- Created: 2019-11-18T19:01:08.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-01-26T08:03:41.000Z (over 2 years ago)
- Last Synced: 2025-08-28T22:50:10.960Z (10 months ago)
- Language: C#
- Homepage: https://codewf.com/
- Size: 54.7 KB
- Stars: 16
- Watchers: 4
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
---
title: FluentValidation在C# WPF中的应用
slug: Uses-fluent-validation-in-WPF
description: 介绍FluentValidation的文章不少，其实它也可以用于WPF属性验证，本文主要也是讲解该组件在WPF中的使用
date: 2019-11-19 03:43:13
lastmod: 2024-01-20 23:43:47
author: 沙漠尽头的狼
draft: false
cover: https://img1.dotnet9.com/2019/11/cover_01.png
categories: WPF
copyright: Original
tags: WPF,FluentValiatoin
---
## 1. 引言
在.NET开发领域，`FluentValidation`以其优雅、易扩展的特性成为开发者进行属性验证的首选工具。它不仅适用于Web开发，如MVC、Web API和ASP.NET CORE，同样也能完美集成在WPF应用程序中，提供强大的数据验证功能。本文将深入探讨如何在C# WPF项目中运用FluentValidation进行属性验证，并展示如何通过MVVM模式实现这一功能。
## 2. 功能概览
我们的目标是构建一个WPF应用程序，它能够通过FluentValidation实现以下验证功能：
1. 验证ViewModel层的基本数据类型属性，如int、string等。
2. 对ViewModel中的复杂属性进行验证，这包括对象属性的子属性以及集合属性。
3. 提供两种直观的错误提示样式，以增强用户体验。
先看实现效果图：
## 3. 解决问题与探索
在调研过程中，我发现FluentValidation官方文档主要关注于Web应用的验证。对于WPF和复杂属性的验证，官方文档提供的示例有限。然而，通过深入研究和实践，我找到了将FluentValidation与WPF结合使用的有效方法，特别是针对复杂属性的验证。
## 4. 开发步骤
### 4.1. 创建工程、库引入
首先，创建一个新的WPF项目，并引入`FluentValidation`库用于属性验证，以及`Prism.Wpf`库以简化MVVM模式的实现。
```xml
```
### 4.2. 创建实体类
我创建了两个实体类：Student和Field，分别代表对象属性和集合项属性。这两个类都实现了IDataErrorInfo接口，以触发FluentValidation的验证机制。
#### 4.2.1. 普通类 - Student
学生类包含3个属性：名字、年龄、邮政编码。
```C#
///
/// 学生实体
/// 继承BindableBase,即继承属性变化接口INotifyPropertyChanged
/// 实现IDataErrorInfo接口，用于FluentValidation验证，必须实现此接口
///
public class Student : BindableBase, IDataErrorInfo
{
private int _age;
private string? _name;
private string? _zip;
private readonly StudentValidator _validator = new();
public string? Name
{
get => _name;
set => SetProperty(ref _name, value);
}
public int Age
{
get => _age;
set => SetProperty(ref _age, value);
}
public string? Zip
{
get => _zip;
set => SetProperty(ref _zip, value);
}
public string this[string columnName]
{
get
{
var validateResult = _validator.Validate(this);
if (validateResult.IsValid)
{
return string.Empty;
}
var firstOrDefault =
validateResult.Errors.FirstOrDefault(error => error.PropertyName == columnName);
return firstOrDefault == null ? string.Empty : firstOrDefault.ErrorMessage;
}
}
public string Error
{
get
{
var validateResult = _validator.Validate(this);
if (validateResult.IsValid)
{
return string.Empty;
}
var errors = string.Join(Environment.NewLine, validateResult.Errors.Select(x => x.ErrorMessage).ToArray());
return errors;
}
}
}
```
上面关键代码在`public string this[string columnName]`：这里进行输入表单项的数据校验，`FluentValidation`调用就在这里，校验逻辑封装在`StudentValidator`，表单输入时会实时调用该处代码，`columnName`表示表单项的列名，就是ViewModel绑定的属性名。
#### 4.2.2. 集合类 - Field
此类用作ViewModel中的集合项使用，模拟动态表单数据校验，简单包含4个属性：字段名称、字段显示名称、数据类型、数据值，表单主要根据数据类型验证输入的数据值是否合法。同样此实体需要继承IDataErrorInfo接口，用于触发FluentValidation验证使用。
```csharp
///
/// 扩展字段，用于生成动态表单
/// 继承BindableBase,即继承属性变化接口INotifyPropertyChanged
/// 实现IDataErrorInfo接口，用于FluentValidation验证，必须实现此接口
///
public class Field : BindableBase, IDataErrorInfo
{
private string _value;
private readonly FieldValidator _validator = new();
public Field(DataType type, string typeLabel, string name, string value)
{
Type = type;
TypeLabel = typeLabel;
Name = name;
Value = value;
}
///
/// 数据类型
///
public DataType Type { get; set; }
///
/// 数据类型名称
///
public string TypeLabel { get; set; }
///
/// 名称
///
public string Name { get; set; }
///
/// 值
///
public string Value
{
get => _value;
set => SetProperty(ref _value, value);
}
public string this[string columnName]
{
get
{
var validateResult = _validator.Validate(this);
if (validateResult.IsValid)
{
return string.Empty;
}
var firstOrDefault =
validateResult.Errors.FirstOrDefault(error => error.PropertyName == columnName);
return firstOrDefault == null ? string.Empty : firstOrDefault.ErrorMessage;
}
}
public string Error
{
get
{
var validateResult = _validator.Validate(this);
if (validateResult.IsValid)
{
return string.Empty;
}
var errors = string.Join(Environment.NewLine, validateResult.Errors.Select(x => x.ErrorMessage).ToArray());
return errors;
}
}
}
public enum DataType
{
Text,
Number,
Date
}
```
看上面代码，`public string this[string columnName]`代码处写法和`Student`类一样，只是`_validator`变量类型不同，前者为`StudentValidator`，这里是`FieldValidator`，下面我们看看这两个类怎么写。
### 4.3. 创建验证器
对于每个实体类，我都创建了一个对应的验证器类：StudentValidator和FieldValidator。这些验证器类继承自AbstractValidator，并在其中定义了验证规则。
> 注：验证属性的写法有两种：
>
> 1. 可以在实体属性上方添加特性（本文不作特别说明，百度文章介绍很多）；
> 2. 通过代码的形式添加，如下方，创建一个验证器类，继承自AbstractValidator，在此验证器构造函数中写规则验证属性，方便管理。
本文使用第二种，通过创建`StudentValidator`和`FieldValidator`两个验证器类介绍。
#### 4.3.1. StudentValidator
这是学生验证器`StudentValidator`，需要继承`AbstractValidator`，泛型指定前面需要验证的实体类`Student`：
```C#
public class StudentValidator : AbstractValidator
{
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;
}
}
```
代码简单，使用到数字的大小和范围验证（见Age）、字符串不能为空和长度限制（见Name）、字符串正则表达式验证（见Zip）。
#### 4.3.2. FieldValidator
动态表单数据值校验器，同理需要继承`AbstractValidator`，泛型指定前面需要验证的实体类`Field`：：
```csharp
public class FieldValidator : AbstractValidator
{
public FieldValidator()
{
RuleFor(field => field.Value)
.Must((field, value) => (field.Type == DataType.Text && !string.IsNullOrWhiteSpace(field.Value))
|| (field.Type == DataType.Number && double.TryParse(field.Value, out var _))
|| (field.Type == DataType.Date && DateTime.TryParse(field.Value, out var _)))
.WithMessage("1.文本不能为空；2.数字类型请填写数字；3.日志类型请填写日期类型");
}
}
```
这里写的简单了点：
1. 文本数据类型，值不能为空；
2. 数字数据类型，必须是`double`类型；
3. 日期类型，必须能使用`DateTime`转换；
本文只做简单演示，可按实际情况修改。
#### 4.3.3. StudentViewModelValidator
此外，我们还创建了一个StudentViewModelValidator，用于验证ViewModel层的属性。这个验证器能够处理基本数据类型、对象属性以及集合属性的验证。
```csharp
public class StudentViewModelValidator : AbstractValidator
{
public StudentViewModelValidator()
{
RuleFor(vm => vm.Title)
.NotEmpty()
.WithMessage("标题长度不能为空！")
.Length(5, 30)
.WithMessage("标题长度限制在5到30个字符之间！");
RuleFor(vm => vm.CurrentStudent).SetValidator(new StudentValidator());
RuleForEach(vm => vm.Fields).SetValidator(new FieldValidator());
}
}
```
1. `Title`用于关联验证基本数据类型(string类型)；
2. `CurrentStudent`用于验证对象属性（Student类的实例），设置验证该属性时使用`StudentValidator`验证器；
3. `Fields`用于验证集合属性(`ObservableCollection`)，设置验证该属性子项时使用`FieldValidator`验证器，注意前面使用的`RuleForEach`表示关联集合中的项验证器。
### 4.4. ViewModel层实现
`StudentViewModel`与`Student`实体类结构类似，都需要实现`IDataErrorInfo`接口，该类由一个简单的`string`属性(`Title`)和一个复杂的`Student`对象属性(`CurrentStudent`)、集合属性`ObservableCollection Fields`组成，代码如下：
```C#
///
/// 视图ViewModel
/// 继承BindableBase,即继承属性变化接口INotifyPropertyChanged
/// 实现IDataErrorInfo接口，用于FluentValidation验证，必须实现此接口
///
public class StudentViewModel : BindableBase, IDataErrorInfo
{
private Student _currentStudent;
private string _title;
private readonly StudentViewModelValidator _validator;
public string Title
{
get => _title;
set => SetProperty(ref _title, value);
}
public Student CurrentStudent
{
get => _currentStudent;
set => SetProperty(ref _currentStudent, value);
}
public ObservableCollection Fields { get; } = new();
private DelegateCommand _saveCommand;
public DelegateCommand SaveCommand => _saveCommand ??= new DelegateCommand(HandleSaveCommand,
HandleCanExecuteSaveCommand);
private DelegateCommand _cancelCommand;
public DelegateCommand CancelCommand =>
_cancelCommand ??= new DelegateCommand(HandleCancelCommand, () => true);
public StudentViewModel()
{
_validator = new StudentViewModelValidator();
CurrentStudent = new Student
{
Name = "李刚的儿",
Age = 23
};
Fields.Add(new Field(DataType.Text, "文本，比如：四川省成都市场", "地址", ""));
Fields.Add(new Field(DataType.Number, "数字，比如：12", "工龄", ""));
Fields.Add(new Field(DataType.Date, "时间，比如：2023-09-26 05:13:23", "培训时间", ""));
PropertyChanged += Validate;
CurrentStudent.PropertyChanged += Validate;
foreach (var field in Fields)
{
field.PropertyChanged += Validate;
}
}
~StudentViewModel()
{
PropertyChanged -= Validate;
CurrentStudent.PropertyChanged -= Validate;
foreach (var field in Fields)
{
field.PropertyChanged -= Validate;
}
}
private void Validate(object sender, PropertyChangedEventArgs e)
{
_isCanExecuteSaveCommand = _validator.Validate(this).IsValid;
SaveCommand.RaiseCanExecuteChanged();
}
private void HandleSaveCommand()
{
var validateResult = _validator.Validate(this);
if (validateResult.IsValid)
{
MessageBox.Show("看到我说明验证成功！");
}
else
{
var errorMsg = string.Join(Environment.NewLine,
validateResult.Errors.Select(x => x.ErrorMessage).ToArray());
MessageBox.Show($"慌啥子嘛，你再检查下输入噻：\r\n{errorMsg}");
}
}
private bool _isCanExecuteSaveCommand;
private bool HandleCanExecuteSaveCommand()
{
return _isCanExecuteSaveCommand;
}
private void HandleCancelCommand()
{
MessageBox.Show("我啥都不做，退休了");
}
public string this[string columnName]
{
get
{
var validateResult = _validator.Validate(this);
if (validateResult.IsValid)
{
return string.Empty;
}
var firstOrDefault =
validateResult.Errors.FirstOrDefault(error => error.PropertyName == columnName);
return firstOrDefault == null ? string.Empty : firstOrDefault.ErrorMessage;
}
}
public string Error
{
get
{
var validateResult = _validator.Validate(this);
if (validateResult.IsValid)
{
return string.Empty;
}
var errors = string.Join(Environment.NewLine, validateResult.Errors.Select(x => x.ErrorMessage).ToArray());
return errors;
}
}
}
```
`ViewModel`属性验证和`Student`及`Field`类似，这里我加上了保存(`SaveCommand`)和取消(`CancelCommand`)两个命令，其中保存命令需要所有属性验证通过才可用，通过注册属性的变化事件`PropertyChanged`，在变化事件处理程序中验证：
```csharp
PropertyChanged += Validate;
CurrentStudent.PropertyChanged += Validate;
foreach (var field in Fields)
{
field.PropertyChanged += Validate;
}
```
```csharp
private void Validate(object sender, PropertyChangedEventArgs e)
{
_isCanExecuteSaveCommand = _validator.Validate(this).IsValid;
SaveCommand.RaiseCanExecuteChanged();
}
```
### 4.5. 视图层实现
在视图层，我创建了一个用户控件StudentView，用于显示输入表单和验证结果。通过绑定ViewModel层的属性和命令，视图层能够与ViewModel层进行交互，并实时显示验证错误。这里比较简单，提供简单属性标题(Title)、复杂属性(包括学生姓名(CurrentStudent.Name)、学生年龄( CurrentStudent .Age)、学生邮政编码( CurrentStudent .Zip)）验证、集合属性验证，xaml代码如下：
```xml
```
### 4.6. 错误提示样式
为了提升用户体验，我定义了两种错误提示样式：一种是通过红色图标提示输入框旁边的错误，另一种是在输入框右侧显示错误文字。这些样式定义在App.xaml中，并可以在整个应用程序中复用。
```xml
<Setter Property="Margin" Value="0,5" />
<Setter Property="Width" Value="250" />
<Setter Property="Height" Value="25" />
<Setter Property="HorizontalAlignment" Value="Left" />
<Setter Property="Validation.ErrorTemplate">
<Setter.Value>
<ControlTemplate>
<DockPanel>
<Grid
Width="16"
Height="16"
Margin="3,0,0,0"
VerticalAlignment="Center"
DockPanel.Dock="Right">
<Ellipse
Width="16"
Height="16"
Fill="Red" />
<Ellipse
Width="3"
Height="8"
Margin="0,2,0,0"
HorizontalAlignment="Center"
VerticalAlignment="Top"
Fill="White" />
<Ellipse
Width="2"
Height="2"
Margin="0,0,0,2"
HorizontalAlignment="Center"
VerticalAlignment="Bottom"
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>
<Setter Property="Width" Value="250" />
<Setter Property="Height" Value="25" />
<Setter Property="VerticalContentAlignment" Value="Center" />
<Setter Property="Padding" Value="5,0" />
<Setter Property="HorizontalAlignment" Value="Left" />
<Setter Property="Validation.ErrorTemplate">
<Setter.Value>
<ControlTemplate>
<StackPanel Orientation="Horizontal">
<AdornedElementPlaceholder x:Name="textBox" />
<Grid>
<TextBlock Margin="10 0 0 0" Width="130"
Foreground="Red" TextWrapping="Wrap"
Text="{Binding [0].ErrorContent}" />
</Grid>
</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}" />
<Setter Property="Background" Value="LightPink" />
<Setter Property="BorderBrush" Value="Red" />
<Setter Property="Foreground" Value="White" />
</Trigger>
<Setter Property="Margin" Value="5" />
<Setter Property="Padding" Value="2" />
<Setter Property="BorderBrush" Value="#FF0078D7" />
<Setter Property="BorderThickness" Value="2" />
<Setter Property="Background" Value="#FFF0F0F0" />
<Setter Property="Foreground" Value="#FF0078D7" />
<Setter Property="FontWeight" Value="Bold" />
<Setter Property="MinWidth" Value="75" />
<Setter Property="MinHeight" Value="25" />
<Setter Property="Background" Value="White" />
<Setter Property="Foreground" Value="Black" />
<Setter Property="Background" Value="Green" />
<Setter Property="Foreground" Value="White" />
```
## 5. 效果展示
通过上述步骤的实现，我们得到了一个功能完善的WPF应用程序。它能够根据用户输入实时进行验证，并提供直观的错误提示。当所有属性都验证通过时，提交按钮将变为可用状态。
## 6. 源码分享
为了方便读者学习和交流，本文将所有代码同步到了Gitee和Github平台上。欢迎感兴趣的开发者访问以下链接获取源码：
- gitee: https://gitee.com/dotnet9/FluentValidationForWpf
- github： https://github.com/dotnet9/FluentValidationForWPF
## 7. 总结
通过本文的介绍和实践，我们成功将FluentValidation应用于C# WPF项目中，实现了对ViewModel层属性的全面验证。这不仅提升了数据的安全性和准确性，也为用户提供了更好的交互体验。希望本文能对广大开发者在WPF项目中使用FluentValidation提供有益的参考和启示。
参考：
- FluentValidation官网： https://fluentvalidation.net/