Типизация функций с помощью TypeScript

9 месяцев назад·15 мин. на чтение

Туториал по TypeScript - Типизация функций TypeScript

Содержание туториала по TypeScript Функции — это основной строительный блок любого приложения, будь то локальные функции, импортированные из другого модуля или методы класса. Они также являются значениями, и, как и другие значения, в TypeScript есть много способов описать, как можно вызывать функции.

Типизация функций

Самый простой способ типизировать функцию — использовать выражение функционального типа. Эти типы синтаксически похожи на стрелочные функции:
function greeter(fn: (a: string) => void) {
  fn('Hello, World');
}

function printToConsole(s: string) {
  console.log(s);
}

greeter(printToConsole);
Синтаксис (a:string) => void означает "функция с одним параметром a, типа string, который не имеет возвращаемого значения". Как и в случае с определением функции, если тип параметра не указан, он будет иметь тип any. Обратите внимание, что имя параметра является обязательным. Тип функции (string) => void означает "функция с параметром, названным string типа any"! Конечно, мы можем использовать псевдоним типа для обозначения типа функции:
type GreetFunction = (a: string) => void;
function greeter(fn: GreetFunction) {
  // ...
}

Сигнатура вызова (Call Signature)

В JavaScript функции могут не только вызываться, но и иметь свойства. Однако синтаксис выражения функционального типа не позволяет объявлять свойства. Если мы хотим описать что-то вызываемое с помощью свойств, мы можем написать сигнатуру вызова в объектном типе:
type DescribableFunction = {
  description: string;
  (someArg: number): boolean;
};
function doSomething(fn: DescribableFunction) {
  console.log(fn.description + ' returned ' + fn(6));
}
Обратите внимание, что синтаксис немного отличается от выражения функционального типа — используется : между списком параметров и возвращаемым типом, а не =>.

Сигнатура конструктора (Construct Signature)

Функции JavaScript также можно вызывать с помощью оператора new. В TypeScript они считаются конструкторами, потому что они обычно создают новый объект. Вы можете написать сигнатуру конструктора, добавив ключевое слово new перед сигнатурой вызова:
type SomeConstructor = {
  new (s: string): SomeObject;
};
function fn(ctor: SomeConstructor) {
  return new ctor('hello');
}
Некоторые объекты, такие как объект Date в JavaScript, можно вызывать как с оператором new, так и без него. Вы можете произвольно комбинировать сигнатуры вызова и конструктора в одном и том же типе:
interface CallOrConstruct {
  new (s: string): Date;
  (n?: number): number;
}

Функции-дженерики (Generic Functions)

Обычно пишут функцию, в которой типы входных данных связаны с типом выходных данных или где типы двух входных данных каким-то образом связаны. Давайте рассмотрим функцию, которая возвращает первый элемент массива:
function firstElement(arr: any[]) {
  return arr[0];
}
Эта функция выполняет свою работу, но, к сожалению, имеет возвращаемый тип any. Лучше бы функция возвращала тип элемента массива. В TypeScript дженерики используются, когда мы хотим описать соответствие между двумя значениями. Мы делаем это, объявляя параметр типа в сигнатуре функции:
function firstElement<Type>(arr: Type[]): Type | undefined {
  return arr[0];
}
Добавив к этой функции параметр Type и используя его в двух местах, мы создали связь между входными данными функции (массивом) и выходными (возвращаемым значением). Теперь, когда мы ее вызываем, получается более конкретный тип:
// s имеет тип 'string'
const s = firstElement(['a', 'b', 'c']);
// n имеет тип 'number'
const n = firstElement([1, 2, 3]);
// u имеет тип undefined
const u = firstElement([]);

Предположение типа (Inference)

Мы можем использовать несколько параметров типа. Например, самописная версия функции map может выглядеть так:
function map<Input, Output>(
  arr: Input[],
  func: (arg: Input) => Output
): Output[] {
  return arr.map(func);
}

// Параметр 'n' имеет тип 'string'
// 'parsed' имеет тип 'number[]'
const parsed = map(['1', '2', '3'], (n) => parseInt(n));
Обратите внимание, что в приведенном примере TypeScript может сделать вывод относительно типа Input на основе переданного string[], а относительно типа Output на основе возвращаемого number.

Ограничения (constraints)

Ограничение используется для того, чтобы ограничивать типы, которые принимаются параметром типа. Реализуем функцию, возвращающую самое длинное из двух значений. Для этого нам потребуется свойство length, которое будет числом. Мы ограничим параметр типа типом number с помощью ключевого слова extends:
function longest<Type extends { length: number }>(a: Type, b: Type) {
  if (a.length >= b.length) {
    return a;
  } else {
    return b;
  }
}

// longerArray имеет тип 'number[]'
const longerArray = longest([1, 2], [1, 2, 3]);
// longerString имеет тип 'alice' | 'bob'
const longerString = longest('alice', 'bob');
// Ошибка! У чисел нет свойства 'length'
const notOK = longest(10, 100);

// Argument of type 'number' is not assignable to parameter of type '{ length: number; }'.
// Аргумент типа 'number' не может быть присвоен аргументу типа '{ length: number; }'.
В этом примере есть несколько интересных моментов. Мы позволили TypeScript определять возвращаемый тип самого длинного значения. Вывод типа возвращаемого значения также работает с функциями-дженериками. Поскольку мы ограничили Type значением {length: number}, мы смогли получить доступ к свойству .length параметров a и b. Без ограничения типа мы не смогли бы получить доступ к этим свойствам, потому что значения могли быть какого-то другого типа без свойства length. Типы longerArray и longerString были выведены на основе аргументов. Помните, что дженерики — это связывание двух или более значений с одним и тем же типом. Наконец, как мы и хотели, вызов longest(10, 100) ,был отклонен, потому что тип number не имеет свойства .length.

