Модуль проти простору імен - Імпортувати та вимагати написання сценарію


102

Я отримую багато плутанини module/namespace/exportі import, require, referenceвикористання. Будучи з фону Java, чи може хтось пояснити мені в двох словах, коли використовувати який і який правильний дизайн? Я відчуваю, що псуюся, коли пишу зразок проекту

Поки це моє розуміння 1. moduleпризначено для зовнішніх пакетів 2. namespaceдля внутрішніх пакетів

  • Я не зрозумів, як їх класифікувати?
  • Коли експортувати клас чи простір імен чи пакет?
  • Якщо ми експортуємо пакет / простір імен, всі класи, що експортуються, або повинні бути явно експортовані
  • Як кожен з них можна імпортувати / вимагати?

За словами doc , якщо я створюю кожен файл "ts" для кожного менеджера / моделі, Typescript не рекомендує використовувати "простори імен"? Безпосередньо використовувати опорні шляхи?

Будь ласка, поясніть докладно, як я приїжджаю з іншого походження та не впевнений у ES6 / ES5 тощо.

Я бачив, як кілька людей піднімаються / плутаються в одних і тих же питаннях. Сподіваюся, хтось може детально пояснити сценарій реального світу


це багато уваги, яке відповідає на ваше запитання, не впевнений, чому він надихнувся
— Dan Pantry

@DanPantry, перед початком щедрості не було однозначної відповіді :(
— Reddy

моя помилка - я не порівнював часові позначки.
— Ден Комора

Відповіді:


80

Я не зрозумів, як їх класифікувати?

Простори імен використовуються для організації / інкапсуляції вашого коду. Зовнішні модулі використовуються для організації / інкапсуляції вашого коду І для пошуку коду під час виконання. На практиці у вас є два варіанти під час виконання: 1) поєднати весь перекладений код в один файл, або 2) використовувати зовнішні модулі, мати декілька файлів і вимагати деякого іншого механізму, щоб отримати ці файли.

Коли експортувати клас чи простір імен чи пакет?

Щоб зробити тип або значення видимими поза файлом, у якому він знаходиться, його потрібно експортувати, якщо він знаходиться в просторі імен. Якщо ви експортуєте його на верхньому рівні чи в просторі імен, вирішите, чи тепер він знаходиться у зовнішньому модулі.

Якщо ми експортуємо пакет / простір імен, всі класи, що експортуються, або повинні бути явно експортовані

Класи в просторі імен завжди повинні бути явно експортовані для того, щоб клас був видимим під час компіляції поза файлом, у якому він визначений.

Як кожен з них можна імпортувати / вимагати?

Це залежить від того, якщо ви використовуєте зовнішні модулі. Зовнішній модуль завжди потрібно імпортувати, щоб "використовувати" його. Імпорт простору імен, який не знаходиться у зовнішньому модулі, насправді просто надає псевдонім для простору імен - вам все одно потрібно встановити префікс типу / що завгодно з псевдонімом (і саме тому ви зазвичай не бажаєте використовувати простори імен із зовнішніми модулями; це означає, що вам завжди потрібно використовувати префікс при посиланні на все, що надається зовнішнім модулем.) Простори імен, які не є у зовнішньому модулі, можуть охоплювати файли, тому якщо ви знаходитесь в одному просторі імен, ви можете звернутися до всього, що експортується простір імен без необхідності будь-якого імпорту.

Щоб реально зрозуміти вищесказане, потрібні основні знання. Головне, що потрібно розуміти з посиланнями / просторами імен / зовнішніми модулями, - це те, що ці конструкції роблять під час компіляції та що вони роблять під час виконання.

Довідкові директиви використовуються під час компіляції для пошуку інформації про тип. У вашому джерелі є певний символ. Як компілятор TypeScript знаходить визначення цього символу? Довідкова директива значною мірою поширюється механізмом tsconfig.json - використовуючи tsconfig.json, ви повідомляєте компілятору, де всі ваші джерела.

