Use native JavaScript to build a wheel. After reading this article, I know how to do it. What about you?

This article teaches you how to create a set of practical and reusable wheels. Explanation of paging configuration and basic parameters. In daily work, we often find that a large number of businesses are actually repeated, and using other people’s plug-ins cannot solve some customized needs well, so I decided to separate some commonly used components. , encapsulate it to form its own plug-in library. Here, I will use this tutorial series to record the development process of each plug-in

So, Let's begin!

The current project uses ES5 and UMD standard packaging, so it is only supported on the front end# for the time being. ## The way to introduce tags will be gradually refactored with ES6 in the futureDemo address: pagination Github: csdwheels Don’t be stingy with your Star~(〃'▽'〃) <img src="https://img.php.cn//upload/image/362/228/542/153268100178000Use%20native%20JavaScript%20to%20build%20a%20wheel.%20After%20reading%20this%20article,%20I%20know%20how%20to%20do%20it.%20What%20about%20you?" title="153268100178000Use native JavaScript to build a wheel. After reading this article, I know how to do it. What about you?" alt="Use native JavaScript to build a wheel. After reading this article, I know how to do it. What about you?">##JavaScript modularization

To develop a For JavaScript plug-ins, we must first start with the modularization of JavaScript. What is modularity? Simply put, it allows JavaScript to organize and maintain code in a holistic manner. When multiple people develop, they can reference each other's code blocks without causing conflicts. ECMAScript6 Common modular specifications before the standard include: CommonJS , AMD , UMD , etc., because our code is temporarily ES5 syntax is used for development, so we choose UMD specifications to organize the code. For the development process of modularization, please refer to:

A brief history of JavaScript modular programming (2009-2016)

JavaScript module evolution Brief History

On top of the standard of this module specification, we also need a mechanism to load different modules, such as require.js that implements the AMD specification. For its usage, please refer to This tutorial written by Ruan Yifeng:

Javascript Modular Programming (3): Usage of require.js

Because of the wheel we develop Multi-module loading is not involved for the time being, so module loading will not be discussed too much for the time being. Readers can expand their own learning. Back to our topic, before formal development, we need to add some other aspects of knowledge.

Self-executing function

There are generally three ways to define a function in ES5:

Function declaration

function foo () {} Functions declared in this way, like variables, will be automatically promoted, so we can place the function declaration after the statement that calls it: foo(); function foo () {}

Function expression

var foo = function () {} The right side is actually an anonymous function, but it is assigned to a variable. We can call it through this variable name, but unlike the first method, the function declared through an expression does not will be promoted.

Using Function constructor

var foo = new Function () So is there a way to declare a function directly without writing the function name and call it automatically? Woolen cloth? The answer is yes, that is to use self-executing functions. (Actually, I mentioned it in another article of mine, Breaking Bricks - JS Object-Oriented Introduction) Self-executing function

Immediately-Invoked Function Expression , as the name suggests, is Automatically executed functions are also called immediately called function expressions in some places. Its basic form is as follows: (function () { console.log('hello') }());

(function () { console.log('hello') })(); The two writing methods are equivalent, but the former makes the code look more like a whole.

As you can see, the function of these two writing methods is actually to define a function within (), and then use () to execute the function, so it is self-executing. Some benefits of IIFE are as follows:

Avoid polluting global variables

Reduce naming conflicts

Lazy loading

The most important point is that it can create an independent scope. Before ES6, JavaScript did not have a block-level scope. Using this, we can easily ensure that variables between multiple modules are not overwritten: // libA.js (function(){ var num = 1; })();

// libB.js (function(){ var num = 2; })(); The scopes in the above two file modules are independent and do not affect each other. . (If modules want to reference each other, you need to use the module loader, such as the

require.js and other libraries mentioned above), Based on this, we You can take a look at what an IIFE template that implements the UMD specification looks like:

