Які хороші способи збалансування інформаційних винятків та чистого коду?

З нашим загальнодоступним SDK ми, як правило, хочемо надсилати дуже інформативні повідомлення про те, чому відбувається виняток. Наприклад:

if (interfaceInstance == null)
{
     string errMsg = string.Format(
          "Construction of Action Argument: {0}, via the empty constructor worked, but type: {1} could not be cast to type {2}.",
          ParameterInfo.Name,
          ParameterInfo.ParameterType,
          typeof(IParameter)
    );

    throw new InvalidOperationException(errMsg);
}

Однак це, як правило, захаращує потік коду, оскільки, як правило, робить велику увагу на повідомленнях про помилки, а не на те, що робить код.

Колега почав перетворювати деякі винятки, кидаючи щось подібне:

if (interfaceInstance == null)
    throw EmptyConstructor();

...

private Exception EmptyConstructor()
{
    string errMsg = string.Format(
          "Construction of Action Argument: {0}, via the empty constructor worked, but type: {1} could not be cast to type {2}.",
          ParameterInfo.Name,
          ParameterInfo.ParameterType,
          typeof(IParameter)
    );

    return new InvalidOperationException(errMsg);
}

Це полегшує розуміння логіки коду, але додає багато додаткових методів для обробки помилок.

Які ще способи уникнути проблеми "логіки, що заважають довгим виняткам"? Я в першу чергу запитую про ідіоматичну C # /. NET, але як корисні інші мови.

[Редагувати]

Було б непогано мати і плюси і мінуси кожного підходу.

Чому б не провести спеціалізовані класи виключень?

if (interfaceInstance == null)
{
    throw new ThisParticularEmptyConstructorException(<maybe a couple parameters>);
}

Це підштовхує форматування та деталі до самого винятку, а основний клас залишає незабрудненим.

Microsoft, здається, (переглядаючи джерело .NET) іноді використовує рядки ресурсу / середовища. Наприклад ParseDecimal:

throw new OverflowException(Environment.GetResourceString("Overflow_Decimal"));

Плюси:

• Централізація повідомлень про винятки, що дозволяє повторно використовувати
• Тримаючи повідомлення про виключення (можливо, яке не має значення для кодування) подалі від логіки методів
• Тип виключення, що викидається, зрозумілий
• Повідомлення можна локалізувати

Мінуси:

• Якщо одне повідомлення про виключення буде змінено, всі вони змінюються
• Повідомлення про виняток не так легко доступне для коду, який викидає виняток.
• Повідомлення статичне і не містить інформації про те, які значення неправильні. Якщо ви хочете відформатувати його, це більше захаращеність у коді.

Для загальнодоступного сценарію SDK я б настійно розглядав можливість використання контрактів з кодом Microsoft, оскільки вони забезпечують інформативні помилки, статичні перевірки, а також ви можете створювати документацію для додавання в XML-документи та файли довідки, створені Sandcastle . Він підтримується у всіх платних версіях Visual Studio.

Додатковою перевагою є те, що якщо ваші клієнти використовують C #, вони можуть використовувати довідкові збори вашого кодового контракту для виявлення потенційних проблем ще до того, як вони запустять свій код.

Повна документація для Код контрактів знаходиться тут .

Я використовую техніку - комбінувати та передавати аутентифікацію та взагалі передавати функцію корисності.

Найважливішою перевагою є те, що вона зводиться до однорівневої в логіці бізнесу .

Б'юсь об заклад, що ви не можете зробити кращого, якщо не зможете додатково зменшити його - усунути всі перевірки аргументів та засоби охорони об'єктів із бізнес-логіки, зберігаючи лише виняткові експлуатаційні умови.

Звичайно, є способи цього - чітко набрана мова, "не допустимі недійсні об'єкти ніколи", дизайн за контрактом тощо.

Приклад:

internal static class ValidationUtil
{
    internal static void ThrowIfRectNullOrInvalid(int imageWidth, int imageHeight, Rect rect)
    {
        if (rect == null)
        {
            throw new ArgumentNullException("rect");
        }
        if (rect.Right > imageWidth || rect.Bottom > imageHeight || MoonPhase.Now == MoonPhase.Invisible)
        {
            throw new ArgumentException(
                message: "This is uselessly informative",
                paramName: "rect");
        }
    }
}

public class Thing
{
    public void DoSomething(Rect rect)
    {
        ValidationUtil.ThrowIfRectNullOrInvalid(_imageWidth, _imageHeight, rect);
        // rest of your code
    }
}

[Примітка] Я скопіював це з питання у відповідь, якщо є коментарі до нього.

Перемістіть кожен виняток у метод класу, взявши будь-які аргументи, які потребують форматування.

private Exception EmptyConstructor()
{
    string errMsg = string.Format(
          "Construction of Action Argument: {0}, via the empty constructor worked, but type: {1} could not be cast to type {2}.",
          ParameterInfo.Name,
          ParameterInfo.ParameterType,
          typeof(IParameter)
    );

    return new InvalidOperationException(errMsg);
}

Закріпіть усі методи виключень у регіоні та поставте їх у кінці заняття.

Плюси:

• Виводить повідомлення з основної логіки методу
• Дозволяє додавати логічну інформацію до кожного повідомлення (ви можете передати аргументи методу)

