متدی تحت عنوان ValidateEmail را تصور کنید. این متد از حیث بازگشت نتیجه به عنوان خروجی میتواند به اشکال مختلفی پیاده سازی شود که در ادامه مشاهده میکنیم:
متد ValidateEmail با خروجی Boolean
public bool ValidateEmail(string email)
{
var valid = true;
if (string.IsNullOrWhiteSpace(email))
{
valid = false;
}
var isValidFormat = true;//todo: using RegularExpression
if (!isValidFormat)
{
valid = false;
}
var isRealDoamin = true;//todo: Code here that confirms whether domain exists.
if (!isRealDoamin)
{
valid = false;
}
return valid;
} همانطور که در تکه کد زیر مشخص میباشد، استفاده کننده از متد بالا، امکان بررسی خروجی آن را در قالب یک شرط خواهد داشت و علاوه بر اینکه پیاده سازی آن ساده میباشد، خوانایی کد را نیز بالا می‌برد؛ ولی با این حال نمی‌توان متوجه شد مشکل اصلی آدرس ایمیل ارسالی به عنوان آرگومان، دقیقا چیست.
var email = "email@example.com";
var isValid = ValidateEmail(email);
if(isValid)
{
//do something
}
متد ValidateEmail با صدور استثناء
public void ValidateEmail(string email)
{
if (string.IsNullOrWhiteSpace(email)) throw new ArgumentNullException(nameof(email));
var isValidFormat = true;//todo: using RegularExpression
if (!isValidFormat) throw new ArgumentException("email is not in a correct format");
var isRealDoamin = true;//todo: Code here that confirms whether domain exists.
if (!isRealDoamin) throw new ArgumentException("email does not include a valid domain.")
} روش بالا هم جواب میدهد ولی بهتر است کلاس Exception سفارشی به عنوان مثال ValidationException برای این قضیه در نظر گرفته شود تا بتوان وهله‌های صادر شده از این نوع را در لایه‌های بالاتر مدیریت کرد.
متد ValidateEmail با چندین خروجی
برای این منظور چندین راه حل پیش رو داریم.
با استفاده از پارامتر out:
public bool ValidateEmail(string email, out string message)
{
var valid = true;
message = string.Empty;
if (string.IsNullOrWhiteSpace(email))
{
valid = false;
message = "email is null.";
}
if (valid)
{
var isValidFormat = true;//todo: using RegularExpression
if (!isValidFormat)
{
valid = false;
message = "email is not in a correct format";
}
}
if (valid)
{
var isRealDoamin = true;//todo: Code here that confirms whether domain exists.
if (!isRealDoamin)
{
valid = false;
message = "email does not include a valid domain.";
}
}
return valid;
} var email = "email@example.com";
var isValid = ValidateEmail(email, out string message);
if (isValid)
{
//do something
} Tuple<bool, List<string>> result = Tuple.Create<bool, List<string>>(true, new List<string>());
public class OperationResult
{
public bool Success { get; set; }
public IList<string> Messages { get; } = new List<string>();
public void AddMessage(string message)
{
Messages.Add(message);
}
} public OperationResult ValidateEmail(string email)
{
var result = new OperationResult();
if (string.IsNullOrWhiteSpace(email))
{
result.Success = false;
result.AddMessage("email is null.");
}
if (result.Success)
{
var isValidFormat = true;//todo: using RegularExpression
if (!isValidFormat)
{
result.Success = false;
result.AddMessage("email is not in a correct format");
}
}
if (result.Success)
{
var isRealDoamin = true;//todo: Code here that confirms whether domain exists.
if (!isRealDoamin)
{
result.Success = false;
result.AddMessage("email does not include a valid domain.");
}
}
return result;
} این بار خروجی متد مذکور از نوع OperationResult ای میباشد که هم موفقیت آمیز بودن یا عدم آن را مشخص میکند و همچنین امکان دسترسی به لیست پیغام‌های مرتبط با اعتبارسنجی‌های انجام شده، وجود دارد.
استفاده از Exception برای نمایش پیغام برای کاربر نهایی
با صدور یک استثناء و مدیریت سراسری آن در بالاترین (خارجی ترین) لایه و نمایش پیغام مرتبط با آن به کاربر نهایی، میتوان از آن به عنوان ابزاری برای ارسال هر نوع پیغامی به کاربر نهایی استفاده کرد. اگر قوانین تجاری با موفقیت برآورده نشده‌اند یا لازم است به هر دلیلی یک پیغام مرتبط با یک اعتبارسنجی تجاری را برای کاربر نمایش دهید، این روش بسیار کارساز میباشد و با یکبار وقت گذاشتن برای توسعه زیرساخت برای این موضوع به عنوان یک Cross Cutting Concern تحت عنوان Exception Management آزادی عمل زیادی در ادامه توسعه سیستم خود خواهید داشت.
به عنوان مثال داشتن یک کلاس Exception سفارشی تحت عنوان UserFriendlyException در این راستا یک الزام میباشد.
[Serializable]
public class UserFriendlyException : Exception
{
public string Details { get; private set; }
public int Code { get; set; }
public UserFriendlyException()
{
}
public UserFriendlyException(SerializationInfo serializationInfo, StreamingContext context)
: base(serializationInfo, context)
{
}
public UserFriendlyException(string message)
: base(message)
{
}
public UserFriendlyException(int code, string message)
: this(message)
{
Code = code;
}
public UserFriendlyException(string message, string details)
: this(message)
{
Details = details;
}
public UserFriendlyException(int code, string message, string details)
: this(message, details)
{
Code = code;
}
public UserFriendlyException(string message, Exception innerException)
: base(message, innerException)
{
}
public UserFriendlyException(string message, string details, Exception innerException)
: this(message, innerException)
{
Details = details;
}
} و همچنین لازم است در بالاترین لایه سیستم خود به عنوان مثال برای یک پروژه ASP.NET MVC یا ASP.NET Core MVC میتوان یک ExceptionFilter سفارشی نیز تهیه کرد که هم به صورت سراسری استثنا‌ءهای سفارشی شما را مدیریت کند و همچنین خروجی مناسب Json برای استفاده در سمت کلاینت را نیز مهیا کند. به عنوان مثال برای درخواست‌های Ajax ای لازم است در سمت کلاینت نیز پاسخ‌های رسیده از سمت سرور به صورت سراسری مدیریت شوند و برای سایر درخواست‌ها همان نمایش صفحات خطای پیغام مرتبط با استثناء رخ داده شده کفایت میکند.
یک مدل پیشنهادی برای تهیه خروجی مناسب برای ارسال جزئیات استثنا رخ داده در درخواست‌های Ajax ای
[Serializable]
public class MvcAjaxResponse : MvcAjaxResponse<object>
{
public MvcAjaxResponse()
{
}
public MvcAjaxResponse(bool success)
: base(success)
{
}
public MvcAjaxResponse(object result)
: base(result)
{
}
public MvcAjaxResponse(ErrorInfo error, bool unAuthorizedRequest = false)
: base(error, unAuthorizedRequest)
{
}
}
[Serializable]
public class MvcAjaxResponse<TResult> : MvcAjaxResponseBase
{
public MvcAjaxResponse(TResult result)
{
Result = result;
Success = true;
}
public MvcAjaxResponse()
{
Success = true;
}
public MvcAjaxResponse(bool success)
{
Success = success;
}
public MvcAjaxResponse(ErrorInfo error, bool unAuthorizedRequest = false)
{
Error = error;
UnAuthorizedRequest = unAuthorizedRequest;
Success = false;
}
/// <summary>
/// The actual result object of AJAX request.
/// It is set if <see cref="MvcAjaxResponseBase.Success" /> is true.
/// </summary>
public TResult Result { get; set; }
}
public class MvcAjaxResponseBase
{
public string TargetUrl { get; set; }
public bool Success { get; set; }
public ErrorInfo Error { get; set; }
public bool UnAuthorizedRequest { get; set; }
public bool __mvc { get; } = true;
} [Serializable]
public class ErrorInfo
{
public int Code { get; set; }
public string Message { get; set; }
public string Detail { get; set; }
public Dictionary<string, string> ValidationErrors { get; set; }
public ErrorInfo()
{
}
public ErrorInfo(string message)
{
Message = message;
}
public ErrorInfo(int code)
{
Code = code;
}
public ErrorInfo(int code, string message)
: this(message)
{
Code = code;
}
public ErrorInfo(string message, string details)
: this(message)
{
Detail = details;
}
public ErrorInfo(int code, string message, string details)
: this(message, details)
{
Code = code;
}
} public async Task CheckIsDeactiveAsync(long id)
{
if (await _organizationalUnits.AnyAsync(a => a.Id == id && !a.IsActive).ConfigureAwait(false))
throw new UserFriendlyException("واحد سازمانی جاری غیرفعال میباشد.");
} روش نام گذاری متدهایی که امکان بازگشت خروجی Null را دارند
public User GetById(long id);
[Serializable]
public class EntityNotFoundException : Exception
{
public Type EntityType { get; set; }
public object Id { get; set; }
public EntityNotFoundException()
{
}
public EntityNotFoundException(string message)
: base(message)
{
}
public EntityNotFoundException(string message, Exception innerException)
: base(message, innerException)
{
}
public EntityNotFoundException(SerializationInfo serializationInfo, StreamingContext context)
: base(serializationInfo, context)
{
}
public EntityNotFoundException(Type entityType, object id)
: this(entityType, id, null)
{
}
public EntityNotFoundException(Type entityType, object id, Exception innerException)
: base($"There is no such an entity. Entity type: {entityType.FullName}, id: {id}", innerException)
{
EntityType = entityType;
Id = id;
}
} یک مثال واقعی
public async Task<UserOrganizationalUnitInfo> GetCurrentOrganizationalUnitInfoOrNullAsync(long userId)
{
return (await _setting.GetSettingValueForUserAsync(
UserSettingNames.CurrentOrganizationalUnitInfo, userId).ConfigureAwait(false))
.FromJsonString<UserOrganizationalUnitInfo>();
} 
