Spec-Zone.ru › Angular.js 1.7

Улучшить эту документацию Просмотреть исходный код $injector

  1. сервис в модуле auto

Обзор

$injector используется для получения экземпляров объектов, определенных провайдером, создания экземпляров типов, вызова методов и загрузки модулей.

Следующее всегда верно:

var $injector = angular.injector();
expect($injector.get('$injector')).toBe($injector);
expect($injector.invoke(function($injector) {
  return $injector;
})).toBe($injector);

Аннотация функций инъекции

В JavaScript нет аннотаций, а для инъекции зависимостей они необходимы. Ниже приведены все допустимые способы аннотации функций с аргументами инъекции, которые эквивалентны.

// inferred (only works if code not minified/obfuscated)
$injector.invoke(function(serviceA){});

// annotated
function explicit(serviceA) {};
explicit.$inject = ['serviceA'];
$injector.invoke(explicit);

// inline
$injector.invoke(['serviceA', function(serviceA){}]);

Вывод

В JavaScript вызов toString() функции возвращает определение функции. Затем определение можно проанализировать, и можно извлечь аргументы функции. Этот метод обнаружения аннотаций запрещен, когда инжектор находится в режиме строгости. ПРИМЕЧАНИЕ: Это не работает с минификацией и инструментами обфускации, поскольку эти инструменты изменяют имена аргументов.

Аннотация $inject

Добавив свойство $inject к функции, можно указать параметры инъекции.

Встроенный

В виде массива имен инъекции, где последний элемент массива — вызываемая функция.

Методы

  • get(name, [caller]);

    Возвращает экземпляр сервиса.

    Параметры

    Параметр Тип Подробности
    name string

    Имя экземпляра для получения.

    caller
    (необязательно)
    string

    Необязательная строка, указывающая источник вызова функции для сообщений об ошибках.

    Возвращаемое значение

    *

    Экземпляр.

  • invoke(fn, [self], [locals]);

    Вызывает метод и предоставляет аргументы метода из $injector.

    Параметры

    Параметр Тип Подробности
    fn function()Array.<(string|function())>

    Функция инъекции для вызова. Параметры функции вводятся в соответствии с правилами аннотации $inject Annotation.

    self
    (необязательно)
    Object

    this для вызываемого метода.

    locals
    (необязательно)
    Object

    Необязательный объект. Если он задан, имена аргументов сначала считываются из этого объекта, а затем из $injector.

    Возвращаемое значение

    *

    Значение, возвращаемое вызываемой fn функцией.

  • has(name);

    Позволяет пользователю запросить наличие конкретного сервиса.

    Параметры

    Параметр Тип Подробности
    name string

    Имя сервиса для запроса.

    Возвращаемое значение

    boolean

    true если инжектор имеет указанный сервис.

  • instantiate(Type, [locals]);

    Создаёт новый экземпляр типа JS. Метод принимает конструкторскую функцию, вызывает оператор new и предоставляет все аргументы конструкторской функции, как указано в аннотации конструктора.

    Параметры

    Параметр Тип Подробности
    Type Function

    Аннотированная конструкторская функция.

    locals
    (необязательно)
    Object

    Необязательный объект. Если он задан, имена аргументов сначала считываются из этого объекта, а затем из $injector.

    Возвращаемое значение

    Object

    новый экземпляр Type.

  • annotate(fn, [strictDi]);

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

    Имена аргументов

    Самый простой способ — извлечь зависимости из аргументов функции. Это делается путём преобразования функции в строку с помощью toString() метода и извлечения имён аргументов.

    // Given
    function MyController($scope, $route) {
      // ...
    }
    
    // Then
    expect(injector.annotate(MyController)).toEqual(['$scope', '$route']);
    

    Вы можете запретить этот метод, используя строгий режим инъекции.

    Этот метод не работает с минификацией/обфускацией кода. По этой причине поддерживаются следующие стратегии аннотации.

    Свойство $inject

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

    // Given
    var MyController = function(obfuscatedScope, obfuscatedRoute) {
      // ...
    }
    // Define function dependencies
    MyController['$inject'] = ['$scope', '$route'];
    
    // Then
    expect(injector.annotate(MyController)).toEqual(['$scope', '$route']);
    

    Запись в виде массива

    Часто желательно встроенный вызов функций инъекций, и в этом случае установка свойства $inject неудобна. В таких ситуациях использование записи в виде массива для указания зависимостей, которая сохраняется при минификации, является лучшим выбором:

    // We wish to write this (not minification / obfuscation safe)
    injector.invoke(function($compile, $rootScope) {
      // ...
    });
    
    // We are forced to write break inlining
    var tmpFn = function(obfuscatedCompile, obfuscatedRootScope) {
      // ...
    };
    tmpFn.$inject = ['$compile', '$rootScope'];
    injector.invoke(tmpFn);
    
    // To better support inline function the inline annotation is supported
    injector.invoke(['$compile', '$rootScope', function(obfCompile, obfRootScope) {
      // ...
    }]);
    
    // Therefore
    expect(injector.annotate(
       ['$compile', '$rootScope', function(obfus_$compile, obfus_$rootScope) {}])
     ).toEqual(['$compile', '$rootScope']);
    

    Параметры

    Параметр Тип Подробности
    fn function()Array.<(string|function())>

    Функция, для которой требуются имена зависимых сервисов, как описано выше.

    strictDi
    (необязательно)
    boolean

    Запретить вывод аннотации имен аргументов.

    (по умолчанию: false)

    Возвращаемое значение

    Array.<string>

    Имена сервисов, которые требуются функции.

  • loadNewModules([mods]);

    Это опасный API, используйте его на свой страх и риск!

    Добавляет указанные модули в текущий инжектор.

    Этот метод добавит каждый из инъектов в инжектор и выполнит все блоки config и run для каждого модуля, переданного в метод.

    Если модуль уже загружен в инжектор, он не будет загружен повторно.

    • Разработчик приложения отвечает за загрузку кода, содержащего модули, и за обеспечение того, чтобы ленивые скрипты не загружались и не выполнялись чаще, чем нужно.
    • Ранее скомпилированный HTML не будет затронут вновь загруженными директивами, фильтрами и компонентами.
    • Модули нельзя выгрузить.

    Вы можете использовать $injector.modules для проверки того, загружен ли модуль в инжектор, что может указать на то, что скрипт уже был выполнен.

    Параметры

    Параметр Тип Подробности
    mods
    (необязательно)
    Array<String|Function|Array>=

    массив модулей для загрузки в приложение. Каждый элемент массива должен быть именем предварительно определенного модуля или (аннотированной с помощью DI) функцией, которая будет вызвана инжектором как блок config. См.: модули

    Пример

    Вот пример загрузки набора модулей с помощью утилитарного метода, называемого getScript:

    app.factory('loadModule', function($injector) {
      return function loadModule(moduleName, bundleUrl) {
        return getScript(bundleUrl).then(function() { $injector.loadNewModules([moduleName]); });
      };
    })
    

Свойства

  • modules

    Хеш-таблица, содержащая все модули, которые были загружены в $injector.

    Вы можете использовать это свойство для получения информации о модуле с помощью метода myModule.info(...).

    Например:

    var info = $injector.modules['ngAnimate'].info();
    

    Не используйте это свойство для попыток изменить модули после запуска приложения.

© 2010–2018 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://code.angularjs.org/1.7.8/docs/api/auto/service/$injector

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API