Nominalne znamke v TypeScriptu: Nepregledne definicije tipov za izboljšano varnost tipov

TypeScript kljub ponujanju statičnega tipiziranja primarno uporablja strukturno tipiziranje. To pomeni, da se tipi štejejo za združljive, če imajo enako obliko, ne glede na njihova deklarirana imena. Čeprav je to prožno, lahko včasih vodi do nenamernih zamenjav tipov in zmanjšane varnosti tipov. Nominalno označevanje, znano tudi kot definicije nepreglednih tipov, ponuja način za doseganje bolj robustnega sistema tipov, bližjega nominalnemu tipiziranju, znotraj TypeScripta. Ta pristop uporablja pametne tehnike, da se tipi obnašajo, kot da bi bili unikatno poimenovani, kar preprečuje nenamerne zamenjave in zagotavlja pravilnost kode.

Razumevanje strukturnega v primerjavi z nominalnim tipiziranjem

Preden se poglobimo v nominalno označevanje, je ključno razumeti razliko med strukturnim in nominalnim tipiziranjem.

Strukturno tipiziranje

Pri strukturnem tipiziranju se dva tipa štejeta za združljiva, če imata enako strukturo (tj. enake lastnosti z enakimi tipi). Poglejmo si ta primer v TypeScriptu:

interface Kilogram { value: number; }
interface Gram { value: number; }

const kg: Kilogram = { value: 10 };
const g: Gram = { value: 10000 };

// TypeScript dovoli to, ker imata oba tipa enako strukturo
const kg2: Kilogram = g;

console.log(kg2);

Čeprav `Kilogram` in `Gram` predstavljata različni merski enoti, TypeScript dovoli dodelitev objekta tipa `Gram` spremenljivki tipa `Kilogram`, ker imata oba lastnost `value` tipa `number`. To lahko vodi do logičnih napak v vaši kodi.

Nominalno tipiziranje

V nasprotju s tem nominalno tipiziranje šteje dva tipa za združljiva le, če imata isto ime ali če je eden izrecno izpeljan iz drugega. Jeziki, kot sta Java in C#, primarno uporabljajo nominalno tipiziranje. Če bi TypeScript uporabljal nominalno tipiziranje, bi zgornji primer povzročil napako tipa.

Potreba po nominalnem označevanju v TypeScriptu

Strukturno tipiziranje v TypeScriptu je na splošno koristno zaradi svoje prožnosti in enostavnosti uporabe. Vendar pa obstajajo situacije, ko potrebujete strožje preverjanje tipov, da preprečite logične napake. Nominalno označevanje ponuja rešitev za doseganje tega strožjega preverjanja brez žrtvovanja prednosti TypeScripta.

Razmislite o teh scenarijih:

• Upravljanje z valutami: Razlikovanje med zneski v `USD` in `EUR` za preprečevanje nenamernega mešanja valut.
• ID-ji v podatkovnih bazah: Zagotavljanje, da se `UserID` pomotoma ne uporabi tam, kjer se pričakuje `ProductID`.
• Merske enote: Razlikovanje med `metri` in `čevlji` za preprečevanje napačnih izračunov.
• Varni podatki: Razlikovanje med navadnim besedilom `Geslo` in zgoščenim `ZgoščenoGeslo` za preprečevanje nenamernega razkritja občutljivih informacij.

V vsakem od teh primerov lahko strukturno tipiziranje povzroči napake, ker je osnovna predstavitev (npr. število ali niz) enaka za oba tipa. Nominalno označevanje vam pomaga uveljaviti varnost tipov, tako da te tipe naredi različne.

Implementacija nominalnih znamk v TypeScriptu

Obstaja več načinov za implementacijo nominalnega označevanja v TypeScriptu. Raziskali bomo pogosto in učinkovito tehniko z uporabo presekov in unikatnih simbolov.

Uporaba presekov in unikatnih simbolov

Ta tehnika vključuje ustvarjanje unikatnega simbola in njegovo presekanje z osnovnim tipom. Unikatni simbol deluje kot "znamka", ki loči tip od drugih z enako strukturo.

// Definiramo unikatni simbol za znamko Kilogram
const kilogramBrand: unique symbol = Symbol();

