# FluentValidation验证器测试指南 ##为什么要测试验证器？验证器是应用程序的第一道防线，测试验证器功能： 1. **确保数据完整性** \-防止无效数据进入系统 2. **业务规则文件化** \- 测试即活文件，清晰展示业务规则 3. **安全性保障** \- 防止恶意或不当数据输入 4. **重构安全网** \- 业务规则变更时提供保障 5. **跨栏位逻辑验证** \-确保复杂逻辑正确兼容 ## 前置需求 ### 套件安装 ### 基本使用指令使用 FluentValidation；使用 FluentValidation.TestHelper；使用 Microsoft.Extensions.Time.Testing；使用 NSubstitute；使用 Xunit；使用 AwesomeAssertions； ## 核心测试模式本章节7种核心测试模式，众多模式包含验证器定义和完整测试示例。 > 📖 完整程序代码范例请参考 [references/core-test-patterns.md]() * **模式1：基本栏位验证** — 使用 `TestValidate` \+ `ShouldHaveValidationErrorFor` / `ShouldNotHaveValidationErrorFor` 测试单一栏位规则 * **模式2：参数化测试** — 使用 `[Theory]` \+ `[InlineData]` 测试多个无效/有效输入组合 * **模式3：跨栏位验证** — 密码确认、自订`Must()`规则等多栏位关联验证 * **模式4：时间相依验证** — 注入`TimeProvider`，配合`FakeTimeProvider`控制时间进行测试 * **模式5：条件式验证** — 使用`.When()`的任选栏位验证，测试条件触发与超越占领 * **模式6：非同步验证** — `MustAsync` \+ `TestValidateAsync`，搭配 NSubstitute Mock 外部服务 * **模式7：集合验证** — 验证集合非空与元素有效性 ### 示例快速：基本栏位验证公共类 UserValidatorTests { 私有只读 UserValidator _validator = new(); [事实] public void Validate_空白用户名称_应该验证失败() { var 结果 = _validator.TestValidate( 新的 UserRegistrationRequest { 用户名 = "" }); result.ShouldHaveValidationErrorFor(x => x.用户名) .WithErrorMessage("用户名称不可为 null 或空白"); } } ## FluentValidation.TestHelper 核心 API ### 测试方法方法 | 用途 | 示例 ---|---|--- `测试验证（模型）` | 执行同步验证 | `_validator.TestValidate(请求)` `TestValidateAsync（模型）` | 执行非同步验证 | `等待_validator.TestValidateAsync（请求）` ###断言方法方法 | 用途 | 示例 ---|---|--- `ShouldHaveValidationErrorFor(x => x.Property)` | 断言该属性应该有错误 | `result.ShouldHaveValidationErrorFor(x => x.用户名)` `ShouldNotHaveValidationErrorFor(x => x.Property)` | 断言该属性不应该有错误 | `result.ShouldNotHaveValidationErrorFor(x => x.Email)` `ShouldNotHaveAnyValidationErrors()` | 断言整个物品没有任何错误 | `结果.ShouldNotHaveAnyValidationErrors()` ### 错误消息验证方法 | 用途 | 示例 ---|---|--- `WithErrorMessage（字符串）` | 验证错误消息内容 | `.WithErrorMessage("用户名称不可为空")` `WithErrorCode（字符串）` | 验证错误代码 | `.WithErrorCode("NOT_EMPTY")` ## 最佳测试实践 ### ✅ 推荐做法 1. **使用参数化测试** \- 使用理论测试多种输入组合 2. **边界测试值** \-特别注意边界条件 3. **控制时间** \- FakeTimeProvider 处理时间相依 4. **Mock 外部依赖** \- 使用 NSubstitute 隔离外部服务 5. **建立辅助方法** \-统一管理测试数据 6. **明确的测试命名** \- 使用 `方法_威胁_预测结果` 格式 7. **测试错误消息** \-确保用户看到正确的错误消息 ### ❌避免做法 1. **避免使用DateTime.Now** \- 会导致测试不稳定 2. **避免测试过度耦合** \- 每个测试只验证一个规则 3. **避免硬编码测试数据** \- 使用辅助方法建立 4. **避免忽视边界条件** \- 边界值是最容易出错的地方 5. **避免跳过错误消息验证** \- 错误消息是用户体验的一部分 ## 常见测试场景 ### 场景1：邮件格式验证 [理论] [InlineData("", "电子邮件不可为 null 或空白")] [InlineData("无效", "电子邮件格式不正确")] [InlineData("@example.com", "电子邮件格式不正确")] public void Validate_无效Email_应该验证失败(string email, string ExpectedError) { var request = new UserRegistrationRequest { 电子邮件 = 电子邮件 }; var 结果 = _validator.TestValidate(request); result.ShouldHaveValidationErrorFor(x => x.Email).WithErrorMessage(expectedError); } ### 场景2：年龄范围验证 [理论] [InlineData(17, "年龄必须大于或等于 18 岁")] [InlineData(121, "年龄必须小于或等于 120 岁")] public void Validate_无效年龄_应该验证失败(intage, stringexpectedError) { var request = new UserRegistrationRequest { 年龄 = 年龄 }; var 结果 = _validator.TestValidate(request); result.ShouldHaveValidationErrorFor(x => x.Age).WithErrorMessage(expectedError); } ### 场景3：必填栏位验证 [事实] public void Validate_未同意条款_应验证失败() { var request = new UserRegistrationRequest { AgreeToTerms = false }; var 结果 = _validator.TestValidate(request); result.ShouldHaveValidationErrorFor(x => x.AgreeToTerms) .WithErrorMessage("必须同意使用条款"); } ## 测试辅助工具 ### 测试资料浏览器公共静态类 TestDataBuilder { 公共静态 UserRegistrationRequest CreateValidRequest() { 返回新的用户注册请求 { 用户名 = "testuser123", 电子邮件=“test@example.com”，密码=“TestPass123”，确认密码 = "TestPass123", 出生日期 = 新日期时间(1990, 1, 1), 年龄 = 34, 电话号码 = "0912345678", 角色 = new List { "用户" }, 同意条款 = true }; } 公共静态 UserRegistrationRequest WithUsername（此 UserRegistrationRequest 请求，字符串用户名） { 请求.用户名 = 用户名; 退货请求； } 公共静态 UserRegistrationRequest WithEmail（此 UserRegistrationRequest 请求，字符串电子邮件） { 请求。电子邮件=电子邮件；退货请求； } } // 使用示例 var request = TestDataBuilder.CreateValidRequest() .WithUsername("新用户") .WithEmail("new@example.com"); ## 与其他技能整合该技能可与以下技能组合使用： * **单元测试基础** : 单元测试基础与 3A 模式 * **test-naming-conventions** : 测试命名规范 * **nsubstitute-mocking** : Mock 外部服务依赖 * **test-data-builder-pattern** ：目前复杂的测试数据 * **datetime-testing-timeprovider** : 时间相依测试 ##疑难排解 ### Q1：如何测试需要资料库查询的验证？ **A:** 使用 Mock 隔离资料库依赖： _mockUserService.IsUsernameAvailableAsync(“用户名”) .Returns(Task.FromResult(false)); ### Q2：如何处理时间相关的验证？ **A:** 使用FakeTimeProvider控制时间： _fakeTimeProvider.SetUtcNow(new DateTime(2024, 1, 1)); ### Q3：如何测试复杂的跨栏位验证？ **A:** 分别测试每个条件，确保完整覆盖： // 生日测试已过的情况 // 生日测试未到的情况 // 边界测试日期 ### Q4：应该测试到什么程度？ **A:** 重点测试： * 每个验证规则至少一个测试 * 边界值及特殊情况 * 错误信息正确性 * 跨位栏逻辑的所有组合 ## 范本档案参考本技能提供以下范本档案： * `templates/validator-test-template.cs`: 完整的验证器测试示例 * `templates/async-validator-examples.cs`: 非同步验证示例 ## 输出格式 * 产生 Validator 测试类别（含 TestHelper 设置） * 使用 ShouldHaveValidationErrorFor/ShouldNotHaveValidationErrorFor 断言 * 包含非同步验证、跨栏位逻辑测试示例 * 提供.csproj套件参考（FluentValidation.TestHelper） ## 参考资源 ### 原始文章本技能内容提炼自「老派软体工程师的测试修练 - 30天挑战」系列文章： * **第 18 天 - 验证测试：FluentValidation 测试扩展** * 铁人赛文章： * 示例程序代码： ### 官方文件 * [FluentValidation 文档]() * [FluentValidation.TestHelper]() * [FluentValidation GitHub]() ### 相关技能 * `unit-test-fundamentals` \- 单元测试基础 * `nsubstitute-mocking` \- 测试替身与模拟

Dotnet 测试 Fluentvalidation 测试

包含技能