// if the module has no dependencies, the above pattern can be simplified to (function (root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. define([], factory); } else if (typeof module === 'object' && module.exports) { // Node. Does not work with strict CommonJS, but // only CommonJS-like environments that support module.exports, // like Node. module.exports = factory(); } else { // Browser globals (root is window) root.returnExports = factory(); } }(typeof self !== 'undefined' ? self : this, function () { // Just return a value to define the module export. // This example returns an object, but the module // can return a function as the exported value. return {}; })); As you can see, the UMD specification is compatible with browsers, Node environments and AMD specifications at the same time. In this way, our code is packaged using UMD It can be run in different environments.

Plug-in template

The most important point in developing plug-ins is the compatibility of the plug-in. A plug-in must be able to run in several different environments at the same time. Secondly, it also needs to meet the following functions and conditions:

The plug-in’s own scope is independent of the user’s current scope, that is, the private variables inside the plug-in cannot affect the user. Environment variables;

The plug-in needs to have default setting parameters; 插件除了具备已实现的基本功能外，需提供部分API，使用者可以通过该API修改插件功能的默认参数，从而实现用户自定义插件效果；

插件支持链式调用；

插件需提供监听入口，及针对指定元素进行监听，使得该元素与插件响应达到插件效果。

第一点我们利用UMD包装的方式已经实现了，现在来看看第二和第三点。

通常情况下，一个插件内部会有默认参数，并且会提供一些参数让用户实现部分功能的自定义。那么怎么实现呢，这其实就是一个对象合并的问题，例如：

function extend(o, n, override) { for (var p in n) { if (n.hasOwnProperty(p) && (!o.hasOwnProperty(p) || override)) o[p] = n[p]; } }

// 默认参数 var options = { pageNumber: 1, pageShow: 2 };

// 用户设置 var userOptions = { pageShow: 3, pageCount: 10 }

extend(options, userOptions, true);

// 合并后 options = { pageNumber: 1, pageShow: 3, pageCount: 10 } 如上，采用一个类似的 extend 函数就可以实现对象的合并了，这样我们插件也就实现了设置参数的功能。

这里的extend函数为浅拷贝，因为插件的用户参数一般是不会修改的，如果想实现深拷贝可参考jQuery中extend的实现方法。 第四点我们插件暂时不需要这样的功能，可以暂时不支持它。第五点在代码中我们会通过回调函数去逐步实现它。

综上，我们就可以实现出一个基础的插件模板了：

;// JavaScript弱语法的特点,如果前面刚好有个函数没有以";"结尾,那么可能会有语法错误 (function(root, factory) { if (typeof define === 'function' && define.amd) { define([], factory); } else if (typeof module === 'object' && module.exports) { module.exports = factory(); } else { root.Plugin = factory(); } }(typeof self !== 'undefined' ? self : this, function() { 'use strict';

// tool function extend(o, n, override) { for (var p in n) { if (n.hasOwnProperty(p) && (!o.hasOwnProperty(p) || override)) o[p] = n[p]; } }

