Looking for requirejs Answers? Try Ask4KnowledgeBase
Looking for requirejs Keywords? Try Ask4Keywords

requirejsRozpoczęcie pracy z RequJS


Uwagi

RequireJS to implementacja interfejsu API modułu asynchronicznego (AMD) służącego do asynchronicznego ładowania plików javascript (tj. Bez blokowania) i zarządzania zależnościami między wieloma plikami javascript. Zawiera także narzędzie optymalizujące do łączenia i minimalizowania plików skryptów do wdrożenia, pozwalając jednocześnie deweloperowi zachować logicznie oddzielny kod.

Witaj świecie

Poniższy przykład demonstruje podstawową instalację i konfigurację RequireJS.

Utwórz nowy plik HTML o nazwie index.html i wklej następującą treść:

<!DOCTYPE html>
<html lang="en">
<head>
    <title>Hello RequireJS</title>
    <script type="text/javascript" src="http://requirejs.org/docs/release/2.3.2/minified/require.js"></script>
</head>
<body>
    <!-- place content here --->
    <script>
        requirejs(["scripts/say"], function(say) {
            alert(say.hello());
        });
    </script>
</body>
 

Utwórz nowy plik JS w scripts/say.js i wklej następującą treść:

define([], function(){
    return {
        hello: function(){
           return "Hello World";
        }
    };
});
 

Struktura projektu powinna wyglądać następująco:

- project
    - index.html
    - scripts
        - say.js
 

Otwórz plik index.html w przeglądarce, a wyświetli ostrzeżenie „Hello World”.


Wyjaśnienie

  1. Załaduj plik skryptu wymaganego.js.

    <script type="text/javascript" src="http://requirejs.org/docs/release/2.3.2/minified/require.js"></script>
     
  2. Załaduj moduł say asynchronicznie z folderu scripts . (Pamiętaj, że nie potrzebujesz rozszerzenia .js podczas odwoływania się do modułu.) Zwrócony moduł jest następnie przekazywany do podanej funkcji, w której wywoływane jest hello() .

    <script>
       requirejs(["scripts/say"], function(say) {
           alert(say.hello());
       });
    </script>
     
  3. Moduł say zwraca pojedynczy obiekt z jedną funkcją hello zdefiniowaną.

    define([], function(){
        return {
            hello: function(){
               return "Hello World";
            }
        };
    });
     

Hello World with Nested Dependencies

Poniższy przykład rozwija się w Hello World , pokazując wiele zależności za pomocą funkcji define() .

Utwórz nowy plik HTML o nazwie index.html i wklej następującą treść:

<!DOCTYPE html>
<html lang="en">
<head>
    <title>Hello RequireJS</title>
    <script type="text/javascript" src="http://requirejs.org/docs/release/2.3.2/minified/require.js"></script>
</head>
<body>
    <!-- place content here --->
    <script>
        requirejs(["scripts/say"], function(say) {
            console.log(say.hello("english"));
            console.log(say.hello("spanish"));
            console.log(say.hello("french"));
        });
    </script>
</body>
 

Utwórz nowy plik JS w scripts/say.js i wklej następującą treść:

define(["scripts/translations"], function(translations){
    return {
        hello: function(language){
           return translations[language].hello + " " + translations[language].world;
        }
    };
});
 

Utwórz nowy plik JS w scripts/translations.js i wklej następującą treść:

define([], function(){
    return {
        "english": {
            hello: "Hello",
            world: "World"
        },
        "spanish": {
            hello: "Hola",
            world: "Mundo"
        },
        "french": {
            hello: "Bonjour",
            world: "Le Monde"
        }
    };
});
 

Struktura projektu powinna wyglądać następująco:

- project
    - index.html
    - scripts
        - say.js
        - translations.js
 

Otwórz plik index.html w przeglądarce, a konsola wyświetli:

Hello World
Hola Mundo
Bonjour Le Monde
 

Wyjaśnienie

  1. Załaduj plik skryptu wymaganego.js.

    <script type="text/javascript" src="http://requirejs.org/docs/release/2.3.2/minified/require.js"></script>
     
  2. Załaduj moduł say asynchronicznie z folderu scripts . (Pamiętaj, że nie potrzebujesz rozszerzenia .js podczas odwoływania się do modułu.) Zwrócony moduł jest następnie przekazywany do podanej funkcji, w której wywoływane jest hello() .

    <script>
         requirejs(["scripts/say"], function(say) {
             console.log(say.hello("english"));
             console.log(say.hello("spanish"));
             console.log(say.hello("french"));
         });
    </script>
     
  3. Moduł say zwraca pojedynczy obiekt z jedną funkcją hello , ale w tym przypadku zdefiniowaliśmy zależność ( scripts/translations ) i stamtąd ściągniemy tłumaczenia.

    define(["scripts/translations"], function(translations){
        return {
            hello: function(language){
               return translations[language].hello + " " + translations[language].world;
            }
        };
    });
     
  4. Moduł translations po prostu zwraca obiekt z różnymi tłumaczeniami słów.

    define([], function(){
        return {
            "english": {
                hello: "Hello",
                world: "World"
            },
            "spanish": {
                hello: "Hola",
                world: "Mundo"
            },
            "french": {
                hello: "Bonjour",
                world: "Le Monde"
            }
        };
    });
     

Włączanie bibliotek innych niż AMD

Nie wszystkie biblioteki są zdefiniowane w sposób zgodny z AMD i funkcją Define define() funkcji RequireJS. Autorzy shim się tym, wprowadzając shim dyrektywę dotyczącą konfigurowania tych zależności.

Jednym z przykładów jest użycie wtyczki jQuery UI Layout. Ta wtyczka zależy od jQuery. Możesz to skonfigurować w następujący sposób:

requirejs.config({
    paths: {
        'jquery': '../path/to/jquery.min',
        'jquery.layout': '../path/to/jquery.layout.min'
    },
    shim: {
        'jquery.layout': {
            deps: ['jquery']
        }
    }
});
 

A następnie użyj go w module układu takim jak ten:

define(['jquery', 'jquery.layout'], function ($, layout) {
    $('body').layout();
});
 

Korzystanie z głównego punktu wejścia danych

Pojedynczy punkt wejścia do aplikacji jest możliwy dzięki RequireJS za pomocą atrybutu data-main w tagu <script> .

<script type="text/javascript" data-main="scripts/main" src="http://requirejs.org/docs/release/2.3.2/minified/require.js"></script>
 

Podczas ładowania RequireJS wyszuka atrybut data-main i wstrzykuje główny znacznik skryptu do DOM z zestawem atrybutów async . To jest ten plik, który chcesz wykonać dowolną konfigurację przed uruchomieniem aplikacji.

Na przykład:

// contents of scripts/main.js
require.config({
    waitSeconds: 10,
    paths: {
        jquery: 'libs/jquery-1.4.2.min'
    }
});

requirejs(["jquery", "libs/say"], function($, say) {
    var $body = $('body');
    $body.append( $('<p/>').text(say.hello("english")) );
    $body.append( $('<p/>').text(say.hello("spanish")) );
    $body.append( $('<p/>').text(say.hello("french")) );
});