структура з безглуздим значенням за замовчуванням

У моїй системі я часто працюю з кодами аеропортів ( "YYZ", "LAX", "SFO"і т.д.), вони завжди знаходяться в тому ж форматі (3 листи, представлений в верхньому регістрі). Зазвичай система займається 25-50 цими (різними) кодами на запит API, загалом - понад тисяча виділень, вони передаються через багато шарів нашої програми, і їх порівнюють за рівність досить часто.

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

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

public sealed class Airport
{
    public Airport(string code)
    {
        if (code == null)
        {
            throw new ArgumentNullException(nameof(code));
        }

        if (code.Length != 3 || !char.IsLetter(code[0]) 
        || !char.IsLetter(code[1]) || !char.IsLetter(code[2]))
        {
            throw new ArgumentException(
                "Must be a 3 letter airport code.", 
                nameof(code));
        }

        Code = code.ToUpperInvariant();
    }

    public string Code { get; }

    public override string ToString()
    {
        return Code;
    }

    private bool Equals(Airport other)
    {
        return string.Equals(Code, other.Code);
    }

    public override bool Equals(object obj)
    {
        return obj is Airport airport && Equals(airport);
    }

    public override int GetHashCode()
    {
        return Code?.GetHashCode() ?? 0;
    }

    public static bool operator ==(Airport left, Airport right)
    {
        return Equals(left, right);
    }

    public static bool operator !=(Airport left, Airport right)
    {
        return !Equals(left, right);
    }
}

Це значно спростило наш код і ми спростили наші перевірки рівності, словник / встановлені звичаї. Тепер ми знаємо, що якщо наші методи приймають Airportекземпляр, що він буде вести себе так, як ми очікуємо, він спростив нашу перевірку методів до нульової контрольної перевірки.

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

Моє рішення для цього полягало в перетворенні classв struct. Переважно це була лише зміна ключового слова, за винятком GetHashCodeта ToString:

public override string ToString()
{
    return Code ?? string.Empty;
}

public override int GetHashCode()
{
    return Code?.GetHashCode() ?? 0;
}

Для обробки справи, де default(Airport)використовується.

Мої запитання:

1. Чи було створення Airportкласу чи структури хорошим рішенням взагалі, чи я вирішую неправильну задачу / вирішую її неправильним шляхом, створюючи тип? Якщо це не гарне рішення, яке краще рішення?