Простори імен можуть містити визначення типів та / або реалізацію. Якщо простір імен містить лише інформацію про тип, то він взагалі не має проявів виконання - ви можете перевірити це, подивившись на вихід JS та знайдіть порожній файл JS. Якщо у просторі імен є код реалізації, то код загортається всередину закриття, яке присвоюється глобальній змінній з тим самим іменем, що і простір імен. З вкладеними просторами імен з'явиться глобальна змінна для простору імен кореня. Ще раз перевірте вихід JS. Простори імен - це історично те, як бібліотеки на стороні клієнта JS намагалися уникнути проблеми із зіткненнями імен. Ідея полягає в тому, щоб згорнути всю вашу бібліотеку в одне закриття, а потім виставити якомога менший глобальний слід - лише одну глобальну змінну, що посилається на закриття. Ну, проблема все ще полягає в тому, що ви заявили ім’я в глобальному просторі. Що робити, якщо ви хотіли, скажімо, двох версій бібліотеки? У просторі імен TypeScript все ще виникає питання про те, як знайти джерело для простору імен. Тобто у вихідному коді, на який посилається AB, все ще виникає проблема сказати компілятору, як знайти AB - або за допомогою довідкових директив, або за допомогою tsconfig.json. Або помістивши простір імен у зовнішній модуль, а потім імпортуючи зовнішній модуль.

Зовнішні модулі походять із JS на стороні сервера. Між зовнішнім модулем і файлом у файловій системі існує відповідність один одному. Ви можете використовувати структуру каталогів файлової системи для організації зовнішніх модулів у вкладену структуру. Імпорт зовнішнього модуля, як правило, завжди вводить залежність від цього зовнішнього модуля (виняток - коли ви імпортуєте зовнішній модуль, але потім не використовуєте жоден його експорт у позиційній позиції - тобто ви імпортуєте лише зовнішній модуль отримати інформацію про його тип). Зовнішній модуль неявно перебуває у закритті, і це важливо: користувач модуля може призначити закриття будь-якій локальній змінній, яку вони хочуть. TypeScript / ES6 додає додатковий синтаксис навколо відображення експорту зовнішніх модулів до локальних імен, але це лише суть. На стороні сервера, розміщення зовнішнього модуля відносно прямо: просто знайдіть файл, що представляє зовнішній модуль, у локальній файловій системі. Якщо ви хочете використовувати зовнішні модулі на стороні клієнта, у браузері він стає складнішим, оскільки немає еквівалента файловій системі, яка має модуль для завантаження. Тож тепер на стороні клієнта вам потрібен спосіб зв'язати всі ті файли у форму, яку можна віддалено використовувати у браузері - саме тут вбудовані модулі типу Webpack (хоча Webpack робить чорт набагато більше, ніж модулі пакетів) і Перегляньте, вступайте в гру. Модулі постачальників дозволяють виконувати роздільну здатність зовнішніх модулів у браузері. у браузері він стає складнішим, оскільки немає еквівалента файловій системі, яка має модуль для завантаження. Тож тепер на стороні клієнта вам потрібен спосіб зв'язати всі ці файли у форму, яку можна віддалено використовувати у браузері - саме тут вбудовані модулі типу Webpack (хоча Webpack робить чорт набагато більше, ніж модулі пакетів) і Перегляньте, вступайте в гру. Модулі постачальників дозволяють виконувати роздільну здатність зовнішніх модулів у браузері. у браузері він стає складнішим, оскільки немає еквівалента файловій системі, яка має модуль для завантаження. Тож тепер на стороні клієнта вам потрібен спосіб зв'язати всі ці файли у форму, яку можна віддалено використовувати у браузері - саме тут вбудовані модулі типу Webpack (хоча Webpack робить чорт набагато більше, ніж модулі пакетів) і Перегляньте, вступайте в гру. Модулі постачальників дозволяють виконувати роздільну здатність зовнішніх модулів у браузері.

Реальний сценарій: AngularJS. Прикиньте зовнішні модулі не існують, використовуйте єдиний простір імен для обмеження забруднення глобального простору (у прикладі нижче однієї змінної MyApp є все, що є у глобальному просторі), експортуйте лише інтерфейси та використовуйте AngularJS-залежність-injection для здійснення реалізацій доступний для використання. Покладіть всі класи в корінь каталогів, додайте tsconfig.json до кореня, встановіть типи angularjs під тим же коренем каталогу, щоб tsconfig.json також підбирав його, поєднував увесь вихідний файл в один JS-файл. Це буде добре для більшості проектів, якщо повторне використання коду не викликає особливих проблем.

MyService.ts:

namespace MyApp {

    // without an export the interface is not visible outside of MyService.ts
    export interface MyService { 
        ....
    }

    // class is not exported; AngularJS DI will wire up the implementation
    class MyServiceImpl implements MyService {
    }

    angular.module("MyApp").service("myService", MyServiceImpl);
}

MyController.ts:

namespace MyApp {