Работа со значениями с ограничениями

Вот распространенная ошибка при работе с ограничениями-дженериками:
function minimumLength<Type extends { length: number }>(
  obj: Type,
  minimum: number
): Type {
  if (obj.length >= minimum) {
    return obj;
  } else {
    return { length: minimum };

    // Type '{ length: number; }' is not assignable to type 'Type'.
    // '{ length: number; }' is assignable to the constraint of type 'Type', but 'Type' could be instantiated with a different subtype of constraint '{ length: number; }'.
  }
}
Может показаться, что с этой функцией все в порядке — Type ограничен до { length: number }, и функция либо возвращает Type, либо значение, соответствующее этому ограничению. Проблема в том, что функция обещает вернуть тот же тип объекта, который был передан, а не просто какой-то объект, соответствующий ограничению. Если бы этот код был работающим, вы могли бы написать код, который не работал бы:
// 'arr' получает значение { length: 6 }
const arr = minimumLength([1, 2, 3], 6);
// и падает, т.к. массив имеет метод 'slice'
// но не возвращаемый объект!
console.log(arr.slice(0));

Определение типа аргументов

TypeScript обычно может вывести предполагаемые аргументы типа в вызове дженерика, но не всегда. Например, вы написали функцию для объединения двух массивов:
function combine<Type>(arr1: Type[], arr2: Type[]): Type[] {
  return arr1.concat(arr2);
}
Обычно было бы ошибкой вызывать эту функцию с несовпадающими массивами:
const arr = combine([1, 2, 3], ['hello']);

// Type 'string' is not assignable to type 'number'.
// Нельзя присвоить тип 'string' типу 'number'.
Однако, если вы намеревались сделать это, вы можете вручную указать Type:
const arr = combine<string | number>([1, 2, 3], ['hello']);

Как написать хорошую функцию-дженерик?

Написание функций-дженериков — это весело, и можно легко увлечься параметрами типа. Наличие слишком большого количества параметров типа или использование ограничений там, где они не нужны, может сделать вывод менее успешным, вызывая разочарование у пользователей функции.

Используйте параметры типа без ограничений

Вот два способа написания функции, которые кажутся похожими:
function firstElement1<Type>(arr: Type[]) {
  return arr[0];
}

function firstElement2<Type extends any[]>(arr: Type) {
  return arr[0];
}

// a: number (хорошо)
const a = firstElement1([1, 2, 3]);
// b: any (плохо)
const b = firstElement2([1, 2, 3]);
На первый взгляд они могут показаться идентичными, но firstElement1 — гораздо лучший способ написать эту функцию. Предполагаемый тип возвращаемого значения — Type, но предполагаемый возвращаемый тип firstElement2any, поскольку TypeScript должен разрешать выражение arr[0] с использованием типа ограничения, а не «ждать» элемент во время вызова. Правило: по возможности используйте сам параметр типа, а не ограничивайте его.

Используйте меньше параметров типа

Вот еще пара похожих функций:
function filter1<Type>(arr: Type[], func: (arg: Type) => boolean): Type[] {
  return arr.filter(func);
}

function filter2<Type, Func extends (arg: Type) => boolean>(
  arr: Type[],
  func: Func
): Type[] {
  return arr.filter(func);
}
Мы создали параметр типа Func, который не связывает два значения. Это всегда красный флаг, потому что это означает, что вызывающие программы, желающие указать аргументы типа, должны вручную указать дополнительный аргумент типа без всякой причины. Func ничего не делает, но затрудняет чтение и осмысление функции! Правило: всегда используйте как можно меньше параметров типа

Параметры типа должны появляться дважды

Иногда мы забываем, что функции не обязательно быть дженериком:
function greet<Str extends string>(s: Str) {
  console.log('Hello, ' + s);
}

greet('world');
Мы могли бы написать более простую версию:
function greet(s: string) {
  console.log('Hello, ' + s);
}
Помните, что параметры типа предназначены для связи типов нескольких значений. Если параметр типа используется только один раз в сигнатуре функции, он ни с чем не связан. Правило: если параметр типа появляется только в одном месте, серьезно подумайте, действительно ли он вам нужен.

Необязательные параметры

Функции в JavaScript часто принимают переменное количество аргументов. Например, метод toFixed для значений типа number принимает необязательное количество цифр:
function f(n: number) {
  console.log(n.toFixed()); // 0 аргументов
  console.log(n.toFixed(3)); // 1 аргумент
}
Мы можем смоделировать это в TypeScript, пометив параметр как необязательный с помощью ?:
function f(x?: number) {
  // ...
}
f(); // OK
f(10); // OK
Хотя параметр указан как типа number, параметр x на самом деле будет иметь тип number | undefined, потому что неуказанные параметры в JavaScript получают значение undefined. Вы также можете указать параметр по умолчанию:
function f(x = 10) {
  // ...
}
Теперь в теле f, x будет иметь тип number, потому что любой неопределенный аргумент будет заменен на 10. Обратите внимание, что, когда параметр является необязательным, вызывающая сторона всегда может передать значение undefined, так как это просто имитирует «отсутствующий» аргумент:
declare function f(x?: number): void;

// все вызовы допустимы
f();
f(10);
f(undefined);

Необязательные параметры в функциях обратного вызова

