Alternative TypeScript Enumima: Konst-Tvrdnje vs. Unijski Tipovi

TypeScriptov enum je moćna značajka za definiranje skupa imenovanih konstanti. Međutim, nije uvijek najbolji izbor. Ovaj članak istražuje alternative enumima, posebno konst-tvrdnje i unijske tipove, te pruža smjernice o tome kada koristiti svaku od njih za optimalnu kvalitetu koda, održivost i performanse. Ući ćemo u nijanse svakog pristupa, nudeći praktične primjere i rješavajući uobičajene brige.

Razumijevanje TypeScript Enumima

Prije nego što zaronimo u alternative, brzo ćemo pregledati TypeScript enume. Enum je način za definiranje skupa imenovanih numeričkih konstanti. Prema zadanim postavkama, prvom članu enuma dodjeljuje se vrijednost 0, a sljedeći članovi se povećavaju za 1.

            
enum Status {
  Pending,
  InProgress,
  Completed,
  Rejected,
}

const currentStatus: Status = Status.InProgress; // currentStatus will be 1

            

              
                Copy
              
            
          

Također možete eksplicitno dodijeliti vrijednosti članovima enuma:

            
enum HTTPStatus {
  OK = 200,
  BadRequest = 400,
  Unauthorized = 401,
  Forbidden = 403,
  NotFound = 404,
}

const serverResponse: HTTPStatus = HTTPStatus.OK; // serverResponse will be 200

            

              
                Copy
              
            
          

Prednosti Enuma

• Čitljivost: Enumi poboljšavaju čitljivost koda pružajući smislena imena za numeričke konstante.
• Sigurnost Tipa: Oni osiguravaju sigurnost tipa ograničavanjem vrijednosti na definirane članove enuma.
• Automatsko dovršavanje: IDE-ovi pružaju prijedloge za automatsko dovršavanje članova enuma, smanjujući pogreške.

Nedostaci Enuma

• Dodatno opterećenje pri izvođenju: Enumi se kompiluju u JavaScript objekte, što može unijeti dodatno opterećenje pri izvođenju, posebno u velikim aplikacijama.
• Mutacija: Enumi su po zadanim postavkama promjenjivi. Iako TypeScript pruža const enum za sprječavanje mutacije, on ima svoja ograničenja.
• Obrnuto mapiranje: Numerički enumi stvaraju obrnuto mapiranje (npr. Status[1] vraća "InProgress"), što je često nepotrebno i može povećati veličinu paketa.

Alternativa 1: Konst-Tvrdnje

Konst-tvrdnje pružaju način za stvaranje nepromjenjivih, samo za čitanje podatkovnih struktura. Mogu se koristiti kao alternativa enumima u mnogim slučajevima, posebno kada trebate jednostavan skup nizovnih ili numeričkih konstanti.

            
const Status = {
  Pending: 'pending',
  InProgress: 'in_progress',
  Completed: 'completed',
  Rejected: 'rejected',
} as const;

// Typescript infers the following type:
// {
//    readonly Pending: "pending";
//    readonly InProgress: "in_progress";
//    readonly Completed: "completed";
//    readonly Rejected: "rejected";
// }

type StatusType = typeof Status[keyof typeof Status]; // 'pending' | 'in_progress' | 'completed' | 'rejected'

function processStatus(status: StatusType) {
  console.log(`Processing status: ${status}`);
}

processStatus(Status.InProgress); // Valid
// processStatus('invalid'); // Error: Argument of type '"invalid"' is not assignable to parameter of type 'StatusType'.

            

              
                Copy
              
            
          

U ovom primjeru, definiramo običan JavaScript objekt s nizovnim vrijednostima. as const tvrdnja govori TypeScriptu da tretira ovaj objekt kao samo za čitanje i da zaključi najspecifičnije tipove za njegova svojstva. Zatim izvlačimo unijski tip iz ključeva. Ovaj pristup nudi nekoliko prednosti:

Prednosti Konst-Tvrdnji

• Nepromjenjivost: Konst-tvrdnje stvaraju nepromjenjive podatkovne strukture, sprječavajući slučajne izmjene.
• Bez dodatnog opterećenja pri izvođenju: Oni su jednostavni JavaScript objekti, tako da nema dodatnog opterećenja pri izvođenju povezanog s enumima.
• Sigurnost tipa: Pružaju snažnu sigurnost tipa ograničavanjem vrijednosti na definirane konstante.
• Kompatibilno s "tree-shakingom": Moderni bundleri mogu lako ukloniti neiskorištene vrijednosti, smanjujući veličinu paketa.

Razmatranja za Konst-Tvrdnje

• Opširnije: Definiranje i tipiziranje može biti nešto opširnije nego kod enuma, posebno za jednostavne slučajeve.
• Bez obrnutog mapiranja: Ne pružaju obrnuto mapiranje, ali to je često prednost, a ne nedostatak.

Alternativa 2: Unijski Tipovi

Unijski tipovi omogućuju definiranje varijable koja može sadržavati jedan od nekoliko mogućih tipova. Oni su izravniji način definiranja dopuštenih vrijednosti bez objekta, što je korisno kada vam ne treba odnos ključ-vrijednost enuma ili konst-tvrdnje.

            
type Status = 'pending' | 'in_progress' | 'completed' | 'rejected';