   class MyController {
       // No import of MyService is needed as we are spanning 
       // one namespace with multiple files.
       // MyService is only used at compile time for type checking. 
       // AngularJS DI is done on the name of the variable. 
       constructor(private myService: MyService) { 
       }
   }
   angular.module("MyApp").controller("myController", MyController);
}

Використання IIFE, щоб уникнути забруднення глобальної області виконання. У цьому прикладі взагалі не створюються глобальні змінні. (Передбачається tsconfig.json.)

Foo.ts:

namespace Foo {
    // without an export IFoo is not visible. No JS is generated here
    // as we are only defining a type.
    export interface IFoo {
        x: string;
    }
}

interface ITopLevel {
    z: string;
}

(function(){
    // export required above to make IFoo visible as we are not in the Foo namespace
    class Foo1 implements Foo.IFoo {
        x: string = "abc";
    }
    // do something with Foo1 like register it with a DI system
})();

Bar.ts:

// alias import; no external module created
import IFoo = Foo.IFoo;

(function() {

    // Namespace Foo is always visible as it was defined at
    // top level (outside of any other namespace).
    class Bar1 implements Foo.IFoo {
        x: string;
    }

    // equivalent to above
    class Bar2 implements IFoo {
        x: string;
    }

    // IToplevel is visible here for the same reason namespace Foo is visible
    class MyToplevel implements ITopLevel {
        z: string;
    }

})();

Використовуючи IIFE, ви можете усунути введення MyApp як глобальної змінної у першому прикладі.

MyService.ts:

interface MyService { 
    ....
}

(function() {

    class MyServiceImpl implements MyService {
    }

    angular.module("MyApp").service("myService", MyServiceImpl);
})();

MyController.ts:

(function() { 

   class MyController { 
       constructor(private myService: MyService) { 
       }
   }

   angular.module("MyApp").controller("myController", MyController);
})();

30

Є дві речі:

  • Модуль в друкованому є стандартним ES6 поняття, вона використовує import/ exportключові слова на верхньому рівні коду;
  • Простори назв є поняття специфічні для машинопису , щоб допомогти організувати код в застарілої моді.

Простори імен

Це майже застаріле поняття. До модулів ES6 загальним способом розділення коду JavaScript в браузері було створення глобальних змінних. Наприклад, усі функції такого API, як підкреслення, знаходились у глобальній змінній з назвою _.

Цей старий спосіб продовжити подібно пакетам Java або просторам імен PHP. Він не адаптований до мережі Інтернет. Новий стандарт ECMAScript вирішує такі питання: як використовувати дві бібліотеки з однаковою назвою? Як використовувати дві різні версії однієї бібліотеки?

Примітка: У версіях TypeScript до визначення ECMAScript "модулів" (літо 2014 р.) Простори імен називали "внутрішні модулі", а модулі називали "зовнішніми модулями".

Примітка 2. Ключове слово exportвсередині а namespace- це нестандартне використання ключового слова TypeScript. Це засіб оголосити те, що є загальнодоступним за межами простору імен.

Модулі ES6

Модуль - це файл, який містить ключові слова importабо exportна верхньому рівні коду.

TypeScript слідує стандарту ECMAScript. Я пропоную прочитати гарне вступ до модулів ES6 у статті Mozilla.

Якщо ви хочете використовувати модулі в прикладній програмі (у браузері), тоді вам доведеться скористатися пакетним пакетом ( Webpack [ тут документація ], Browserify) або завантажувачем ( SystemJS [ тут навчальний посібник ], RequireJS) та налаштувати TypeScript з цим середовищем.

Якщо ваш код виконується в Node.js, просто налаштуйте компілятор TypeScript для створення формату CommonJS.

Примітка. У модулі може бути оголошено простір імен. У цьому випадку вона не буде доступною як глобальна змінна поза модулем. Однак його можна експортувати з модуля.


Чи не компілятор машинопису автоматично поєднує модулі в один файл .js?
— Кокодоко

@ Кокодоко, ні. Це може просто об'єднатися.
— Палео

Ем ... в чому різниця? .... Я використовую модулі та лише tsc для створення одного єдиного .js-файлу. Мені не потрібно використовувати systemJS, webpack або переглядати веб-переглядачі.
— Кокодоко

1
@Kokodoko Ви маєте рацію! Моє ліжко! Здається, компілятор TypeScript може створити пакет з TS 1.8 , я пропустив цю функцію.
— Палео

