TypeScript brendirani tipovi: Nominalno tipiziranje u strukturalnom sustavu

TypeScriptov strukturalni sustav tipova nudi fleksibilnost, ali ponekad može dovesti do neočekivanog ponašanja. Brendirani tipovi pružaju način za nametanje nominalnog tipiziranja, čime se poboljšava sigurnost tipova i jasnoća koda. Ovaj članak detaljno istražuje brendirane tipove, pružajući praktične primjere i najbolje prakse za njihovu implementaciju.

Razumijevanje strukturalnog i nominalnog tipiziranja

Prije nego što zaronimo u brendirane tipove, razjasnimo razliku između strukturalnog i nominalnog tipiziranja.

Strukturalno tipiziranje (Duck Typing)

U strukturalnom sustavu tipova, dva se tipa smatraju kompatibilnima ako imaju istu strukturu (tj. ista svojstva s istim tipovima). TypeScript koristi strukturalno tipiziranje. Razmotrite ovaj primjer:


interface Point {
  x: number;
  y: number;
}

interface Vector {
  x: number;
  y: number;
}

const point: Point = { x: 10, y: 20 };
const vector: Vector = point; // Valjano u TypeScriptu

console.log(vector.x); // Ispis: 10

Iako su Point i Vector deklarirani kao različiti tipovi, TypeScript dopušta dodjeljivanje objekta tipa Point varijabli tipa Vector jer dijele istu strukturu. To može biti praktično, ali može dovesti i do grešaka ako trebate razlikovati logički različite tipove koji slučajno imaju isti oblik. Na primjer, koordinate za geografsku širinu/dužinu koje bi se mogle slučajno podudarati s koordinatama piksela na zaslonu.

Nominalno tipiziranje

U nominalnom sustavu tipova, tipovi se smatraju kompatibilnima samo ako imaju isto ime. Čak i ako dva tipa imaju istu strukturu, tretiraju se kao različiti ako imaju različita imena. Jezici poput Jave i C# koriste nominalno tipiziranje.

Potreba za brendiranim tipovima

TypeScriptovo strukturalno tipiziranje može biti problematično kada trebate osigurati da vrijednost pripada određenom tipu, neovisno o njezinoj strukturi. Na primjer, razmotrite predstavljanje valuta. Mogli biste imati različite tipove za USD i EUR, ali oba bi se mogla predstaviti kao brojevi. Bez mehanizma za njihovo razlikovanje, mogli biste slučajno izvršiti operacije na pogrešnoj valuti.

Brendirani tipovi rješavaju ovaj problem omogućujući vam stvaranje različitih tipova koji su strukturno slični, ali ih sustav tipova tretira kao različite. To poboljšava sigurnost tipova i sprječava greške koje bi inače mogle proći nezapaženo.

Implementacija brendiranih tipova u TypeScriptu

Brendirani tipovi implementiraju se pomoću presječnih tipova (intersection types) i jedinstvenog simbola ili string literala. Ideja je dodati "brend" tipu koji ga razlikuje od drugih tipova s istom strukturom.

Korištenje simbola (preporučeno)

Korištenje simbola za brendiranje općenito se preferira jer su simboli zajamčeno jedinstveni.


const USD = Symbol('USD');
type USD = number & { readonly [USD]: unique symbol };

const EUR = Symbol('EUR');
type EUR = number & { readonly [EUR]: unique symbol };

function createUSD(value: number): USD {
  return value as USD;
}

function createEUR(value: number): EUR {
  return value as EUR;
}

function addUSD(a: USD, b: USD): USD {
  return (a + b) as USD;
}

const usd1 = createUSD(10);
const usd2 = createUSD(20);
const eur1 = createEUR(15);

const totalUSD = addUSD(usd1, usd2);
console.log("Total USD:", totalUSD);

// Otkrivanje komentara na sljedećoj liniji uzrokovat će grešku tipa
// const invalidOperation = addUSD(usd1, eur1);

U ovom primjeru, USD i EUR su brendirani tipovi temeljeni na tipu number. unique symbol osigurava da su ti tipovi različiti. Funkcije createUSD i createEUR koriste se za stvaranje vrijednosti ovih tipova, a funkcija addUSD prihvaća samo USD vrijednosti. Pokušaj dodavanja EUR vrijednosti USD vrijednosti rezultirat će greškom tipa.

Korištenje string literala

Možete koristiti i string literale za brendiranje, iako je ovaj pristup manje robustan od korištenja simbola jer string literali nisu zajamčeno jedinstveni.


type USD = number & { readonly __brand: 'USD' };
type EUR = number & { readonly __brand: 'EUR' };

function createUSD(value: number): USD {
  return value as USD;
}

function createEUR(value: number): EUR {
  return value as EUR;
}

function addUSD(a: USD, b: USD): USD {
  return (a + b) as USD;
}

const usd1 = createUSD(10);
const usd2 = createUSD(20);
const eur1 = createEUR(15);

const totalUSD = addUSD(usd1, usd2);
console.log("Total USD:", totalUSD);