function processStatus(status: Status) {
  console.log(`Processing status: ${status}`);
}

processStatus('in_progress'); // Valid
// processStatus('invalid'); // Error: Argument of type '"invalid"' is not assignable to parameter of type 'Status'.

            

              
                Copy
              
            
          

Ovo je sažet i tipski siguran način za definiranje skupa dopuštenih vrijednosti.

Prednosti Unijskih Tipova

• Sažetost: Unijski tipovi su najsažetiji pristup, posebno za jednostavne skupove nizovnih ili numeričkih konstanti.
• Sigurnost tipa: Pružaju snažnu sigurnost tipa ograničavanjem vrijednosti na definirane opcije.
• Bez dodatnog opterećenja pri izvođenju: Unijski tipovi postoje samo u vrijeme kompilacije i nemaju reprezentaciju pri izvođenju.

Razmatranja za Unijske Tipove

• Bez povezanosti ključ-vrijednost: Ne pružaju odnos ključ-vrijednost kao enumi ili konst-tvrdnje. To znači da ne možete lako pretraživati vrijednost po njezinom imenu.
• Ponavljanje string literala: Možda ćete morati ponavljati string literale ako koristite isti skup vrijednosti na više mjesta. To se može ublažiti dijeljenom definicijom type.

Kada koristiti koji?

Najbolji pristup ovisi o vašim specifičnim potrebama i prioritetima. Evo vodiča koji će vam pomoći pri odabiru:

• Koristite Enume Kada:
  • Trebate jednostavan skup numeričkih konstanti s implicitnim povećavanjem.
  • Trebate obrnuto mapiranje (iako je to rijetko potrebno).
  • Radite s naslijeđenim kodom koji već opsežno koristi enume i nemate hitnu potrebu da ga mijenjate.
• Koristite Konst-Tvrdnje Kada:
  • Trebate skup nizovnih ili numeričkih konstanti koje trebaju biti nepromjenjive.
  • Trebate odnos ključ-vrijednost i želite izbjeći dodatno opterećenje pri izvođenju.
  • "Tree-shaking" i veličina paketa su važna razmatranja.
• Koristite Unijske Tipove Kada:
  • Trebate jednostavan, sažet način za definiranje skupa dopuštenih vrijednosti.
  • Ne trebate odnos ključ-vrijednost.
  • Performanse i veličina paketa su kritični.

Primjer scenarija: Definiranje korisničkih uloga

Razmotrimo scenarij u kojem trebate definirati korisničke uloge u aplikaciji. Možda imate uloge poput "Admin", "Editor" i "Viewer".

Korištenje Enuma:

            
enum UserRole {
  Admin,
  Editor,
  Viewer,
}

function authorize(role: UserRole) {
  // ...
}

            

              
                Copy
              
            
          

Korištenje Konst-Tvrdnji:

            
const UserRole = {
  Admin: 'admin',
  Editor: 'editor',
  Viewer: 'viewer',
} as const;

type UserRoleType = typeof UserRole[keyof typeof UserRole];

function authorize(role: UserRoleType) {
  // ...
}

            

              
                Copy
              
            
          

Korištenje Unijskih Tipova:

            
type UserRole = 'admin' | 'editor' | 'viewer';

function authorize(role: UserRole) {
  // ...
}

            

              
                Copy
              
            
          

U ovom scenariju, unijski tipovi nude najsažetije i najučinkovitije rješenje. Konst-tvrdnje su dobra alternativa ako preferirate odnos ključ-vrijednost, možda za traženje opisa svake uloge. Enumi se ovdje općenito ne preporučuju, osim ako nemate specifičnu potrebu za numeričkim vrijednostima ili obrnutim mapiranjem.

Primjer scenarija: Definiranje statusnih kodova API krajnjih točaka

Razmotrimo scenarij u kojem trebate definirati statusne kodove API krajnjih točaka. Možda imate kodove kao što su 200 (OK), 400 (Bad Request), 401 (Unauthorized) i 500 (Internal Server Error).

Korištenje Enuma:

            
enum StatusCode {
  OK = 200,
  BadRequest = 400,
  Unauthorized = 401,
  InternalServerError = 500
}

function processStatus(code: StatusCode) {
  // ...
}

            

              
                Copy
              
            
          

Korištenje Konst-Tvrdnji:

            
const StatusCode = {
  OK: 200,
  BadRequest: 400,
  Unauthorized: 401,
  InternalServerError: 500
} as const;

type StatusCodeType = typeof StatusCode[keyof typeof StatusCode];

function processStatus(code: StatusCodeType) {
  // ...
}

            

              
                Copy
              
            
          

Korištenje Unijskih Tipova:

            
type StatusCode = 200 | 400 | 401 | 500;

function processStatus(code: StatusCode) {
  // ...
}

            

              
                Copy
              
            
          

