summaryrefslogtreecommitdiffhomepage
path: root/es-es/amd-es.html.markdown
blob: 3de23a6ce8a7551e15dae3be128c1be055a1a2cd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
---

category: tool

tool: amd

contributors:

    - ["Frederik Ring", "https://github.com/m90"]

translators:

    - ["Damaso Sanoja", "https://github.com/damasosanoja"]

filename: learnamd-es.js

lang: es-es

---



## Iniciando con AMD



El API del **Módulo de Definición Asíncrono** especifica un mecanismo para definir módulos

JavaScript de manera que tanto el módulo como sus dependencias puedan ser cargadas de manera asíncrona. Esto es particularmente adecuado para el entorno del navegador donde la carga sincronizada de los módulos genera problemas de rendimiento, usabilidad, depuración y acceso cruzado de dominios.



### Conceptos básicos

```javascript

// El API básico de AMD consiste en nada más que dos métodos: `define` y `require`

// y se basa en la definición y consumo de los módulos:

// `define(id?, dependencies?, factory)` define un módulo

// `require(dependencies, callback)` importa un conjunto de dependencias y

// las consume en el callback invocado



// Comencemos usando define para definir un nuevo módulo

// que no posee dependencias. Lo haremos enviando un nombre

// y una función factoría para definirla:

define('awesomeAMD', function(){

  var isAMDAwesome = function(){

    return true;

  };

  // El valor que regresa de la función factoría del módulo es

  // aquello que los otros módulos o llamados require reciben cuando

  // solicitan nuestro módulo `awesomeAMD`.

  // El valor exportado puede ser cualquier cosa, funciones (constructores),

  // objetos, primitivos, incluso indefinidos (aunque eso no ayuda mucho).

  return isAMDAwesome;

});



// Ahora definamos otro módulo que dependa de nuestro módulo `awesomeAMD`.

// Observe que ahora hay un argumento adicional que define 

// las dependencias de nuestro módulo:

define('loudmouth', ['awesomeAMD'], function(awesomeAMD){

  // las dependencias serán enviadas a los argumentos de la factoría

  // en el orden que sean especificadas

  var tellEveryone = function(){

    if (awesomeAMD()){

      alert('This is sOoOo rad!');

    } else {

      alert('Pretty dull, isn\'t it?');

    }

  };

  return tellEveryone;

});



// Como ya sabemos utilizar define usemos ahora `require` para poner en marcha

//  nuestro programa. La firma de `require` es `(arrayOfDependencies, callback)`.

require(['loudmouth'], function(loudmouth){

  loudmouth();

});



// Para hacer que este tutorial corra código, vamos a implementar una

// versión muy básica (no-asíncrona) de AMD justo aquí:

function define(name, deps, factory){

  // observa como son manejados los módulos sin dependencias

  define[name] = require(factory ? deps : [], factory || deps);

}



function require(deps, callback){

  var args = [];

  // primero recuperemos todas las dependencias que necesita

  // el llamado require

  for (var i = 0; i < deps.length; i++){

    args[i] = define[deps[i]];

  }

  // satisfacer todas las dependencias del callback

  return callback.apply(null, args);

}

// puedes ver este código en acción aquí: http://jsfiddle.net/qap949pd/

```



### Uso en el mundo real con require.js



En contraste con el ejemplo introductorio, `require.js` (la librería AMD más popular) implementa la **A** de **AMD**, permitiéndote cargar los módulos y sus dependencias asincrónicamente via XHR:



```javascript

/* file: app/main.js */

require(['modules/someClass'], function(SomeClass){

  // el callback es diferido hasta que la dependencia sea cargada

  var thing = new SomeClass();

});

console.log('So here we are, waiting!'); // esto correrá primero

```



Por convención, usualmente guardas un módulo en un fichero. `require.js` puede resolver los nombres de los módulos basados en rutas de archivo, de forma que no tienes que nombrar tus módulos, simplemente referenciarlos usando su ubicación. En el ejemplo `someClass` es asumido que se ubica en la carpeta `modules`, relativa a tu `baseUrl` configurada:



* app/

  * main.js

  * modules/

    * someClass.js

    * someHelpers.js

    * ...

  * daos/

    * things.js

    * ...



Esto significa que podemos definir `someClass` sin especificar su id de módulo:



