Реализациия аппликатива валидации*, для упрощения работы с ошибками доменного уровня.
Исключительные ситуации, возникающие в программах, можно условно разделить на 2 основные группы:
- Исключения, приводящие программу в неопределнное состояние (aka panics). Обычно тактие ошибки не обрабатываются на месте, а перехватываются и логгируются на самом верхнем уровне. Примеры таких ошибок - NullReference, OutOfMemory, и проч.
- Ошибки, являющиеся частью доменной модели. Такие ошибки являются частью бизнесс-процесса и должны быть учтены при его проектировании. Примером таких ошибок могут служить ошибки валидации введенной пользователем формы, отправка строки некорректного формата серверу и проч.
В языке C# стандартным и единственным подходом обработки ошибок в программе является использование исключений. Этот подход отлично подходит для работы с ошибками из первой группы, но для второй его использование не так удобно. Во первых, исключения ломают обычный процесс исполнения программы. Во вторых, по сигнатуре функции невозможно понять, выбрасывает ли она исключение. В третьих, обработка исключений очень многословна и способна существенно раздуть размер кода.
В функциональных языках для обработки подобного рода ошибок обчно используется тип-сумма. Объект такого типа может хранить либо значение, либо найденную ошибку (например Either в Haskell, Result в F#). Преимущество этого подхода заключается в первую очередь в нагладности - по типу возращаемого значения функции сразу можно понять, что она можно вернуть ошибку. Во вторых, использование указанных типов-оберток не позволит просто так достать из них значение, опустив при этом обработку исключительных ситуаций.
В отличие от типов вроде Either, которые обычно содержат только первую найденную ошибку, представленный в библиотеке тип Validation способен их аккумулировать. Это удобно использовать для задачи валидации, когда хочется сразу вернуть пользователю список найденных ошибок, а не ограничиваться только одной.
Пусть стоит задача реализовать валидацию простой формы, включающей в себя логин пользователя и его email. Напишем пару методов для валидации отдельных частей формы:
public IValidation<string> ValidateUsername(string username)
{
if (string.IsNullOrEmpty(username))
{
return Validation.Failure<string>("Username is empty");
}
if (!username.Contains("test"))
{
return Validation.Failure<string>("No such user");
}
return Validation.Success(username);
}
public IValidation<string> ValidateEmail(string email)
{
if (string.IsNullOrWhiteSpace(email))
{
return Validation.Failure<string>("Email is empty");
}
if (!email.Contains("@"))
{
return Validation.Failure<string>("Email must contain @-sign");
}
return Validation.Success(email);
}Создадим также класс формы:
public class FormData
{
public string Username { get; set; }
public string Email { get; set; }
}Далее есть несколько возможных подходов к комбинированию этих функций, от которых зависит конечный результат:
// Возращает объект FormData или первую найденную ошибку
// В случае, если одна из функций валидации вернет Failure, вычисление дальше продолжаться не будет
// Воркфлоу валидации имеет следующий вид:
//
// ----------------------------- validatedUsername ----------------------- validatedEmail
// | ValidateUsername(username)|------------------------->| ValidateEmail(email)|-------------------------->
// ----------------------------- -----------------------
// | |
// | Failure | Failure
// ↓ ↓
// ------------------------------------------------------------------------------------------->
//
public IValidation<FormData> ValidateMonadic(string username, string email)
{
return from validatedUsername in ValidateUsername(username) // typeof(validatedUsername) == string
from validatedEmail in ValidateEmail(email) // typeof(validatedEmail) == string
select new FormData { Username = validatedUsername, Email = validatedEmail };
}
// Возращает объект FormData или все найденные ошибки
// В отличие от ValidateMonadic, позволяет выполнить независимую валидацию с последующим объединением результата валидации функцией ZipWith
// Воркфлоу валидации имеет следующий вид:
//
// |---------------------------| wrappedUsername
// | ValidateUsername(username)|--------------------------↓
// |---------------------------| |------------------------------------| (username, email)
// | Zip(wrappedUsername, wrappedEmail) | ------------------------------->
// |---------------------------| wrappedEmail |------------------------------------|
// | ValidateEmail(email) | -------------------------↑ ↓ Failure
// |---------------------------| ----------------------------------------------------->
//
public IValidation<FormData> ValidateWithZip(string username, string email)
{
return from _ in Validation.DefaultSuccess() // заглушка для начала do-нотации
let wrappedUsername = ValidateUsername(username) // typeof(wrappedUsername) == IValidation<string>
let wrappedEmail = ValidateEmail(email) // typeof(wrappedEmail) == IValidation<string>
let wrappedAll = wrappedUsername.ZipWith(wrappedEmail, (validatedUsername, validatedEmail) => (validatedUsername, validatedEmail))
from data in wrappedAll
select new FormData { Username = data.validatedUsername, Email = data.validatedEmail };
}
// Возращает объект FormData или все найденные ошибки
// Поведение аналогично ValidateWithZip, с использованием функции Lift вместо Zip
// Lift позволяет преобразовать функцию вида (A, B) => C в (IValidation<A>, IValidation<B>) => IValidation<C>,
// что дает возможность передавать исходной функции значения в контексте IValidation
public IValidation<FormData> ValidateApplicative(string username, string email)
{
// строим функцию создания объекта
Func<string, string, FormData> objectBulider = (uname, mail) => new FormData { Username = uname, Email = mail };
// вносим ее в контекст IValidation
Func<IValidation<string>, IValidation<string>, IValidation<FormData>> liftedObjectBulider = objectBulider.Lift();
// валидируем
var validatedUsername = ValidateUsername(username);
var validatedEmail = ValidateEmail(email);
// передаем функции создания наши результаты валидации
return liftedObjectBulider(validatedUsername, validatedEmail);
}