Ponovno, unijski tipovi nude najsažetije i najučinkovitije rješenje. Konst-tvrdnje su snažna alternativa i mogu biti preferirane jer daju detaljniji opis za zadani statusni kod. Enumi bi mogli biti korisni ako vanjske biblioteke ili API-ji očekuju statusne kodove temeljene na cijelim brojevima, a želite osigurati besprijekornu integraciju. Numeričke vrijednosti usklađene su sa standardnim HTTP kodovima, potencijalno pojednostavljujući interakciju s postojećim sustavima.

Razmatranja performansi

U većini slučajeva, razlika u performansama između enuma, konst-tvrdnji i unijskih tipova je zanemariva. Međutim, u aplikacijama kritičnim za performanse, važno je biti svjestan potencijalnih razlika.

• Enumi: Enumi uvode dodatno opterećenje pri izvođenju zbog stvaranja JavaScript objekata. Ovo opterećenje može biti značajno u velikim aplikacijama s mnogo enuma.
• Konst-Tvrdnje: Konst-tvrdnje nemaju dodatno opterećenje pri izvođenju. To su jednostavni JavaScript objekti koje TypeScript tretira kao samo za čitanje.
• Unijski Tipovi: Unijski tipovi nemaju dodatno opterećenje pri izvođenju. Oni postoje samo u vrijeme kompilacije i brišu se tijekom kompilacije.

Ako su performanse glavna briga, unijski tipovi su općenito najbolji izbor. Konst-tvrdnje su također dobra opcija, pogotovo ako trebate odnos ključ-vrijednost. Izbjegavajte korištenje enuma u dijelovima koda kritičnim za performanse, osim ako za to nemate specifičan razlog.

Globalne implikacije i najbolje prakse

Pri radu na projektima s međunarodnim timovima ili globalnim korisnicima, ključno je uzeti u obzir lokalizaciju i internacionalizaciju. Evo nekoliko najboljih praksi za korištenje enuma i njihovih alternativa u globalnom kontekstu:

• Koristite opisna imena: Odaberite imena članova enuma (ili ključeve konst-tvrdnji) koja su jasna i nedvosmislena, čak i za govornike koji nisu izvorni engleski. Izbjegavajte žargon.
• Razmislite o lokalizaciji: Ako trebate prikazati imena članova enuma korisnicima, razmislite o korištenju biblioteke za lokalizaciju kako biste pružili prijevode za različite jezike. Na primjer, umjesto izravnog prikazivanja Status.InProgress, mogli biste prikazati i18n.t('status.in_progress').
• Izbjegavajte kulturno specifične pretpostavke: Budite svjesni kulturnih razlika pri definiranju vrijednosti enuma. Na primjer, formati datuma, simboli valuta i mjerne jedinice mogu se značajno razlikovati među kulturama. Ako trebate predstaviti te vrijednosti, razmislite o korištenju biblioteke koja se bavi lokalizacijom i internacionalizacijom.
• Dokumentirajte svoj kod: Pružite jasnu i sažetu dokumentaciju za svoje enume i njihove alternative, objašnjavajući njihovu svrhu i upotrebu. To će pomoći drugim programerima da razumiju vaš kod, bez obzira na njihovo podrijetlo ili iskustvo.

Primjer: Lokalizacija korisničkih uloga

Vratimo se primjeru korisničkih uloga i razmotrimo kako lokalizirati imena uloga za različite jezike.

            
// Using Const Assertions with Localization
const UserRole = {
  Admin: 'admin',
  Editor: 'editor',
  Viewer: 'viewer',
} as const;

type UserRoleType = typeof UserRole[keyof typeof UserRole];

// Localization function (using a hypothetical i18n library)
function getLocalizedRoleName(role: UserRoleType, locale: string): string {
  switch (role) {
    case UserRole.Admin:
      return i18n.t('user_role.admin', { locale });
    case UserRole.Editor:
      return i18n.t('user_role.editor', { locale });
    case UserRole.Viewer:
      return i18n.t('user_role.viewer', { locale });
    default:
      return 'Unknown Role';
  }
}

// Example usage
const currentRole: UserRoleType = UserRole.Editor;
const localizedRoleName = getLocalizedRoleName(currentRole, 'fr-CA'); // Returns localized "Éditeur" for French Canadian.
console.log(`Current role: ${localizedRoleName}`);

            

              
                Copy
              
            
          

U ovom primjeru, koristimo funkciju lokalizacije za dohvaćanje prevedenog imena uloge na temelju korisničkog lokaliteta. To osigurava da se imena uloga prikazuju na jeziku koji korisnik preferira.

Zaključak

TypeScript enumi su korisna značajka, ali nisu uvijek najbolji izbor. Konst-tvrdnje i unijski tipovi nude održive alternative koje mogu pružiti bolje performanse, nepromjenjivost i održivost koda. Razumijevanjem prednosti i nedostataka svakog pristupa, možete donijeti informirane odluke o tome koji ćete koristiti u svojim projektima. Razmotrite specifične potrebe svoje aplikacije, preferencije svog tima i dugoročnu održivost svog koda. Pažljivim odmjeravanjem ovih faktora, možete odabrati najbolji pristup za definiranje konstanti u svojim TypeScript projektima, što će dovesti do čišćih, učinkovitijih i održivijih kodnih baza.