Мы уже знаем о необязательных параметрах и типизации функциональных выражений. Очень легко сделать следующие ошибки при написании функций, которые вызывают колбеки:
function myForEach(arr: any[], callback: (arg: any, index?: number) => void) {
  for (let i = 0; i < arr.length; i++) {
    callback(arr[i], i);
  }
}
Обычно при написании index? в качестве необязательного параметр разработчики хотят, чтобы оба этих вызова валидными:
myForEach([1, 2, 3], (a) => console.log(a));
myForEach([1, 2, 3], (a, i) => console.log(a, i));
На самом деле это означает, что колбек может быть вызван с одним аргументом. Другими словами, в определении функции сказано, что реализация может выглядеть так:
function myForEach(arr: any[], callback: (arg: any, index?: number) => void) {
  for (let i = 0; i < arr.length; i++) {
    callback(arr[i]);
  }
}
В свою очередь, TypeScript будет применять это значение и выдавать ошибки:
myForEach([1, 2, 3], (a, i) => {
  console.log(i.toFixed());
  // Object is possibly 'undefined'.
  // Объект, возможно, 'undefined'.
});
В JavaScript, если вы вызываете функцию с бОльшим количеством аргументов, лишние аргументы просто игнорируются. TypeScript ведет себя точно так же. Функции с меньшим количеством параметров (одного и того же типа) всегда могут заменить функции с бОльшим количеством параметров. При типизации функции для колбека никогда делайте параметр необязательным, если вы не собираетесь вызывать функцию без передачи этого аргумента.

Перегрузка функций (Function Overloads)

Некоторые функции JavaScript можно вызывать с различным числом аргументов и типами. Например, вы можете написать функцию для создания даты Date, которая принимает отметку времени (один аргумент) или спецификацию месяц/день/год (три аргумента). В TypeScript мы можем указать функцию, которую можно вызывать по-разному, написав сигнатуры перегрузки. Для этого нужно написать несколько сигнатур функции (обычно две или более), а затем тело функции:
function makeDate(timestamp: number): Date;
function makeDate(m: number, d: number, y: number): Date;
function makeDate(mOrTimestamp: number, d?: number, y?: number): Date {
  if (d !== undefined && y !== undefined) {
    return new Date(y, mOrTimestamp, d);
  } else {
    return new Date(mOrTimestamp);
  }
}
const d1 = makeDate(12345678);
const d2 = makeDate(5, 5, 5);
const d3 = makeDate(1, 3);

// No overload expects 2 arguments, but overloads do exist that expect either 1 or 3 arguments.
// Нет перегрузки, ожидающей 2 аргумента, но есть перегрузки, которые ожидают либо 1, либо 3 аргумента.
В этом примере мы написали две перегрузки: одну, принимающую один аргумент, и другую, принимающую три аргумента. Эти первые две сигнатуры называются сигнатурами перегрузки. Затем мы написали реализацию функции с совместимой сигнатурой. Функции имеют сигнатуру реализации, но эту сигнатуру нельзя вызвать напрямую. Несмотря на то, что мы написали функцию с двумя необязательными параметрами после обязательного, ее нельзя вызвать с двумя параметрами!

Сигнатуры перегрузки и сигнатура реализации

Это распространенный источник путаницы. Часто люди пишут такой код и не понимают, почему возникает ошибка:
function fn(x: string): void;
function fn() {
  // ...
}
// Expected to be able to call with zero arguments
// Ожидается, что можно вызвать без аргументов
fn();
// Expected 1 arguments, but got 0.
// Ожидается 1 аргумент, но получено 0.
Сигнатура, используемая для написания тела функции, не может быть использована извне. Сигнатура реализации не видна снаружи. При написании перегруженной функции вы всегда должны иметь две или более сигнатуры над реализацией функции. Сигнатура реализации также должна быть совместима с сигнатурами перегрузки. Например, в этих функциях есть ошибки, потому что сигнатура реализации не соответствует перегруженным версиям должным образом:
function fn(x: boolean): void;
// Неправильный аргумент функции
function fn(x: string): void;
// This overload signature is not compatible with its implementation signature.
// Эта перегрузка сигнатуры не совместима с сигнатурой реализации.
function fn(x: boolean) {}
function fn(x: string): string;
// Неверный возвращаемый тип
function fn(x: number): boolean;
// This overload signature is not compatible with its implementation signature.
// Cигнатура перегрузки не совместима с сигнатурой реализации.
function fn(x: string | number) {
  return 'oops';
}

Как написать хорошую перегрузку

Как и в случае с дженериками, при использовании перегруженных функций следует соблюдать несколько рекомендаций. Следование этим принципам упростит вызов вашей функции, ее понимание и реализацию. Рассмотрим функцию, которая возвращает длину строки или массива:
function len(s: string): number;
function len(arr: any[]): number;
function len(x: any) {
  return x.length;
}
С этой функцией все в порядке; мы можем вызывать ее со строками или массивами. Однако мы не можем вызвать ее со значением, которое может быть строкой или массивом, потому что TypeScript может разрешить вызов функции только для одной перегрузки:
len(''); // OK
len([0]); // OK
len(Math.random() > 0.5 ? 'hello' : [0]);
// No overload matches this call.
//  Overload 1 of 2, '(s: string): number', gave the following error.
//    Argument of type 'number[] | "hello"' is not assignable to parameter of type 'string'.
//      Type 'number[]' is not assignable to type 'string'.
//  Overload 2 of 2, '(arr: any[]): number', gave the following error.
//    Argument of type 'number[] | "hello"' is not assignable to parameter of type 'any[]'.
//     Type 'string' is not assignable to type 'any[]'.
Поскольку обе перегрузки имеют одинаковое количество аргументов и один и тот же тип возвращаемого значения, вместо этого мы можем написать не перегруженную версию функции:
function len(x: any[] | string) {
  return x.length;
}
Так гораздо лучше! Ее можно вызывать со значением любого типа, и в качестве дополнительного бонуса нам не нужно вычислять правильную сигнатуру реализации. Всегда предпочитайте параметры с объединением вместо перегрузок, когда это возможно.

Определение this в функциях