// polyfill var EventUtil = { addEvent: function(element, type, handler) { // 添加绑定 if (element.addEventListener) { // 使用DOM2级方法添加事件 element.addEventListener(type, handler, false); } else if (element.attachEvent) { // 使用IE方法添加事件 element.attachEvent("on" + type, handler); } else { // 使用DOM0级方法添加事件 element["on" + type] = handler; } }, // 移除事件 removeEvent: function(element, type, handler) { if (element.removeEventListener) { element.removeEventListener(type, handler, false); } else if (element.datachEvent) { element.detachEvent("on" + type, handler); } else { element["on" + type] = null; } }, getEvent: function(event) { // 返回事件对象引用 return event ? event : window.event; }, // 获取mouseover和mouseout相关元素 getRelatedTarget: function(event) { if (event.relatedTarget) { return event.relatedTarget; } else if (event.toElement) { // 兼容IE8- return event.toElement; } else if (event.formElement) { return event.formElement; } else { return null; } }, getTarget: function(event) { //返回事件源目标 return event.target || event.srcElement; }, preventDefault: function(event) { //取消默认事件 if (event.preventDefault) { event.preventDefault(); } else { event.returnValue = false; } }, stoppropagation: function(event) { //阻止事件流 if (event.stoppropagation) { event.stoppropagation(); } else { event.canceBubble = false; } }, // 获取mousedown或mouseup按下或释放的按钮是鼠标中的哪一个 getButton: function(event) { if (document.implementation.hasFeature("MouseEvents", "2.0")) { return event.button; } else { //将IE模型下的button属性映射为DOM模型下的button属性 switch (event.button) { case 0: case 1: case 3: case 5: case 7: //按下的是鼠标主按钮（一般是左键） return 0; case 2: case 6: //按下的是中间的鼠标按钮 return 2; case 4: //鼠标次按钮（一般是右键） return 1; } } }, //获取表示鼠标滚轮滚动方向的数值 getWheelDelta: function(event) { if (event.wheelDelta) { return event.wheelDelta; } else { return -event.detail * 40; } }, // 以跨浏览器取得相同的字符编码，需在keypress事件中使用 getCharCode: function(event) { if (typeof event.charCode == "number") { return event.charCode; } else { return event.keyCode; } } };

// plugin construct function function Plugin(selector, userOptions) { // Plugin() or new Plugin() if (!(this instanceof Plugin)) return new Plugin(selector, userOptions); this.init(selector, userOptions) } Plugin.prototype = { constructor: Plugin, // default option options: {}, init: function(selector, userOptions) { extend(this.options, userOptions, true); } };

return Plugin; })); 这里还使用到了一个 EventUtil 对象，它主要是针对事件注册的一些兼容性做了一些polyfill封装，具体原理可以参阅：

EventUtil——跨浏览器的事件对象

跨浏览器的事件对象-------EventUtil 中的方法及用法

到此，一个插件的基本模板就大致成型了。下一节，我们终于可以正式开始分页插件的开发了！

思路分析 有人说计算机的本质就是对现实世界的抽象，而编程则是对这个抽象世界规则的制定。 正如上面这句话所说，在实际编码之前我们一般需要对要实现的需求效果进行一个思路的分析，最后再进一步把这个思路过程抽象为有逻辑的代码。 我们先看一下要实现的分页效果是什么样的，我把它分成两种情况，显示和不显示省略号的，首先来看第一种：

// 总共30页 // 第一种情况：不显示省略号，当前页码前后最多显示2个页码 当前页码为 1，那么显示 1 2 3 4 5 当前页码为 2，那么显示 1 2 3 4 5 当前页码为 3，那么显示 1 2 3 4 5 当前页码为 4，那么显示 2 3 4 5 6 ... 当前页码为 15，那么显示 13 14 15 16 17 ... 当前页码为 27，那么显示 25 26 27 28 29 当前页码为 28，那么显示 26 27 28 29 30 当前页码为 29，那么显示 26 27 28 29 30 当前页码为 30，那么显示 26 27 28 29 30 虽然上面每一个数字在实际应用中都是一个按钮或超链接，但现在既然是分析，我们不妨就把它简化并忽略，于是这个问题就变成了一个简单的字符串输出题。 我们先定义一个函数：

function showPages (page, total, show) {

} 函数传入的参数分别为：当前页码、总页码数、当前页码面前后最多显示页码数，然后我们需要循环调用这个函数打印分页：

