講故事
前幾天看到公司一個新專案使用了 FluentValidation,大家都知道 FluentValidation 是一個非常強大的用於建立強型別驗證規則的 .NET 框架,幫程式設計師解決了繁瑣的驗證問題,用起來非常爽,但我還是遇到了一件非常不爽的事情,如下程式碼所示:
public class UserInformationValidator : AbstractValidator<UserInformation>
{
public UserInformationValidator()
{
RuleFor(o => o.UserName).Length(2, 20).WithMessage("姓名長度輸入錯誤");
RuleFor(o => o.Sex).Must(o=>o=="男"||o=="女").WithMessage("性別輸入錯誤");
RuleFor(o => o.Age).ExclusiveBetween(0, 200).WithMessage("年齡輸入錯誤");
RuleFor(o => o.Email).EmailAddress().WithMessage("信箱輸入錯誤");
}
}
static void Main(string[] args)
{
UserInformation userInformation = new UserInformation();
userInformation.UserName = "";
userInformation.Sex = "不男不女";
userInformation.Age = 2200;
userInformation.Email = "xxxxx";
UserInformationValidator validationRules = new UserInformationValidator();
var result= validationRules.Validate(userInformation);
if (!result.IsValid)
{
Console.WriteLine( string.Join(Environment.NewLine, result.Errors.Select(x => x.ErrorMessage).ToArray()));
}
}
我們每驗證一個物件,就要新建一個型別的驗證器,如上的 UserInformationValidator,雖然這樣寫邏輯上沒有任何問題,但我有潔癖啦,接下來我們試著封裝一下,嘿嘿,用更少的程式碼做更多的事情。
安裝
在建立任何驗證器之前,您需要在專案中加入對 FluentValidation.dll 的參考。最簡單的方法是使用 NuGet 套件管理員 或 dotnet CLI。
樣板化程式碼封裝探索
將樣板化的程式碼提取到父類別中
仔細看上面的程式碼你會發現,我們每新增一個驗證器,就必須要建立一個繼承自 AbstractValidator<T> 的類別,其中 T 是您希望驗證的類別的型別,封裝一個驗證器父類別
public class CommonVaildator<T> : AbstractValidator<T>
{
}
增加驗證規則
真正的業務邏輯是寫在 UserInformationValidator 驗證器裡面的,而這塊程式碼中只需要拿到 RuleFor 即可,其他的統一封裝到父類別中,對不對,我們按照這個思路程式碼,封裝一個長度驗證器規則。
首先讓我們看看 RuleFor 的原型
public IRuleBuilderInitial<T, TProperty> RuleFor<TProperty>(Expression<Func<T, TProperty>> expression)
它的參數是一個 Func 委派,那麼 Expression 是什麼呢?
Expression 是一種運算式樹!
運算式樹是一種允許將 lambda 運算式表示為樹狀資料結構,而不是可執行邏輯的程式碼。
在 C# 中是用 Expression 來定義的,它是一種語法樹,或者說是一種資料結構。其主要用於儲存需要計算、運算的一種結構,它只提供儲存功能,不進行運算。通常 Expression 是配合 Lambda 一起使用,這裡就不做過多的解釋了!
那麼我們就能很輕易地封裝出長度驗證器規則了!
public void LengthVaildator(Expression<Func<T, string>> expression, int min, int max, string Message)
{
RuleFor(expression).Length(min, max).WithMessage(Message);
}
同理,我們也可以接著封裝述詞驗證器規則、電子郵件驗證器規則等等
public void MustVaildator(Expression<Func<T, string>> expression ,Func<T,string, bool> expression2, string Message)
{
RuleFor(expression).Must(expression2).WithMessage(Message);
}
public void EmailAddressVaildator(Expression<Func<T, string>> expression, string Message)
{
RuleFor(expression).EmailAddress().WithMessage(Message);
}
封裝驗證方法
上面我們把驗證器封裝好了,那麼將 var result= validationRules.Validate(userInformation); 這種驗證方法封裝一下不是手到擒來,程式碼如下:
public static string ModelValidator<T>(T source, AbstractValidator<T> sourceValidator) where T : class
{
var results = sourceValidator.Validate(source);
if (!results.IsValid)
return string.Join(Environment.NewLine, results.Errors.Select(x => x.ErrorMessage).ToArray());
else
return "";
}
測試封裝後的程式碼
CommonVaildator<UserInformation> commonUserInformation = new CommonVaildator<UserInformation>();
commonUserInformation.LengthVaildator(o => o.UserName, 2, 30, "姓名長度輸入錯誤");
commonUserInformation.MustVaildator(o => o.Sex, (user, _) => user.Sex =="男"||user.Sex=="女" , "性別輸入錯誤");
commonUserInformation.ExclusiveBetweenVaildator(o=>o.Age,0, 200, "年齡輸入錯誤");
commonUserInformation.EmailAddressVaildator(o => o.Email, "信箱輸入錯誤");
string msg= VaildatorHelper.ModelValidator(userInformation, commonUserInformation);
Console.WriteLine(msg);
這樣程式碼看起來是不是就簡潔多了,我這裡就只封裝了四種驗證規則,其他的我就不在此封裝了。
總結
文章來源於工作中的點點滴滴,這也是我的即興封裝,大家要是有更好的封裝程式碼,歡迎交流,獨樂樂不如眾樂樂,本篇就說到這裡啦,希望對您有幫助。