С помощью анализа потока кода TypeScript сделает вывод о том, чем является this:
const user = {
  id: 123,

  admin: false,
  becomeAdmin: function () {
    this.admin = true;
  },
};
TypeScript понимает, что функция user.becomeAdmin имеет соответствующий this, который является объектом user извне. В спецификации JavaScript указано, что у вас не может быть параметра с именем this, TypeScript использует это, чтобы можно было объявить тип для this в теле функции.
interface DB {
  filterUsers(filter: (this: User) => boolean): User[];
}

const db = getDB();
const admins = db.filterUsers(function (this: User) {
  return this.admin;
});
Этот шаблон распространен в API обратного вызова, где другой объект обычно управляет вызовом вашей функции. Обратите внимание, что вам нужно использовать function, а не стрелочные функции, чтобы получить такое поведение:
interface DB {
  filterUsers(filter: (this: User) => boolean): User[];
}

const db = getDB();
const admins = db.filterUsers(() => this.admin);
// The containing arrow function captures the global value of 'this'.
// Стрелочная функция захватывает глобальный `this`.

// Element implicitly has an 'any' type because type 'typeof globalThis' has no index signature.
// Элемент неявно имеет тип 'any' т.к. тип 'typeof globalThis' не имеет сигнатуры.

Другие типы, о которых следует знать

Есть несколько дополнительных типов, которые часто появляются при работе с типами функций. Как и все типы, вы можете использовать их везде, но они особенно актуальны в функциях.

void

void представляет возвращаемое значение функций, которые не возвращают значения. Этот тип выведется из функции, когда функция не имеет операторов return или не возвращает никакого явного значения из этих операторов return:
// Выведенный тип возвращаемого результата void
function noop() {
  return;
}
В JavaScript функция, которая не возвращает никакого значения, неявно вернет значение undefined. Однако void и undefined — это не одно и то же в TypeScript. Дополнительные подробности приведены в конце этой главы.

object

Специальный тип object относится к любому значению, не являющемуся примитивом (string, number, bigint, boolean, symbol, null или undefined). Это отличается от типа пустого объекта { }, а также отличается от глобального типа Object. Очень вероятно, что вы никогда не будете использовать Object. object не является Object. Всегда используйте object! Обратите внимание, что в JavaScript функции являются объектами: у них есть свойства, есть Object.prototype в своей цепочке прототипов, являются instanceof Object, вы можете вызывать для них Object.keys и т.д. По этой причине типы функций считаются object в TypeScript.

unknown

Тип unknown представляет любое значение. Это похоже на тип any, но безопаснее, потому что нельзя ничего делать с неизвестным значением:
function f1(a: any) {
  a.b(); // OK
}
function f2(a: unknown) {
  a.b();
  // Object is of type 'unknown'.
  // Объект типа 'unknown'.
}
Это полезно при описании типов функций, потому что вы можете описывать функции, которые принимают любое значение, не имея значений any в теле вашей функции. И наоборот, вы можете описать функцию, которая возвращает значение типа unknown:
function safeParse(s: string): unknown {
  return JSON.parse(s);
}

// Нужно быть осторожным с 'obj'!
const obj = safeParse(someRandomString);

never

Некоторые функции никогда не возвращают значение:
function fail(msg: string): never {
  throw new Error(msg);
}
Тип never представляет значения, которые никогда не возвращаются. В возвращаемом типе это означает, что функция выдает исключение или завершает выполнение программы. never появляется, когда TypeScript определяет, что в объединении ничего не осталось.
function fn(x: string | number) {
  if (typeof x === 'string') {
    // что-то делаем
  } else if (typeof x === 'number') {
    // что-то делаем еще
  } else {
    x; // имеет тип 'never'!
  }
}

Function

Глобальный тип Function описывает такие свойства, как bind, call, apply и другие, присутствующие во всех значениях функций в JavaScript. Он также имеет специальное свойство, позволяющее вызывать значения типа Function — такие вызовы возвращают any:
function doSomething(f: Function) {
  return f(1, 2, 3);
}
Это нетипизированный вызов функции, и его обычно лучше избегать из-за небезопасного возвращаемого типа any. Если вам нужно принять произвольную функцию без ее вызова, тип () => void, как правило, безопаснее.

Остальные параметры и аргументы (rest)

Остальные параметры

В дополнение к использованию необязательных параметров или перегрузок функций, которые могут принимать множество фиксированных аргументов, мы также можем определить функции, которые принимают неограниченное количество аргументов, используя синтаксис остальных параметров (rest parameters). Остальные параметры появляется после всех остальных параметров и используют синтаксис ...:
function multiply(n: number, ...m: number[]) {
  return m.map((x) => n * x);
}
// 'a' имеет значение [10, 20, 30, 40]
const a = multiply(10, 1, 2, 3, 4);
В TypeScript аннотация типа для этих параметров неявно является any[] вместо any, и любая указанная аннотация типа должна иметь форму Array<T> или T[] или тип кортежа (о котором мы узнаем позже).

Остальные аргументы

И наоборот, мы можем предоставить переменное количество аргументов из массива, используя синтаксис распыления (spread syntax). Например, метод массивов push принимает любое количество аргументов:
const arr1 = [1, 2, 3];
const arr2 = [4, 5, 6];
arr1.push(...arr2);
Обратите внимание, что в целом TypeScript не предполагает, что массивы иммутабельные. Это может привести к неожиданному поведению:
// Предполагаемый тип number[] - массив с двумя или более числами,
// не конкретно с двумя числами
const args = [8, 5];
const angle = Math.atan2(...args);
// A spread argument must either have a tuple type or be passed to a rest parameter.
// Распыленный аргумент должен быть типом кортежа или отправлен как остальные параметры (rest)
Лучшее решение для этой ситуации зависит от вашего кода, но в целом const является наиболее простым решением:
// Представлен как кортеж длины 2
const args = [8, 5] as const;
// OK
const angle = Math.atan2(...args);
Использование остальных аргументов может потребовать включения downlevelIteration если старые среды выполнения являются целевыми.

