欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

javascript中UMD规范的代码推演

程序员文章站 2024-02-07 15:18:40
1. umd规范 地址: umd规范,就是所有规范里长得最丑的那个,没有之一!!!它是为了让模块同时兼容amd和commonjs规范而出现的,多被一些需要同时支持浏...

1. umd规范

地址:

umd规范,就是所有规范里长得最丑的那个,没有之一!!!它是为了让模块同时兼容amd和commonjs规范而出现的,多被一些需要同时支持浏览器端和服务端引用的第三方库所使用。umd是一个时代的产物,当各种环境最终实现es harmony的统一的规范后,它也将退出历史舞台。

umd规范的结构乍一看非常复杂,主要是因为想要看懂这段范式需要一些javascript基础知识,它的基本结构是这样的:

(function (root, factory) {
 if (typeof define === 'function' && define.amd) {
  // amd
  define(['jquery', 'underscore'], factory);
 } else if (typeof exports === 'object') {
  // node, commonjs之类的
  module.exports = factory(require('jquery'), require('underscore'));
 } else {
  // 浏览器全局变量(root 即 window)
  root.returnexports = factory(root.jquery, root._);
 }
}(this, function ($, _) {
 // 方法
 function a(){}; // 私有方法,因为它没被返回 (见下面)
 function b(){}; // 公共方法,因为被返回了
 function c(){}; // 公共方法,因为被返回了

 // 暴露公共方法
 return {
  b: b,
  c: c
 }
}));

2. 源码范式推演
2.1 基本结构

先来看最外层的结构:

(function (){}());

非常简单,就是一个自执行函数。既然它是一个模块化的标准,也就意味着这个自执行函数最终可以导出一个模块,那么从代码的角度来讲实际上有两种常见的实现方式:

  1. return返回一个模块;
  2. 实参传入一个对象,把函数内部生成好的需要导出的东西挂在这个对象的属性上;

可以看到上面的函数体内部是没有return语句的,那么可以猜测umd在实现时是采用了第二种方式。既然umd是一种模块化的规范,那么它的功能就是根据使用要求生产模块,也就是说它的职责定位叫做模块工厂,我们可以定义一个factory方法,每当执行该方法时,就回返回一个模块,所以它的基本结构就变成了如下的样子:

(function (factory){
 //假设没有使用任何模块化方案,那么将工厂函数执行后返回的内容直接挂载到全局
 window.some_attr = factory();
}(function(){
 //自定义模块主体的内容
 /*
  var a,b,c
  function a1(){}
  function b1(){}
  function c1(){}
  return {
   a:a1,
   b:b1
  }
  */
}))

也就是说我们自定义一个匿名函数,然后把它当做实参传给了自执行函数,然后在自执行函数内部通过形参来访问这个工厂方法(或者你会更熟悉回调函数或callback这样的叫法),把它简单地挂在到全局对象上,这样就完成了基本的模块导出。

有的时候我们也希望可以将模块挂载到非全局的环境,将挂载对象动态传入可以让代码变得更灵活,此处涉及到一个基础知识,就是浏览器环境中的全局对象拥有parent,top,self三个属性来追踪页面中嵌入<iframe>后引入的新的window对象的,单页面window.self是指向自己的,代码中常通过是否包含self属性来鉴别全局对象,所以此处的写法可以改进为兼容:

(function(root,factory){
 root.some_attr = factory();
}(self !== undefined ? self : this, function(){
 
}));

2.2 适配amd

接着我们先来加入amd的规范的适配,规范地址:amd规范github地址:https://github.com/amdjs/amdjs-api/blob/master/amd.md

/*
* amd规范的模块定义格式是define(id?, dependencies?, factory),factory就是实际的模块内容
*/
(function (factory){
 //判断全局环境是否支持amd标准
 if(typeof define === 'function' && define.amd){
  //定义一个amd模块
  define([/*denpendencies*/],factory);
 }
}(function(/*formal parameters*/){
 //自定义模块主体的内容
 /*
  var a,b,c
  function a1(){}
  function b1(){}
  function c1(){}
  return {
   a:a1,
   b:b1
  }
  */
}))

2.3 适配commonjs

接着我们先来加入commonjs的规范的适配:

/*
* commonjs规范使用require('modulename')的格式来引用模块,使用module.exports对象输出模块,所以只要把模块的输出内容挂载到module.exports上就完成了模块定义。
*/
(function (factory){
 //判断全局环境是否支持commonjs标准
  if(typeof exports === 'object' && typeof define !== 'function'){
    module.exports = factory(/*require(modulea), require(moduleb)*/);
  }
}(function(/*formal parameters*/){
 //自定义模块主体的内容
 /*
  var a,b,c
  function a1(){}
  function b1(){}
  function c1(){}
  return {
   a:a1,
   b:b1
  }
  */
}))

加入对commonjs的适配后,函数主体中return的内容(一般是一个对象)就被挂载到了module.exports上,如果你编写过node.js代码,对此一定不会陌生。

把上面的片段揉到一块,你也就看懂umd的样子了。

3. 更具针对性的umd范式

umd在其github主页上提供了更具针对性的范式,适用于不同的场景,感兴趣的读者可以自行查看(地址在第一节已经给出)。

javascript中UMD规范的代码推演

在此贴一个可能对大多数开发者比较有用的jqueryplugin的开发范式,如果看懂了上面的分析,那么下面的代码应该不难看懂:

// uses commonjs, amd or browser globals to create a jquery plugin.
(function (factory) {
 if (typeof define === 'function' && define.amd) {
  // amd. register as an anonymous module.
  define(['jquery'], factory);
 } else if (typeof module === 'object' && module.exports) {
  // node/commonjs
  module.exports = function( root, jquery ) {
   if ( jquery === undefined ) {
    // require('jquery') returns a factory that requires window to
    // build a jquery instance, we normalize how we use modules
    // that require this pattern but the window provided is a noop
    // if it's defined (how jquery works)
    if ( typeof window !== 'undefined' ) {
     jquery = require('jquery');
    }
    else {
     jquery = require('jquery')(root);
    }
   }
   factory(jquery);
   return jquery;
  };
 } else {
  // browser globals
  factory(jquery);
 }
}(function ($) {
 $.fn.jqueryplugin = function () { return true; };
}));

4. 模块化开发

前端模块化本身是一个稍显混乱的话题,笔者自己最初也是require( )和require.js傻傻分不清楚,但模块化是前端开发中非常重要的课题,如果你不想一辈子只是在一个页面内写代码,这一关是一定要过的,感兴趣的读者可以按照下面的基本类别划分分块进行学习。

javascript中UMD规范的代码推演