// Otkrivanje komentara na sljedećoj liniji uzrokovat će grešku tipa
// const invalidOperation = addUSD(usd1, eur1);

Ovaj primjer postiže isti rezultat kao i prethodni, ali koristi string literale umjesto simbola. Iako je jednostavnije, važno je osigurati da su string literali koji se koriste za brendiranje jedinstveni unutar vaše kodne baze.

Praktični primjeri i slučajevi upotrebe

Brendirani tipovi mogu se primijeniti u različitim scenarijima gdje trebate nametnuti sigurnost tipova izvan strukturalne kompatibilnosti.

Identifikatori (ID-ovi)

Razmotrite sustav s različitim vrstama identifikatora, kao što su UserID, ProductID i OrderID. Svi ti identifikatori mogu biti predstavljeni kao brojevi ili stringovi, ali želite spriječiti slučajno miješanje različitih vrsta identifikatora.


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

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

function getUser(id: UserID): { name: string } {
  // ... dohvati podatke o korisniku
  return { name: "Alice" };
}

function getProduct(id: ProductID): { name: string, price: number } {
  // ... dohvati podatke o proizvodu
  return { name: "Example Product", price: 25 };
}

function createUserID(id: string): UserID {
  return id as UserID;
}

function createProductID(id: string): ProductID {
  return id as ProductID;
}

const userID = createUserID('user123');
const productID = createProductID('product456');

const user = getUser(userID);
const product = getProduct(productID);

console.log("User:", user);
console.log("Product:", product);

// Otkrivanje komentara na sljedećoj liniji uzrokovat će grešku tipa
// const invalidCall = getUser(productID);

Ovaj primjer pokazuje kako brendirani tipovi mogu spriječiti prosljeđivanje ProductID funkciji koja očekuje UserID, čime se poboljšava sigurnost tipova.

Vrijednosti specifične za domenu

Brendirani tipovi također mogu biti korisni za predstavljanje vrijednosti specifičnih za domenu s ograničenjima. Na primjer, mogli biste imati tip za postotke koji bi uvijek trebali biti između 0 i 100.


const PercentageBrand = Symbol('Percentage');
type Percentage = number & { readonly [PercentageBrand]: unique symbol };

function createPercentage(value: number): Percentage {
  if (value < 0 || value > 100) {
    throw new Error('Percentage must be between 0 and 100');
  }
  return value as Percentage;
}

function applyDiscount(price: number, discount: Percentage): number {
  return price * (1 - discount / 100);
}

try {
  const discount = createPercentage(20);
  const discountedPrice = applyDiscount(100, discount);
  console.log("Discounted Price:", discountedPrice);

  // Otkrivanje komentara na sljedećoj liniji uzrokovat će grešku tijekom izvođenja
  // const invalidPercentage = createPercentage(120);
} catch (error) {
  console.error(error);
}

Ovaj primjer pokazuje kako nametnuti ograničenje na vrijednost brendiranog tipa tijekom izvođenja. Iako sustav tipova ne može jamčiti da je vrijednost Percentage uvijek između 0 i 100, funkcija createPercentage može nametnuti to ograničenje tijekom izvođenja. Također možete koristiti biblioteke poput io-ts za nametanje validacije brendiranih tipova u stvarnom vremenu.

Prikazi datuma i vremena

Rad s datumima i vremenima može biti kompliciran zbog različitih formata i vremenskih zona. Brendirani tipovi mogu pomoći u razlikovanju različitih prikaza datuma i vremena.


const UTCDateBrand = Symbol('UTCDate');
type UTCDate = string & { readonly [UTCDateBrand]: unique symbol };

const LocalDateBrand = Symbol('LocalDate');
type LocalDate = string & { readonly [LocalDateBrand]: unique symbol };

function createUTCDate(dateString: string): UTCDate {
  // Validacija da je datumski string u UTC formatu (npr. ISO 8601 sa Z)
  if (!/\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}Z/.test(dateString)) {
    throw new Error('Invalid UTC date format');
  }
  return dateString as UTCDate;
}

function createLocalDate(dateString: string): LocalDate {
  // Validacija da je datumski string u formatu lokalnog datuma (npr. YYYY-MM-DD)
  if (!/\d{4}-\d{2}-\d{2}/.test(dateString)) {
    throw new Error('Invalid local date format');
  }
  return dateString as LocalDate;
}

function convertUTCDateToLocalDate(utcDate: UTCDate): LocalDate {
  // Izvrši pretvorbu vremenske zone
  const date = new Date(utcDate);
  const localDateString = date.toLocaleDateString();
  return createLocalDate(localDateString);
}

try {
  const utcDate = createUTCDate('2024-01-20T10:00:00.000Z');
  const localDate = convertUTCDateToLocalDate(utcDate);
  console.log("UTC Date:", utcDate);
  console.log("Local Date:", localDate);
} catch (error) {
  console.error(error);
}

