编写原生的 JavaScript 插件
JoeDigamma
7年前
<h3><strong>一、前言</strong></h3> <p>通过 "WWW" 原则我们来了解 JavaScript 插件这个东西</p> <p>第一个 W "What" -- 是什么?什么是插件,我就不照搬书本上的抽象概念了,我个人简单理解就是,能方便实现某个功能的扩展工具.(下面我会通过简单的例子来帮助读者理解)</p> <p>第二个 W "Why" -- 为什么? 为什么要有插件这种东西,首先结合第一个 W 来理解就是,使用插件的目的是方便我们实现某一个功能. 也就是说在编程过程中我们只需要找轮子,或者改轮子而不需要重新造轮子.节省开发时间,并且各司其职会更加专业(做得更好)。其次就是方便维护，因为每个功能模块可以分得更清楚，所谓的松耦合。</p> <p>第三个 W "How" -- 如何做?我们如何开发 JavaScript 插件?这是我们这片文章要谈论的重点.</p> <h3><strong>二、准备知识</strong></h3> <p>在讨论如何做之前我们不妨先通过反向思维来看看插件的特点。我们从如何使用 Javascript 插件开始。</p> <p>假设我们现在要使用插件 js-plugin.js</p> <p>第一步：引入插件，注意依赖项，例如有些插件是基于 jquery 编写的，先引入 jquery</p> <p>第二步：通过插件提供的 API 实现我们所要的业务</p> <p>以经典的 jquery 使用方法为例</p> <pre> <code class="language-javascript"><script src="//cdn.bootcss.com/jquery/3.1.0/jquery.min.js"></script> <script> $(function(){ $("Id").html('hello world!'); }) </script> </code></pre> <p>顺便说一句，能使用CDN的尽量使用CDN,这将使你的资源加载得更快.并节省你主机的带宽开销 </p> <p>上述两点其实也就是说我们的插件要做到，引入相关文件就可以方便地进行使用。换句话说插件必须满足下面的特点：</p> <p>首先，我觉得插件最重要的一点 -- 复用性。就是说你这个插件在这个项目中是能用的，搬到另一个项目中它也是能用的（废话），并且原则上依赖项越少越好</p> <p>其次，我觉得这是插件的宗旨 -- 易用性。开发一个插件，如果使用繁琐，倒不如重新造轮子，那就失去了插件的意义。</p> <p>除此之外，当然还有高效性，考虑执行的效率还有内存的优化。</p> <h3><strong>三、Module 模式</strong></h3> <p>插件开发不得不提的是 Modlule 模式，Module -- 模块，模块化开发，是在编程中十分通用的模式。说白了就是把业务需求分模块。每一个模块负责一个功能的实现。有点像其他面向对象编程语言中的类。例如 JsonHelper 专门负责 json 解析，FilesUpload,专门用来做文件上传的，等等这些。</p> <p>插件就是用这样一种模块化思想来进行开发的，下面我们通过代码来简单解释下 Module 模式。</p> <pre> <code class="language-javascript">var Helloword = function(objId){ var _get_dom = function(Id){ return document.getElementById(Id); } var _aim_obj = _get_dom(objId); var _say_hello = function(str){ _aim_obj.innerHTML = str; HelloWorld.sayHello('hello','hello text'); } return{ sayHello:_say_hello } } </code></pre> <p>由上述代码可见，我们将某些功能，如 “sayHello” 给归到 Helloword （模块）中了。当然我们可以继续在下面添加其他功能，但都归于模块 Helloword 来管理。这就是 Module 的体现。</p> <p>使用方法（注意这里使用了 new ）</p> <pre> <code class="language-javascript">var Hei = new Helloword('hello'); Hei.sayHello('Hello Word'); var Hei2 = new Helloword('hi'); Hei2.sayHello('hi'); </code></pre> <p>更直观点，我们来看下完整的代码</p> <pre> <code class="language-javascript"><!DOCTYPE html> <html> <head> <title>Module</title> </head> <body> <div Id="hello"></div> <div Id="hi"></div> <script type="text/javascript"> var Helloword = function(objId){ var _get_dom = function(Id){ return document.getElementById(Id); } var _aim_obj = _get_dom(objId); var _say_hello = function(str){ _aim_obj.innerHTML = str; } return{ sayHello:_say_hello } } var Hei = new Helloword('hello'); Hei.sayHello('Hello Word'); var Hei = new Helloword('hi'); Hei.sayHello('hi'); </script> </body> </html> </code></pre> <p>运行结果如下</p> <p style="text-align:center"><img src="https://simg.open-open.com/show/57fe3624734fd996584ba8fa2e9835d8.png"></p> <p>我们这里需要注意的是，每使用 new 创建出来的新对象都将开辟新的内存空间（新的一份copy），只要引用没有释放，那么该对象的占用的内存空间将不会被回收。那么如何避免过多浪费内存呢？一句话“释放引用”，只需要释放对该对象的 所有 引用，垃圾回收机制就会将该对象占用的内存空间回收。</p> <pre> <code class="language-javascript">var Hei = new Helloword('hello'); Hei.sayHello('Hello Word'); Hei = null;//解除引用 </code></pre> <p>这样还要“手动”内存管理，麻烦。如何让该模块在内存中只保留一份（copy）呢？请看下面一段代码</p> <pre> <code class="language-javascript">var HelloWorld = (function(){ var _getDom = function(Id){ return document.getElementById(Id) } var _sayHello = function(Id,str){ _getDom(Id).innerHTML = str; } return { getDom:_getDom, sayHello:_sayHello } }()) </code></pre> <p>使用方法</p> <pre> <code class="language-javascript">HelloWorld.sayHello('hello','hello text'); </code></pre> <p>是的,正如你所见到的,不需要 new 了。使用时不再需要创建新对象，也就是说我们只保持了该对象在内存中的一份引用，也就是HelloWorld 对它的引用。当 HelloWorld 对其引用解除时其所占用的内存将得到释放。上述代码实质上是一个匿名闭包。</p> <h3><strong>四、插件基础代码</strong></h3> <p>了解了上面的种种之后我们要开始直切主题了。</p> <p>首先我们创建一个 js 文件 取名为 first-js-plugin.js(啥名字都行)，键入以下代码</p> <pre> <code class="language-javascript">; var plugin =(function(){ function _firstFunc(str){ console.log(str); }; return{ firstFunc: _firstFunc, }; })(); </code></pre> <p>再创建一个 HTML页面 取名为 pluginTest.html (啥名字都行)</p> <p>完整代码如下</p> <pre> <code class="language-javascript"><!DOCTYPE html> <html> <head> <title></title> <script type="text/javascript" src="./first-js-plugin.js"></script> <script type="text/javascript"> plugin.firstFunc("Hello ! I am firstFunc"); </script> </head> <body> </body> </html> </code></pre> <p>运行结果如下图显示</p> <p style="text-align:center"><img src="https://simg.open-open.com/show/2bee49d936aff2ffa1404b0677cdb110.png"></p> <p>通过这个简单的插件，我们来分析一下里面的代码.</p> <p>在分析代码之前我们先来了解另一个东西,自调用匿名函数(防止插件用户定义函数与插件冲突)</p> <pre> <code class="language-javascript">(function(){ //code })(); </code></pre> <p>可能有些童鞋会觉得有点陌生,那看下下面的代码</p> <pre> <code class="language-javascript">var func = function(){ //code } func(); </code></pre> <p>其实这两段代码是等价的,当然有点差别,第一个是匿名函数.作用都是定义一个函数并立即执行.</p> <pre> <code class="language-javascript">(function(){ //code })(); </code></pre> <p>代码分析:</p> <ol> <li>最后面的小括号 () 表示执行该函数</li> <li> <p>(匿名函数) 小括号(分组表达式)包起来匿名函数的声明,作用相当是将函数声明转为表达式,这样才能执行,仅此而已</p> <p>如果采取以下写法</p> <pre> <code class="language-javascript">function(){ //code }(); </code></pre> <p>编译器报错,问题是函数声明无法执行,表达式才能执行</p> </li> </ol> <p>搞清楚这些之后我们回头给下面的代码加上分析,如下</p> <pre> <code class="language-javascript">;//JavaScript 弱语法的特点,如果前面刚好有个函数没有以";"结尾,那么可能会有语法错误 /* plugin.api_funcs 给对象设置属性,属性值为 自调用匿名函数 这里涉及到js作用域链以及闭包的知识点 */ var plugin =(function(){ function _firstFunc(str){ alert(str); }; //返回API return{ firstFunc: _firstFunc }; })(); </code></pre> <p>我们将代码抽取一下(只为帮助理解，已经理解的朋友请忽略)</p> <pre> <code class="language-javascript">//01.定义变量 var plugin = 某对象; //02.创建对象并返回 (function(){//code;return ...})();//匿名执行函数 return 某对象 //然后看核心的返回 return{firstFunc: _firstFunc}; //说白了就是,通过某个key将一个函数存储起来.使用时通过key访问到这个函数 var plugin = {key:function(){//code}} //所以最终的体现如下 var plugin = {firstFunc: “具体的函数引用”} </code></pre> <p>所以我们最后才能通过， 插件名.属性 来使用插件，正如：</p> <pre> <code class="language-javascript">plugin.firstFunc("Hello ! I am firstFunc"); </code></pre> <h3><strong>五、插件的几种写法</strong></h3> <p>这里我就不墨迹了,直接上代码,关键处会给注释</p> <ol> <li> <p>面向对象思想 类方式</p> <pre> <code class="language-javascript">//自定义类 function plugin(){} //提供默认参数 plugin.prototype.str = "default param"; //提供方法(如果不传参,则使用默认参数) plugin.prototype.firstFunc = function(str = this.str){ alert(str); } //创建"对象" var p = new plugin(); //调用方法 p.firstFunc("Hello ! I am firstFunc");//Hello ! I am firstFunc p.firstFunc();//default param </code></pre> </li> <li> <p>闭包方式</p> <p>闭包方式就是我们刚刚一直在介绍</p> <pre> <code class="language-javascript">var plugin =(function(){ function _firstFunc(str){ alert(str); }; return{ firstFunc: _firstFunc, }; })(); </code></pre> </li> <li> <p>第二种方式上的一些变化</p> <pre> <code class="language-javascript">(function(){ //定义一些默认参数 var _options={ default_word:"default hello" } //定义一些api var _plugin_api = { firstFunc:function(str = _options.default_word){ alert(str); return this;//返回当前方法 }, secondFunc:function(){ alert("secondFunc"); return this;//返回当前方法 } } //这里确定了插件的名称 this.CJPlugin = _plugin_api; })(); CJPlugin.firstFunc("hello");//hello CJPlugin.firstFunc();//default hello CJPlugin.secondFunc();//secondFunc </code></pre> </li> </ol> <p>结语</p> <p>JavaScript 插件的相关知识今天暂时聊到这了．</p> <p> </p> <p> </p> <p>来自：http://www.cnblogs.com/cboyce/p/6029782.html</p> <p> </p>