Деструктуризация параметров (Parameter Destructuring)

Вы можете использовать деструктуризацию параметров для удобной распаковки объектов, предоставленных в качестве аргумента, в одну или несколько локальных переменных в теле функции. В JavaScript это выглядит так:
function sum({ a, b, c }) {
  console.log(a + b + c);
}
sum({ a: 10, b: 3, c: 9 });
Аннотация типа для объекта идет после синтаксиса деструктурирования:
function sum({ a, b, c }: { a: number; b: number; c: number }) {
  console.log(a + b + c);
}
Это может выглядеть немного многословно, но здесь вы также можете использовать именованный тип:
type ABC = { a: number; b: number; c: number };
function sum({ a, b, c }: ABC) {
  console.log(a + b + c);
}

Присваиваемость функций

Возвращаемый тип void

Возвращаемый тип void для функций может привести к необычному, но ожидаемому поведению. Контекстуальная типизация (contextual typing) с возвращаемым типом void не заставляет функции ничего не возвращать. Иными словами, По-другому можно сказать, что функция с возвращаемым типом void (type vf = () => void), при реализации может вернуть любое другое значение, но оно будет проигнорировано. Таким образом, допустимы следующие реализации () => void:
type voidFunc = () => void;

const f1: voidFunc = () => {
  return true;
};

const f2: voidFunc = () => true;

const f3: voidFunc = function () {
  return true;
};
И когда возвращаемое значение одной из этих функций будет присвоено другой переменной, оно сохранит тип void:
const v1 = f1();

const v2 = f2();

const v3 = f3();
Поэтому следующий код валидный, несмотря на то, что Array.prototype.push возвращает number, а метод Array.prototype.forEach ожидает функцию с возвращаемым типом void.
const src = [1, 2, 3];
const dst = [0];

src.forEach((el) => dist.push(el));
Есть еще один особый случай, о котором следует знать, когда литеральное определение функции имеет возвращаемый тип void, эта функция не должна ничего возвращать.
function f2(): void {
  // @ts-expect-error
  return true;
}

const f3 = function (): void {
  // @ts-expect-error
  return true;
};

Продвинутые стратегии при работе с React и TypeScript

год назад·10 мин. на чтение

Создание и обслуживание сложных приложений React и TypeScript требует надежной стратегии. В этой статье мы рассмотрим продвинутые стратегии разработки приложений React и TypeScript, включая архитектуру, тестирование, производительность, процесс разработки, специальные возможности, безопасность и поддержку.

React и TypeScript являются двумя наиболее популярными технологиями, используемыми в современной веб-разработке. Компонентная архитектура React и виртуальный DOM в сочетании с мощной типизацией и удобством сопровождения TypeScript создают мощный дуэт.

Архитектура

Хорошо спроектированная архитектура необходима для создания масштабируемых, поддерживаемых и расширяемых приложений. Продуманная архитектурная стратегия может гарантировать, что ваше приложение остается управляемым по мере его роста и развития с течением времени. Существует несколько архитектурных шаблонов, доступных для приложений React, таких как Flux, Redux и Context API. Каждый шаблон имеет свои сильные и слабые стороны, и выбор будет зависеть от требований вашего приложения и предпочтений вашей команды. При создании приложения TypeScript важно выбрать архитектуру, которая хорошо работает с дополнительным уровнем сложности TypeScript. Многоуровневая архитектура, такая как Domain-Driven Design, может помочь управлять сложностью и обеспечивать разделение задач. Кроме того, модульная архитектура, такая как Micro Frontends, может помочь разбить большие приложения на более мелкие, более управляемые части. Другая архитектурная стратегия заключается в использовании компонентов-контейнеров и презентационных компонентов. Компоненты-контейнеры отвечают за управление состоянием приложения и потоком данных, в то время как презентационные компоненты связаны с отображением пользовательского интерфейса. Такой подход помогает обеспечить разделение задач и упорядочить кодовую базу.
Давайте подробнее рассмотрим пример архитектуры приложения React и TypeScript.
// App.tsx
import React from 'react';
import { BrowserRouter as Router, Switch, Route } from 'react-router-dom';
import { Provider } from 'react-redux';
import store from './store';
import Header from './components/Header';
import Footer from './components/Footer';
import Home from './pages/Home';
import About from './pages/About';
import Contact from './pages/Contact';
import NotFound from './pages/NotFound';

function App() {
  return (
    <Provider store={store}>
      <Router>
        <Header />
        <Switch>
          <Route exact path="/" component={Home} />
          <Route exact path="/about" component={About} />
          <Route exact path="/contact" component={Contact} />
          <Route component={NotFound} />
        </Switch>
        <Footer />
      </Router>
    </Provider>
  );
}
export default App;
В этом примере архитектуры у нас есть компонент контейнера App, который управляет состоянием приложения и потоком данных. Мы используем React Router для управления маршрутизацией приложения и рендеринга различных страниц на основе URL- адреса. Компонент контейнера также заключает все приложение в Provider Redux, который предоставляет доступ к глобальному состоянию приложения. Презентационные компоненты, Header и Footer, связаны с отображением пользовательского интерфейса и получением пропса от компонента контейнера.

Тестирование