Мінуси:

• Спосіб захаращення. Потенційно у вас може бути безліч методів, які просто повертають винятки і насправді не пов'язані з бізнес-логікою.
• Неможливо повторно використовувати повідомлення в інших класах

Якщо ви можете уникнути трохи більш загальних помилок, ви можете написати загальнодоступну загальну статичну функцію лиття для вас, що визначає тип джерела:

public static I CastOrThrow<I,T>(T t, string source)
{
    if (t is I)
        return (I)t;

    string errMsg = string.Format(
          "Failed to complete {0}, because type: {1} could not be cast to type {2}.",
          source,
          typeof(T),
          typeof(I)
        );

    throw new InvalidOperationException(errMsg);
}


/// and then:

var interfaceInstance = SdkHelper.CastTo<IParameter>(passedObject, "Action constructor");

Можливі варіанти (подумайте SdkHelper.RequireNotNull()), які перевіряють лише вимоги до входів і кидають, якщо вони не спрацьовують, але в цьому прикладі поєднання ролях і отримання результату є самодокументаційним та компактним.

Якщо ви перебуваєте на .net 4.5, є способи змусити компілятор вставити ім'я поточного методу / файлу як параметр методу (див. CallerMemberAttibute ). Але для SDK ви, ймовірно, не можете вимагати від клієнтів перейти на 4.5.

Що ми любимо робити для помилок ділової логіки (не обов'язково помилок аргументів тощо) - це мати єдиний перерахунок, який визначає всі потенційні типи помилок:

/// <summary>
/// This enum is used to identify each business rule uniquely.
/// </summary>
public enum BusinessRuleId {

    /// <summary>
    /// Indicates that a valid body weight value of a patient is missing for dose calculation.
    /// </summary>
    [Display(Name = @"DoseCalculation_PatientBodyWeightMissing")]
    PatientBodyWeightMissingForDoseCalculation = 1,

    /// <summary>
    /// Indicates that a valid body height value of a patient is missing for dose calculation.
    /// </summary>
    [Display(Name = @"DoseCalculation_PatientBodyHeightMissing")]
    PatientBodyHeightMissingForDoseCalculation = 2,

    // ...
}

Ці [Display(Name = "...")]атрибути визначають ключ в ресурсі файлів , які будуть використовуватися для перекладу повідомлень про помилки.

Також цей файл може використовуватися як відправна точка для пошуку всіх випадків, коли у вашому коді генерується певний тип помилок.

Перевірка бізнес-правил може бути делегована на спеціалізовані класи Validator, які дають списки порушених бізнес-правил.

Потім ми використовуємо спеціальний тип винятку для транспортування порушених правил:

[Serializable]
public class BusinessLogicException : Exception {

    /// <summary>
    /// The Business Rule that was violated.
    /// </summary>
    public BusinessRuleId ViolatedBusinessRule { get; set; }

    /// <summary>
    /// Optional: additional parameters to be used to during generation of the error message.
    /// </summary>
    public string[] MessageParameters { get; set; }

    /// <summary>
    /// This exception indicates that a Business Rule has been violated. 
    /// </summary>
    public BusinessLogicException(BusinessRuleId violatedBusinessRule, params string[] messageParameters) {
        ViolatedBusinessRule = violatedBusinessRule;
        MessageParameters = messageParameters;
    }
}

Виклики сервісу бекенда обгорнуті загальним кодом обробки помилок, який переводить порушене правило бізнесу в повідомлення про помилку, прочитане користувачем:

public object TryExecuteServiceAction(Action a) {
    try {
        return a();
    }
    catch (BusinessLogicException bex) {
        _logger.Error(GenerateErrorMessage(bex));
    }
}

public string GenerateErrorMessage(BusinessLogicException bex) {
    var translatedError = bex.ViolatedBusinessRule.ToTranslatedString();
    if (bex.MessageParameters != null) {
        translatedError = string.Format(translatedError, bex.MessageParameters);
    }
    return translatedError;
}

Ось ToTranslatedString()метод розширення, для enumякого можна зчитувати ключі ресурсів з [Display]атрибутів і використовувати ResourceManagerдля перекладу цих ключів. Значення відповідного ключа ресурсу може містити заповнювачі string.Format, які відповідають заданому MessageParameters. Приклад запису у файлі resx:

<data name="DoseCalculation_PatientBodyWeightMissing" xml:space="preserve">
    <value>The dose can not be calculated because the body weight observation for patient {0} is missing or not up to date.</value>
    <comment>{0} ... Patient name</comment>
</data>

Приклад використання:

throw new BusinessLogicException(BusinessRuleId.PatientBodyWeightMissingForDoseCalculation, patient.Name);

При такому підході ви можете від'єднати генерацію повідомлення про помилку від генерації помилки, без необхідності вводити новий клас винятків для кожного нового типу помилок. Корисно, якщо різні фронти повинні відображати різні повідомлення, якщо відображене повідомлення має залежати від мови користувача та / або ролі тощо.

Я б використовував захисні пропозиції, як у цьому прикладі, щоб перевірити параметри можна повторно.

Крім того, ви можете використовувати шаблон для побудови, так що більше однієї перевірки може бути ланцюжком. Це буде трохи схоже на вільні твердження .