Це було сказано ... Мої модулі збираються, але не виконуються після SystemJS.import ('/ js / main.js'); Будь-яка ідея, як "запустити" додаток?
— Кокодоко

13
  1. модуль призначений для зовнішніх пакунків 2. Простір імен призначений для внутрішніх пакетів

Насправді moduleключове слово було замінено на namespaceключове слово.

Краще твердження, таким чином, Модулі - це те, що раніше називалося зовнішніми модулями, простір імен - це те, що раніше називалося внутрішніми модулями.

Більше

Сподіваюся, що це допомагає краще: https://basarat.gitbooks.io/typescript/content/docs/project/modules.html


8
Вибачте, повідомляйте, питання не відповідають. Я очікував детально пояснити на прикладі реального світу, а не з визначенням підручника.
— Редді

Ви маєте на увазі, що зараз у TypeScript немає модульної клавіатури?
— Мохаммед Кермані

7

" вимагати " та " імпортувати " еквівалентні за функціональністю. ми можемо використовувати їх як взаємозамінні, оскільки у нас є транспілятори, яким не байдуже, підтримує їх веб-переглядач чи ні. але, хоча « вимагає » коріння у старому стилі кодування, що надходить із CommonJS ще у 2009 році, «імпорт» походить із синтаксису із загальноприйнятого синтаксису ES6 (ES2015). тому слід використовувати " імпорт " для нових проектів, а не " вимагати ".


1
Саме так. Так заплутано, і так мало інформації про нього, що це в основному те саме. Цікаво, чому це було проголосовано?
— Шай Петел

0

Іменування плутанини

У перші дні Typescript простори імен називали внутрішніми модулями, а модулі ES6 називали зовнішніми .

Тепер для оголошення просторів імен команда Typescript рекомендує використовувати namespace { }замість module { }синтаксису, щоб уникнути плутанини імен із зовнішніми модулями. Тому що зовнішні модулі тепер просто "модулі", а внутрішні - "простори імен".


Простори імен

Декларація

Простір імен в Typescript можна оголосити за допомогою namespaceабо moduleключового слова. Обидва ключові слова роблять те саме. Тоді ми можемо вирішити, яку частину нашого простору імен оприлюднити за допомогою exportключового слова.

// LivingThings.ts
export namespace Animals {
    export class Dog { }
    export class Cat { }
}
export namespace Plants {
    export class Orchid { }
    export class Bamboo { }
}

// LivingThingsUser.ts
import { Animals, Plants } from "./LivingThings"

Логічне групування

Перед ES6 простори імен використовувались у Typescript для інкапсуляції інтерфейсів, класів, функцій та змінних для підтримки групи відповідних функціональних можливостей та приховування деталей реалізації. Таким чином ми могли запобігти проникненню змінних у глобальний простір. Це допомогло покращити організацію коду та запобігти зіткнення імен. Тепер для цього рекомендується використовувати модулі ES6.

Простори імен тепер використовуються для зовнішнього оголошення імен.

Використання одного файлу

Ми можемо оголосити простори імен для кількох файлів, і їх можна об'єднати за допомогою --outFileпрапора. Потім ми можемо використовувати цей зв'язаний файл всередині <script>тегу на нашій HTML-сторінці. Це дозволяє нам добре структурувати наш код у веб-додатку на стороні клієнта з урахуванням усіх залежностей.


Модулі

Декларація

Модулі також називаються модулями ES6. Ми використовуємо кілька файлів для групування відповідних функцій і просто використовуємо exportключове слово, щоб зробити бажаний об’єкт загальнодоступним.

// Animals.ts
export class Dog { }
export class Cat { }

// Plants.ts
export class Orchid { }
export class Bamboo { }

// LivingThingsUser.ts
import { Dog, Cat } from "./Animals"
import { Orchid, Bamboo } from "./Plants"

Логічне групування

Логічне групування в модулях досягається використанням окремих файлів для групування відповідних функцій. З цієї причини зовнішні модулі також називаються файловими модулями .

Використання одного файлу

Ми не завантажуємо модулі клієнтської веб-програми за допомогою <script>тегу, тому що браузери можуть мляво під час завантаження такої кількості файлів і одночасно рендерінгу сторінки. Для цього ми використовуємо завантажувачі модулів типу CommonJS, AMD, SystemJS, які дозволяють нам завантажувати файли асинхронно або об'єднувати файли зовнішнього модуля в один оптимізований файл.

На стороні сервера, особливо в Node.js, модулі настійно рекомендуються.

Це воно!

Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.