2. Як моя програма повинна обробляти випадки, коли default(Airport)використовується? Тип default(Airport)мого додатку не є чутливим, тому я робив if (airport == default(Airport) { throw ... }місця, де отримання екземпляра Airport(та його Codeвластивості) є критично важливим для операції.

Примітки. Я переглянув питання C # / VB structure - як уникнути випадку з нульовими значеннями за замовчуванням, що вважається недійсним для даної структури? , і використовуйте структуру чи ні перед тим, як ставити запитання, проте я думаю, що мої запитання є досить різними, щоб гарантувати власну посаду.

Оновлення: я переписав свою відповідь, щоб вирішити деякі невірні припущення щодо C # структур, а також ОП, що повідомляє нас у коментарях про те, що використовуються інтерновані рядки.

Якщо ви можете контролювати дані, що надходять до вашої системи, використовуйте клас, який ви розмістили у своєму запитанні. Якщо хтось біжить, default(Airport)він отримає nullзначення назад. Не забудьте написати свій приватний Equalsметод, щоб повернути помилкове, коли порівнюєте нульові об’єкти аеропорту, а потім дозвольте NullReferenceExceptionлетіти в інше місце в коді.

Однак якщо ви берете дані в систему з джерел, якими ви не керуєте, вам не потрібно переривати весь потік. У цьому випадку структура є ідеальною для простого факту default(Airport)дасть вам щось, крім nullвказівника. Складіть очевидне значення для відображення "немає значення" або "значення за замовчуванням", щоб у вас є що надрукувати на екрані або у файлі журналу (наприклад, "---"). Насправді я б просто зберегти codeприватне і взагалі не виставляти Codeмайно - просто зосередитись на поведінці.

public struct Airport
{
    private string code;

    public Airport(string code)
    {
        // Check `code` for validity, throw exceptions if not valid

        this.code = code;
    }

    public override string ToString()
    {
        return code ?? (code = "---");
    }

    // int GetHashcode()

    // bool Equals(...)

    // bool operator ==(...)

    // bool operator !=(...)

    private bool Equals(Airport other)
    {
        if (other == null)
            // Even if this method is private, guard against null pointers
            return false;

        if (ToString() == "---" || other.ToString() == "---")
            // "Default" values should never match anything, even themselves
            return false;

        // Do a case insensitive comparison to enforce logic that airport
        // codes are not case sensitive
        return string.Equals(
            ToString(),
            other.ToString(),
            StringComparison.InvariantCultureIgnoreCase);
    }
}

Гірший сценарій перетворення default(Airport)в рядок видає "---"і повертає помилкове порівняно з іншими дійсними кодами аеропортів. Будь-який "код за умовчанням" аеропорту не відповідає нічого, включаючи інші коди аеропортів за замовчуванням.

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

Я би тут трохи схилив правила, через це.

Оригінальний відповідь (з деякими фактичними помилками)

Якщо ви можете керувати даними, які надходять до вашої системи, я б зробив так, як у коментарях запропонував Роберт Харві: Створіть конструктор без параметрів і киньте виняток, коли він викликається. Це запобігає потраплянню недійсних даних у систему через default(Airport).

public Airport()
{
    throw new InvalidOperationException("...");
}

Однак якщо ви берете дані в систему з джерел, якими ви не керуєте, вам не потрібно переривати весь потік. У цьому випадку ви можете створити код аеропорту, який недійсний, але зробити це очевидною помилкою. Це передбачає створення конструктора без параметрів і встановлення значення Codeна зразок "---":

public Airport()
{
    Code = "---";
}

Оскільки ви використовуєте stringкод як код, немає сенсу використовувати структуру. Структура виділяється на стек, лише щоб мати Codeвиділений як вказівник на рядок в купі пам'яті, тому тут немає різниці між класом і Stru.

Якщо ви змінили код аеропорту на масив з 3 елементами char, то структура буде повністю розподілена на стеку. Навіть тоді обсяг даних не такий великий, щоб змінити значення.

Використовуйте шаблон Flyweight

Оскільки аеропорт, як правило, непорушний, немає необхідності створювати більше ніж один екземпляр будь-якого конкретного, скажімо, SFO. Використовуйте Hashtable або подібне (зверніть увагу, я хлопець на Java, а не C #, тому точні деталі можуть відрізнятися), щоб кешувати аеропорти, коли вони будуть створені. Перш ніж створити новий, перевірте в Hashtable. Ви ніколи не звільняєте аеропорти, тому GC не має потреби їх звільняти.

Ще однією незначною перевагою (принаймні на Java, не впевнені в C #) є те, що вам не потрібно писати equals()метод, це ==буде просто . Те саме для hashcode().

Я не особливо просунутий програміст, але хіба це не було б ідеальним використанням для Enum?

Існують різні способи побудови перелічених класів зі списків або рядків. Ось я бачив раніше, але не впевнений, чи це найкращий спосіб.

https://blog.kloud.com.au/2016/06/17/converting-webconfig-values-into-enum-or-list/

Однією з причин, за якою ви бачите більше активності в GC, є те, що зараз ви створюєте другий рядок - .ToUpperInvariant()версію початкового рядка. Оригінальний рядок є придатним для GC відразу після запуску конструктора, а другий - придатний одночасно з Airportоб'єктом. Можливо, ви зможете мінімізувати його по-іншому (зверніть увагу на третій параметр string.Equals()):

public sealed class Airport : IEquatable<Airport>
{
    public Airport(string code)
    {
        if (code == null)
        {
            throw new ArgumentNullException(nameof(code));
        }

        if (code.Length != 3 || !char.IsLetter(code[0])
                             || !char.IsLetter(code[1]) || !char.IsLetter(code[2]))
        {
            throw new ArgumentException(
                "Must be a 3 letter airport code.",
                nameof(code));
        }

        Code = code;
    }

    public string Code { get; }

    public override string ToString()
    {
        return Code; // TODO: Upper-case it here if you really need to for display.
    }

    public bool Equals(Airport other)
    {
        return string.Equals(Code, other?.Code, StringComparison.InvariantCultureIgnoreCase);
    }

    public override bool Equals(object obj)
    {
        return obj is Airport airport && Equals(airport);
    }

    public override int GetHashCode()
    {
        return Code.GetHashCode();
    }

    public static bool operator ==(Airport left, Airport right)
    {
        return Equals(left, right);
    }

    public static bool operator !=(Airport left, Airport right)
    {
        return !Equals(left, right);
    }
}