requirejsIniziare con requirejs


Osservazioni

RequireJS è un'implementazione dell'API Asynchronous Module (AMD) utilizzata per caricare i file javascript in modo asincrono (cioè senza bloccare) e gestire le dipendenze tra più file javascript. Include anche uno strumento di ottimizzazione per combinare e ridurre al minimo i file di script per la distribuzione consentendo allo sviluppatore di mantenere il codice logicamente separato.

Ciao mondo

L'esempio seguente mostrerà un'installazione e un'installazione di base di RequireJS.

Crea un nuovo file HTML chiamato index.html e incolla il seguente contenuto:

<!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>
 

Crea un nuovo file JS su scripts/say.js e incolla il seguente contenuto:

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

La struttura del tuo progetto dovrebbe assomigliare a questa:

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

Apri il file index.html in un browser e ti avviserà con "Hello World".


Spiegazione

  1. Carica il file di script require.js.

    <script type="text/javascript" src="http://requirejs.org/docs/release/2.3.2/minified/require.js"></script>
     
  2. Carica il modulo say modo asincrono dalla cartella degli scripts . (Nota che non hai bisogno dell'estensione .js quando fai riferimento al modulo.) Il modulo restituito viene quindi passato alla funzione fornita dove viene invocato hello() .

    <script>
       requirejs(["scripts/say"], function(say) {
           alert(say.hello());
       });
    </script>
     
  3. Il modulo say restituisce un singolo oggetto con una funzione definita hello .

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

Ciao mondo con dipendenze annidate

L'esempio seguente espande Hello World dimostrando più dipendenze utilizzando la funzione define() .

Crea un nuovo file HTML chiamato index.html e incolla il seguente contenuto:

<!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>
 

Crea un nuovo file JS su scripts/say.js e incolla il seguente contenuto:

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

Crea un nuovo file JS su scripts/translations.js e incolla il seguente contenuto:

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

La struttura del tuo progetto dovrebbe assomigliare a questa:

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

Apri il file index.html in un browser e la console emetterà:

Hello World
Hola Mundo
Bonjour Le Monde
 

Spiegazione

  1. Carica il file di script require.js.

    <script type="text/javascript" src="http://requirejs.org/docs/release/2.3.2/minified/require.js"></script>
     
  2. Carica il modulo say modo asincrono dalla cartella degli scripts . (Nota che non hai bisogno dell'estensione .js quando fai riferimento al modulo.) Il modulo restituito viene quindi passato alla funzione fornita dove viene invocato hello() .

    <script>
         requirejs(["scripts/say"], function(say) {
             console.log(say.hello("english"));
             console.log(say.hello("spanish"));
             console.log(say.hello("french"));
         });
    </script>
     
  3. Il modulo say restituisce un singolo oggetto con una funzione definita hello , ma in questo caso abbiamo definito una dipendenza ( scripts/translations ) e tireremo le traduzioni da lì.

    define(["scripts/translations"], function(translations){
        return {
            hello: function(language){
               return translations[language].hello + " " + translations[language].world;
            }
        };
    });
     
  4. Il modulo di translations restituisce semplicemente un oggetto con varie traduzioni di parole.

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

Incorporando librerie non AMD

Non tutte le librerie sono definite in modo compatibile con la funzione define() AMD e RequireJS. L'autore ha affrontato questo problema includendo una direttiva shim per la configurazione di tali dipendenze.

Un esempio è l'uso del plugin di layout dell'interfaccia utente jQuery. Questo plugin dipende da jQuery. Puoi configurarlo in questo modo:

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

E poi usarlo in un modulo di layout come questo:

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

Utilizzo del punto di ingresso principale dei dati

Un singolo punto di accesso alla tua applicazione è possibile con RequireJS usando la data-main attribuita all'interno del tag <script> .

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

Al momento del caricamento, RequireJS cercherà l'attributo data-main e inserirà il tag principale dello script nel DOM con l'attributo async set. È questo file che vorrete fare qualsiasi configurazione prima di dare il via alla vostra applicazione.

Per esempio:

// 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")) );
});