Enum как результат

Иногда, бывает очень удобно возвращать результат работы сервис-метода в качестве Enum значения. Представим ситуацию: Вы пишите сервис-метод, который возвращает два возможных состояния true/false (область значений), как бы Вы поступили, ограничились бы стандартным типом Bool или все-таки ввели бы новый Enum? Идея оставить Bool не совсем удачна, если вдруг придется расширить область значений сервис-метода. Например, в задаче аутентификации пользователя, где помимо информации об удаче/неудаче необходимо указать, в чем состоит неудача аутентификации, в итоге получим 4 возможных результата: "успех" (Ok), "провал" (Fail), "логин не верен" (LoginIncorrect), "пароль не верен" (PasswordIncorrect):

// Результат аутентификации

enum LoginStatus

{

    // Успех

    Ok = 0,

    // Провал

    Fail = (2 << 1),

    // Уточняем, в чем провал:

    LoginIncorrect = (2 << 2),

    PasswordIncorrect = (2 << 3)

}

На этом можно было бы и закончить, но возможно, Вы возразите мне: "А как связаны статусы: Fail и PasswordIncorrect ? Интуитивно понятно, что связь между статусами есть.". Проблема решается просто на уровне битовых полей и флагов, давайте свяжем эти статусы следующим образом: статус PasswordIncorrect, это тот же статус Fail, но с небольшим уточнением в виде одного бита (2 << 3):

// Результат аутентификации

[Flags]

enum LoginStatus

{

    // Успех

    Ok = 0,

    // Провал

    Fail = (2 << 1),

 

    // Уточняем, в чем провал:

    LoginIncorrect = (2 << 2) | Fail,

    PasswordIncorrect = (2 << 3) | Fail

}

Вот это уже намного лучше. Осталось привести пример использования:

if ((LoginStatus.Fail & status) == LoginStatus.Fail)

{

    // Аутентификация завершилась неудачей

    // и не важно, почему.

}

 

if ((LoginStatus.LoginIncorrect & status) == LoginStatus.LoginIncorrect)

{

    // Аутентификация завершилась неудачей:

    // как минимум логин пользователя не существует.

}

 

if ((LoginStatus.PasswordIncorrect & status) == LoginStatus.PasswordIncorrect)

{

    // Аутентификация завершилась неудачей:

    // как минимум пароль указан неверно.

}

Допустим, мы ввели еще один статус "Пароль имеет пустое значение" (PasswordIsEmpty), тогда мы с легкостью сможем расширить наш Enum следующим образом:

// Результат аутентификации

[Flags]

enum LoginStatus

{

    // Успех

    Ok = 0,

    // Провал

    Fail = (2 << 1),

 

    // Уточняем, в чем провал:

    LoginIncorrect = (2 << 2) | Fail,

    PasswordIncorrect = (2 << 3) | Fail,

 

    // Пустой пароль

    PasswordIsEmpty = (2 << 4) | PasswordIncorrect

}

Достоинства:

1. Никаких magic-constants.
2. Простота и легкость расширения.
3. Установление взаимосвязей за счет комбинирования.

Недостатки:

1. Ограничение числа возможных статусов разрядностью Enum.

Ссылки:

1. Enumeration Types (C# Programming Guide)