```javascript

/* file: app/modules/someClass.js */

define(['daos/things', 'modules/someHelpers'], function(thingsDao, helpers){

  // definición de módulo, por supuesto, ocurrirá también asincrónicamente

  function SomeClass(){

    this.method = function(){/**/};

    // ...

  }

  return SomeClass;

});

```

Para alterar el comportamiento del mapeo de ruta usa `requirejs.config(configObj)` en tu `main.js`:



```javascript

/* file: main.js */

requirejs.config({

  baseUrl : 'app',

  paths : {

    // también puedes cargar módulos desde otras ubicaciones

    jquery : '//ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min',

    coolLibFromBower : '../bower_components/cool-lib/coollib'

  }

});

require(['jquery', 'coolLibFromBower', 'modules/someHelpers'], function($, coolLib, helpers){

  // un fichero `main` necesita llamar a require al menos una vez,

  // de otra forma jamás correrá el código

  coolLib.doFancyStuffWith(helpers.transform($('#foo')));

});

```

Las aplicaciones basadas en `require.js` usualmente tendrán un solo punto de entrada (`main.js`) que se pasa a la etiqueta del script `require.js` como un atributo de datos. Será cargado y ejecutado automáticamente al cargar la página:



```html

<!DOCTYPE html>

<html>

<head>

  <title>Cien etiquetas de script? Nunca más!</title>

</head>

<body>

  <script src="require.js" data-main="app/main"></script>

</body>

</html>

```



### Optimizar todo un proyecto usando r.js



Muchas personas prefiere usar AMD para la sana organización del código durante el desarrollo, pero todavía prefiere enviar para producción un solo fichero en vez de ejecutar cientos de XHRs en las cargas de página.



`require.js` incluye un script llamado `r.js` (el que probablemente correrás en node.js, aunque Rhino también es soportado) que puede analizar el gráfico de dependencias de tu proyecto, y armar un solo fichero que contenga todos tus módulos (adecuadamente nombrados), minificado y listo para consumo.



Instálalo usando `npm`:

```shell

$ npm install requirejs -g

```



Ahora puedes alimentarlo con un fichero de configuración:

```shell

$ r.js -o app.build.js

```



Para nuestro ejemplo anterior el archivo de configuración luciría así:

```javascript

/* file : app.build.js */

({

  name : 'main', // name of the entry point

  out : 'main-built.js', // name of the file to write the output to

  baseUrl : 'app',

  paths : {

    // `empty:` tells r.js that this should still be loaded from the CDN, using

    // the location specified in `main.js`

    jquery : 'empty:',

    coolLibFromBower : '../bower_components/cool-lib/coollib'

  }

})

```



Para usar el fichero creado en producción, simplemente intercambia `data-main`:

```html

<script src="require.js" data-main="app/main-built"></script>

```



Un increíblemente detallado [resumen de opciones de generación](https://github.com/jrburke/r.js/blob/master/build/example.build.js) está disponible en el repositorio de GitHub.



### Tópicos no cubiertos en este tutorial

* [Cargador de plugins / transformaciones](http://requirejs.org/docs/plugins.html)

* [Cargando y exportando estilos CommonJS](http://requirejs.org/docs/commonjs.html)

* [Configuración avanzada](http://requirejs.org/docs/api.html#config)

* [Configuración de Shim (cargando módulos no-AMD)](http://requirejs.org/docs/api.html#config-shim)

* [Cargando y optimizando CSS con require.js](http://requirejs.org/docs/optimization.html#onecss)

* [Usando almond.js para construcciones](https://github.com/jrburke/almond)



### Otras lecturas:



* [Especificaciones oficiales](https://github.com/amdjs/amdjs-api/wiki/AMD)

* [¿Por qué AMD?](http://requirejs.org/docs/whyamd.html)

* [Definición Universal de Módulos](https://github.com/umdjs/umd)



### Implementaciones:



* [require.js](http://requirejs.org)

* [dojo toolkit](http://dojotoolkit.org/documentation/tutorials/1.9/modules/)

* [cujo.js](http://cujojs.com/)

* [curl.js](https://github.com/cujojs/curl)

* [lsjs](https://github.com/zazl/lsjs)

* [mmd](https://github.com/alexlawrence/mmd)