Система модулей TypeScript

Система модулей — основа современной разработки на TypeScript.

TypeScript полностью поддерживает синтаксис ES Module и предоставляет богатые стратегии разрешения модулей.

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


Диаграмма SVG: экспорт/импорт модулей Background Title Module Export/Import Flow user.ts Module user.ts export const name = "Alice" export class User { ... } export interface Config { ... Arrow import main.ts Module main.ts import { name, User } from "./user"; import User from "./user" Arrow use Runtime Output JavaScript Execute Code Lower Section: Export Types Export/Import Methods Method 1 Named Export/Import Method 2 Default Export/Import Method 3 Re-export Method 4 Dynamic Import Arrow Marker

Зачем нужна система модулей

По мере роста масштаба проекта объём кода увеличивается.

Распределение кода по нескольким файлам и организация его через модули улучшает сопровождаемость и переиспользуемость кода.

Система модулей даёт каждому файлу собственную область видимости, предотвращая загрязнение глобальных переменных.

Объяснение концепции:Модуль — это файл TypeScript, содержащий инструкции export и import. Содержимое экспортируется с помощью export и импортируется с помощью import.


Экспорт модуля

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

Модуль user.ts

// Экспорт переменной
export var name = "Alice";
export const age = 25;

// Экспорт функции
export function greet(message: string): string {
    return "Привет, " + message;
}

// Экспорт класса
export class User {
    // Свойства параметров конструктора
    constructor(public name: string) {}

    // Метод самопредставления
    introduce(): string {
        return "Я " + this.name;
    }
}

// Экспорт интерфейса (интерфейсы исчезают после компиляции; используются только для проверки типов)
export interface Config {
    // Настроить хост
    host: string;
    // Настроить порт
    port: number;
}

// Пакетный экспорт: переименование экспортов
export { name as userName, age as userAge };

Примечание:Интерфейсы и типы не генерируют фактический код в скомпилированном JavaScript; они используются только для проверки типов TypeScript.


Импорт модуля

Используйте ключевое слово import, чтобы импортировать экспортированное содержимое из других модулей.

main.ts Импорт модуля

// Именованный импорт: импорт конкретного содержимого из модуля
import { name, age, greet } from "./user";

// Импорт по умолчанию: импорт экспорта по умолчанию модуля
import User from "./user";

// Импорт всего: поместить все экспорты модуля в объект
import * as UserModule from "./user";

// Переименование импорта: избежать конфликтов имён
import { greet as sayHello } from "./user";

// Использовать импортированное содержимое
console.log(greet("World"));
console.log(sayHello("TypeScript"));

Вывод:

Hello, World
Hello, TypeScript

Объяснение пути:Пути импорта могут быть относительными путями (например,./user) или абсолютными путями (например,@/utils)。


Экспорт по умолчанию

Каждый модуль может иметь один экспорт по умолчанию.

Экспорты по умолчанию не требуют фигурных скобок при импорте, и им можно дать любое имя.

Модуль math.ts

// Экспорт по умолчанию: у модуля может быть только один экспорт по умолчанию
export default function add(a: number, b: number): число {
    return a + b;
}

// Можно смешивать с другими экспортами
export function multiply(a: number, b: number): число {
    return a * b;
}

Импорт main.ts

// Импорт экспорта по умолчанию: можно использовать любое имя
import add from "./math";

// Импорт именованного экспорта: требуются фигурные скобки
import { multiply } from "./math";

console.log("Сложение: " + add(2, 3));
console.log("Умножение: " + multiply(4, 5));

Вывод:

加法: 5
乘法: 20

Рекомендация:Используйте экспорт по умолчанию для основного экспортируемого содержимого, такого как служебные функции и классы; используйте именованный экспорт для вспомогательных функций, интерфейсов и т. д.


Реэкспорт

Реэкспорт используется для агрегирования содержимого из нескольких модулей или предоставления экспорта одного модуля другому модулю.

index.ts Агрегирующий модуль

// Реэкспорт конкретного содержимого из других модулей
export { name, age } from "./user";

// Реэкспорт экспорта по умолчанию (требуется переименование)
export { default as User } from "./user";

// Реэкспортировать всё содержимое
export * from "./math";

Сценарии использования:Используйте index.ts в качестве входного файла для централизованного экспорта содержимого дочерних модулей для унифицированного импорта.


Стратегии разрешения модулей

TypeScript предоставляет несколько стратегий разрешения модулей для поиска импортируемых модулей.

Это можно настроить в tsconfig.json.

Конфигурация tsconfig.json

{
    "compilerOptions": {
        // Стратегия разрешения Node
        // Следует правилам разрешения модулей Node.js
        "moduleResolution": "node",

        // Классическая стратегия разрешения
        // Стратегия, использовавшаяся в ранних версиях TypeScript
        "module": "classic",

        // базовый URL
        // Все импорты с неотносительными путями разрешаются на основе этого пути
        "baseUrl": "./src",

        // Сопоставление путей: задаёт псевдонимы для путей импорта
        "paths": {
            // Импорты, начинающиеся с @, сопоставляются с каталогом src
            "@/*": ["./*"],
            // Импорты, начинающиеся с @components, сопоставляются с каталогом components
            "@components/*": ["./components/*"]
        }
    }
}

Рекомендация по конфигурации:Для новых проектов рекомендуется стратегия разрешения Node, так как в настоящее время это наиболее часто используемый подход.


Динамический импорт

Динамический импорт использует синтаксис import() для загрузки модулей по требованию во время выполнения.

Это очень полезно для разделения кода и ленивой загрузки.

Пример

// Динамический импорт - ленивая загрузка
// import() возвращает Promise
async function loadMath() {
    // Динамически импортируем модуль; он загружается только при достижении этой точки выполнения
    var math = await import("./math");

    // math.default — это функция, экспортируемая по умолчанию
    console.log("Динамическое сложение: " + math.default(1, 2));
}

// Вызов лениво загруженной функции
loadMath();

// Условный импорт: динамически загружаем разные модули в зависимости от условий
async function loadFeature(enable: boolean) {
    if (enable) {
        // Загружать модуль только при выполнении условия
        var feature = await import("./feature");
        feature.run();
    }
}

// Загрузка по условию
loadFeature(true);

Вывод:

动态加法: 3

Оптимизация производительности:Динамические импорты обеспечивают разделение кода, загружая дополнительный код только при необходимости, сокращая время начальной загрузки.


Примечания

  • Относительные пути:Используйте относительные пути для импорта локальных модулей (./, ../)
  • Расширения модулей:TypeScript автоматически обрабатывает расширения во время компиляции
  • По умолчанию или именованные:Один экспорт по умолчанию на модуль, несколько именованных экспортов
  • esModuleInterop:Включение этой опции упрощает импорт модулей CommonJS

Лучшие практики:Поддерживайте согласованность путей импорта, используйте псевдонимы путей для упрощения длинных путей и создайте чёткую структуру организации модулей.


Итог

Модульная система — основа организации проекта TypeScript.

  • export:Экспорт переменных, функций, классов, интерфейсов
  • import:Импорт экспортированного содержимого
  • Экспорт по умолчанию:Один на модуль, гибко использовать
  • Реэкспорт:Агрегирование модулей, создание входных файлов
  • Динамический импорт:Ленивая загрузка, оптимизация производительности
  • Разрешение модулей:Настройка псевдонимов путей и стратегий разрешения

Рекомендация:Разумно организуйте структуру модулей, используйте псевдонимы путей для упрощения импорта и установите чёткие соглашения об экспорте/импорте.

Другие расширения