Тестирование имеет решающее значение для обеспечения того, чтобы ваш код работал так, как задумано, выявляя ошибки до того, как они попадут в продакшен. Эффективное тестирование требует комплексной стратегии, охватывающей все аспекты приложения, от модульных тестов до интеграционных тестов и end-to-end тестов. Существует несколько фреймворков тестирования и инструментов, доступных для React и TypeScript, таких как Jest, Enzyme и React Testing Library. При тестировании приложений TypeScript важно убедиться, что тесты правильно типизируют код и обнаруживают ошибки, связанные с типами. Модульные тесты должны быть написаны для охвата отдельных функций или компонентов, в то время как интеграционные тесты должны проверять, как различные части приложения работают вместе. End-to-end (e2e) тесты должны имитировать реальные пользовательские сценарии и охватывать все аспекты приложения. Давайте подробнее рассмотрим пример стратегии тестирования для приложения React и TypeScript.
// Example.test.tsx

import React from 'react';
import { render, screen } from '@testing-library/react';
import { Provider } from 'react-redux';
import store from './store';
import Example from './Example';

describe('Example component', () => {
  it('renders correctly', () => {
    render(
      <Provider store={store}>
        <Example />
      </Provider>
    );
    const linkElement = screen.getByText(/Example Component/i);
    expect(linkElement).toBeInTheDocument();
  });
});
В этом примере стратегии тестирования мы используем платформы Jest и React Testing Library для написания модульного теста для компонента Example. Компонент заключен в провайдер Redux Provider, который предоставляет доступ к глобальному состоянию приложения. Функция render используется для рендеринга компонента и предоставления его для тестирования. screen - объект из библиотеки React Testing Library используется для поиска элемента с текстом Example Component. Наконец, функция expect используется для обеспечения того, чтобы элемент находился в документе.

Производительность

Производительность имеет решающее значение для обеспечения быстрого и отзывчивого взаимодействия с пользователем, особенно для более крупных и сложных приложений. Оптимизация производительности должна быть включена в вашу стратегию развития с самого начала. Для React и TypeScript доступно несколько методов оптимизации производительности, таких как отложенная загрузка (ленивая загрузка, lazy loading), разделение кода и мемоизация. При оптимизации производительности приложения TypeScript важно убедиться, что TypeScript используется эффективным и оптимизированным образом. Кроме того, следует проводить регулярное тестирование производительности и профилирование, чтобы убедиться, что оптимизация повышает производительность. Давайте подробнее рассмотрим пример метода оптимизации производительности для приложений React и TypeScript.
// LazyLoadedComponent.tsx

import React, { lazy, Suspense } from 'react';

const LazyLoadedComponent = lazy(() => import('./LazyLoadedComponentImpl'));
function LazyLoadedComponentWrapper() {
  return (
    <Suspense fallback={<div>Loading...</div>}>
      <LazyLoadedComponent />
    </Suspense>
  );
}
export default LazyLoadedComponentWrapper;
В этом примере метода оптимизации производительности мы используем функцию React lazy для ленивой загрузки компонента. Функция lazy принимает функцию, которая возвращает динамический импорт, позволяя загружать компонент только при необходимости. Компонент Suspense используется для предоставления резервного пользовательского интерфейса во время загрузки компонента. Этот метод может помочь улучшить начальное время загрузки приложения за счет уменьшения объема кода, который необходимо загрузить и проанализировать.

Процесс разработки

Эффективный и оптимизированный процесс разработки может помочь вам писать лучший код быстрее и эффективнее. Такие инструменты, как webpack, Babel и ESLint, могут помочь оптимизировать процесс разработки, а системы управления версиями, такие как Git, могут помочь управлять кодом и эффективно взаимодействовать с вашей командой. Гибкие методологии разработки, такие как Scrum, могут помочь оптимизировать процесс разработки, способствовать сотрудничеству и общению, а также более эффективно предоставлять высококачественное программное обеспечение. Регулярные проверки кода и сеансы обмена знаниями также могут помочь поддерживать качество кода и гарантировать, что все члены команды будут в курсе последних разработок. Другим аспектом оптимизированного процесса разработки является автоматизация. Автоматизация повторяющихся задач, таких как построение и развертывание приложения, может помочь сэкономить время и уменьшить количество ошибок. Конвейеры непрерывной интеграции и непрерывной доставки (CI/CD) помогают автоматизировать процесс разработки, позволяя сосредоточиться на написании кода и предоставлении функций.
Давайте подробнее рассмотрим пример процесса разработки для приложения React и TypeScript.
// package.json
{
  "name": "my-app",
  "version": "1.0.0",
  "scripts": {
    "start": "webpack-dev-server --mode development",
    "build": "webpack -mode production",
    "test": "jest",
    "lint": "eslint src",
    "precommit": "lint-staged",
    "deploy": "npm run build && aws s3 sync dist s3://my-bucket -delete"
  },
  "devDependencies": {
    "webpack": "5.64.4",
    "webpack-cli": "4.9.1",
    "webpack-dev-server": "4.6.0",
    "babel-loader": "8.2.3",
    "@babel/core": "7.16.7",
    "@babel/preset-env": "7.16.8",
    "@babel/preset-react": "7.16.7",
    "@babel/preset-typescript": "7.16.7",
    "eslint": "8.6.0",
    "eslint-plugin-react": "7.29.0",
    "eslint-plugin-react-hooks": "4.3.0",
    "jest": "27.4.3",
    "ts-jest": "27.0.5",
    "lint-staged": "12.2.4",
    "husky": "7.0.4"
  },
  "dependencies": {
    "react": "17.0.2",
    "react-dom": "17.0.2",
    "react-redux": "7.2.6",
    "react-router-dom": "6.2.1",
    "redux": "4.1.2",
    "axios": "0.24.0"
  },
  "lint-staged": {
    "*.{js,jsx,ts,tsx}": [
      "eslint --fix",
      "git add"
    ]
  }
}
В этом примере процесса разработки мы используем webpack для объединения нашего кода и Babel для преобразования нашего кода TypeScript в JavaScript. Мы используем Jest для выполнения наших тестов и ESLint для линтинга нашего кода. Скрипт precommit использует lint-staged для запуска ESLint и форматирования нашего кода перед каждым коммитом. Наконец, скрипт deploy создает наше приложение и развертывает его в бакете AWS S3.