var total = 30; for (var i = 1; i 这样从页码为1到最后一页的结果就全输出了，最后我们需要完成 showPages() 函数：

function showPages (page, total, show) { var str = ''; if (page total - show) { for (var i = total - show * 2; i 思路是分段拼出页码，打印结果如下：

不显示省略号的页码正常输出了，然后我们来看显示省略号的情况：

// 第二种情况：显示省略号，当前页码前后最多显示2个页码 当前页码为 1，那么显示 1 2 3 ... 30 当前页码为 2，那么显示 1 2 3 4 ... 30 当前页码为 3，那么显示 1 2 3 4 5 ... 30 当前页码为 4，那么显示 1 2 3 4 5 6 ... 30 当前页码为 5，那么显示 1 ... 3 4 5 6 7 ... 30 ... 当前页码为 15，那么显示 1 ... 13 14 15 16 17 ... 30 ... 当前页码为 26，那么显示 1 ... 24 25 26 27 28 ... 30 当前页码为 27，那么显示 1 ... 25 26 27 28 29 30 当前页码为 28，那么显示 1 ... 26 27 28 29 30 当前页码为 29，那么显示 1 ... 27 28 29 30 当前页码为 30，那么显示 1 ... 28 29 30 同样需要完成 showPages() 函数：

但是仔细看看上面的代码会发现有大量重复冗余的逻辑了，能不能优化呢？下面是一种更为取巧的思路：

基本架构 一个好的插件，代码一定是高复用、低耦合、易拓展的，因此我们需要采用面向对象的方法来搭建这个插件的基本架构：

// 模仿jQuery $() function $(selector, context) { context = arguments.length > 1 ? context : document; return context ? context.querySelectorAll(selector) : null; }

Pagination.prototype = { constructor: Pagination, changePage: function() {} };

return Pagination; 如上，一个采用原型模式的分页器对象就搭建完成了，下面我们对上面的代码进行一一讲解。

分页配置 本分页器提供如下基本参数：

// 分页元素ID（必填） var selector = '#pagelist';

// 分页配置 var pageOption = { // 每页显示数据条数（必填） limit: 5, // 数据总数（一般通过后端获取，必填） count: 162, // 当前页码（选填，默认为1） curr: 1, // 是否显示省略号（选填，默认显示） ellipsis: true, // 当前页前后两边可显示的页码个数（选填，默认为2） pageShow: 2, // 开启location.hash，并自定义hash值 （默认关闭） // 如果开启，在触发分页时，会自动对url追加：#!hash值={curr} 利用这个，可以在页面载入时就定位到指定页 hash: false, // 页面加载后默认执行一次，然后当分页被切换时再次触发 callback: function(obj) { // obj.curr：获取当前页码 // obj.limit：获取每页显示数据条数 // obj.isFirst：是否首次加载页面，一般用于初始加载的判断

// 首次不执行 if (!obj.isFirst) { // do something } } }; 在构造函数里调用 extend() 完成了用户参数与插件默认参数的合并。

回调事件 通常情况下，在改变了插件状态后（点击事件等），插件需要作出一定的反应。因此我们需要对用户行为进行一定的监听，这种监听习惯上就叫作回调函数。 在上面代码中我们可以看到有这么一段：

// 执行回调函数 this.options.callback && this.options.callback({ curr: this.pageNumber, limit: this.options.limit, isFirst: true }); 这种写法是不是有点奇怪呢，其实它相当于：

if(this.options.callback){ this.options.callback({ curr: this.pageNumber, limit: this.options.limit, isFirst: true }); } 想必聪明的你已经明白了吧，这里的 callback 并不是某个具体的东西，而是一个引用。不管callback指向谁，我们只需要判断它有没有存在，如果存在就执行它。

事件绑定 接下来需要对分页器进行点击事件的绑定，也就是完成我们的 changePage() 方法：

changePage: function() { var self = this; var pageElement = self.pageElement; EventUtil.addEvent(pageElement, "click", function(ev) { var e = ev || window.event; var target = e.target || e.srcElement; if (target.nodeName.toLocaleLowerCase() == "a") { if (target.id === "prev") { self.prevPage(); } else if (target.id === "next") { self.nextPage(); } else if (target.id === "first") { self.firstPage(); } else if (target.id === "last") { self.lastPage(); } else if (target.id === "page") { self.goPage(parseInt(target.innerHTML)); } else { return; } self.renderPages(); self.options.callback && self.options.callback({ curr: self.pageNumber, limit: self.options.limit, isFirst: false }); self.pageHash(); } }); } 整体的逻辑大家应该都能轻松看懂，无非就是判断当前点击的是什么，然后执行对应的逻辑操作，但具体的实现方式有的同学可能会有一点陌生。

Q：这个 target 是啥？这个 srcElement 又是啥？ A：这其实是JavaScript事件委托方面的知识，大家可以参考如下文章进行学习，这里不再赘述。

js中的事件委托或是事件代理详解

插件对象、配置完成了，事件也绑定了，那接下来就应该完成我们页码上显示的DOM节点的渲染了。

渲染DOM 渲染的过程其实就是对上面我们封装的那几个字符串打印函数的改进，把字符串改为具体的DOM节点，然后添加进页面即可。 首先我们需要完成一个 createHtml() 函数：

createHtml: function(elemDatas) { var self = this; var fragment = document.createDocumentFragment(); var liEle = document.createElement("li"); var aEle = document.createElement("a"); elemDatas.forEach(function(elementData, index) { liEle = liEle.cloneNode(false); aEle = aEle.cloneNode(false); liEle.setAttribute("class", CLASS_NAME.ITEM); aEle.setAttribute("href", "javascript:;"); aEle.setAttribute("id", elementData.id); if (elementData.id !== 'page') { aEle.setAttribute("class", CLASS_NAME.LINK); } else { aEle.setAttribute("class", elementData.className); } aEle.innerHTML = elementData.content; liEle.appendChild(aEle); fragment.appendChild(liEle); }); return fragment; } 这个函数的作用很简单，就是生成一个节点：

1 代码中有涉及到两个性能优化的API，第一个API是 document.createDocumentFragment() ，它的作用是创建一个临时占位符，然后存放那些需要插入的节点，可以有效避免页面进行DOM操作时的重绘和回流，减小页面的负担，提升页面性能。相关知识点，可参阅以下文章：

JS性能优化之创建文档碎片

前端性能优化第三篇-documentFragment

第二个API是 cloneNode() ，如果需要创建很多元素，就可以利用这个API来减少属性的设置次数，不过必须先提前准备一个样板节点，例如：

var frag = document.createDocumentFragment(); for (var i = 0; i 完成这个函数后，再进一步封装成两个插入节点的函数：（这一步可省略）

addFragmentBefore: function(fragment, datas) { fragment.insertBefore(this.createHtml(datas), fragment.firstChild); }

addFragmentAfter: function(fragment, datas) { fragment.appendChild(this.createHtml(datas)); } 前者在最前插入节点，后者在最后插入节点。 一些常量和重复操作也可以进一步抽取：

pageInfos: [{ id: "first", content: "首页" }, { id: "prev", content: "前一页" }, { id: "next", content: "后一页" }, { id: "last", content: "尾页" }, { id: "", content: "..." } ]

getPageInfos: function(className, content) { return { id: "page", className: className, content: content }; } 利用上面封装好的对象和方法，我们就可以对最开始那两个字符串函数进行改造了：

renderNoEllipsis: function() { var fragment = document.createDocumentFragment(); if (this.pageNumber this.pageCount - this.options.pageShow) { fragment.appendChild(this.renderDom(this.pageCount - this.options.pageShow * 2, this.pageCount)); } else { fragment.appendChild(this.renderDom(this.pageNumber - this.options.pageShow, this.pageNumber + this.options.pageShow)); } if (this.pageNumber > 1) { this.addFragmentBefore(fragment, [ this.pageInfos[0], this.pageInfos[1] ]); } if (this.pageNumber < this.pageCount) { this.addFragmentAfter(fragment, [this.pageInfos[2], this.pageInfos[3]]); } return fragment; }

renderEllipsis: function() { var fragment = document.createDocumentFragment(); this.addFragmentAfter(fragment, [ this.getPageInfos(CLASS_NAME.LINK + " current", this.pageNumber) ]); for (var i = 1; i 1) { this.addFragmentBefore(fragment, [ this.getPageInfos(CLASS_NAME.LINK, this.pageNumber - i) ]); } if (this.pageNumber + i 1) { this.addFragmentBefore(fragment, [this.pageInfos[4]]); } if (this.pageNumber > 1) { this.addFragmentBefore(fragment, [ this.pageInfos[0], this.pageInfos[1], this.getPageInfos(CLASS_NAME.LINK, 1) ]); } if (this.pageNumber + this.options.pageShow + 1 < this.pageCount) { this.addFragmentAfter(fragment, [this.pageInfos[4]]); } if (this.pageNumber < this.pageCount) { this.addFragmentAfter(fragment, [ this.getPageInfos(CLASS_NAME.LINK, this.pageCount), this.pageInfos[2], this.pageInfos[3] ]); } return fragment; }

renderDom: function(begin, end) { var fragment = document.createDocumentFragment(); var str = ""; for (var i = begin; i 逻辑和最开始的 showPages() 完全一样，只是变成了DOM的操作而已。

至此，渲染部分的函数基本也封装完成，最后还剩一些操作页码的函数，比较简单，这里就不作讲解了，可自行参考源码。

使用场景 相信大家也看出来了，此分页器只负责分页本身的逻辑，具体的数据请求与渲染需要另外去完成。 不过，此分页器不仅能应用在一般的异步分页上，还可直接对一段已知数据进行分页展现，使用场景如下：

前端分页 在callback里对总数据进行处理，然后取出当前页需要展示的数据即可

后端分页 利用url上的页码参数，可以在页面载入时就定位到指定页码，并且可以同时请求后端指定页码下对应的数据 在callback回调函数里取得当前页码，可以使用 window.location.href 改变url，并将当前页码作为url参数，然后进行页面跳转，例如"./test.html?page="

插件调用 插件的调用也非常方便，首先，我们在页面引入相关的CSS、JS文件：

样式如果觉得不满意可自行调整 然后将HTML结构插入文档中：

最后，将必填、选填的参数配置好即可完成本分页插件的初始化：

// 分页元素ID（必填） var selector = '#pagelist';

// 分页配置 var pageOption = { // 每页显示数据条数（必填） limit: 5, // 数据总数（一般通过后端获取，必填） count: 162, // 当前页码（选填，默认为1） curr: 1, // 是否显示省略号（选填，默认显示） ellipsis: true, // 当前页前后两边可显示的页码个数（选填，默认为2） pageShow: 2, // 开启location.hash，并自定义hash值 （默认关闭） // 如果开启，在触发分页时，会自动对url追加：#!hash值={curr} 利用这个，可以在页面载入时就定位到指定页 hash: false, // 页面加载后默认执行一次，然后当分页被切换时再次触发 callback: function(obj) { // obj.curr：获取当前页码 // obj.limit：获取每页显示数据条数 // obj.isFirst：是否首次加载页面，一般用于初始加载的判断

// 首次不执行 if (!obj.isFirst) { // do something } } };

// 初始化分页器 new Pagination(selector, pageOption); 在两种基础模式之上，还可以开启Hash模式 那么，整个分页器插件的封装到这里就全部讲解完毕了，怎么样，是不是觉得还挺简单？偷偷告诉你，接下来我们会逐渐尝试点更有难度的插件哦！敬请期待~~

平心而论，整体的代码质量虽然一般，但是逻辑和结构我觉得还是写得算比较清晰的吧。代码的不足之处肯定还有很多，也希望各位看官多多指教！ To be continued...apache php mysql

参考内容 由匿名函数展开的一系列知识点

自执行函数(IIFE)

UMD (Universal Module Definition)

原生JavaScript插件编写指南

如何定义一个高逼格的原生JS插件

如何写一个简单的分页

我总结的js性能优化的小知识

原生javascript实现图片轮播效果代码