Ovaj primjer razlikuje UTC i lokalne datume, osiguravajući da radite s ispravnim prikazom datuma i vremena u različitim dijelovima vaše aplikacije. Validacija tijekom izvođenja osigurava da se samo ispravno formatirani datumski stringovi mogu dodijeliti ovim tipovima.

Najbolje prakse za korištenje brendiranih tipova

Za učinkovito korištenje brendiranih tipova u TypeScriptu, razmotrite sljedeće najbolje prakse:

Koristite simbole za brendiranje: Simboli pružaju najjače jamstvo jedinstvenosti, smanjujući rizik od grešaka tipa.
Kreirajte pomoćne funkcije: Koristite pomoćne funkcije za stvaranje vrijednosti brendiranih tipova. To pruža središnju točku za validaciju i osigurava dosljednost.
Primijenite validaciju tijekom izvođenja: Iako brendirani tipovi poboljšavaju sigurnost tipova, ne sprječavaju dodjeljivanje neispravnih vrijednosti tijekom izvođenja. Koristite validaciju tijekom izvođenja za nametanje ograničenja.
Dokumentirajte brendirane tipove: Jasno dokumentirajte svrhu i ograničenja svakog brendiranog tipa kako biste poboljšali održivost koda.
Uzmite u obzir implikacije na performanse: Brendirani tipovi uvode malo opterećenje zbog presječnog tipa i potrebe za pomoćnim funkcijama. Razmotrite utjecaj na performanse u kritičnim dijelovima vašeg koda.

Prednosti brendiranih tipova

Poboljšana sigurnost tipova: Sprječava slučajno miješanje strukturno sličnih, ali logički različitih tipova.
Poboljšana jasnoća koda: Čini kod čitljivijim i lakšim za razumijevanje eksplicitnim razlikovanjem tipova.
Smanjenje grešaka: Hvata potencijalne greške u vrijeme kompajliranja, smanjujući rizik od bugova tijekom izvođenja.
Povećana održivost: Olakšava održavanje i refaktoriranje koda pružanjem jasnog odvajanja odgovornosti.

Nedostaci brendiranih tipova

Povećana složenost: Dodaje složenost kodnoj bazi, posebno kada se radi s mnogo brendiranih tipova.
Opterećenje tijekom izvođenja: Uvodi malo opterećenje tijekom izvođenja zbog potrebe za pomoćnim funkcijama i validacijom.
Potencijal za ponavljajući kod (boilerplate): Može dovesti do ponavljajućeg koda, posebno pri stvaranju i validaciji brendiranih tipova.

Alternative brendiranim tipovima

Iako su brendirani tipovi moćna tehnika za postizanje nominalnog tipiziranja u TypeScriptu, postoje alternativni pristupi koje biste mogli razmotriti.

Neprozirni tipovi (Opaque Types)

Neprozirni tipovi slični su brendiranim tipovima, ali pružaju eksplicitniji način skrivanja temeljnog tipa. TypeScript nema ugrađenu podršku za neprozirne tipove, ali ih možete simulirati pomoću modula i privatnih simbola.

Klase

Korištenje klasa može pružiti objektno orijentirani pristup definiranju različitih tipova. Iako su klase u TypeScriptu strukturalno tipizirane, nude jasnije odvajanje odgovornosti i mogu se koristiti za nametanje ograničenja putem metoda.

Biblioteke poput `io-ts` ili `zod`

Ove biblioteke pružaju sofisticiranu validaciju tipova tijekom izvođenja i mogu se kombinirati s brendiranim tipovima kako bi se osigurala sigurnost i u vrijeme kompajliranja i tijekom izvođenja.

Zaključak

TypeScript brendirani tipovi vrijedan su alat za poboljšanje sigurnosti tipova i jasnoće koda u strukturalnom sustavu tipova. Dodavanjem "brenda" tipu, možete nametnuti nominalno tipiziranje i spriječiti slučajno miješanje strukturno sličnih, ali logički različitih tipova. Iako brendirani tipovi unose određenu složenost i opterećenje, prednosti poboljšane sigurnosti tipova i održivosti koda često nadmašuju nedostatke. Razmislite o korištenju brendiranih tipova u scenarijima gdje trebate osigurati da vrijednost pripada određenom tipu, neovisno o njezinoj strukturi.

Razumijevanjem principa iza strukturalnog i nominalnog tipiziranja te primjenom najboljih praksi navedenih u ovom članku, možete učinkovito iskoristiti brendirane tipove za pisanje robusnijeg i održivijeg TypeScript koda. Od predstavljanja valuta i identifikatora do nametanja ograničenja specifičnih za domenu, brendirani tipovi pružaju fleksibilan i moćan mehanizam za poboljšanje sigurnosti tipova u vašim projektima.

Dok radite s TypeScriptom, istražite različite tehnike i biblioteke dostupne za validaciju i nametanje tipova. Razmislite o korištenju brendiranih tipova u kombinaciji s bibliotekama za validaciju tijekom izvođenja poput io-ts ili zod kako biste postigli sveobuhvatan pristup sigurnosti tipova.