Специальные возможности и доступность (Accessibility)

Специальные возможности имеют решающее значение для обеспечения того, чтобы все пользователи, независимо от их возможностей, могли получить доступ к приложению и использовать его. Следует следовать рекомендациям и стандартам по специальным возможностям, таким как Руководство по доступности веб (WCAG), чтобы обеспечить доступность приложения для всех. При разработке приложений React и TypeScript специальные возможности должны быть включены в процесс разработки с самого начала. Такие инструменты, как axe-core, можно использовать для проверки проблем со специальными возможностями и обеспечения соответствия приложения рекомендациям по специальным возможностям. Кроме того, использование семантического HTML и предоставление альтернативного текста для изображений может помочь улучшить специальные возможности вашего приложения. Давайте подробнее рассмотрим пример метода специальных возможностей для приложения React и TypeScript.
// AccessibleButton.tsx

import React, { ButtonHTMLAttributes } from 'react';
interface AccessibleButtonProps extends ButtonHTMLAttributes<HTMLButtonElement> {
  label: string;
}
function AccessibleButton({ label, ...rest }: AccessibleButtonProps) {
  return (
    <button aria-label={label} {...rest}>
      {label}
    </button>
  );
}
export default AccessibleButton;
В этом примере метода специальных возможностей мы используем атрибут aria-label для предоставления метки со специальными возможностями для кнопки. Компонент AccessibleButton принимает проп label и отображает кнопку с атрибутом aria-label. Такой подход гарантирует, что кнопка будет доступна всем пользователям, включая пользователей, использующих программы чтения с экрана.

Безопасность

Безопасность является еще одним важным аспектом продвинутой разработки React и TypeScript. Уязвимости безопасности могут иметь серьезные последствия, начиная от утечек данных и заканчивая простоями приложений. Существует несколько рекомендаций по безопасности, которые следует соблюдать при разработке приложений React и TypeScript, такие как методы безопасного кодирования, валидация ввода и использование HTTPS. При разработке приложений TypeScript важно убедиться, что ваш код написан с учетом безопасности. Распространенные уязвимости системы безопасности, такие как внедрение кода SQL и межсайтовые скрипты (XSS), можно предотвратить с помощью параметризованных запросов и санитизации пользовательского ввода. Кроме того, использование HTTPS может помочь обеспечить шифрование данных при передаче и предотвратить атаки типа man-in-the-middle.
Давайте подробнее рассмотрим пример техники безопасности для приложения React и TypeScript.
// SecureForm.tsx
import React, { useState } from 'react';
import axios from 'axios';

function SecureForm() {
  const [name, setName] = useState('');
  const [email, setEmail] = useState('');
  const handleSubmit = async (event: React.FormEvent<HTMLFormElement>) => {
    event.preventDefault();
    try {
      await axios.post('/api/submit-form', { name, email });
      alert('Form submitted successfully!');
    } catch (error) {
      alert('Error submitting form. Please try again.');
    }
  };
  return (
    <form onSubmit={handleSubmit}>
      <label>
        Name:
        <input
          type="text"
          value={name}
          onChange={(event) => setName(event.target.value)}
        />
      </label>
      <label>
        Email:
        <input
          type="email"
          value={email}
          onChange={(event) => setEmail(event.target.value)}
        />
      </label>
      <button type="submit">Submit</button>
    </form>
  );
}
export default SecureForm;
В этом примере техники безопасности мы используем методы безопасного кодирования и проверки ввода для предотвращения уязвимостей безопасности. Функция handleSubmit очищает и проверяет введенные пользователем данные перед отправкой на сервер. Кроме того, форма отправляется с использованием безопасного протокола HTTPS, чтобы обеспечить шифрование данных при передаче.

Обслуживание и поддержка

Обслуживание большого и сложного приложения React и TypeScript может быть сложной задачей, требующей надежной стратегии обслуживания. Хорошая стратегия обслуживания должна включать регулярные проверки кода, рефакторинг и обновление зависимостей. Проверки кода необходимы для поддержания качества кода и обеспечения соответствия кода стандартам вашей команды. Рефакторинг может помочь улучшить структуру и удобство сопровождения кода, упрощая его изменение и обновление в будущем. Обновление зависимостей может помочь гарантировать, что приложение использует последние и наиболее безопасные версии сторонних библиотек и платформ. Давайте подробнее рассмотрим пример стратегии обслуживания приложений React и TypeScript.
// ExampleComponent.tsx

import React from 'react';
import PropTypes from 'prop-types';