// Definiramo tip Kilogram, označen z unikatnim simbolom
type Kilogram = number & { readonly [kilogramBrand]: true };

// Definiramo unikatni simbol za znamko Gram
const gramBrand: unique symbol = Symbol();

// Definiramo tip Gram, označen z unikatnim simbolom
type Gram = number & { readonly [gramBrand]: true };

// Pomožna funkcija za ustvarjanje vrednosti tipa Kilogram
const Kilogram = (value: number) => value as Kilogram;

// Pomožna funkcija za ustvarjanje vrednosti tipa Gram
const Gram = (value: number) => value as Gram;

const kg: Kilogram = Kilogram(10);
const g: Gram = Gram(10000);

// To bo zdaj povzročilo napako v TypeScriptu
// const kg2: Kilogram = g; // Type 'Gram' is not assignable to type 'Kilogram'.

console.log(kg, g);

Pojasnilo:

• Definiramo unikatni simbol z uporabo `Symbol()`. Vsak klic `Symbol()` ustvari unikatno vrednost, kar zagotavlja, da so naše znamke različne.
• Tipa `Kilogram` in `Gram` definiramo kot preseka tipa `number` in objekta, ki vsebuje unikatni simbol kot ključ z vrednostjo `true`. Modifikator `readonly` zagotavlja, da znamke po ustvarjanju ni mogoče spremeniti.
• Uporabljamo pomožne funkcije (`Kilogram` in `Gram`) z zatrjevanjem tipa (`as Kilogram` in `as Gram`) za ustvarjanje vrednosti označenih tipov. To je potrebno, ker TypeScript ne more samodejno sklepati o označenem tipu.

Zdaj TypeScript pravilno označi napako, ko poskušate dodeliti vrednost tipa `Gram` spremenljivki tipa `Kilogram`. To uveljavlja varnost tipov in preprečuje nenamerne zamenjave.

Generično označevanje za ponovno uporabo

Da bi se izognili ponavljanju vzorca označevanja za vsak tip, lahko ustvarite generični pomožni tip:

type Brand = K & { readonly __brand: unique symbol; };

// Definiramo Kilogram z uporabo generičnega tipa Brand
type Kilogram = Brand;

// Definiramo Gram z uporabo generičnega tipa Brand
type Gram = Brand;

// Pomožna funkcija za ustvarjanje vrednosti tipa Kilogram
const Kilogram = (value: number) => value as Kilogram;

// Pomožna funkcija za ustvarjanje vrednosti tipa Gram
const Gram = (value: number) => value as Gram;

const kg: Kilogram = Kilogram(10);
const g: Gram = Gram(10000);

// To bo še vedno povzročilo napako v TypeScriptu
// const kg2: Kilogram = g; // Type 'Gram' is not assignable to type 'Kilogram'.

console.log(kg, g);

Ta pristop poenostavi sintakso in olajša dosledno definiranje označenih tipov.

Napredni primeri uporabe in premisleki

Označevanje objektov

Nominalno označevanje se lahko uporablja tudi za objekte, ne le za primitivne tipe, kot so števila ali nizi.

interface User {
  id: number;
  name: string;
}

const UserIDBrand: unique symbol = Symbol();
type UserID = number & { readonly [UserIDBrand]: true };

interface Product {
  id: number;
  name: string;
}

const ProductIDBrand: unique symbol = Symbol();
type ProductID = number & { readonly [ProductIDBrand]: true };

// Funkcija, ki pričakuje UserID
function getUser(id: UserID): User {
  // ... implementacija za pridobitev uporabnika po ID-ju
  return {id: id, name: "Example User"};
}

const userID = 123 as UserID;
const productID = 456 as ProductID;

const user = getUser(userID);

// To bi povzročilo napako, če bi odkomentirali
// const user2 = getUser(productID); // Argument of type 'ProductID' is not assignable to parameter of type 'UserID'.

console.log(user);

To preprečuje nenamerno posredovanje `ProductID`, kjer se pričakuje `UserID`, čeprav sta oba na koncu predstavljena kot števili.

Delo s knjižnicami in zunanjimi tipi

