闲话 ASP.NET Core 数据校验（二）：FluentValidation 基本用法

前言

除了使用 ASP.NET Core 内置框架来校验数据，事实上，通过很多第三方框架校验数据，更具优势。

比如 FluentValidation，FluentValidation 是第三方的数据校验框架，具有许多优势，是开发人员首选的数据校验工具之一。

以下列举 FluentValidation 的一些优势：

FluentValidation 使用 Fluent 方式配置校验规则，通过链式调用方法，使得编写校验规则变得非常直观和易于理解，可以轻松地构建复杂的校验规则
FluentValidation 内置更多的校验规则，可以满足各种复杂的数据校验需求
FluentValidation 更方便扩展自定义规则，实现校验逻辑的重用，提高代码的可维护性和复用性
FluentValidation 与 ASP.NET MVC、ASP.NET Core、Web API 等框架无缝集成，数据校验和验证可以轻松地与应用程序的其他部分进行交互
FluentValidation 支持根据具体的校验规则和场景来定义更加友好和具体的错误消息，提高用户体验
FluentValidation 的校验规则更容易进行单元测试

Step By Step 步骤

创建一个 Asp.Net Core WebApi 项目
引用以下 Nuget 包

FluentValidation.AspNetCore

创建 Login 操作方法的请求参数模型类 LoginRequest

c# 复制代码

// LoginRequest 类只是一个普通的 C# 类，
// 没有标注任何的 Attribute 或者实现任何的接口，
// 它的唯一责任就是传递数据
public record LoginRequest(string Email, string Password, string PasswordConfirm);

编写继承自AbstractValidator的数据校验类，留意注释

c# 复制代码

using FluentValidation;

// 数据校验类要继承自 AbstractValidator
// 通过 AbstractValidator 的泛型参数指定对哪个类进行校验
public class LoginRequestValidator: AbstractValidator<LoginRequest>
{
	// 校验规则写到校验类的构造方法中
	public LoginRequestValidator()
	{
		// 通过RuleFor来指定要对哪个属性进行校验
		// 多个校验规则可以采用链式调用的写法
		// 每个需要校验的属性对应一组RuleFor调用
		RuleFor(x => x.Email)
			.NotNull()
			.EmailAddress()
			// 在Must方法中编写自定义校验规则，
			.Must(v => v.EndsWith("@qq.com") || v.EndsWith("@163.com"))
			// 通过WithMessage方法自定义报错信息，
			// WithMessage方法设置的报错信息只作用于它之前的那个校验规则
			.WithMessage("只支持QQ和163邮箱");

		RuleFor(x => x.Password)
			.NotNull()
			.Length(3, 10).WithMessage("密码长度必须介于3到10之间")
			.Equal(x => x.PasswordConfirm).WithMessage("两次密码必须一致");
	}
}

打开 Program.cs，注册 FluentValidation 服务

c# 复制代码

using FluentValidation;
using FluentValidation.AspNetCore;
using System.Reflection;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.

builder.Services.AddControllers();
// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();

Assembly assembly = Assembly.GetExecutingAssembly();
builder.Services.AddFluentValidationAutoValidation()
	.AddFluentValidationClientsideAdapters()
	.AddValidatorsFromAssembly(assembly);
var app = builder.Build();

// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{
	app.UseSwagger();
	app.UseSwaggerUI();
}

app.UseHttpsRedirection();

app.UseAuthorization();

app.MapControllers();

app.Run();

打开登录请求控制器，编写 Login API

c# 复制代码

using Microsoft.AspNetCore.Mvc;

namespace FluentValidationSample.Controllers
{
	[ApiController]
	[Route("[controller]/[action]")]
	public class TestController : ControllerBase
	{
		[HttpPost]
		public ActionResult Login(LoginRequest req)
		{
			return Ok();
		}
	}
}

总结

FluentValidation 把数据校验的规则写到单独的数据校验类中，这样模型类和数据校验类各司其职，符合 "单一职责原则"
在 FluentValidation 中编写自定义校验代码更加简单
FluentValidation 和 .NET Core 内置的校验方式是可以共存的，也就是可以一部分校验规则用 FluentValidation 写，另一部分校验规则用 .NET Core 内置的校验方式写（不建议）。