interface ExampleComponentProps {
  text: string;
}
function ExampleComponent({ text }: ExampleComponentProps) {
  return <div>{text}</div>;
}
ExampleComponent.propTypes = {
  text: PropTypes.string.isRequired,
};
export default ExampleComponent;
В этом примере стратегии обслуживания мы используем propTypes для документирования пропса, который ожидает наш компонент. Эта документация может помочь гарантировать, что наш код остается согласованным и поддерживаемым с течением времени. Кроме того, регулярные проверки и рефакторинг кода могут помочь сохранить качество кода и гарантировать, что код соответствует стандартам нашей команды.
Создание и поддержка продвинутых приложений React и TypeScript требует надежной стратегии. Хорошо продуманная архитектура, комплексное тестирование, оптимизация производительности, эффективный процесс разработки, доступность, безопасность и стратегия обслуживания — все это важные компоненты успешной стратегии развития. Следуя этим стратегиям, вы можете гарантировать, что ваше приложение является масштабируемым, обслуживаемым и эффективным, обеспечивая высококачественный пользовательский интерфейс для ваших пользователей. В дополнение к стратегиям, рассмотренным выше, существует множество других продвинутых методов и шаблонов React и TypeScript, которые могут помочь вам создавать лучшие приложения. Некоторые примеры этих методов включают компоненты высшего порядка, render props и контекст. Компоненты высшего порядка (HOC) являются популярным шаблоном в React, который может помочь вам повторно использовать и совместно использовать логику между компонентами. HOC — это функции, которые принимают компонент и возвращают новый компонент с дополнительной функциональностью. Например, можно использовать HOC для добавления проверки подлинности или авторизации компонента. renderProps — еще один популярный шаблон в React, который может помочь вам повторно использовать логику между компонентами. Render props — это функции, которые передаются компоненту в качестве пропса, позволяя компоненту отображать динамическое содержимое. Например, можно использовать рендер проп для рендеринга загружаемого спиннера во время извлечения данных. Контекст — это функциональность в React, которая позволяет передавать данные через дерево компонентов без необходимости вручную передавать проп на каждом уровне. Контекст может быть полезен для передачи данных, таких как тема или предпочитаемый язык, компонентам, которые находятся глубоко в дереве компонентов.
Давайте подробнее рассмотрим пример реализации каждого из этих передовых методов.
// withAuthentication.tsx
import React, { ComponentType } from 'react';

function withAuthentication<T>(WrappedComponent: ComponentType<T>) {
  return function WithAuthentication(props: T) {
    const isAuthenticated = true; // replace with actual authentication logic
    return isAuthenticated ? (
      <WrappedComponent {...props} />
    ) : (
      <div>You must be logged in to view this content.</div>
    );
  };
}
export default withAuthentication;
В этом примере реализации HOC мы используем функцию withAuthentication для добавления проверки подлинности к компоненту. Функция withAuthentication принимает компонент и возвращает новый компонент с дополнительной логикой проверки подлинности. Новый компонент отображает упакованный компонент, если пользователь прошел проверку подлинности, или сообщение о том, что пользователь должен войти в систему в противном случае.
// FetchData.tsx

import React, { useState, useEffect } from 'react';

interface FetchDataProps {
  url: string;
  render: (data: any) => React.ReactNode;
}
function FetchData({ url, render }: FetchDataProps) {
  const [data, setData] = useState(null);
  const [isLoading, setIsLoading] = useState(false);
  const [error, setError] = useState(null);
  useEffect(() => {
    setIsLoading(true);
    fetch(url)
      .then((response) => response.json())
      .then((data) => {
        setData(data);
        setIsLoading(false);
      })
      .catch((error) => {
        setError(error);
        setIsLoading(false);
      });
  }, [url]);
  if (isLoading) {
    return <div>Loading...</div>;
  }
  if (error) {
    return <div>{error.message}</div>;
  }
  return <>{render(data)}</>;
}
export default FetchData;
В этом примере реализации рендер пропса мы используем компонент FetchData для извлечения данных из API и их рендеринга с помощью рендер пропса. Компонент FetchData принимает url, который указывает конечную точку API для извлечения, и render prop который является функцией, которая принимает извлеченные данные и возвращает JSX для рендеринга.
// ThemeContext.tsx
import React from 'react';

export const ThemeContext = React.createContext('light');
export const ThemeProvider = ({ children }: { children: React.ReactNode }) => (
  <ThemeContext.Provider value="dark">{children}</ThemeContext.Provider>
);
В этом примере реализации контекста мы используем ThemeContext для предоставления темы нашему приложению. ThemeContext создается с помощью функции createContext, которая создает новый объект контекста. Компонент ThemeProvider используется для предоставления ThemeContext нашему приложению. ThemeProvider принимает проп children, который представляет собой дерево компонентов, которое должно быть обернуто контекстом темы.
В дополнение к этим передовым методам существует множество других инструментов и библиотек, которые могут помочь вам создавать лучшие приложения React и TypeScript. Вот некоторые примеры этих инструментов:
  • Redux: предсказуемый контейнер состояния для JavaScript приложений.
  • React Router: библиотека для маршрутизации в приложениях React.
  • Styled Components: библиотека для стилизации компонентов React с помощью CSS-in-JS.
  • Formik: библиотека для построения форм в React.
  • Storybook: инструмент для изолированного построения компонентов пользовательского интерфейса.
Используя эти средства и следуя передовым методам и стратегиям React и TypeScript, вы можете создавать лучшие, более масштабируемые и более удобные в обслуживании приложения.

Итоги

Разработка продвинутых приложений на React и TypeScript требует надежной стратегии, которая включает в себя хорошо продуманную архитектуру, всестороннее тестирование, оптимизацию производительности, эффективный процесс разработки, доступность, безопасность и стратегию обслуживания. Следуя этим стратегиям и методам, вы можете создавать лучшие приложения, которые обеспечивают высококачественный пользовательский интерфейс для ваших пользователей. В этой статье мы рассмотрели многие передовые методы и стратегии React и TypeScript, в том числе:
  • Архитектура и состав компонентов
  • Комплексное тестирование
  • Оптимизация производительности
  • Эффективный процесс разработки
  • Доступность
  • Безопасность
  • Поддержка
Кроме того, мы рассмотрели некоторые продвинутые методы React и TypeScript, такие как компоненты высшего порядка, renderProps и контекст, а также некоторые инструменты и библиотеки, которые могут помочь вам создавать лучшие приложения. Внедряя эти методы и стратегии в процесс разработки React и TypeScript, вы можете создавать лучшие приложения, которые являются масштабируемыми, обслуживаемыми и эффективными, обеспечивая высококачественный пользовательский интерфейс для ваших пользователей.