Pri delu z zunanjimi knjižnicami ali API-ji, ki ne zagotavljajo označenih tipov, lahko uporabite zatrjevanje tipa za ustvarjanje označenih tipov iz obstoječih vrednosti. Vendar bodite pri tem previdni, saj v bistvu trdite, da vrednost ustreza označenemu tipu, in zagotoviti morate, da je temu res tako.

// Predpostavimo, da od API-ja prejmete število, ki predstavlja UserID
const rawUserID = 789; // Število iz zunanjega vira

// Ustvarite označen UserID iz surovega števila
const userIDFromAPI = rawUserID as UserID;

Premisleki glede izvajanja

Pomembno si je zapomniti, da je nominalno označevanje v TypeScriptu zgolj konstrukt v času prevajanja. Znamke (unikatni simboli) se med prevajanjem izbrišejo, zato ni dodatnih stroškov med izvajanjem. Vendar to tudi pomeni, da se na znamke ne morete zanašati za preverjanje tipov med izvajanjem. Če potrebujete preverjanje tipov med izvajanjem, boste morali implementirati dodatne mehanizme, kot so varovala za tipe po meri.

Varovala za tipe za preverjanje med izvajanjem

Za izvajanje preverjanja označenih tipov med izvajanjem lahko ustvarite varovala za tipe po meri:

function isKilogram(value: number): value is Kilogram {
  // V resničnem primeru bi tukaj lahko dodali dodatna preverjanja,
  // kot je zagotavljanje, da je vrednost znotraj veljavnega območja za kilograme.
  return typeof value === 'number';
}

const someValue: any = 15;

if (isKilogram(someValue)) {
  const kg: Kilogram = someValue;
  console.log("Vrednost je kilogram:", kg);
} else {
  console.log("Vrednost ni kilogram");
}

To vam omogoča varno zožitev tipa vrednosti med izvajanjem, s čimer zagotovite, da ustreza označenemu tipu, preden jo uporabite.

Prednosti nominalnega označevanja

• Izboljšana varnost tipov: Preprečuje nenamerne zamenjave tipov in zmanjšuje tveganje za logične napake.
• Izboljšana jasnost kode: Naredi kodo bolj berljivo in lažje razumljivo z izrecnim razlikovanjem med različnimi tipi z enako osnovno predstavitvijo.
• Manj časa za odpravljanje napak: Zazna napake, povezane s tipi, že v času prevajanja, kar prihrani čas in trud pri odpravljanju napak.
• Povečano zaupanje v kodo: Zagotavlja večje zaupanje v pravilnost vaše kode z uveljavljanjem strožjih omejitev tipov.

Omejitve nominalnega označevanja

• Samo v času prevajanja: Znamke se med prevajanjem izbrišejo, zato ne zagotavljajo preverjanja tipov med izvajanjem.
• Zahteva zatrjevanje tipa: Ustvarjanje označenih tipov pogosto zahteva zatrjevanje tipa, kar lahko ob nepravilni uporabi zaobide preverjanje tipov.
• Povečan "boilerplate": Definiranje in uporaba označenih tipov lahko vaši kodi doda nekaj ponavljajoče se kode, čeprav se to lahko omili z generičnimi pomožnimi tipi.

Najboljše prakse za uporabo nominalnih znamk

• Uporabljajte generično označevanje: Ustvarite generične pomožne tipe za zmanjšanje ponavljajoče se kode in zagotavljanje doslednosti.
• Uporabljajte varovala za tipe: Implementirajte varovala za tipe po meri za preverjanje med izvajanjem, kadar je to potrebno.
• Uporabljajte znamke premišljeno: Ne pretiravajte z nominalnim označevanjem. Uporabite ga le takrat, ko morate uveljaviti strožje preverjanje tipov, da preprečite logične napake.
• Jasno dokumentirajte znamke: Jasno dokumentirajte namen in uporabo vsakega označenega tipa.
• Upoštevajte zmogljivost: Čeprav so stroški med izvajanjem minimalni, se lahko čas prevajanja poveča ob prekomerni uporabi. Po potrebi profilirajte in optimizirajte.

Primeri v različnih panogah in aplikacijah

Nominalno označevanje se uporablja na različnih področjih:

• Finančni sistemi: Razlikovanje med različnimi valutami (USD, EUR, GBP) in vrstami računov (varčevalni, tekoči) za preprečevanje napačnih transakcij in izračunov. Na primer, bančna aplikacija lahko uporabi nominalne tipe, da zagotovi, da se izračuni obresti izvajajo samo na varčevalnih računih in da se pretvorbe valut pravilno uporabijo pri prenosu sredstev med računi v različnih valutah.
• Platforme za e-trgovino: Razlikovanje med ID-ji izdelkov, ID-ji strank in ID-ji naročil za preprečevanje poškodb podatkov in varnostnih ranljivosti. Predstavljajte si, da pomotoma dodelite podatke o kreditni kartici stranke izdelku – nominalni tipi lahko pomagajo preprečiti takšne katastrofalne napake.
• Aplikacije v zdravstvu: Ločevanje ID-jev pacientov, ID-jev zdravnikov in ID-jev terminov za zagotavljanje pravilne povezave podatkov in preprečevanje nenamernega mešanja pacientovih kartotek. To je ključnega pomena za ohranjanje zasebnosti pacientov in integritete podatkov.
• Upravljanje dobavne verige: Razlikovanje med ID-ji skladišč, ID-ji pošiljk in ID-ji izdelkov za natančno sledenje blaga in preprečevanje logističnih napak. Na primer, zagotavljanje, da je pošiljka dostavljena v pravilno skladišče in da se izdelki v pošiljki ujemajo z naročilom.
• Sistemi IoT (Internet stvari): Razlikovanje med ID-ji senzorjev, ID-ji naprav in ID-ji uporabnikov za zagotavljanje pravilnega zbiranja podatkov in nadzora. To je še posebej pomembno v scenarijih, kjer sta varnost in zanesljivost ključnega pomena, na primer pri avtomatizaciji pametnih domov ali industrijskih nadzornih sistemih.
• Igre: Razlikovanje med ID-ji orožij, ID-ji likov in ID-ji predmetov za izboljšanje logike igre in preprečevanje zlorab. Preprosta napaka bi lahko igralcu omogočila, da opremi predmet, namenjen samo NPC-jem, kar bi porušilo ravnotežje v igri.

Alternative nominalnemu označevanju

Čeprav je nominalno označevanje močna tehnika, lahko druge pristopi v določenih situacijah dosežejo podobne rezultate:

• Razredi: Uporaba razredov z zasebnimi lastnostmi lahko zagotovi določeno stopnjo nominalnega tipiziranja, saj so instance različnih razredov same po sebi različne. Vendar pa je ta pristop lahko bolj zgovoren kot nominalno označevanje in morda ni primeren za vse primere.
• Enum: Uporaba TypeScript enumov zagotavlja določeno stopnjo nominalnega tipiziranja med izvajanjem za določen, omejen nabor možnih vrednosti.
• Literalni tipi: Uporaba literalnih tipov nizov ali števil lahko omeji možne vrednosti spremenljivke, vendar ta pristop ne zagotavlja enake stopnje varnosti tipov kot nominalno označevanje.
• Zunanje knjižnice: Knjižnice, kot je `io-ts`, ponujajo zmožnosti preverjanja in validacije tipov med izvajanjem, ki se lahko uporabijo za uveljavljanje strožjih omejitev tipov. Vendar te knjižnice dodajo odvisnost med izvajanjem in morda niso potrebne za vse primere.

Zaključek

Nominalno označevanje v TypeScriptu ponuja močan način za izboljšanje varnosti tipov in preprečevanje logičnih napak z ustvarjanjem nepreglednih definicij tipov. Čeprav ni nadomestek za pravo nominalno tipiziranje, ponuja praktično rešitev, ki lahko znatno izboljša robustnost in vzdrževanje vaše TypeScript kode. Z razumevanjem načel nominalnega označevanja in njegovo premišljeno uporabo lahko pišete bolj zanesljive aplikacije brez napak.

Ne pozabite upoštevati kompromisov med varnostjo tipov, kompleksnostjo kode in stroški med izvajanjem, ko se odločate, ali boste v svojih projektih uporabili nominalno označevanje.

Z vključevanjem najboljših praks in skrbnim premislekom o alternativah lahko izkoristite nominalno označevanje za pisanje čistejše, lažje vzdrževane in bolj robustne kode v TypeScriptu. Sprejmite moč varnosti tipov in gradite boljšo programsko opremo!