史上最全!图解浏览器的工作原理

译注:本文作者FrontEndInDepth

  可能每一个前端工程师都想要理解浏览器的工作原理。

  我们希望知道从在浏览器地址栏中输入 url 到页面展现的短短几秒内浏览器究竟做了什么;

  我们希望了解平时常常听说的各种代码优化方案是究竟为什么能起到优化的作用;

  我们希望更细化的了解浏览器的渲染流程。

  浏览器的多进程架构

  一个好的程序常常被划分为几个相互独立又彼此配合的模块,浏览器也是如此,以 Chrome 为例,它由多个进程组成,每个进程都有自己核心的职责,它们相互配合完成浏览器的整体功能,每个进程中又包含多个线程,一个进程内的多个线程也会协同工作,配合完成所在进程的职责。

  对一些前端开发同学来说,进程和线程的概念可能会有些模糊,为了更好的理解浏览器的多进程架构,这里我们简单讨论一下进程和线程。

  进程(process)和线程(thread)

  进程就像是一个有边界的生产厂间,而线程就像是厂间内的一个个员工,可以自己做自己的事情,也可以相互配合做同一件事情。

  当我们启动一个应用,计算机会创建一个进程,操作系统会为进程分配一部分内存,应用的所有状态都会保存在这块内存中,应用也许还会创建多个线程来辅助工作,这些线程可以共享这部分内存中的数据。如果应用关闭,进程会被终结,操作系统会释放相关内存。

  一个进程还可以要求操作系统生成另一个进程来执行不同的任务,系统会为新的进程分配独立的内存,两个进程之间可以使用 IPC (Inter Process Communication)进行通信。很多应用都会采用这样的设计,如果一个工作进程反应迟钝,重启这个进程不会影响应用其它进程的工作。

  浏览器的架构

  有了上面的知识做铺垫,我们可以更合理的讨论浏览器的架构了,其实如果要开发一个浏览器,它可以是单进程多线程的应用,也可以是使用 IPC 通信的多进程应

  浏览器的架构模型

  不同浏览器采用了不同的架构模式,这里并不存在标准,本文以 Chrome 为例进行说明 :

  Chrome 采用多进程架构,其顶层存在一个 Browser process 用以协调浏览器的其它进程。

  Chrome 的不同进程

  具体说来,Chrome 的主要进程及其职责如下:

  Browser Process:

  - 负责包括地址栏,书签栏,前进后退按钮等部分的工作;

  - 负责处理浏览器的一些不可见的底层操作,比如网络请求和文件访问;

  Renderer Process:

  - 负责一个 tab 内关于网页呈现的所有事情

  Plugin Process:

  - 负责控制一个网页用到的所有插件,如 flash GPU Process

  - 负责处理 GPU 相关的任务

  不同进程负责的浏览器区域示意图

  Chrome 还为我们提供了「任务管理器」,供我们方便的查看当前浏览器中运行的所有进程及每个进程占用的系统资源,右键单击还可以查看更多类别信息。

  通过「页面右上角的三个点点点 — 更多工具 — 任务管理器」即可打开相关面板。

  Chrome 多进程架构的优缺点

  优点

  某一渲染进程出问题不会影响其他进程

  更为安全,在系统层面上限定了不同进程的权限

  缺点

  由于不同进程间的内存不共享,不同进程的内存常常需要包含相同的内容。

  为了节省内存,Chrome 限制了最多的进程数,最大进程数量由设备的内存和 CPU 能力决定,当达到这一限制时,新打开的 Tab 会共用之前同一个站点的渲染进程。

  测试了一下在 Chrome 中打开不断打开知乎首页,在 Mac i5 8g 上可以启动四十多个渲染进程,之后新打开 tab 会合并到已有的渲染进程中。

  Chrome 把浏览器不同程序的功能看做服务,这些服务可以方便的分割为不同的进程或者合并为一个进程。以 Broswer Process 为例,如果 Chrome 运行在强大的硬件上,它会分割不同的服务到不同的进程,这样 Chrome 整体的运行会更加稳定,但是如果 Chrome 运行在资源贫瘠的设备上,这些服务又会合并到同一个进程中运行,这样可以节省内存,示意图如下。

  iframe 的渲染 – Site Isolation

  在上面的进程图中我们还可以看到一些进程下还存在着 Subframe,这就是 Site Isolation 机制作用的结果。

  Site Isolation 机制从 Chrome 67 开始默认启用。这种机制允许在同一个 Tab 下的跨站 iframe 使用单独的进程来渲染,这样会更为安全。

  iframe 会采用不同的渲染进程

  Site Isolation 被大家看做里程碑式的功能, 其成功实现是多年工程努力的结果。Site Isolation 不是简单的叠加多个进程。这种机制在底层改变了 iframe 之间通信的方法,Chrome 的其它功能都需要做对应的调整,比如说 devtools 需要相应的支持,甚至 Ctrl + F 也需要支持。

  介绍完了浏览器的基本架构模式,接下来我们看看一个常见的导航过程对浏览器来说究竟发生了什么。

  导航过程发生了什么

  也许大多数人使用 Chrome 最多的场景就是在地址栏输入关键字进行搜索或者输入地址导航到某个网站,我们来看看浏览器是怎么看待这个过程的。

  我们知道浏览器 Tab 外的工作主要由 Browser Process 掌控,Browser Process 又对这些工作进一步划分,使用不同线程进行处理:

  - UI thread : 控制浏览器上的按钮及输入框;

  - network thread: 处理网络请求,从网上获取数据;

  - storage thread: 控制文件等的访问;

  浏览器主进程中的不同线程

  回到我们的问题,当我们在浏览器地址栏中输入文字,并点击回车获得页面内容的过程在浏览器看来可以分为以下几步:

  1. 处理输入

  UI thread 需要判断用户输入的是 URL 还是 query;

  2. 开始导航

  当用户点击回车键,UI thread 通知 network thread 获取网页内容,并控制 tab 上的 spinner 展现,表示正在加载中。

  network thread 会执行 DNS 查询,随后为请求建立 TLS 连接。

  UI thread 通知 Network thread 加载相关信息

  如果 network thread 接收到了重定向请求头如 301,network thread 会通知 UI thread 服务器要求重定向,之后,另外一个 URL 请求会被触发

  3. 读取响应

  当请求响应返回的时候,network thread 会依据 Content-Type 及 MIME Type sniffing 判断响应内容的格式。

  判断响应内容的格式

  如果响应内容的格式是 HTML ,下一步将会把这些数据传递给 renderer process,如果是 zip 文件或者其它文件,会把相关数据传输给下载管理器。

  Safe Browsing 检查也会在此时触发,如果域名或者请求内容匹配到已知的恶意站点,network thread 会展示一个警告页。此外 CORB 检测也会触发确保敏感数据不会被传递给渲染进程。

  4. 查找渲染进程

  当上述所有检查完成,network thread 确信浏览器可以导航到请求网页,network thread 会通知 UI thread 数据已经准备好,UI thread 会查找到一个 renderer process 进行网页的渲染。

  收到 Network thread 返回的数据后,UI thread 查找相关的渲染进程

  由于网络请求获取响应需要时间,这里其实还存在着一个加速方案。当 UI thread 发送 URL 请求给 network thread 时,浏览器其实已经知道了将要导航到那个站点。UI thread 会并行的预先查找和启动一个渲染进程,如果一切正常,当 network thread 接收到数据时,渲染进程已经准备就绪了,但是如果遇到重定向,准备好的渲染进程也许就不可用了,这时候就需要重启一个新的渲染进程。

  5. 确认导航

  进过了上述过程,数据以及渲染进程都可用了, Browser Process 会给 renderer process 发送 IPC 消息来确认导航,一旦 Browser Process 收到 renderer process 的渲染确认消息,导航过程结束,页面加载过程开始。

  此时,地址栏会更新,展示出新页面的网页信息。history tab 会更新,可通过返回键返回导航来的页面,为了让关闭 tab 或者窗口后便于恢复,这些信息会存放在硬盘中。

  6. 额外的步骤

  一旦导航被确认,renderer process 会使用相关的资源渲染页面,下文中我们将重点介绍渲染流程。当 renderer process 渲染结束(渲染结束意味着该页面内的所有的页面,包括所有 iframe 都触发了 onload 时),会发送 IPC 信号到 Browser process, UI thread 会停止展示 tab 中的 spinner。

  Renderer Process 发送 IPC 消息通知 browser process 页面已经加载完成。

  当然上面的流程只是网页首帧渲染完成,在此之后,客户端依旧可下载额外的资源渲染出新的视图。

  在这里我们可以明确一点,所有的 JS 代码其实都由 renderer Process 控制的,所以在你浏览网页内容的过程大部分时候不会涉及到其它的进程。不过也许你也曾经监听过 beforeunload 事件,这个事件再次涉及到 Browser Process 和 renderer Process 的交互,当当前页面关闭时(关闭 Tab ,刷新等等),Browser Process 需要通知 renderer Process 进行相关的检查,对相关事件进行处理。

  浏览器进程发送 IPC 消息给渲染进程,通知要离开当前网站了

  如果导航由 renderer process 触发(比如在用户点击某链接,或者 JS 执行 window.location = “http://newsite.com“ ) renderer process 会首先检查是否有 beforeunload 事件处理器,导航请求由 renderer process 传递给 Browser process。

  如果导航到新的网站,会启用一个新的 render process 来处理新页面的渲染,老的进程会留下来处理类似 unload 等事件。

  关于页面的生命周期,更多内容可参考 Page Lifecycle API 。

  浏览器进程发送 IPC 消息到新的渲染进程通知渲染新的页面,同时通知旧的渲染进程卸载。

  除了上述流程,有些页面还拥有 Service Worker (服务工作线程),Service Worker 让开发者对本地缓存及判断何时从网络上获取信息有了更多的控制权,如果 Service Worker 被设置为从本地 cache 中加载数据,那么就没有必要从网上获取更多数据了。

  值得注意的是 service worker 也是运行在渲染进程中的 JS 代码,因此对于拥有 Service Worker 的页面,上述流程有些许的不同。

  当有 Service Worker 被注册时,其作用域会被保存,当有导航时,network thread 会在注册过的 Service Worker 的作用域中检查相关域名,如果存在对应的 Service worker,UI thread 会找到一个 renderer process 来处理相关代码,Service Worker 可能会从 cache 中加载数据,从而终止对网络的请求,也可能从网上请求新的数据。

  Service Worker 依据具体情形做处理。

  如果 Service Worker 最终决定通过网上获取数据,Browser 进程 和 renderer 进程的交互其实会延后数据的请求时间 。Navigation Preload 是一种与 Service Worker 并行的加速加载资源的机制,服务端通过请求头可以识别这类请求,而做出相应的处理。

  渲染进程是如何工作的?

  渲染进程几乎负责 Tab 内的所有事情,渲染进程的核心目的在于转换 HTML CSS JS 为用户可交互的 web 页面。渲染进程中主要包含以下线程:

  渲染进程包含的线程

  1. 主线程 Main thread

  2. 工作线程 Worker thread

  3. 排版线程 Compositor thread

  4. 光栅线程 Raster thread

  后文我们将逐步介绍不同线程的职责,在此之前我们先看看渲染的流程。

  1. 构建 DOM

  当渲染进程接收到导航的确认信息,开始接受 HTML 数据时,主线程会解析文本字符串为 DOM。

  渲染 html 为 DOM 的方法由 HTML Standard 定义。

  2. 加载次级的资源

  网页中常常包含诸如图片,CSS,JS 等额外的资源,这些资源需要从网络上或者 cache 中获取。主进程可以在构建 DOM 的过程中会逐一请求它们,为了加速 preload scanner 会同时运行,如果在 html 中存在 等标签,preload scanner 会把这些请求传递给 Browser process 中的 network thread 进行相关资源的下载。

  3.JS 的下载与执行

  当遇到 script 标签时,渲染进程会停止解析 HTML,而去加载,解析和执行 JS 代码,停止解析 html 的原因在于 JS 可能会改变 DOM 的结构(使用诸如 documwnt.write()等 API)。

  不过开发者其实也有多种方式来告知浏览器应对如何应对某个资源,比如说如果在 script 标签上添加了 async 或 defer 等属性,浏览器会异步的加载和执行 JS 代码,而不会阻塞渲染。更多的方法可参考 Resource Prioritization – Getting the Browser to Help You。

  4. 样式计算

  仅仅渲染 DOM 还不足以获知页面的具体样式,主进程还会基于 CSS 选择器解析 CSS 获取每一个节点的最终的计算样式值。即使不提供任何 CSS,浏览器对每个元素也会有一个默认的样式。

  渲染进程主线程计算每一个元素节点的最终样式值

  5. 获取布局

  想要渲染一个完整的页面,除了获知每个节点的具体样式,还需要获知每一个节点在页面上的位置,布局其实是找到所有元素的几何关系的过程。其具体过程如下:

  通过遍历 DOM 及相关元素的计算样式,主线程会构建出包含每个元素的坐标信息及盒子大小的布局树。布局树和 DOM 树类似,但是其中只包含页面可见的元素,如果一个元素设置了 display:none ,这个元素不会出现在布局树上,伪元素虽然在 DOM 树上不可见,但是在布局树上是可见的。

  6. 绘制各元素

  即使知道了不同元素的位置及样式信息,我们还需要知道不同元素的绘制先后顺序才能正确绘制出整个页面。在绘制阶段,主线程会遍历布局树以创建绘制记录。绘制记录可以看做是记录各元素绘制先后顺序的笔记。

  主线程依据布局树构建绘制记录

  7. 合成帧

  熟悉 PS 等绘图软件的童鞋肯定对图层这一概念不陌生,现代 Chrome 其实利用了这一概念来组合不同的层。

  复合是一种分割页面为不同的层,并单独栅格化,随后组合为帧的技术。不同层的组合由 compositor 线程(合成器线程)完成。

  主线程会遍历布局树来创建层树(layer tree),添加了 will-change CSS 属性的元素,会被看做单独的一层。

  主线程遍历布局树生成层树

  你可能会想给每一个元素都添加上 will-change,不过组合过多的层也许会比在每一帧都栅格化页面中的某些小部分更慢。为了更合理的使用层,可参考 坚持仅合成器的属性和管理层计数 。

  一旦层树被创建,渲染顺序被确定,主线程会把这些信息通知给合成器线程,合成器线程会栅格化每一层。有的层的可以达到整个页面的大小,因此,合成器线程将它们分成多个磁贴,并将每个磁贴发送到栅格线程,栅格线程会栅格化每一个磁贴并存储在 GPU 显存中。

  栅格线程会栅格化每一个磁贴并存储在 GPU 显存中

  一旦磁贴被光栅化,合成器线程会收集称为绘制四边形的磁贴信息以创建合成帧。

  合成帧随后会通过 IPC 消息传递给浏览器进程,由于浏览器的 UI 改变或者其它拓展的渲染进程也可以添加合成帧,这些合成帧会被传递给 GPU 用以展示在屏幕上,如果滚动发生,合成器线程会创建另一个合成帧发送给 GPU。

  合成器线程会发送合成帧给 GPU 渲染

  合成器的优点在于,其工作无关主线程,合成器线程不需要等待样式计算或者 JS 执行,这就是为什么合成器相关的动画 最流畅,如果某个动画涉及到布局或者绘制的调整,就会涉及到主线程的重新计算,自然会慢很多。

  浏览器对事件的处理

  浏览器通过对不同事件的处理来满足各种交互需求,这一部分我们一起看看从浏览器的视角,事件是什么,在此我们先主要考虑鼠标事件。

  在浏览器的看来,用户的所有手势都是输入,鼠标滚动,悬置,点击等等都是。

  当用户在屏幕上触发诸如 touch 等手势时,首先收到手势信息的是 Browser process, 不过 Browser process 只会感知到在哪里发生了手势,对 tab 内内容的处理是还是由渲染进程控制的。

  事件发生时,浏览器进程会发送事件类型及相应的坐标给渲染进程,渲染进程随后找到事件对象并执行所有绑定在其上的相关事件处理函数。

  事件从浏览器进程传送给渲染进程

  前文中,我们提到过合成器可以独立于主线程之外通过合成栅格化层平滑的处理滚动。如果页面中没有绑定相关事件,组合器线程可以独立于主线程创建组合帧。如果页面绑定了相关事件处理器,主线程就不得不出来工作了。这时候合成器线程会怎么处理呢?

  这里涉及到一个专业名词「理解非快速滚动区域(non-fast scrollable region)」由于执行 JS 是主线程的工作,当页面合成时,合成器线程会标记页面中绑定有事件处理器的区域为 non-fast scrollable region ,如果存在这个标注,合成器线程会把发生在此处的事件发送给主线程,如果事件不是发生在这些区域,合成器线程则会直接合成新的帧而不用等到主线程的响应。

  涉及 non-fast scrollable region 的事件,合成器线程会通知主线程进行相关处理。

  web 开发中常用的事件处理模式是事件委托,基于事件冒泡,我们常常在最顶层绑定事件:

1
2
3
4
5
6
7
document.body.addEventListener('touchstart',
event => {
if (event.target === area) {
event.preventDefault();
}
}
);

  上述做法很常见,但是如果从浏览器的角度看,整个页面都成了 non-fast scrollable region 了。

  这意味着即使操作的是页面无绑定事件处理器的区域,每次输入时,合成器线程也需要和主线程通信并等待反馈,流畅的合成器独立处理合成帧的模式就失效了。

  由于事件绑定在最顶部,整个页面都成为了 non-fast scrollable region。

  为了防止这种情况,我们可以为事件处理器传递 passive: true 做为参数,这样写就能让浏览器即监听相关事件,又让组合器线程在等等主线程响应前构建新的组合帧。

1
2
3
4
5
6
7
document.body.addEventListener('touchstart',
event => {
if (event.target === area) {
event.preventDefault()
}
}, {passive: true}
);

  不过上述写法可能又会带来另外一个问题,假设某个区域你只想要水平滚动,使用 passive: true 可以实现平滑滚动,但是垂直方向的滚动可能会先于event.preventDefault()发生,此时可以通过 event.cancelable 来防止这种情况。

1
2
3
4
5
6
7
8
document.body.addEventListener('pointermove', event => {
if (event.cancelable) {
event.preventDefault(); // block the native scroll
/*
* do what you want the application to do here
*/
}
}, {passive: true});

  也可以使用 css 属性 touch-action 来完全消除事件处理器的影响,如:

1
2
3
#area {
touch-action: pan-x;
}

  查找到事件对象

  当组合器线程发送输入事件给主线程时,主线程首先会进行命中测试(hit test)来查找对应的事件目标,命中测试会基于渲染过程中生成的绘制记录( paint records )查找事件发生坐标下存在的元素。

  主线程依据绘制记录查找事件相关元素。

  事件的优化

  一般我们屏幕的刷新速率为 60fps,但是某些事件的触发量会不止这个值,出于优化的目的,Chrome 会合并连续的事件 (如 wheel, mousewheel, mousemove, pointermove, touchmove ),并延迟到下一帧渲染时候执行 。

  而如 keydown, keyup, mouseup, mousedown, touchstart, 和 touchend 等非连续性事件则会立即被触发。

  Chrome 会合并连续事件到下一帧触发。

  合并事件虽然能提示性能,但是如果你的应用是绘画等,则很难绘制一条平滑的曲线了,此时可以使用 getCoalescedEvents API 来获取组合的事件。示例代码如下:

1
2
3
4
5
6
7
8
window.addEventListener('pointermove', event => {
const events = event.getCoalescedEvents();
for (let event of events) {
const x = event.pageX;
const y = event.pageY;
// draw a line using x and y coordinates.
}
});

  感谢作者,真是好文

underscore源码-带中文注解

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
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
//     Underscore.js 1.8.3
// http://underscorejs.org
// (c) 2009-2015 Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors
// Underscore may be freely distributed under the MIT license.
// 中文注释 by hanzichi @https://github.com/hanzichi
// 我的源码解读顺序(跟系列解读文章相对应)
// Object -> Array -> Collection -> Function -> Utility

(function() {

// Baseline setup
// 基本设置、配置
// --------------

// Establish the root object, `window` in the browser, or `exports` on the server.
// 将 this 赋值给局部变量 root
// root 的值, 客户端为 `window`, 服务端(node) 中为 `exports`
var root = this;

// Save the previous value of the `_` variable.
// 将原来全局环境中的变量 `_` 赋值给变量 previousUnderscore 进行缓存
// 在后面的 noConflict 方法中有用到
var previousUnderscore = root._;

// Save bytes in the minified (but not gzipped) version:
// 缓存变量, 便于压缩代码
// 此处「压缩」指的是压缩到 min.js 版本
// 而不是 gzip 压缩
var ArrayProto = Array.prototype, ObjProto = Object.prototype, FuncProto = Function.prototype;

// Create quick reference variables for speed access to core prototypes.
// 缓存变量, 便于压缩代码
// 同时可减少在原型链中的查找次数(提高代码效率)
var
push = ArrayProto.push,
slice = ArrayProto.slice,
toString = ObjProto.toString,
hasOwnProperty = ObjProto.hasOwnProperty;

// All **ECMAScript 5** native function implementations that we hope to use
// are declared here.
// ES5 原生方法, 如果浏览器支持, 则 underscore 中会优先使用
var
nativeIsArray = Array.isArray,
nativeKeys = Object.keys,
nativeBind = FuncProto.bind,
nativeCreate = Object.create;

// Naked function reference for surrogate-prototype-swapping.
var Ctor = function(){};

// Create a safe reference to the Underscore object for use below.
// 核心函数
// `_` 其实是一个构造函数
// 支持无 new 调用的构造函数(思考 jQuery 的无 new 调用)
// 将传入的参数(实际要操作的数据)赋值给 this._wrapped 属性
// OOP 调用时,_ 相当于一个构造函数
// each 等方法都在该构造函数的原型链上
// _([1, 2, 3]).each(alert)
// _([1, 2, 3]) 相当于无 new 构造了一个新的对象
// 调用了该对象的 each 方法,该方法在该对象构造函数的原型链上
var _ = function(obj) {
// 以下均针对 OOP 形式的调用
// 如果是非 OOP 形式的调用,不会进入该函数内部

// 如果 obj 已经是 `_` 函数的实例,则直接返回 obj
if (obj instanceof _)
return obj;

// 如果不是 `_` 函数的实例
// 则调用 new 运算符,返回实例化的对象
if (!(this instanceof _))
return new _(obj);

// 将 obj 赋值给 this._wrapped 属性
this._wrapped = obj;
};

// Export the Underscore object for **Node.js**, with
// backwards-compatibility for the old `require()` API. If we're in
// the browser, add `_` as a global object.
// 将上面定义的 `_` 局部变量赋值给全局对象中的 `_` 属性
// 即客户端中 window._ = _
// 服务端(node)中 exports._ = _
// 同时在服务端向后兼容老的 require() API
// 这样暴露给全局后便可以在全局环境中使用 `_` 变量(方法)
if (typeof exports !== 'undefined') {
if (typeof module !== 'undefined' && module.exports) {
exports = module.exports = _;
}
exports._ = _;
} else {
root._ = _;
}

// Current version.
// 当前 underscore 版本号
_.VERSION = '1.8.3';

// Internal function that returns an efficient (for current engines) version
// of the passed-in callback, to be repeatedly applied in other Underscore
// functions.
// underscore 内部方法
// 根据 this 指向(context 参数)
// 以及 argCount 参数
// 二次操作返回一些回调、迭代方法
var optimizeCb = function(func, context, argCount) {
// 如果没有指定 this 指向,则返回原函数
if (context === void 0)
return func;

switch (argCount == null ? 3 : argCount) {
case 1: return function(value) {
return func.call(context, value);
};
case 2: return function(value, other) {
return func.call(context, value, other);
};

// 如果有指定 this,但没有传入 argCount 参数
// 则执行以下 case
// _.each、_.map
case 3: return function(value, index, collection) {
return func.call(context, value, index, collection);
};

// _.reduce、_.reduceRight
case 4: return function(accumulator, value, index, collection) {
return func.call(context, accumulator, value, index, collection);
};
}

// 其实不用上面的 switch-case 语句
// 直接执行下面的 return 函数就行了
// 不这样做的原因是 call 比 apply 快很多
// .apply 在运行前要对作为参数的数组进行一系列检验和深拷贝,.call 则没有这些步骤
// 具体可以参考:
// https://segmentfault.com/q/1010000007894513
// http://www.ecma-international.org/ecma-262/5.1/#sec-15.3.4.3
// http://www.ecma-international.org/ecma-262/5.1/#sec-15.3.4.4
return function() {
return func.apply(context, arguments);
};
};

// A mostly-internal function to generate callbacks that can be applied
// to each element in a collection, returning the desired result — either
// identity, an arbitrary callback, a property matcher, or a property accessor.
var cb = function(value, context, argCount) {
if (value == null) return _.identity;
if (_.isFunction(value)) return optimizeCb(value, context, argCount);
if (_.isObject(value)) return _.matcher(value);
return _.property(value);
};

_.iteratee = function(value, context) {
return cb(value, context, Infinity);
};

// An internal function for creating assigner functions.
// 有三个方法用到了这个内部函数
// _.extend & _.extendOwn & _.defaults
// _.extend = createAssigner(_.allKeys);
// _.extendOwn = _.assign = createAssigner(_.keys);
// _.defaults = createAssigner(_.allKeys, true);
var createAssigner = function(keysFunc, undefinedOnly) {
// 返回函数
// 经典闭包(undefinedOnly 参数在返回的函数中被引用)
// 返回的函数参数个数 >= 1
// 将第二个开始的对象参数的键值对 "继承" 给第一个参数
return function(obj) {
var length = arguments.length;
// 只传入了一个参数(或者 0 个?)
// 或者传入的第一个参数是 null
if (length < 2 || obj == null) return obj;

// 枚举第一个参数除外的对象参数
// 即 arguments[1], arguments[2] ...
for (var index = 1; index < length; index++) {
// source 即为对象参数
var source = arguments[index],
// 提取对象参数的 keys 值
// keysFunc 参数表示 _.keys
// 或者 _.allKeys
keys = keysFunc(source),
l = keys.length;

// 遍历该对象的键值对
for (var i = 0; i < l; i++) {
var key = keys[i];
// _.extend 和 _.extendOwn 方法
// 没有传入 undefinedOnly 参数,即 !undefinedOnly 为 true
// 即肯定会执行 obj[key] = source[key]
// 后面对象的键值对直接覆盖 obj
// ==========================================
// _.defaults 方法,undefinedOnly 参数为 true
// 即 !undefinedOnly 为 false
// 那么当且仅当 obj[key] 为 undefined 时才覆盖
// 即如果有相同的 key 值,取最早出现的 value 值
// *defaults 中有相同 key 的也是一样取首次出现的
if (!undefinedOnly || obj[key] === void 0)
obj[key] = source[key];
}
}

// 返回已经继承后面对象参数属性的第一个参数对象
return obj;
};
};

// An internal function for creating a new object that inherits from another.
// use in `_.create`
var baseCreate = function(prototype) {
// 如果 prototype 参数不是对象
if (!_.isObject(prototype)) return {};

// 如果浏览器支持 ES5 Object.create
if (nativeCreate) return nativeCreate(prototype);

Ctor.prototype = prototype;
var result = new Ctor;
Ctor.prototype = null;
return result;
};

// 闭包
var property = function(key) {
return function(obj) {
return obj == null ? void 0 : obj[key];
};
};

// Helper for collection methods to determine whether a collection
// should be iterated as an array or as an object
// Related: http://people.mozilla.org/~jorendorff/es6-draft.html#sec-tolength
// Avoids a very nasty iOS 8 JIT bug on ARM-64. #2094

// Math.pow(2, 53) - 1 是 JavaScript 中能精确表示的最大数字
var MAX_ARRAY_INDEX = Math.pow(2, 53) - 1;

// getLength 函数
// 该函数传入一个参数,返回参数的 length 属性值
// 用来获取 array 以及 arrayLike 元素的 length 属性值
var getLength = property('length');

// 判断是否是 ArrayLike Object
// 类数组,即拥有 length 属性并且 length 属性值为 Number 类型的元素
// 包括数组、arguments、HTML Collection 以及 NodeList 等等
// 包括类似 {length: 10} 这样的对象
// 包括字符串、函数等
var isArrayLike = function(collection) {
// 返回参数 collection 的 length 属性值
var length = getLength(collection);
return typeof length == 'number' && length >= 0 && length <= MAX_ARRAY_INDEX;
};


// Collection Functions
// 数组或者对象的扩展方法
// 共 25 个扩展方法
// --------------------

// The cornerstone, an `each` implementation, aka `forEach`.
// Handles raw objects in addition to array-likes. Treats all
// sparse array-likes as if they were dense.
// 与 ES5 中 Array.prototype.forEach 使用方法类似
// 遍历数组或者对象的每个元素
// 第一个参数为数组(包括类数组)或者对象
// 第二个参数为迭代方法,对数组或者对象每个元素都执行该方法
// 该方法又能传入三个参数,分别为 (item, index, array)((value, key, obj) for object)
// 与 ES5 中 Array.prototype.forEach 方法传参格式一致
// 第三个参数(可省略)确定第二个参数 iteratee 函数中的(可能有的)this 指向
// 即 iteratee 中出现的(如果有)所有 this 都指向 context
// notice: 不要传入一个带有 key 类型为 number 的对象!
// notice: _.each 方法不能用 return 跳出循环(同样,Array.prototype.forEach 也不行)
_.each = _.forEach = function(obj, iteratee, context) {
// 根据 context 确定不同的迭代函数
iteratee = optimizeCb(iteratee, context);

var i, length;

// 如果是类数组
// 默认不会传入类似 {length: 10} 这样的数据
if (isArrayLike(obj)) {
// 遍历
for (i = 0, length = obj.length; i < length; i++) {
iteratee(obj[i], i, obj);
}
} else { // 如果 obj 是对象
// 获取对象的所有 key 值
var keys = _.keys(obj);

// 如果是对象,则遍历处理 values 值
for (i = 0, length = keys.length; i < length; i++) {
iteratee(obj[keys[i]], keys[i], obj); // (value, key, obj)
}
}

// 返回 obj 参数
// 供链式调用(Returns the list for chaining)
// 应该仅 OOP 调用有效
return obj;
};

// Return the results of applying the iteratee to each element.
// 与 ES5 中 Array.prototype.map 使用方法类似
// 传参形式与 _.each 方法类似
// 遍历数组(每个元素)或者对象的每个元素(value)
// 对每个元素执行 iteratee 迭代方法
// 将结果保存到新的数组中,并返回
_.map = _.collect = function(obj, iteratee, context) {
// 根据 context 确定不同的迭代函数
iteratee = cb(iteratee, context);

// 如果传参是对象,则获取它的 keys 值数组(短路表达式)
var keys = !isArrayLike(obj) && _.keys(obj),
// 如果 obj 为对象,则 length 为 key.length
// 如果 obj 为数组,则 length 为 obj.length
length = (keys || obj).length,
results = Array(length); // 结果数组

// 遍历
for (var index = 0; index < length; index++) {
// 如果 obj 为对象,则 currentKey 为对象键值 key
// 如果 obj 为数组,则 currentKey 为 index 值
var currentKey = keys ? keys[index] : index;
results[index] = iteratee(obj[currentKey], currentKey, obj);
}

// 返回新的结果数组
return results;
};

// Create a reducing function iterating left or right.
// dir === 1 -> _.reduce
// dir === -1 -> _.reduceRight
function createReduce(dir) {
// Optimized iterator function as using arguments.length
// in the main function will deoptimize the, see #1991.
function iterator(obj, iteratee, memo, keys, index, length) {
for (; index >= 0 && index < length; index += dir) {
var currentKey = keys ? keys[index] : index;
// 迭代,返回值供下次迭代调用
memo = iteratee(memo, obj[currentKey], currentKey, obj);
}
// 每次迭代返回值,供下次迭代调用
return memo;
}

// _.reduce(_.reduceRight)可传入的 4 个参数
// obj 数组或者对象
// iteratee 迭代方法,对数组或者对象每个元素执行该方法
// memo 初始值,如果有,则从 obj 第一个元素开始迭代
// 如果没有,则从 obj 第二个元素开始迭代,将第一个元素作为初始值
// context 为迭代函数中的 this 指向
return function(obj, iteratee, memo, context) {
iteratee = optimizeCb(iteratee, context, 4);
var keys = !isArrayLike(obj) && _.keys(obj),
length = (keys || obj).length,
index = dir > 0 ? 0 : length - 1;

// Determine the initial value if none is provided.
// 如果没有指定初始值
// 则把第一个元素指定为初始值
if (arguments.length < 3) {
memo = obj[keys ? keys[index] : index];
// 根据 dir 确定是向左还是向右遍历
index += dir;
}

return iterator(obj, iteratee, memo, keys, index, length);
};
}

// **Reduce** builds up a single result from a list of values, aka `inject`,
// or `foldl`.
// 与 ES5 中 Array.prototype.reduce 使用方法类似
// _.reduce(list, iteratee, [memo], [context])
// _.reduce 方法最多可传入 4 个参数
// memo 为初始值,可选
// context 为指定 iteratee 中 this 指向,可选
_.reduce = _.foldl = _.inject = createReduce(1);

// The right-associative version of reduce, also known as `foldr`.
// 与 ES5 中 Array.prototype.reduceRight 使用方法类似
_.reduceRight = _.foldr = createReduce(-1);

// Return the first value which passes a truth test. Aliased as `detect`.
// 寻找数组或者对象中第一个满足条件(predicate 函数返回 true)的元素
// 并返回该元素值
// _.find(list, predicate, [context])
_.find = _.detect = function(obj, predicate, context) {
var key;
// 如果 obj 是数组,key 为满足条件的下标
if (isArrayLike(obj)) {
key = _.findIndex(obj, predicate, context);
} else {
// 如果 obj 是对象,key 为满足条件的元素的 key 值
key = _.findKey(obj, predicate, context);
}

// 如果该元素存在,则返回该元素
// 如果不存在,则默认返回 undefined(函数没有返回,即返回 undefined)
if (key !== void 0 && key !== -1) return obj[key];
};

// Return all the elements that pass a truth test.
// Aliased as `select`.
// 与 ES5 中 Array.prototype.filter 使用方法类似
// 寻找数组或者对象中所有满足条件的元素
// 如果是数组,则将 `元素值` 存入数组
// 如果是对象,则将 `value 值` 存入数组
// 返回该数组
// _.filter(list, predicate, [context])
_.filter = _.select = function(obj, predicate, context) {
var results = [];

// 根据 this 指向,返回 predicate 函数(判断函数)
predicate = cb(predicate, context);

// 遍历每个元素,如果符合条件则存入数组
_.each(obj, function(value, index, list) {
if (predicate(value, index, list)) results.push(value);
});

return results;
};

// Return all the elements for which a truth test fails.
// 寻找数组或者对象中所有不满足条件的元素
// 并以数组方式返回
// 所得结果是 _.filter 方法的补集
_.reject = function(obj, predicate, context) {
return _.filter(obj, _.negate(cb(predicate)), context);
};

// Determine whether all of the elements match a truth test.
// Aliased as `all`.
// 与 ES5 中的 Array.prototype.every 方法类似
// 判断数组中的每个元素或者对象中每个 value 值是否都满足 predicate 函数中的判断条件
// 如果是,则返回 ture;否则返回 false(有一个不满足就返回 false)
// _.every(list, [predicate], [context])
_.every = _.all = function(obj, predicate, context) {
// 根据 this 指向,返回相应 predicate 函数
predicate = cb(predicate, context);

var keys = !isArrayLike(obj) && _.keys(obj),
length = (keys || obj).length;

for (var index = 0; index < length; index++) {
var currentKey = keys ? keys[index] : index;
// 如果有一个不能满足 predicate 中的条件
// 则返回 false
if (!predicate(obj[currentKey], currentKey, obj))
return false;
}

return true;
};

// Determine if at least one element in the object matches a truth test.
// Aliased as `any`.
// 与 ES5 中 Array.prototype.some 方法类似
// 判断数组或者对象中是否有一个元素(value 值 for object)满足 predicate 函数中的条件
// 如果是则返回 true;否则返回 false
// _.some(list, [predicate], [context])
_.some = _.any = function(obj, predicate, context) {
// 根据 context 返回 predicate 函数
predicate = cb(predicate, context);
// 如果传参是对象,则返回该对象的 keys 数组
var keys = !isArrayLike(obj) && _.keys(obj),
length = (keys || obj).length;
for (var index = 0; index < length; index++) {
var currentKey = keys ? keys[index] : index;
// 如果有一个元素满足条件,则返回 true
if (predicate(obj[currentKey], currentKey, obj)) return true;
}
return false;
};

// Determine if the array or object contains a given item (using `===`).
// Aliased as `includes` and `include`.
// 判断数组或者对象中(value 值)是否有指定元素
// 如果是 object,则忽略 key 值,只需要查找 value 值即可
// 即该 obj 中是否有指定的 value 值
// 返回布尔值
_.contains = _.includes = _.include = function(obj, item, fromIndex, guard) {
// 如果是对象,返回 values 组成的数组
if (!isArrayLike(obj)) obj = _.values(obj);

// fromIndex 表示查询起始位置
// 如果没有指定该参数,则默认从头找起
if (typeof fromIndex != 'number' || guard) fromIndex = 0;

// _.indexOf 是数组的扩展方法(Array Functions)
// 数组中寻找某一元素
return _.indexOf(obj, item, fromIndex) >= 0;
};

// Invoke a method (with arguments) on every item in a collection.
// Calls the method named by methodName on each value in the list.
// Any extra arguments passed to invoke will be forwarded on to the method invocation.
// 数组或者对象中的每个元素都调用 method 方法
// 返回调用后的结果(数组或者关联数组)
// method 参数后的参数会被当做参数传入 method 方法中
// _.invoke(list, methodName, *arguments)
_.invoke = function(obj, method) {
// *arguments 参数
var args = slice.call(arguments, 2);

// 判断 method 是不是函数
var isFunc = _.isFunction(method);

// 用 map 方法对数组或者对象每个元素调用方法
// 返回数组
return _.map(obj, function(value) {
// 如果 method 不是函数,则可能是 obj 的 key 值
// 而 obj[method] 可能为函数
var func = isFunc ? method : value[method];
return func == null ? func : func.apply(value, args);
});
};

// Convenience version of a common use case of `map`: fetching a property.
// 一个数组,元素都是对象
// 根据指定的 key 值
// 返回一个数组,元素都是指定 key 值的 value 值
/*
var property = function(key) {
return function(obj) {
return obj == null ? void 0 : obj[key];
};
};
*/
// _.pluck(list, propertyName)
_.pluck = function(obj, key) {
return _.map(obj, _.property(key));
};

// Convenience version of a common use case of `filter`: selecting only objects
// containing specific `key:value` pairs.
// 根据指定的键值对
// 选择对象
_.where = function(obj, attrs) {
return _.filter(obj, _.matcher(attrs));
};

// Convenience version of a common use case of `find`: getting the first object
// containing specific `key:value` pairs.
// 寻找第一个有指定 key-value 键值对的对象
_.findWhere = function(obj, attrs) {
return _.find(obj, _.matcher(attrs));
};

// Return the maximum element (or element-based computation).
// 寻找数组中的最大元素
// 或者对象中的最大 value 值
// 如果有 iteratee 参数,则求每个元素经过该函数迭代后的最值
// _.max(list, [iteratee], [context])
_.max = function(obj, iteratee, context) {
var result = -Infinity, lastComputed = -Infinity,
value, computed;

// 单纯地寻找最值
if (iteratee == null && obj != null) {
// 如果是数组,则寻找数组中最大元素
// 如果是对象,则寻找最大 value 值
obj = isArrayLike(obj) ? obj : _.values(obj);

for (var i = 0, length = obj.length; i < length; i++) {
value = obj[i];
if (value > result) {
result = value;
}
}
} else { // 寻找元素经过迭代后的最值
iteratee = cb(iteratee, context);

// result 保存结果元素
// lastComputed 保存计算过程中出现的最值
// 遍历元素
_.each(obj, function(value, index, list) {
// 经过迭代函数后的值
computed = iteratee(value, index, list);
// && 的优先级高于 ||
if (computed > lastComputed || computed === -Infinity && result === -Infinity) {
result = value;
lastComputed = computed;
}
});
}

return result;
};

// Return the minimum element (or element-based computation).
// 寻找最小的元素
// 类似 _.max
// _.min(list, [iteratee], [context])
_.min = function(obj, iteratee, context) {
var result = Infinity, lastComputed = Infinity,
value, computed;
if (iteratee == null && obj != null) {
obj = isArrayLike(obj) ? obj : _.values(obj);
for (var i = 0, length = obj.length; i < length; i++) {
value = obj[i];
if (value < result) {
result = value;
}
}
} else {
iteratee = cb(iteratee, context);
_.each(obj, function(value, index, list) {
computed = iteratee(value, index, list);
if (computed < lastComputed || computed === Infinity && result === Infinity) {
result = value;
lastComputed = computed;
}
});
}
return result;
};

// Shuffle a collection, using the modern version of the
// [Fisher-Yates shuffle](http://en.wikipedia.org/wiki/Fisher–Yates_shuffle).
// 将数组乱序
// 如果是对象,则返回一个数组,数组由对象 value 值构成
// Fisher-Yates shuffle 算法
// 最优的洗牌算法,复杂度 O(n)
// 乱序不要用 sort + Math.random(),复杂度 O(nlogn)
// 而且,并不是真正的乱序
// @see https://github.com/hanzichi/underscore-analysis/issues/15
_.shuffle = function(obj) {
// 如果是对象,则对 value 值进行乱序
var set = isArrayLike(obj) ? obj : _.values(obj);
var length = set.length;

// 乱序后返回的数组副本(参数是对象则返回乱序后的 value 数组)
var shuffled = Array(length);

// 枚举元素
for (var index = 0, rand; index < length; index++) {
// 将当前所枚举位置的元素和 `index=rand` 位置的元素交换
rand = _.random(0, index);
if (rand !== index) shuffled[index] = shuffled[rand];
shuffled[rand] = set[index];
}

return shuffled;
};

// Sample **n** random values from a collection.
// If **n** is not specified, returns a single random element.
// The internal `guard` argument allows it to work with `map`.
// 随机返回数组或者对象中的一个元素
// 如果指定了参数 `n`,则随机返回 n 个元素组成的数组
// 如果参数是对象,则数组由 values 组成
_.sample = function(obj, n, guard) {
// 随机返回一个元素
if (n == null || guard) {
if (!isArrayLike(obj)) obj = _.values(obj);
return obj[_.random(obj.length - 1)];
}

// 随机返回 n 个
return _.shuffle(obj).slice(0, Math.max(0, n));
};

// Sort the object's values by a criterion produced by an iteratee.
// 排序
// _.sortBy(list, iteratee, [context])
_.sortBy = function(obj, iteratee, context) {
iteratee = cb(iteratee, context);

// 根据指定的 key 返回 values 数组
// _.pluck([{}, {}, {}], 'value')
return _.pluck(
// _.map(obj, function(){}).sort()
// _.map 后的结果 [{}, {}..]
// sort 后的结果 [{}, {}..]
_.map(obj, function(value, index, list) {
return {
value: value,
index: index,
// 元素经过迭代函数迭代后的值
criteria: iteratee(value, index, list)
};
}).sort(function(left, right) {
var a = left.criteria;
var b = right.criteria;
if (a !== b) {
if (a > b || a === void 0) return 1;
if (a < b || b === void 0) return -1;
}
return left.index - right.index;
}), 'value');

};

// An internal function used for aggregate "group by" operations.
// behavior 是一个函数参数
// _.groupBy, _.indexBy 以及 _.countBy 其实都是对数组元素进行分类
// 分类规则就是 behavior 函数
var group = function(behavior) {
return function(obj, iteratee, context) {
// 返回结果是一个对象
var result = {};
iteratee = cb(iteratee, context);
// 遍历元素
_.each(obj, function(value, index) {
// 经过迭代,获取结果值,存为 key
var key = iteratee(value, index, obj);
// 按照不同的规则进行分组操作
// 将变量 result 当做参数传入,能在 behavior 中改变该值
behavior(result, value, key);
});
// 返回结果对象
return result;
};
};

// Groups the object's values by a criterion. Pass either a string attribute
// to group by, or a function that returns the criterion.
// groupBy_ _.groupBy(list, iteratee, [context])
// 根据特定规则对数组或者对象中的元素进行分组
// result 是返回对象
// value 是数组元素
// key 是迭代后的值
_.groupBy = group(function(result, value, key) {
// 根据 key 值分组
// key 是元素经过迭代函数后的值
// 或者元素自身的属性值

// result 对象已经有该 key 值了
if (_.has(result, key))
result[key].push(value);
else result[key] = [value];
});

// Indexes the object's values by a criterion, similar to `groupBy`, but for
// when you know that your index values will be unique.
_.indexBy = group(function(result, value, key) {
// key 值必须是独一无二的
// 不然后面的会覆盖前面的
// 其他和 _.groupBy 类似
result[key] = value;
});

// Counts instances of an object that group by a certain criterion. Pass
// either a string attribute to count by, or a function that returns the
// criterion.
_.countBy = group(function(result, value, key) {
// 不同 key 值元素数量
if (_.has(result, key))
result[key]++;
else result[key] = 1;
});

// Safely create a real, live array from anything iterable.
// 伪数组 -> 数组
// 对象 -> 提取 value 值组成数组
// 返回数组
_.toArray = function(obj) {
if (!obj) return [];

// 如果是数组,则返回副本数组
// 是否用 obj.concat() 更方便?
if (_.isArray(obj)) return slice.call(obj);

// 如果是类数组,则重新构造新的数组
// 是否也可以直接用 slice 方法?
if (isArrayLike(obj)) return _.map(obj, _.identity);

// 如果是对象,则返回 values 集合
return _.values(obj);
};

// Return the number of elements in an object.
// 如果是数组(类数组),返回长度(length 属性)
// 如果是对象,返回键值对数量
_.size = function(obj) {
if (obj == null) return 0;
return isArrayLike(obj) ? obj.length : _.keys(obj).length;
};

// Split a collection into two arrays: one whose elements all satisfy the given
// predicate, and one whose elements all do not satisfy the predicate.
// 将数组或者对象中符合条件(predicate)的元素
// 和不符合条件的元素(数组为元素,对象为 value 值)
// 分别放入两个数组中
// 返回一个数组,数组元素为以上两个数组([[pass array], [fail array]])
_.partition = function(obj, predicate, context) {
predicate = cb(predicate, context);
var pass = [], fail = [];
_.each(obj, function(value, key, obj) {
(predicate(value, key, obj) ? pass : fail).push(value);
});
return [pass, fail];
};


// Array Functions
// 数组的扩展方法
// 共 20 个扩展方法
// Note: All array functions will also work on the arguments object.
// However, Underscore functions are not designed to work on "sparse" arrays.
// ---------------

// Get the first element of an array. Passing **n** will return the first N
// values in the array. Aliased as `head` and `take`. The **guard** check
// allows it to work with `_.map`.
// 返回数组第一个元素
// 如果有参数 n,则返回数组前 n 个元素(组成的数组)
_.first = _.head = _.take = function(array, n, guard) {
// 容错,数组为空则返回 undefined
if (array == null) return void 0;

// 没指定参数 n,则默认返回第一个元素
if (n == null || guard) return array[0];

// 如果传入参数 n,则返回前 n 个元素组成的数组
// 返回前 n 个元素,即剔除后 array.length - n 个元素
return _.initial(array, array.length - n);
};

// Returns everything but the last entry of the array. Especially useful on
// the arguments object. Passing **n** will return all the values in
// the array, excluding the last N.
// 传入一个数组
// 返回剔除最后一个元素之后的数组副本
// 如果传入参数 n,则剔除最后 n 个元素
_.initial = function(array, n, guard) {
return slice.call(array, 0, Math.max(0, array.length - (n == null || guard ? 1 : n)));
};

// Get the last element of an array. Passing **n** will return the last N
// values in the array.
// 返回数组最后一个元素
// 如果传入参数 n
// 则返回该数组后 n 个元素组成的数组
// 即剔除前 array.length - n 个元素
_.last = function(array, n, guard) {
// 容错
if (array == null) return void 0;

// 如果没有指定参数 n,则返回最后一个元素
if (n == null || guard) return array[array.length - 1];

// 如果传入参数 n,则返回后 n 个元素组成的数组
// 即剔除前 array.length - n 个元素
return _.rest(array, Math.max(0, array.length - n));
};

// Returns everything but the first entry of the array. Aliased as `tail` and `drop`.
// Especially useful on the arguments object. Passing an **n** will return
// the rest N values in the array.
// 传入一个数组
// 返回剔除第一个元素后的数组副本
// 如果传入参数 n,则剔除前 n 个元素
_.rest = _.tail = _.drop = function(array, n, guard) {
return slice.call(array, n == null || guard ? 1 : n);
};

// Trim out all falsy values from an array.
// 去掉数组中所有的假值
// 返回数组副本
// JavaScript 中的假值包括 false、null、undefined、''、NaN、0
// 联想 PHP 中的 array_filter() 函数
// _.identity = function(value) {
// return value;
// };
_.compact = function(array) {
return _.filter(array, _.identity);
};

// Internal implementation of a recursive `flatten` function.
// 递归调用数组,将数组展开
// 即 [1, 2, [3, 4]] => [1, 2, 3, 4]
// flatten(array, shallow, false)
// flatten(arguments, true, true, 1)
// flatten(arguments, true, true)
// flatten(arguments, false, false, 1)
// ===== //
// input => Array 或者 arguments
// shallow => 是否只展开一层
// strict === true,通常和 shallow === true 配合使用
// 表示只展开一层,但是不保存非数组元素(即无法展开的基础类型)
// flatten([[1, 2], 3, 4], true, true) => [1, 2]
// flatten([[1, 2], 3, 4], false, true) = > []
// startIndex => 从 input 的第几项开始展开
// ===== //
// 可以看到,如果 strict 参数为 true,那么 shallow 也为 true
// 也就是展开一层,同时把非数组过滤
// [[1, 2], [3, 4], 5, 6] => [1, 2, 3, 4]
var flatten = function(input, shallow, strict, startIndex) {
// output 数组保存结果
// 即 flatten 方法返回数据
// idx 为 output 的累计数组下标
var output = [], idx = 0;

// 根据 startIndex 变量确定需要展开的起始位置
for (var i = startIndex || 0, length = getLength(input); i < length; i++) {
var value = input[i];
// 数组 或者 arguments
// 注意 isArrayLike 还包括 {length: 10} 这样的,过滤掉
if (isArrayLike(value) && (_.isArray(value) || _.isArguments(value))) {
// flatten current level of array or arguments object
// (!shallow === true) => (shallow === false)
// 则表示需深度展开
// 继续递归展开
if (!shallow)
// flatten 方法返回数组
// 将上面定义的 value 重新赋值
value = flatten(value, shallow, strict);

// 递归展开到最后一层(没有嵌套的数组了)
// 或者 (shallow === true) => 只展开一层
// value 值肯定是一个数组
var j = 0, len = value.length;

// 这一步貌似没有必要
// 毕竟 JavaScript 的数组会自动扩充
// 但是这样写,感觉比较好,对于元素的 push 过程有个比较清晰的认识
output.length += len;

// 将 value 数组的元素添加到 output 数组中
while (j < len) {
output[idx++] = value[j++];
}
} else if (!strict) {
// (!strict === true) => (strict === false)
// 如果是深度展开,即 shallow 参数为 false
// 那么当最后 value 不是数组,是基本类型时
// 肯定会走到这个 else-if 判断中
// 而如果此时 strict 为 true,则不能跳到这个分支内部
// 所以 shallow === false 如果和 strict === true 搭配
// 调用 flatten 方法得到的结果永远是空数组 []
output[idx++] = value;
}
}

return output;
};

// Flatten out an array, either recursively (by default), or just one level.
// 将嵌套的数组展开
// 如果参数 (shallow === true),则仅展开一层
// _.flatten([1, [2], [3, [[4]]]]);
// => [1, 2, 3, 4];
// ====== //
// _.flatten([1, [2], [3, [[4]]]], true);
// => [1, 2, 3, [[4]]];
_.flatten = function(array, shallow) {
// array => 需要展开的数组
// shallow => 是否只展开一层
// false 为 flatten 方法 strict 变量
return flatten(array, shallow, false);
};

// Return a version of the array that does not contain the specified value(s).
// without_.without(array, *values)
// Returns a copy of the array with all instances of the values removed.
// ====== //
// _.without([1, 2, 1, 0, 3, 1, 4], 0, 1);
// => [2, 3, 4]
// ===== //
// 从数组中移除指定的元素
// 返回移除后的数组副本
_.without = function(array) {
// slice.call(arguments, 1)
// 将 arguments 转为数组(同时去掉第一个元素)
// 之后便可以调用 _.difference 方法
return _.difference(array, slice.call(arguments, 1));
};

// Produce a duplicate-free version of the array. If the array has already
// been sorted, you have the option of using a faster algorithm.
// Aliased as `unique`.
// 数组去重
// 如果第二个参数 `isSorted` 为 true
// 则说明事先已经知道数组有序
// 程序会跑一个更快的算法(一次线性比较,元素和数组前一个元素比较即可)
// 如果有第三个参数 iteratee,则对数组每个元素迭代
// 对迭代之后的结果进行去重
// 返回去重后的数组(array 的子数组)
// PS: 暴露的 API 中没 context 参数
// _.uniq(array, [isSorted], [iteratee])
_.uniq = _.unique = function(array, isSorted, iteratee, context) {
// 没有传入 isSorted 参数
// 转为 _.unique(array, false, undefined, iteratee)
if (!_.isBoolean(isSorted)) {
context = iteratee;
iteratee = isSorted;
isSorted = false;
}

// 如果有迭代函数
// 则根据 this 指向二次返回新的迭代函数
if (iteratee != null)
iteratee = cb(iteratee, context);

// 结果数组,是 array 的子集
var result = [];

// 已经出现过的元素(或者经过迭代过的值)
// 用来过滤重复值
var seen = [];

for (var i = 0, length = getLength(array); i < length; i++) {
var value = array[i],
// 如果指定了迭代函数
// 则对数组每一个元素进行迭代
// 迭代函数传入的三个参数通常是 value, index, array 形式
computed = iteratee ? iteratee(value, i, array) : value;

// 如果是有序数组,则当前元素只需跟上一个元素对比即可
// 用 seen 变量保存上一个元素
if (isSorted) {
// 如果 i === 0,是第一个元素,则直接 push
// 否则比较当前元素是否和前一个元素相等
if (!i || seen !== computed) result.push(value);
// seen 保存当前元素,供下一次对比
seen = computed;
} else if (iteratee) {
// 如果 seen[] 中没有 computed 这个元素值
if (!_.contains(seen, computed)) {
seen.push(computed);
result.push(value);
}
} else if (!_.contains(result, value)) {
// 如果不用经过迭代函数计算,也就不用 seen[] 变量了
result.push(value);
}
}

return result;
};

// Produce an array that contains the union: each distinct element from all of
// the passed-in arrays.
// union_.union(*arrays)
// Computes the union of the passed-in arrays:
// the list of unique items, in order, that are present in one or more of the arrays.
// ========== //
// _.union([1, 2, 3], [101, 2, 1, 10], [2, 1]);
// => [1, 2, 3, 101, 10]
// ========== //
// 将多个数组的元素集中到一个数组中
// 并且去重,返回数组副本
_.union = function() {
// 首先用 flatten 方法将传入的数组展开成一个数组
// 然后就可以愉快地调用 _.uniq 方法了
// 假设 _.union([1, 2, 3], [101, 2, 1, 10], [2, 1]);
// arguments 为 [[1, 2, 3], [101, 2, 1, 10], [2, 1]]
// shallow 参数为 true,展开一层
// 结果为 [1, 2, 3, 101, 2, 1, 10, 2, 1]
// 然后对其去重
return _.uniq(flatten(arguments, true, true));
};

// Produce an array that contains every item shared between all the
// passed-in arrays.
// 寻找几个数组中共有的元素
// 将这些每个数组中都有的元素存入另一个数组中返回
// _.intersection(*arrays)
// _.intersection([1, 2, 3, 1], [101, 2, 1, 10, 1], [2, 1, 1])
// => [1, 2]
// 注意:返回的结果数组是去重的
_.intersection = function(array) {
// 结果数组
var result = [];

// 传入的参数(数组)个数
var argsLength = arguments.length;

// 遍历第一个数组的元素
for (var i = 0, length = getLength(array); i < length; i++) {
var item = array[i];

// 如果 result[] 中已经有 item 元素了,continue
// 即 array 中出现了相同的元素
// 返回的 result[] 其实是个 "集合"(是去重的)
if (_.contains(result, item)) continue;

// 判断其他参数数组中是否都有 item 这个元素
for (var j = 1; j < argsLength; j++) {
if (!_.contains(arguments[j], item))
break;
}

// 遍历其他参数数组完毕
// j === argsLength 说明其他参数数组中都有 item 元素
// 则将其放入 result[] 中
if (j === argsLength)
result.push(item);
}

return result;
};

// Take the difference between one array and a number of other arrays.
// Only the elements present in just the first array will remain.
// _.difference(array, *others)
// Similar to without, but returns the values from array that are not present in the other arrays.
// ===== //
// _.difference([1, 2, 3, 4, 5], [5, 2, 10]);
// => [1, 3, 4]
// ===== //
// 剔除 array 数组中在 others 数组中出现的元素
_.difference = function(array) {
// 将 others 数组展开一层
// rest[] 保存展开后的元素组成的数组
// strict 参数为 true
// 不可以这样用 _.difference([1, 2, 3, 4, 5], [5, 2], 10);
// 10 就会取不到
var rest = flatten(arguments, true, true, 1);

// 遍历 array,过滤
return _.filter(array, function(value){
// 如果 value 存在在 rest 中,则过滤掉
return !_.contains(rest, value);
});
};

// Zip together multiple lists into a single array -- elements that share
// an index go together.
// ===== //
// _.zip(['moe', 'larry', 'curly'], [30, 40, 50], [true, false, false]);
// => [["moe", 30, true], ["larry", 40, false], ["curly", 50, false]]
// ===== //
// 将多个数组中相同位置的元素归类
// 返回一个数组
_.zip = function() {
return _.unzip(arguments);
};

// Complement of _.zip. Unzip accepts an array of arrays and groups
// each array's elements on shared indices
// The opposite of zip. Given an array of arrays,
// returns a series of new arrays,
// the first of which contains all of the first elements in the input arrays,
// the second of which contains all of the second elements, and so on.
// ===== //
// _.unzip([["moe", 30, true], ["larry", 40, false], ["curly", 50, false]]);
// => [['moe', 'larry', 'curly'], [30, 40, 50], [true, false, false]]
// ===== //
_.unzip = function(array) {
var length = array && _.max(array, getLength).length || 0;
var result = Array(length);

for (var index = 0; index < length; index++) {
result[index] = _.pluck(array, index);
}
return result;
};

// Converts lists into objects. Pass either a single array of `[key, value]`
// pairs, or two parallel arrays of the same length -- one of keys, and one of
// the corresponding values.
// 将数组转化为对象
_.object = function(list, values) {
var result = {};
for (var i = 0, length = getLength(list); i < length; i++) {
if (values) {
result[list[i]] = values[i];
} else {
result[list[i][0]] = list[i][1];
}
}
return result;
};

// Generator function to create the findIndex and findLastIndex functions
// (dir === 1) => 从前往后找
// (dir === -1) => 从后往前找
function createPredicateIndexFinder(dir) {
// 经典闭包
return function(array, predicate, context) {
predicate = cb(predicate, context);

var length = getLength(array);

// 根据 dir 变量来确定数组遍历的起始位置
var index = dir > 0 ? 0 : length - 1;

for (; index >= 0 && index < length; index += dir) {
// 找到第一个符合条件的元素
// 并返回下标值
if (predicate(array[index], index, array))
return index;
}

return -1;
};
}

// Returns the first index on an array-like that passes a predicate test
// 从前往后找到数组中 `第一个满足条件` 的元素,并返回下标值
// 没找到返回 -1
// _.findIndex(array, predicate, [context])
_.findIndex = createPredicateIndexFinder(1);

// 从后往前找到数组中 `第一个满足条件` 的元素,并返回下标值
// 没找到返回 -1
// _.findLastIndex(array, predicate, [context])
_.findLastIndex = createPredicateIndexFinder(-1);

// Use a comparator function to figure out the smallest index at which
// an object should be inserted so as to maintain order. Uses binary search.
// The iteratee may also be the string name of the property to sort by (eg. length).
// ===== //
// _.sortedIndex([10, 20, 30, 40, 50], 35);
// => 3
// ===== //
// var stooges = [{name: 'moe', age: 40}, {name: 'curly', age: 60}];
// _.sortedIndex(stooges, {name: 'larry', age: 50}, 'age');
// => 1
// ===== //
// 二分查找
// 将一个元素插入已排序的数组
// 返回该插入的位置下标
// _.sortedIndex(list, value, [iteratee], [context])
_.sortedIndex = function(array, obj, iteratee, context) {
// 注意 cb 方法
// iteratee 为空 || 为 String 类型(key 值)时会返回不同方法
iteratee = cb(iteratee, context, 1);

// 经过迭代函数计算的值
// 可打印 iteratee 出来看看
var value = iteratee(obj);

var low = 0, high = getLength(array);

// 二分查找
while (low < high) {
var mid = Math.floor((low + high) / 2);
if (iteratee(array[mid]) < value)
low = mid + 1;
else
high = mid;
}

return low;
};

// Generator function to create the indexOf and lastIndexOf functions
// _.indexOf = createIndexFinder(1, _.findIndex, _.sortedIndex);
// _.lastIndexOf = createIndexFinder(-1, _.findLastIndex);
function createIndexFinder(dir, predicateFind, sortedIndex) {
// API 调用形式
// _.indexOf(array, value, [isSorted])
// _.indexOf(array, value, [fromIndex])
// _.lastIndexOf(array, value, [fromIndex])
return function(array, item, idx) {
var i = 0, length = getLength(array);

// 如果 idx 为 Number 类型
// 则规定查找位置的起始点
// 那么第三个参数不是 [isSorted]
// 所以不能用二分查找优化了
// 只能遍历查找
if (typeof idx == 'number') {
if (dir > 0) { // 正向查找
// 重置查找的起始位置
i = idx >= 0 ? idx : Math.max(idx + length, i);
} else { // 反向查找
// 如果是反向查找,重置 length 属性值
length = idx >= 0 ? Math.min(idx + 1, length) : idx + length + 1;
}
} else if (sortedIndex && idx && length) {
// 能用二分查找加速的条件
// 有序 & idx !== 0 && length !== 0

// 用 _.sortIndex 找到有序数组中 item 正好插入的位置
idx = sortedIndex(array, item);

// 如果正好插入的位置的值和 item 刚好相等
// 说明该位置就是 item 第一次出现的位置
// 返回下标
// 否则即是没找到,返回 -1
return array[idx] === item ? idx : -1;
}

// 特判,如果要查找的元素是 NaN 类型
// 如果 item !== item
// 那么 item => NaN
if (item !== item) {
idx = predicateFind(slice.call(array, i, length), _.isNaN);
return idx >= 0 ? idx + i : -1;
}

// O(n) 遍历数组
// 寻找和 item 相同的元素
// 特判排除了 item 为 NaN 的情况
// 可以放心地用 `===` 来判断是否相等了
for (idx = dir > 0 ? i : length - 1; idx >= 0 && idx < length; idx += dir) {
if (array[idx] === item) return idx;
}

return -1;
};
}

// Return the position of the first occurrence of an item in an array,
// or -1 if the item is not included in the array.
// If the array is large and already in sort order, pass `true`
// for **isSorted** to use binary search.
// _.indexOf(array, value, [isSorted])
// 找到数组 array 中 value 第一次出现的位置
// 并返回其下标值
// 如果数组有序,则第三个参数可以传入 true
// 这样算法效率会更高(二分查找)
// [isSorted] 参数表示数组是否有序
// 同时第三个参数也可以表示 [fromIndex] (见下面的 _.lastIndexOf)
_.indexOf = createIndexFinder(1, _.findIndex, _.sortedIndex);

// 和 _indexOf 相似
// 反序查找
// _.lastIndexOf(array, value, [fromIndex])
// [fromIndex] 参数表示从倒数第几个开始往前找
_.lastIndexOf = createIndexFinder(-1, _.findLastIndex);

// Generate an integer Array containing an arithmetic progression. A port of
// the native Python `range()` function. See
// [the Python documentation](http://docs.python.org/library/functions.html#range).
// 返回某一个范围内的数组成的数组
_.range = function(start, stop, step) {
if (stop == null) {
stop = start || 0;
start = 0;
}

step = step || 1;

// 返回数组的长度
var length = Math.max(Math.ceil((stop - start) / step), 0);

// 返回的数组
var range = Array(length);

for (var idx = 0; idx < length; idx++, start += step) {
range[idx] = start;
}

return range;
};


// Function (ahem) Functions
// 函数的扩展方法
// 共 14 个扩展方法
// ------------------

// Determines whether to execute a function as a constructor
// or a normal function with the provided arguments
var executeBound = function(sourceFunc, boundFunc, context, callingContext, args) {
// 非 new 调用 _.bind 返回的方法(即 bound)
// callingContext 不是 boundFunc 的一个实例
if (!(callingContext instanceof boundFunc))
return sourceFunc.apply(context, args);

// 如果是用 new 调用 _.bind 返回的方法

// self 为 sourceFunc 的实例,继承了它的原型链
// self 理论上是一个空对象(还没赋值),但是有原型链
var self = baseCreate(sourceFunc.prototype);

// 用 new 生成一个构造函数的实例
// 正常情况下是没有返回值的,即 result 值为 undefined
// 如果构造函数有返回值
// 如果返回值是对象(非 null),则 new 的结果返回这个对象
// 否则返回实例
// @see http://www.cnblogs.com/zichi/p/4392944.html
var result = sourceFunc.apply(self, args);

// 如果构造函数返回了对象
// 则 new 的结果是这个对象
// 返回这个对象
if (_.isObject(result)) return result;

// 否则返回 self
// var result = sourceFunc.apply(self, args);
// self 对象当做参数传入
// 会直接改变值
return self;
};

// Create a function bound to a given object (assigning `this`, and arguments,
// optionally). Delegates to **ECMAScript 5**'s native `Function.bind` if
// available.
// ES5 bind 方法的扩展(polyfill)
// 将 func 中的 this 指向 context(对象)
// _.bind(function, object, *arguments)
// 可选的 arguments 参数会被当作 func 的参数传入
// func 在调用时,会优先用 arguments 参数,然后使用 _.bind 返回方法所传入的参数
_.bind = function(func, context) {
// 如果浏览器支持 ES5 bind 方法,并且 func 上的 bind 方法没有被重写
// 则优先使用原生的 bind 方法
if (nativeBind && func.bind === nativeBind)
return nativeBind.apply(func, slice.call(arguments, 1));

// 如果传入的参数 func 不是方法,则抛出错误
if (!_.isFunction(func))
throw new TypeError('Bind must be called on a function');

// polyfill
// 经典闭包,函数返回函数
// args 获取优先使用的参数
var args = slice.call(arguments, 2);
var bound = function() {
// args.concat(slice.call(arguments))
// 最终函数的实际调用参数由两部分组成
// 一部分是传入 _.bind 的参数(会被优先调用)
// 另一部分是传入 bound(_.bind 所返回方法)的参数
return executeBound(func, bound, context, this, args.concat(slice.call(arguments)));
};

return bound;
};

// Partially apply a function by creating a version that has had some of its
// arguments pre-filled, without changing its dynamic `this` context. _ acts
// as a placeholder, allowing any combination of arguments to be pre-filled.
// _.partial(function, *arguments)
// _.partial 能返回一个方法
// pre-fill 该方法的一些参数
_.partial = function(func) {
// 提取希望 pre-fill 的参数
// 如果传入的是 _,则这个位置的参数暂时空着,等待手动填入
var boundArgs = slice.call(arguments, 1);

var bound = function() {
var position = 0, length = boundArgs.length;
var args = Array(length);
for (var i = 0; i < length; i++) {
// 如果该位置的参数为 _,则用 bound 方法的参数填充这个位置
// args 为调用 _.partial 方法的 pre-fill 的参数 & bound 方法的 arguments
args[i] = boundArgs[i] === _ ? arguments[position++] : boundArgs[i];
}

// bound 方法还有剩余的 arguments,添上去
while (position < arguments.length)
args.push(arguments[position++]);

return executeBound(func, bound, this, this, args);
};

return bound;
};

// Bind a number of an object's methods to that object. Remaining arguments
// are the method names to be bound. Useful for ensuring that all callbacks
// defined on an object belong to it.
// 指定一系列方法(methodNames)中的 this 指向(object)
// _.bindAll(object, *methodNames)
_.bindAll = function(obj) {
var i, length = arguments.length, key;

// 如果只传入了一个参数(obj),没有传入 methodNames,则报错
if (length <= 1)
throw new Error('bindAll must be passed function names');

// 遍历 methodNames
for (i = 1; i < length; i++) {
key = arguments[i];
// 逐个绑定
obj[key] = _.bind(obj[key], obj);
}
return obj;
};

// Memoize an expensive function by storing its results.
//「记忆化」,存储中间运算结果,提高效率
// 参数 hasher 是个 function,用来计算 key
// 如果传入了 hasher,则用 hasher 来计算 key
// 否则用 key 参数直接当 key(即 memoize 方法传入的第一个参数)
// _.memoize(function, [hashFunction])
// 适用于需要大量重复求值的场景
// 比如递归求解菲波那切数
// @http://www.jameskrob.com/memoize.html
// create hash for storing "expensive" function outputs
// run expensive function
// check whether function has already been run with given arguments via hash lookup
// if false - run function, and store output in hash
// if true, return output stored in hash
_.memoize = function(func, hasher) {
var memoize = function(key) {
// 储存变量,方便使用
var cache = memoize.cache;

// 求 key
// 如果传入了 hasher,则用 hasher 函数来计算 key
// 否则用 参数 key(即 memoize 方法传入的第一个参数)当 key
var address = '' + (hasher ? hasher.apply(this, arguments) : key);

// 如果这个 key 还没被 hash 过(还没求过值)
if (!_.has(cache, address))
cache[address] = func.apply(this, arguments);

// 返回
return cache[address];
};

// cache 对象被当做 key-value 键值对缓存中间运算结果
memoize.cache = {};

// 返回一个函数(经典闭包)
return memoize;
};

// Delays a function for the given number of milliseconds, and then calls
// it with the arguments supplied.
// 延迟触发某方法
// _.delay(function, wait, *arguments)
// 如果传入了 arguments 参数,则会被当作 func 的参数在触发时调用
// 其实是封装了「延迟触发某方法」,使其复用
_.delay = function(func, wait) {
// 获取 *arguments
// 是 func 函数所需要的参数
var args = slice.call(arguments, 2);
return setTimeout(function(){
// 将参数赋予 func 函数
return func.apply(null, args);
}, wait);
};

// Defers a function, scheduling it to run after the current call stack has
// cleared.
// 和 setTimeout(func, 0) 相似(源码看来似乎应该是 setTimeout(func, 1))
// _.defer(function, *arguments)
// 如果传入 *arguments,会被当做参数,和 _.delay 调用方式类似(少了第二个参数)
// 其实核心还是调用了 _.delay 方法,但第二个参数(wait 参数)设置了默认值为 1
// 如何使得方法能设置默认值?用 _.partial 方法
_.defer = _.partial(_.delay, _, 1);

// Returns a function, that, when invoked, will only be triggered at most once
// during a given window of time. Normally, the throttled function will run
// as much as it can, without ever going more than once per `wait` duration;
// but if you'd like to disable the execution on the leading edge, pass
// `{leading: false}`. To disable execution on the trailing edge, ditto.
// 函数节流(如果有连续事件响应,则每间隔一定时间段触发)
// 每间隔 wait(Number) milliseconds 触发一次 func 方法
// 如果 options 参数传入 {leading: false}
// 那么不会马上触发(等待 wait milliseconds 后第一次触发 func)
// 如果 options 参数传入 {trailing: false}
// 那么最后一次回调不会被触发
// **Notice: options 不能同时设置 leading 和 trailing 为 false**
// 示例:
// var throttled = _.throttle(updatePosition, 100);
// $(window).scroll(throttled);
// 调用方式(注意看 A 和 B console.log 打印的位置):
// _.throttle(function, wait, [options])
// sample 1: _.throttle(function(){}, 1000)
// print: A, B, B, B ...
// sample 2: _.throttle(function(){}, 1000, {leading: false})
// print: B, B, B, B ...
// sample 3: _.throttle(function(){}, 1000, {trailing: false})
// print: A, A, A, A ...
// ----------------------------------------- //
_.throttle = function(func, wait, options) {
var context, args, result;

// setTimeout 的 handler
var timeout = null;

// 标记时间戳
// 上一次执行回调的时间戳
var previous = 0;

// 如果没有传入 options 参数
// 则将 options 参数置为空对象
if (!options)
options = {};

var later = function() {
// 如果 options.leading === false
// 则每次触发回调后将 previous 置为 0
// 否则置为当前时间戳
previous = options.leading === false ? 0 : _.now();
timeout = null;
// console.log('B')
result = func.apply(context, args);

// 这里的 timeout 变量一定是 null 了吧
// 是否没有必要进行判断?
if (!timeout)
context = args = null;
};

// 以滚轮事件为例(scroll)
// 每次触发滚轮事件即执行这个返回的方法
// _.throttle 方法返回的函数
return function() {
// 记录当前时间戳
var now = _.now();

// 第一次执行回调(此时 previous 为 0,之后 previous 值为上一次时间戳)
// 并且如果程序设定第一个回调不是立即执行的(options.leading === false)
// 则将 previous 值(表示上次执行的时间戳)设为 now 的时间戳(第一次触发时)
// 表示刚执行过,这次就不用执行了
if (!previous && options.leading === false)
previous = now;

// 距离下次触发 func 还需要等待的时间
var remaining = wait - (now - previous);
context = this;
args = arguments;

// 要么是到了间隔时间了,随即触发方法(remaining <= 0)
// 要么是没有传入 {leading: false},且第一次触发回调,即立即触发
// 此时 previous 为 0,wait - (now - previous) 也满足 <= 0
// 之后便会把 previous 值迅速置为 now
// ========= //
// remaining > wait,表示客户端系统时间被调整过
// 则马上执行 func 函数
// @see https://blog.coding.net/blog/the-difference-between-throttle-and-debounce-in-underscorejs
// ========= //

// console.log(remaining) 可以打印出来看看
if (remaining <= 0 || remaining > wait) {
if (timeout) {
clearTimeout(timeout);
// 解除引用,防止内存泄露
timeout = null;
}

// 重置前一次触发的时间戳
previous = now;

// 触发方法
// result 为该方法返回值
// console.log('A')
result = func.apply(context, args);

// 引用置为空,防止内存泄露
// 感觉这里的 timeout 肯定是 null 啊?这个 if 判断没必要吧?
if (!timeout)
context = args = null;
} else if (!timeout && options.trailing !== false) { // 最后一次需要触发的情况
// 如果已经存在一个定时器,则不会进入该 if 分支
// 如果 {trailing: false},即最后一次不需要触发了,也不会进入这个分支
// 间隔 remaining milliseconds 后触发 later 方法
timeout = setTimeout(later, remaining);
}

// 回调返回值
return result;
};
};

// Returns a function, that, as long as it continues to be invoked, will not
// be triggered. The function will be called after it stops being called for
// N milliseconds. If `immediate` is passed, trigger the function on the
// leading edge, instead of the trailing.
// 函数去抖(连续事件触发结束后只触发一次)
// sample 1: _.debounce(function(){}, 1000)
// 连续事件结束后的 1000ms 后触发
// sample 1: _.debounce(function(){}, 1000, true)
// 连续事件触发后立即触发(此时会忽略第二个参数)
_.debounce = function(func, wait, immediate) {
var timeout, args, context, timestamp, result;

var later = function() {
// 定时器设置的回调 later 方法的触发时间,和连续事件触发的最后一次时间戳的间隔
// 如果间隔为 wait(或者刚好大于 wait),则触发事件
var last = _.now() - timestamp;

// 时间间隔 last 在 [0, wait) 中
// 还没到触发的点,则继续设置定时器
// last 值应该不会小于 0 吧?
if (last < wait && last >= 0) {
timeout = setTimeout(later, wait - last);
} else {
// 到了可以触发的时间点
timeout = null;
// 可以触发了
// 并且不是设置为立即触发的
// 因为如果是立即触发(callNow),也会进入这个回调中
// 主要是为了将 timeout 值置为空,使之不影响下次连续事件的触发
// 如果不是立即执行,随即执行 func 方法
if (!immediate) {
// 执行 func 函数
result = func.apply(context, args);
// 这里的 timeout 一定是 null 了吧
// 感觉这个判断多余了
if (!timeout)
context = args = null;
}
}
};

// 嗯,闭包返回的函数,是可以传入参数的
// 也是 DOM 事件所触发的回调函数
return function() {
// 可以指定 this 指向
context = this;
args = arguments;

// 每次触发函数,更新时间戳
// later 方法中取 last 值时用到该变量
// 判断距离上次触发事件是否已经过了 wait seconds 了
// 即我们需要距离最后一次事件触发 wait seconds 后触发这个回调方法
timestamp = _.now();

// 立即触发需要满足两个条件
// immediate 参数为 true,并且 timeout 还没设置
// immediate 参数为 true 是显而易见的
// 如果去掉 !timeout 的条件,就会一直触发,而不是触发一次
// 因为第一次触发后已经设置了 timeout,所以根据 timeout 是否为空可以判断是否是首次触发
var callNow = immediate && !timeout;

// 设置 wait seconds 后触发 later 方法
// 无论是否 callNow(如果是 callNow,也进入 later 方法,去 later 方法中判断是否执行相应回调函数)
// 在某一段的连续触发中,只会在第一次触发时进入这个 if 分支中
if (!timeout)
// 设置了 timeout,所以以后不会进入这个 if 分支了
timeout = setTimeout(later, wait);

// 如果是立即触发
if (callNow) {
// func 可能是有返回值的
result = func.apply(context, args);
// 解除引用
context = args = null;
}

return result;
};
};

// Returns the first function passed as an argument to the second,
// allowing you to adjust arguments, run code before and after, and
// conditionally execute the original function.
_.wrap = function(func, wrapper) {
return _.partial(wrapper, func);
};

// Returns a negated version of the passed-in predicate.
// 返回一个 predicate 方法的对立方法
// 即该方法可以对原来的 predicate 迭代结果值取补集
_.negate = function(predicate) {
return function() {
return !predicate.apply(this, arguments);
};
};

// Returns a function that is the composition of a list of functions, each
// consuming the return value of the function that follows.
// _.compose(*functions)
// var tmp = _.compose(f, g, h)
// tmp(args) => f(g(h(args)))
_.compose = function() {
var args = arguments; // funcs
var start = args.length - 1; // 倒序调用
return function() {
var i = start;
var result = args[start].apply(this, arguments);
// 一个一个方法地执行
while (i--)
result = args[i].call(this, result);
return result;
};
};

// Returns a function that will only be executed on and after the Nth call.
// 第 times 触发执行 func(事实上之后的每次触发还是会执行 func)
// 有什么用呢?
// 如果有 N 个异步事件,所有异步执行完后执行该回调,即 func 方法(联想 eventproxy)
// _.after 会返回一个函数
// 当这个函数第 times 被执行的时候
// 触发 func 方法
_.after = function(times, func) {
return function() {
// 函数被触发了 times 了,则执行 func 函数
// 事实上 times 次后如果函数继续被执行,也会触发 func
if (--times < 1) {
return func.apply(this, arguments);
}
};
};

// Returns a function that will only be executed up to (but not including) the Nth call.
// 函数至多被调用 times - 1 次((but not including) the Nth call)
// func 函数会触发 time - 1 次(Creates a version of the function that can be called no more than count times)
// func 函数有个返回值,前 time - 1 次触发的返回值都是将参数代入重新计算的
// 第 times 开始的返回值为第 times - 1 次时的返回值(不重新计算)
// The result of the last function call is memoized and returned when count has been reached.
_.before = function(times, func) {
var memo;
return function() {
if (--times > 0) {
// 缓存函数执行结果
memo = func.apply(this, arguments);
}

// func 引用置为空,其实不置为空也用不到 func 了
if (times <= 1)
func = null;

// 前 times - 1 次触发,memo 都是分别计算返回
// 第 times 次开始,memo 值同 times - 1 次时的 memo
return memo;
};
};

// Returns a function that will be executed at most one time, no matter how
// often you call it. Useful for lazy initialization.
// 函数至多只能被调用一次
// 适用于这样的场景,某些函数只能被初始化一次,不得不设置一个变量 flag
// 初始化后设置 flag 为 true,之后不断 check flag
// ====== //
// 其实是调用了 _.before 方法,并且将 times 参数设置为了默认值 2(也就是 func 至多能被调用 2 - 1 = 1 次)
_.once = _.partial(_.before, 2);


// Object Functions
// 对象的扩展方法
// 共 38 个扩展方法
// ----------------

// Keys in IE < 9 that won't be iterated by `for key in ...` and thus missed.
// IE < 9 下 不能用 for key in ... 来枚举对象的某些 key
// 比如重写了对象的 `toString` 方法,这个 key 值就不能在 IE < 9 下用 for in 枚举到
// IE < 9,{toString: null}.propertyIsEnumerable('toString') 返回 false
// IE < 9,重写的 `toString` 属性被认为不可枚举
// 据此可以判断是否在 IE < 9 浏览器环境中
var hasEnumBug = !{toString: null}.propertyIsEnumerable('toString');

// IE < 9 下不能用 for in 来枚举的 key 值集合
// 其实还有个 `constructor` 属性
// 个人觉得可能是 `constructor` 和其他属性不属于一类
// nonEnumerableProps[] 中都是方法
// 而 constructor 表示的是对象的构造函数
// 所以区分开来了
var nonEnumerableProps = ['valueOf', 'isPrototypeOf', 'toString',
'propertyIsEnumerable', 'hasOwnProperty', 'toLocaleString'];

// obj 为需要遍历键值对的对象
// keys 为键数组
// 利用 JavaScript 按值传递的特点
// 传入数组作为参数,能直接改变数组的值
function collectNonEnumProps(obj, keys) {
var nonEnumIdx = nonEnumerableProps.length;
var constructor = obj.constructor;

// 获取对象的原型
// 如果 obj 的 constructor 被重写
// 则 proto 变量为 Object.prototype
// 如果没有被重写
// 则为 obj.constructor.prototype
var proto = (_.isFunction(constructor) && constructor.prototype) || ObjProto;

// Constructor is a special case.
// `constructor` 属性需要特殊处理 (是否有必要?)
// see https://github.com/hanzichi/underscore-analysis/issues/3
// 如果 obj 有 `constructor` 这个 key
// 并且该 key 没有在 keys 数组中
// 存入 keys 数组
var prop = 'constructor';
if (_.has(obj, prop) && !_.contains(keys, prop)) keys.push(prop);

// 遍历 nonEnumerableProps 数组中的 keys
while (nonEnumIdx--) {
prop = nonEnumerableProps[nonEnumIdx];
// prop in obj 应该肯定返回 true 吧?是否有判断必要?
// obj[prop] !== proto[prop] 判断该 key 是否来自于原型链
// 即是否重写了原型链上的属性
if (prop in obj && obj[prop] !== proto[prop] && !_.contains(keys, prop)) {
keys.push(prop);
}
}
}

// Retrieve the names of an object's own properties.
// Delegates to **ECMAScript 5**'s native `Object.keys`
// ===== //
// _.keys({one: 1, two: 2, three: 3});
// => ["one", "two", "three"]
// ===== //
// 返回一个对象的 keys 组成的数组
// 仅返回 own enumerable properties 组成的数组
_.keys = function(obj) {
// 容错
// 如果传入的参数不是对象,则返回空数组
if (!_.isObject(obj)) return [];

// 如果浏览器支持 ES5 Object.key() 方法
// 则优先使用该方法
if (nativeKeys) return nativeKeys(obj);

var keys = [];

// own enumerable properties
for (var key in obj)
// hasOwnProperty
if (_.has(obj, key)) keys.push(key);

// Ahem, IE < 9.
// IE < 9 下不能用 for in 来枚举某些 key 值
// 传入 keys 数组为参数
// 因为 JavaScript 下函数参数按值传递
// 所以 keys 当做参数传入后会在 `collectNonEnumProps` 方法中改变值
if (hasEnumBug) collectNonEnumProps(obj, keys);

return keys;
};

// Retrieve all the property names of an object.
// 返回一个对象的 keys 数组
// 不仅仅是 own enumerable properties
// 还包括原型链上继承的属性
_.allKeys = function(obj) {
// 容错
// 不是对象,则返回空数组
if (!_.isObject(obj)) return [];

var keys = [];
for (var key in obj) keys.push(key);

// Ahem, IE < 9.
// IE < 9 下的 bug,同 _.keys 方法
if (hasEnumBug) collectNonEnumProps(obj, keys);

return keys;
};

// Retrieve the values of an object's properties.
// ===== //
// _.values({one: 1, two: 2, three: 3});
// => [1, 2, 3]
// ===== //
// 将一个对象的所有 values 值放入数组中
// 仅限 own properties 上的 values
// 不包括原型链上的
// 并返回该数组
_.values = function(obj) {
// 仅包括 own properties
var keys = _.keys(obj);
var length = keys.length;
var values = Array(length);
for (var i = 0; i < length; i++) {
values[i] = obj[keys[i]];
}
return values;
};

// Returns the results of applying the iteratee to each element of the object
// In contrast to _.map it returns an object
// 跟 _.map 方法很像
// 但是是专门为对象服务的 map 方法
// 迭代函数改变对象的 values 值
// 返回对象副本
_.mapObject = function(obj, iteratee, context) {
// 迭代函数
// 对每个键值对进行迭代
iteratee = cb(iteratee, context);

var keys = _.keys(obj),
length = keys.length,
results = {}, // 对象副本,该方法返回的对象
currentKey;

for (var index = 0; index < length; index++) {
currentKey = keys[index];
// key 值不变
// 对每个 value 值用迭代函数迭代
// 返回经过函数运算后的值
results[currentKey] = iteratee(obj[currentKey], currentKey, obj);
}
return results;
};

// Convert an object into a list of `[key, value]` pairs.
// 将一个对象转换为元素为 [key, value] 形式的数组
// _.pairs({one: 1, two: 2, three: 3});
// => [["one", 1], ["two", 2], ["three", 3]]
_.pairs = function(obj) {
var keys = _.keys(obj);
var length = keys.length;
var pairs = Array(length);
for (var i = 0; i < length; i++) {
pairs[i] = [keys[i], obj[keys[i]]];
}
return pairs;
};

// Invert the keys and values of an object. The values must be serializable.
// 将一个对象的 key-value 键值对颠倒
// 即原来的 key 为 value 值,原来的 value 值为 key 值
// 需要注意的是,value 值不能重复(不然后面的会覆盖前面的)
// 且新构造的对象符合对象构造规则
// 并且返回新构造的对象
_.invert = function(obj) {
// 返回的新的对象
var result = {};
var keys = _.keys(obj);
for (var i = 0, length = keys.length; i < length; i++) {
result[obj[keys[i]]] = keys[i];
}
return result;
};

// Return a sorted list of the function names available on the object.
// Aliased as `methods`
// 传入一个对象
// 遍历该对象的键值对(包括 own properties 以及 原型链上的)
// 如果某个 value 的类型是方法(function),则将该 key 存入数组
// 将该数组排序后返回
_.functions = _.methods = function(obj) {
// 返回的数组
var names = [];

// if IE < 9
// 且对象重写了 `nonEnumerableProps` 数组中的某些方法
// 那么这些方法名是不会被返回的
// 可见放弃了 IE < 9 可能对 `toString` 等方法的重写支持
for (var key in obj) {
// 如果某个 key 对应的 value 值类型是函数
// 则将这个 key 值存入数组
if (_.isFunction(obj[key])) names.push(key);
}

// 返回排序后的数组
return names.sort();
};

// Extend a given object with all the properties in passed-in object(s).
// extend_.extend(destination, *sources)
// Copy all of the properties in the source objects over to the destination object
// and return the destination object
// It's in-order, so the last source will override properties of the same name in previous arguments.
// 将几个对象上(第二个参数开始,根据参数而定)的所有键值对添加到 destination 对象(第一个参数)上
// 因为 key 值可能会相同,所以后面的(键值对)可能会覆盖前面的
// 参数个数 >= 1
_.extend = createAssigner(_.allKeys);

// Assigns a given object with all the own properties in the passed-in object(s)
// (https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object/assign)
// 跟 extend 方法类似,但是只把 own properties 拷贝给第一个参数对象
// 只继承 own properties 的键值对
// 参数个数 >= 1
_.extendOwn = _.assign = createAssigner(_.keys);

// Returns the first key on an object that passes a predicate test
// 跟数组方法的 _.findIndex 类似
// 找到对象的键值对中第一个满足条件的键值对
// 并返回该键值对 key 值
_.findKey = function(obj, predicate, context) {
predicate = cb(predicate, context);
var keys = _.keys(obj), key;
// 遍历键值对
for (var i = 0, length = keys.length; i < length; i++) {
key = keys[i];
// 符合条件,直接返回 key 值
if (predicate(obj[key], key, obj)) return key;
}
};

// Return a copy of the object only containing the whitelisted properties.
// 根据一定的需求(key 值,或者通过 predicate 函数返回真假)
// 返回拥有一定键值对的对象副本
// 第二个参数可以是一个 predicate 函数
// 也可以是 >= 0 个 key
// _.pick(object, *keys)
// Return a copy of the object
// filtered to only have values for the whitelisted keys (or array of valid keys)
// Alternatively accepts a predicate indicating which keys to pick.
/*
_.pick({name: 'moe', age: 50, userid: 'moe1'}, 'name', 'age');
=> {name: 'moe', age: 50}
_.pick({name: 'moe', age: 50, userid: 'moe1'}, ['name', 'age']);
=> {name: 'moe', age: 50}
_.pick({name: 'moe', age: 50, userid: 'moe1'}, function(value, key, object) {
return _.isNumber(value);
});
=> {age: 50}
*/
_.pick = function(object, oiteratee, context) {
// result 为返回的对象副本
var result = {}, obj = object, iteratee, keys;

// 容错
if (obj == null) return result;

// 如果第二个参数是函数
if (_.isFunction(oiteratee)) {
keys = _.allKeys(obj);
iteratee = optimizeCb(oiteratee, context);
} else {
// 如果第二个参数不是函数
// 则后面的 keys 可能是数组
// 也可能是连续的几个并列的参数
// 用 flatten 将它们展开
keys = flatten(arguments, false, false, 1);

// 也转为 predicate 函数判断形式
// 将指定 key 转化为 predicate 函数
iteratee = function(value, key, obj) { return key in obj; };
obj = Object(obj);
}

for (var i = 0, length = keys.length; i < length; i++) {
var key = keys[i];
var value = obj[key];
// 满足条件
if (iteratee(value, key, obj)) result[key] = value;
}
return result;
};

// Return a copy of the object without the blacklisted properties.
// 跟 _.pick 方法相对
// 返回 _.pick 的补集
// 即返回没有指定 keys 值的对象副本
// 或者返回不能通过 predicate 函数的对象副本
_.omit = function(obj, iteratee, context) {
if (_.isFunction(iteratee)) {
// _.negate 方法对 iteratee 的结果取反
iteratee = _.negate(iteratee);
} else {
var keys = _.map(flatten(arguments, false, false, 1), String);
iteratee = function(value, key) {
return !_.contains(keys, key);
};
}
return _.pick(obj, iteratee, context);
};

// _.defaults(object, *defaults)
// Fill in a given object with default properties.
// Fill in undefined properties in object
// with the first value present in the following list of defaults objects.
// 和 _.extend 非常类似
// 区别是如果 *defaults 中出现了和 object 中一样的键
// 则不覆盖 object 的键值对
// 如果 *defaults 多个参数对象中有相同 key 的对象
// 则取最早出现的 value 值
// 参数个数 >= 1
_.defaults = createAssigner(_.allKeys, true);

// Creates an object that inherits from the given prototype object.
// If additional properties are provided then they will be added to the
// created object.
// 给定 prototype
// 以及一些 own properties
// 构造一个新的对象并返回
_.create = function(prototype, props) {
var result = baseCreate(prototype);

// 将 props 的键值对覆盖 result 对象
if (props) _.extendOwn(result, props);
return result;
};

// Create a (shallow-cloned) duplicate of an object.
// 对象的 `浅复制` 副本
// 注意点:所有嵌套的对象或者数组都会跟原对象用同一个引用
// 所以是为浅复制,而不是深度克隆
_.clone = function(obj) {
// 容错,如果不是对象或者数组类型,则可以直接返回
// 因为一些基础类型是直接按值传递的
// 思考,arguments 呢? Nodelists 呢? HTML Collections 呢?
if (!_.isObject(obj))
return obj;

// 如果是数组,则用 obj.slice() 返回数组副本
// 如果是对象,则提取所有 obj 的键值对覆盖空对象,返回
return _.isArray(obj) ? obj.slice() : _.extend({}, obj);
};

// Invokes interceptor with the obj, and then returns obj.
// The primary purpose of this method is to "tap into" a method chain, in
// order to perform operations on intermediate results within the chain.
// _.chain([1,2,3,200])
// .filter(function(num) { return num % 2 == 0; })
// .tap(alert)
// .map(function(num) { return num * num })
// .value();
// => // [2, 200] (alerted)
// => [4, 40000]
// 主要是用在链式调用中
// 对中间值立即进行处理
_.tap = function(obj, interceptor) {
interceptor(obj);
return obj;
};

// Returns whether an object has a given set of `key:value` pairs.
// attrs 参数为一个对象
// 判断 object 对象中是否有 attrs 中的所有 key-value 键值对
// 返回布尔值
_.isMatch = function(object, attrs) {
// 提取 attrs 对象的所有 keys
var keys = _.keys(attrs), length = keys.length;

// 如果 object 为空
// 根据 attrs 的键值对数量返回布尔值
if (object == null) return !length;

// 这一步有必要?
var obj = Object(object);

// 遍历 attrs 对象键值对
for (var i = 0; i < length; i++) {
var key = keys[i];

// 如果 obj 对象没有 attrs 对象的某个 key
// 或者对于某个 key,它们的 value 值不同
// 则证明 object 并不拥有 attrs 的所有键值对
// 则返回 false
if (attrs[key] !== obj[key] || !(key in obj)) return false;
}

return true;
};


// Internal recursive comparison function for `isEqual`.
// "内部的"/ "递归地"/ "比较"
// 该内部方法会被递归调用
var eq = function(a, b, aStack, bStack) {
// Identical objects are equal. `0 === -0`, but they aren't identical.
// See the [Harmony `egal` proposal](http://wiki.ecmascript.org/doku.php?id=harmony:egal).
// a === b 时
// 需要注意 `0 === -0` 这个 special case
// 0 和 -0 被认为不相同(unequal)
// 至于原因可以参考上面的链接
if (a === b) return a !== 0 || 1 / a === 1 / b;

// A strict comparison is necessary because `null == undefined`.
// 如果 a 和 b 有一个为 null(或者 undefined)
// 判断 a === b
if (a == null || b == null) return a === b;

// Unwrap any wrapped objects.
// 如果 a 和 b 是 underscore OOP 的对象
// 那么比较 _wrapped 属性值(Unwrap)
if (a instanceof _) a = a._wrapped;
if (b instanceof _) b = b._wrapped;

// Compare `[[Class]]` names.
// 用 Object.prototype.toString.call 方法获取 a 变量类型
var className = toString.call(a);

// 如果 a 和 b 类型不相同,则返回 false
// 类型都不同了还比较个蛋!
if (className !== toString.call(b)) return false;

switch (className) {
// Strings, numbers, regular expressions, dates, and booleans are compared by value.
// 以上五种类型的元素可以直接根据其 value 值来比较是否相等
case '[object RegExp]':
// RegExps are coerced to strings for comparison (Note: '' + /a/i === '/a/i')
case '[object String]':
// Primitives and their corresponding object wrappers are equivalent; thus, `"5"` is
// equivalent to `new String("5")`.
// 转为 String 类型进行比较
return '' + a === '' + b;

// RegExp 和 String 可以看做一类
// 如果 obj 为 RegExp 或者 String 类型
// 那么 '' + obj 会将 obj 强制转为 String
// 根据 '' + a === '' + b 即可判断 a 和 b 是否相等
// ================

case '[object Number]':
// `NaN`s are equivalent, but non-reflexive.
// Object(NaN) is equivalent to NaN
// 如果 +a !== +a
// 那么 a 就是 NaN
// 判断 b 是否也是 NaN 即可
if (+a !== +a) return +b !== +b;

// An `egal` comparison is performed for other numeric values.
// 排除了 NaN 干扰
// 还要考虑 0 的干扰
// 用 +a 将 Number() 形式转为基本类型
// 即 +Number(1) ==> 1
// 0 需要特判
// 如果 a 为 0,判断 1 / +a === 1 / b
// 否则判断 +a === +b
return +a === 0 ? 1 / +a === 1 / b : +a === +b;

// 如果 a 为 Number 类型
// 要注意 NaN 这个 special number
// NaN 和 NaN 被认为 equal
// ================

case '[object Date]':
case '[object Boolean]':
// Coerce dates and booleans to numeric primitive values. Dates are compared by their
// millisecond representations. Note that invalid dates with millisecond representations
// of `NaN` are not equivalent.
return +a === +b;

// Date 和 Boolean 可以看做一类
// 如果 obj 为 Date 或者 Boolean
// 那么 +obj 会将 obj 转为 Number 类型
// 然后比较即可
// +new Date() 是当前时间距离 1970 年 1 月 1 日 0 点的毫秒数
// +true => 1
// +new Boolean(false) => 0
}


// 判断 a 是否是数组
var areArrays = className === '[object Array]';

// 如果 a 不是数组类型
if (!areArrays) {
// 如果 a 不是 object 或者 b 不是 object
// 则返回 false
if (typeof a != 'object' || typeof b != 'object') return false;

// 通过上个步骤的 if 过滤
// !!保证到此的 a 和 b 均为对象!!

// Objects with different constructors are not equivalent, but `Object`s or `Array`s
// from different frames are.
// 通过构造函数来判断 a 和 b 是否相同
// 但是,如果 a 和 b 的构造函数不同
// 也并不一定 a 和 b 就是 unequal
// 比如 a 和 b 在不同的 iframes 中!
// aCtor instanceof aCtor 这步有点不大理解,啥用?
var aCtor = a.constructor, bCtor = b.constructor;
if (aCtor !== bCtor && !(_.isFunction(aCtor) && aCtor instanceof aCtor &&
_.isFunction(bCtor) && bCtor instanceof bCtor)
&& ('constructor' in a && 'constructor' in b)) {
return false;
}
}

// Assume equality for cyclic structures. The algorithm for detecting cyclic
// structures is adapted from ES 5.1 section 15.12.3, abstract operation `JO`.

// Initializing stack of traversed objects.
// It's done here since we only need them for objects and arrays comparison.
// 第一次调用 eq() 函数,没有传入 aStack 和 bStack 参数
// 之后递归调用都会传入这两个参数
aStack = aStack || [];
bStack = bStack || [];

var length = aStack.length;

while (length--) {
// Linear search. Performance is inversely proportional to the number of
// unique nested structures.
if (aStack[length] === a) return bStack[length] === b;
}

// Add the first object to the stack of traversed objects.
aStack.push(a);
bStack.push(b);

// Recursively compare objects and arrays.
// 将嵌套的对象和数组展开
// 如果 a 是数组
// 因为嵌套,所以需要展开深度比较
if (areArrays) {
// Compare array lengths to determine if a deep comparison is necessary.
// 根据 length 判断是否应该继续递归对比
length = a.length;

// 如果 a 和 b length 属性大小不同
// 那么显然 a 和 b 不同
// return false 不用继续比较了
if (length !== b.length) return false;

// Deep compare the contents, ignoring non-numeric properties.
while (length--) {
// 递归
if (!eq(a[length], b[length], aStack, bStack)) return false;
}
} else {
// 如果 a 不是数组
// 进入这个判断分支

// Deep compare objects.
// 两个对象的深度比较
var keys = _.keys(a), key;
length = keys.length;

// Ensure that both objects contain the same number of properties before comparing deep equality.
// a 和 b 对象的键数量不同
// 那还比较毛?
if (_.keys(b).length !== length) return false;

while (length--) {
// Deep compare each member
// 递归比较
key = keys[length];
if (!(_.has(b, key) && eq(a[key], b[key], aStack, bStack))) return false;
}
}

// Remove the first object from the stack of traversed objects.
// 与 aStack.push(a) 对应
// 此时 aStack 栈顶元素正是 a
// 而代码走到此步
// a 和 b isEqual 确认
// 所以 a,b 两个元素可以出栈
aStack.pop();
bStack.pop();

// 深度搜索递归比较完毕
// 放心地 return true
return true;
};

// Perform a deep comparison to check if two objects are equal.
// 判断两个对象是否一样
// new Boolean(true),true 被认为 equal
// [1, 2, 3], [1, 2, 3] 被认为 equal
// 0 和 -0 被认为 unequal
// NaN 和 NaN 被认为 equal
_.isEqual = function(a, b) {
return eq(a, b);
};

// Is a given array, string, or object empty?
// An "empty" object has no enumerable own-properties.
// 是否是 {}、[] 或者 "" 或者 null、undefined
_.isEmpty = function(obj) {
if (obj == null) return true;

// 如果是数组、类数组、或者字符串
// 根据 length 属性判断是否为空
// 后面的条件是为了过滤 isArrayLike 对于 {length: 10} 这样对象的判断 bug?
if (isArrayLike(obj) && (_.isArray(obj) || _.isString(obj) || _.isArguments(obj))) return obj.length === 0;

// 如果是对象
// 根据 keys 数量判断是否为 Empty
return _.keys(obj).length === 0;
};


// Is a given value a DOM element?
// 判断是否为 DOM 元素
_.isElement = function(obj) {
// 确保 obj 不是 null, undefined 等假值
// 并且 obj.nodeType === 1
return !!(obj && obj.nodeType === 1);
};

// Is a given value an array?
// Delegates to ECMA5's native Array.isArray
// 判断是否为数组
_.isArray = nativeIsArray || function(obj) {
return toString.call(obj) === '[object Array]';
};

// Is a given variable an object?
// 判断是否为对象
// 这里的对象包括 function 和 object
_.isObject = function(obj) {
var type = typeof obj;
return type === 'function' || type === 'object' && !!obj;
};

// Add some isType methods: isArguments, isFunction, isString, isNumber, isDate, isRegExp, isError.
// 其他类型判断
_.each(['Arguments', 'Function', 'String', 'Number', 'Date', 'RegExp', 'Error'], function(name) {
_['is' + name] = function(obj) {
return toString.call(obj) === '[object ' + name + ']';
};
});

// Define a fallback version of the method in browsers (ahem, IE < 9), where
// there isn't any inspectable "Arguments" type.
// _.isArguments 方法在 IE < 9 下的兼容
// IE < 9 下对 arguments 调用 Object.prototype.toString.call 方法
// 结果是 => [object Object]
// 而并非我们期望的 [object Arguments]。
// so 用是否含有 callee 属性来做兼容
if (!_.isArguments(arguments)) {
_.isArguments = function(obj) {
return _.has(obj, 'callee');
};
}

// Optimize `isFunction` if appropriate. Work around some typeof bugs in old v8,
// IE 11 (#1621), and in Safari 8 (#1929).
// _.isFunction 在 old v8, IE 11 和 Safari 8 下的兼容
// 觉得这里有点问题
// 我用的 chrome 49 (显然不是 old v8)
// 却也进入了这个 if 判断内部
if (typeof /./ != 'function' && typeof Int8Array != 'object') {
_.isFunction = function(obj) {
return typeof obj == 'function' || false;
};
}

// Is a given object a finite number?
// 判断是否是有限的数字
_.isFinite = function(obj) {
return isFinite(obj) && !isNaN(parseFloat(obj));
};

// Is the given value `NaN`? (NaN is the only number which does not equal itself).
// 判断是否是 NaN
// NaN 是唯一的一个 `自己不等于自己` 的 number 类型
// 这样写有 BUG
// _.isNaN(new Number(0)) => true
// 详见 https://github.com/hanzichi/underscore-analysis/issues/13
// 最新版本(edge 版)已经修复该 BUG
_.isNaN = function(obj) {
return _.isNumber(obj) && obj !== +obj;
};

// Is a given value a boolean?
// 判断是否是布尔值
// 基础类型(true、 false)
// 以及 new Boolean() 两个方向判断
// 有点多余了吧?
// 个人觉得直接用 toString.call(obj) 来判断就可以了
_.isBoolean = function(obj) {
return obj === true || obj === false || toString.call(obj) === '[object Boolean]';
};

// Is a given value equal to null?
// 判断是否是 null
_.isNull = function(obj) {
return obj === null;
};

// Is a given variable undefined?
// 判断是否是 undefined
// undefined 能被改写 (IE < 9)
// undefined 只是全局对象的一个属性
// 在局部环境能被重新定义
// 但是「void 0」始终是 undefined
_.isUndefined = function(obj) {
return obj === void 0;
};

// Shortcut function for checking if an object has a given property directly
// on itself (in other words, not on a prototype).
// 判断对象中是否有指定 key
// own properties, not on a prototype
_.has = function(obj, key) {
// obj 不能为 null 或者 undefined
return obj != null && hasOwnProperty.call(obj, key);
};


// Utility Functions
// 工具类方法
// 共 14 个扩展方法
// -----------------

// Run Underscore.js in *noConflict* mode, returning the `_` variable to its
// previous owner. Returns a reference to the Underscore object.
// 如果全局环境中已经使用了 `_` 变量
// 可以用该方法返回其他变量
// 继续使用 underscore 中的方法
// var underscore = _.noConflict();
// underscore.each(..);
_.noConflict = function() {
root._ = previousUnderscore;
return this;
};

// Keep the identity function around for default iteratees.
// 返回传入的参数,看起来好像没什么卵用
// 其实 _.identity 在 undescore 内大量作为迭代函数出现
// 能简化很多迭代函数的书写
_.identity = function(value) {
return value;
};

// Predicate-generating functions. Often useful outside of Underscore.
_.constant = function(value) {
return function() {
return value;
};
};

_.noop = function(){};

// 传送门
/*
var property = function(key) {
return function(obj) {
return obj == null ? void 0 : obj[key];
};
};
*/
_.property = property;

// Generates a function for a given object that returns a given property.
_.propertyOf = function(obj) {
return obj == null ? function(){} : function(key) {
return obj[key];
};
};

// Returns a predicate for checking whether an object has a given set of
// `key:value` pairs.
// 判断一个给定的对象是否有某些键值对
_.matcher = _.matches = function(attrs) {
attrs = _.extendOwn({}, attrs);
return function(obj) {
return _.isMatch(obj, attrs);
};
};

// Run a function **n** times.
// 执行某函数 n 次
_.times = function(n, iteratee, context) {
var accum = Array(Math.max(0, n));
iteratee = optimizeCb(iteratee, context, 1);
for (var i = 0; i < n; i++)
accum[i] = iteratee(i);
return accum;
};

// Return a random integer between min and max (inclusive).
// 返回一个 [min, max] 范围内的任意整数
_.random = function(min, max) {
if (max == null) {
max = min;
min = 0;
}
return min + Math.floor(Math.random() * (max - min + 1));
};

// A (possibly faster) way to get the current timestamp as an integer.
// 返回当前时间的 "时间戳"(单位 ms)
// 其实并不是时间戳,时间戳还要除以 1000(单位 s)
// +new Date 类似
_.now = Date.now || function() {
return new Date().getTime();
};

// List of HTML entities for escaping.
// HTML 实体编码
// escapeMap 用于编码
// see @http://www.cnblogs.com/zichi/p/5135636.html
// in PHP, htmlspecialchars — Convert special characters to HTML entities
// see @http://php.net/manual/zh/function.htmlspecialchars.php
// 能将 & " ' < > 转为实体编码(下面的前 5 种)
var escapeMap = {
'&': '&amp;',
'<': '&lt;',
'>': '&gt;',
'"': '&quot;',
// 以上四个为最常用的字符实体
// 也是仅有的可以在所有环境下使用的实体字符(其他应该用「实体数字」,如下)
// 浏览器也许并不支持所有实体名称(对实体数字的支持却很好)
"'": '&#x27;',
'`': '&#x60;'
};

// _.invert 方法将一个对象的键值对对调
// unescapeMap 用于解码
var unescapeMap = _.invert(escapeMap);

// Functions for escaping and unescaping strings to/from HTML interpolation.
var createEscaper = function(map) {
var escaper = function(match) {
return map[match];
};

// Regexes for identifying a key that needs to be escaped
// 正则替换
// 注意下 ?:
var source = '(?:' + _.keys(map).join('|') + ')';

// 正则 pattern
var testRegexp = RegExp(source);

// 全局替换
var replaceRegexp = RegExp(source, 'g');
return function(string) {
string = string == null ? '' : '' + string;
return testRegexp.test(string) ? string.replace(replaceRegexp, escaper) : string;
};
};

// Escapes a string for insertion into HTML, replacing &, <, >, ", `, and ' characters.
// 编码,防止被 XSS 攻击等一些安全隐患
_.escape = createEscaper(escapeMap);

// The opposite of escape
// replaces &amp;, &lt;, &gt;, &quot;, &#96; and &#x27; with their unescaped counterparts
// 解码
_.unescape = createEscaper(unescapeMap);

// If the value of the named `property` is a function then invoke it with the
// `object` as context; otherwise, return it.
_.result = function(object, property, fallback) {
var value = object == null ? void 0 : object[property];
if (value === void 0) {
value = fallback;
}
return _.isFunction(value) ? value.call(object) : value;
};

// Generate a unique integer id (unique within the entire client session).
// Useful for temporary DOM ids.
// 生成客户端临时的 DOM ids
var idCounter = 0;
_.uniqueId = function(prefix) {
var id = ++idCounter + '';
return prefix ? prefix + id : id;
};

// By default, Underscore uses ERB-style template delimiters, change the
// following template settings to use alternative delimiters.
// ERB => Embedded Ruby
// Underscore 默认采用 ERB-style 风格模板,也可以根据自己习惯自定义模板
// 1. <% %> - to execute some code
// 2. <%= %> - to print some value in template
// 3. <%- %> - to print some values HTML escaped
_.templateSettings = {
// 三种渲染模板
evaluate : /<%([\s\S]+?)%>/g,
interpolate : /<%=([\s\S]+?)%>/g,
escape : /<%-([\s\S]+?)%>/g
};

// When customizing `templateSettings`, if you don't want to define an
// interpolation, evaluation or escaping regex, we need one that is
// guaranteed not to match.
var noMatch = /(.)^/;

// Certain characters need to be escaped so that they can be put into a
// string literal.
var escapes = {
"'": "'",
'\\': '\\',
'\r': 'r', // 回车符
'\n': 'n', // 换行符
// http://stackoverflow.com/questions/16686687/json-stringify-and-u2028-u2029-check
'\u2028': 'u2028', // Line separator
'\u2029': 'u2029' // Paragraph separator
};

// RegExp pattern
var escaper = /\\|'|\r|\n|\u2028|\u2029/g;

var escapeChar = function(match) {
/**
' => \\'
\\ => \\\\
\r => \\r
\n => \\n
\u2028 => \\u2028
\u2029 => \\u2029
**/
return '\\' + escapes[match];
};

// 将 JavaScript 模板编译为可以用于页面呈现的函数
// JavaScript micro-templating, similar to John Resig's implementation.
// Underscore templating handles arbitrary delimiters, preserves whitespace,
// and correctly escapes quotes within interpolated code.
// NB: `oldSettings` only exists for backwards compatibility.
// oldSettings 参数为了兼容 underscore 旧版本
// setting 参数可以用来自定义字符串模板(但是 key 要和 _.templateSettings 中的相同,才能 overridden)
// 1. <% %> - to execute some code
// 2. <%= %> - to print some value in template
// 3. <%- %> - to print some values HTML escaped
// Compiles JavaScript templates into functions
// _.template(templateString, [settings])
_.template = function(text, settings, oldSettings) {
// 兼容旧版本
if (!settings && oldSettings)
settings = oldSettings;

// 相同的 key,优先选择 settings 对象中的
// 其次选择 _.templateSettings 对象中的
// 生成最终用来做模板渲染的字符串
// 自定义模板优先于默认模板 _.templateSettings
// 如果定义了相同的 key,则前者会覆盖后者
settings = _.defaults({}, settings, _.templateSettings);

// Combine delimiters into one regular expression via alternation.
// 正则表达式 pattern,用于正则匹配 text 字符串中的模板字符串
// /<%-([\s\S]+?)%>|<%=([\s\S]+?)%>|<%([\s\S]+?)%>|$/g
// 注意最后还有个 |$
var matcher = RegExp([
// 注意下 pattern 的 source 属性
(settings.escape || noMatch).source,
(settings.interpolate || noMatch).source,
(settings.evaluate || noMatch).source
].join('|') + '|$', 'g');

// Compile the template source, escaping string literals appropriately.
// 编译模板字符串,将原始的模板字符串替换成函数字符串
// 用拼接成的函数字符串生成函数(new Function(...))
var index = 0;

// source 变量拼接的字符串用来生成函数
// 用于当做 new Function 生成函数时的函数字符串变量
// 记录编译成的函数字符串,可通过 _.template(tpl).source 获取(_.template(tpl) 返回方法)
var source = "__p+='";

// replace 函数不需要为返回值赋值,主要是为了在函数内对 source 变量赋值
// 将 text 变量中的模板提取出来
// match 为匹配的整个串
// escape/interpolate/evaluate 为匹配的子表达式(如果没有匹配成功则为 undefined)
// offset 为字符匹配(match)的起始位置(偏移量)
text.replace(matcher, function(match, escape, interpolate, evaluate, offset) {
// \n => \\n
source += text.slice(index, offset).replace(escaper, escapeChar);

// 改变 index 值,为了下次的 slice
index = offset + match.length;

if (escape) {
// 需要对变量进行编码(=> HTML 实体编码)
// 避免 XSS 攻击
source += "'+\n((__t=(" + escape + "))==null?'':_.escape(__t))+\n'";
} else if (interpolate) {
// 单纯的插入变量
source += "'+\n((__t=(" + interpolate + "))==null?'':__t)+\n'";
} else if (evaluate) {
// 可以直接执行的 JavaScript 语句
// 注意 "__p+=",__p 为渲染返回的字符串
source += "';\n" + evaluate + "\n__p+='";
}

// Adobe VMs need the match returned to produce the correct offset.
// return 的作用是?
// 将匹配到的内容原样返回(Adobe VMs 需要返回 match 来使得 offset 值正常)
return match;
});

source += "';\n";

// By default, `template` places the values from your data in the local scope via the `with` statement.
// However, you can specify a single variable name with the variable setting.
// This can significantly improve the speed at which a template is able to render.
// If a variable is not specified, place data values in local scope.
// 指定 scope
// 如果设置了 settings.variable,能显著提升模板的渲染速度
// 否则,默认用 with 语句指定作用域
if (!settings.variable)
source = 'with(obj||{}){\n' + source + '}\n';

// 增加 print 功能
// __p 为返回的字符串
source = "var __t,__p='',__j=Array.prototype.join," +
"print=function(){__p+=__j.call(arguments,'');};\n" +
source + 'return __p;\n';

try {
// render 方法,前两个参数为 render 方法的参数
// obj 为传入的 JSON 对象,传入 _ 参数使得函数内部能用 Underscore 的函数
var render = new Function(settings.variable || 'obj', '_', source);
} catch (e) {
// 抛出错误
e.source = source;
throw e;
}

// 返回的函数
// data 一般是 JSON 数据,用来渲染模板
var template = function(data) {
// render 为模板渲染函数
// 传入参数 _ ,使得模板里 <% %> 里的代码能用 underscore 的方法
//(<% %> - to execute some code)
return render.call(this, data, _);
};

// Provide the compiled source as a convenience for precompilation.
// template.source for debug?
// obj 与 with(obj||{}) 中的 obj 对应
var argument = settings.variable || 'obj';

// 可通过 _.template(tpl).source 获取
// 可以用来预编译,在服务端预编译好,直接在客户端生成代码,客户端直接调用方法
// 这样如果出错就能打印出错行
// Precompiling your templates can be a big help when debugging errors you can't reproduce.
// This is because precompiled templates can provide line numbers and a stack trace,
// something that is not possible when compiling templates on the client.
// The source property is available on the compiled template function for easy precompilation.
// see @http://stackoverflow.com/questions/18755292/underscore-js-precompiled-templates-using
// see @http://stackoverflow.com/questions/13536262/what-is-javascript-template-precompiling
// see @http://stackoverflow.com/questions/40126223/can-anyone-explain-underscores-precompilation-in-template
// JST is a server-side thing, not client-side.
// This mean that you compile Unserscore template on server side by some server-side script and save the result in a file.
// Then use this file as compiled Unserscore template.
template.source = 'function(' + argument + '){\n' + source + '}';

return template;
};

// Add a "chain" function. Start chaining a wrapped Underscore object.
// 使支持链式调用
/**
// 非 OOP 调用 chain
_.chain([1, 2, 3])
.map(function(a) { return a * 2; })
.reverse().value(); // [6, 4, 2]
// OOP 调用 chain
_([1, 2, 3])
.chain()
.map(function(a){ return a * 2; })
.first()
.value(); // 2
**/
_.chain = function(obj) {
// 无论是否 OOP 调用,都会转为 OOP 形式
// 并且给新的构造对象添加了一个 _chain 属性
var instance = _(obj);

// 标记是否使用链式操作
instance._chain = true;

// 返回 OOP 对象
// 可以看到该 instance 对象除了多了个 _chain 属性
// 其他的和直接 _(obj) 的结果一样
return instance;
};

// OOP
// ---------------
// If Underscore is called as a function, it returns a wrapped object that
// can be used OO-style. This wrapper holds altered versions of all the
// underscore functions. Wrapped objects may be chained.

// OOP
// 如果 `_` 被当做方法(构造函数)调用, 则返回一个被包装过的对象
// 该对象能使用 underscore 的所有方法
// 并且支持链式调用

// Helper function to continue chaining intermediate results.
// 一个帮助方法(Helper function)
var result = function(instance, obj) {
// 如果需要链式操作,则对 obj 运行 _.chain 方法,使得可以继续后续的链式操作
// 如果不需要,直接返回 obj
return instance._chain ? _(obj).chain() : obj;
};

// Add your own custom functions to the Underscore object.
// 可向 underscore 函数库扩展自己的方法
// obj 参数必须是一个对象(JavaScript 中一切皆对象)
// 且自己的方法定义在 obj 的属性上
// 如 obj.myFunc = function() {...}
// 形如 {myFunc: function(){}}
// 之后便可使用如下: _.myFunc(..) 或者 OOP _(..).myFunc(..)
_.mixin = function(obj) {
// 遍历 obj 的 key,将方法挂载到 Underscore 上
// 其实是将方法浅拷贝到 _.prototype 上
_.each(_.functions(obj), function(name) {
// 直接把方法挂载到 _[name] 上
// 调用类似 _.myFunc([1, 2, 3], ..)
var func = _[name] = obj[name];

// 浅拷贝
// 将 name 方法挂载到 _ 对象的原型链上,使之能 OOP 调用
_.prototype[name] = function() {
// 第一个参数
var args = [this._wrapped];

// arguments 为 name 方法需要的其他参数
push.apply(args, arguments);
// 执行 func 方法
// 支持链式操作
return result(this, func.apply(_, args));
};
});
};

// Add all of the Underscore functions to the wrapper object.
// 将前面定义的 underscore 方法添加给包装过的对象
// 即添加到 _.prototype 中
// 使 underscore 支持面向对象形式的调用
_.mixin(_);

// Add all mutator Array functions to the wrapper.
// 将 Array 原型链上有的方法都添加到 underscore 中
_.each(['pop', 'push', 'reverse', 'shift', 'sort', 'splice', 'unshift'], function(name) {
var method = ArrayProto[name];
_.prototype[name] = function() {
var obj = this._wrapped;
method.apply(obj, arguments);

if ((name === 'shift' || name === 'splice') && obj.length === 0)
delete obj[0];

// 支持链式操作
return result(this, obj);
};
});

// Add all accessor Array functions to the wrapper.
// 添加 concat、join、slice 等数组原生方法给 Underscore
_.each(['concat', 'join', 'slice'], function(name) {
var method = ArrayProto[name];
_.prototype[name] = function() {
return result(this, method.apply(this._wrapped, arguments));
};
});

// Extracts the result from a wrapped and chained object.
// 一个包装过(OOP)并且链式调用的对象
// 用 value 方法获取结果
// _(obj).value === obj?
_.prototype.value = function() {
return this._wrapped;
};

// Provide unwrapping proxy for some methods used in engine operations
// such as arithmetic and JSON stringification.
_.prototype.valueOf = _.prototype.toJSON = _.prototype.value;

_.prototype.toString = function() {
return '' + this._wrapped;
};

// AMD registration happens at the end for compatibility with AMD loaders
// that may not enforce next-turn semantics on modules. Even though general
// practice for AMD registration is to be anonymous, underscore registers
// as a named module because, like jQuery, it is a base library that is
// popular enough to be bundled in a third party lib, but not be part of
// an AMD load request. Those cases could generate an error when an
// anonymous define() is called outside of a loader request.
// 兼容 AMD 规范
if (typeof define === 'function' && define.amd) {
define('underscore', [], function() {
return _;
});
}
}.call(this));

手写jQuery源码

  虽然jQuery的时代已经过去,但是jQuery漂亮的源码依然非常值得学习。
  jQuery源码中很多方法已经不适用,例如数组相关的:类数组转数组的$.makeArray,数组判断$.isArray…等等,这些ES6都给我们封装到了Array对象中,但这不代表我们不应该去了解源码,去探索造源码的思想;
  很长时间,我都对源码敬而远之,现在,我终于勇敢对它揭面。
  感觉,一个新大陆扑面而来。

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
(function (root) {
var testExp= /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]*))$/,
rejectExp = /^<(\w+)\s*\/?>/,
rootjQuery;

var jQuery = function (selector,context) {
return new jQuery.prototype.init(selector,context,rootjQuery);
};


jQuery.fn = jQuery.prototype = {
length: 0,
init: function( selector,context,rootjQuery ){
var match,elem;

if(!selector){
return this;
}

if(typeof selector === "string"){
if(selector.charAt(0) === "<" && selector.charAt(selector.length -1) === ">" && selector.length >= 3){
match = [null,selector,null];
}else{
match = testExp.exec(selector);
}

if(match[1]){
jQuery.merge(this,jQuery.parseHTML(selector,context && context.nodeType ? context : document));
}else{
elem = document.getElementById(match[2]);
if(elem && elem.nodeType){
this.length = 1;
this[0] = elem;
}
this.context = document;
this.selector = selector;
return this;
}
}else if(selector.nodeType){
this.context = this[0] = selector;
this.length = 1;
return this;
}else if(jQuery.isFunction(selector)) {
rootjQuery.ready(selector)
}

},
ready: function (fn) {
document.addEventListener("DOMContentLoaded",jQuery.ready);
if(jQuery.isReady){
fn.call(document,jQuery);
}else{
jQuery.readyList.push(fn);
}
}
};

jQuery.fn.init.prototype = jQuery.fn;

jQuery.extend = jQuery.fn.extend = function () {
var target = arguments[0] || {},
length = arguments.length,
copyIsArray = false,
deep = false,
option,
clone,
copy,
src,
name,
i = 1;

if(typeof arguments[0] === "boolean"){
deep = target;
target = arguments[i];
i++;
}

if(typeof target !== "object"){
target = {};
}

if(length === i){
target = this;
i--;
}

for(;i<length;i++){
if((option = arguments[i]) !== null){
for(name in option){
src = target[name];
copy = option[name];
if(deep && (jQuery.isPlainObject(copy) || (copyIsArray = jQuery.isArray(copy)))){
if(copyIsArray){
copyIsArray = false;
clone = src && jQuery.isArray(src) ? src : [];
}else{
clone = src && jQuery.isPlainObject(src) ? src : {};
}

target[name] = jQuery.extend(deep,clone,copy);

}else if(copy !== undefined){
target[name] = copy;
}
}
}
}

return target;

};

jQuery.extend({
isPlainObject: function (obj) {
return toString.call(obj) === "[object Object]";
},
isArray: function (obj) {
return toString.call(obj) === "[object Array]";
},
isFunction: function (seletor) {
return typeof seletor === "function";
},
markArray: function (arr) {
var result = [];
if(arr && arr.length){
return jQuery.merge(result,arr);
}
},
merge: function (arg1,arg2) {
var i = arg1.length,
l = arg2.length,
j = 0;

if(typeof l === "number"){
for(;j<l;){
arg1[i++] = arg2[j++];
}
}else{
while(arg2[j] !== undefined){
arg1[i++] = arg2[j++];
}
}

return arg1;
},
parseHTML: function (data,context) {
if(!data || typeof data !== "string"){
return null;
}

var parse = rejectExp.exec(data);
return [context.createElement(parse[1])];
},
each: function (object,callback,args) {
var length = object.length,
name,i = 0;

if(args){
if(length === undefined){
for(name in object){
callback.apply(object,args);
}
}else{
for(;i<length;){
callback.apply(object[i++],args);
}
}
}else{
if(length === undefined){
for(name in object){
callback.call(object,name,object[name]);
}
}else{
for(;i<length;i++){
callback.call(object[i],i,object[i]);
}
}
}


},
isReady: false,
readyList : [],
ready: function () {
jQuery.isReady = true;
jQuery.each(jQuery.readyList,function (key,value) {
this.call(document);
});

jQuery.readyList = [];
}
});

rootjQuery = jQuery(document);
root.$ = root.jQuery = jQuery;
})(this);

前端设计模式之开闭原则(OCP)

译注:本文作者愤怒的韭菜

  定义:
  一个软件实体如类、模块和函数应该对扩展开放,对修改关闭。

  问题由来:
  在软件的生命周期内,因为变化、升级和维护等原因需要对软件原有代码进行修改时,可能会给旧代码中引入错误,也可能会使我们不得不对整个功能进行重构,并且需要原有代码经过重新测试。

  解决方案:
  当软件需要变化时,尽量通过扩展软件实体的行为来实现变化,而不是通过修改已有的代码来实现变化。

  开闭原则是面向对象设计中最基础的设计原则,它指导我们如何建立稳定灵活的系统。开闭原则可能是设计模式六项原则中定义最模糊的一个了,它只告诉我们对扩展开放,对修改关闭,可是到底如何才能做到对扩展开放,对修改关闭,并没有明确的告诉我们。以前,如果有人告诉我“你进行设计的时候一定要遵守开闭原则”,我会觉的他什么都没说,但貌似又什么都说了。因为开闭原则真的太虚了。

  在仔细思考以及仔细阅读很多设计模式的文章后,终于对开闭原则有了一点认识。其实,我们遵循设计模式前面5大原则,以及使用23种设计模式的目的就是遵循开闭原则。也就是说,只要我们对前面5项原则遵守的好了,设计出的软件自然是符合开闭原则的,这个开闭原则更像是前面五项原则遵守程度的“平均得分”,前面5项原则遵守的好,平均分自然就高,说明软件设计开闭原则遵守的好;如果前面5项原则遵守的不好,则说明开闭原则遵守的不好。

  其实笔者认为,开闭原则无非就是想表达这样一层意思:用抽象构建框架,用实现扩展细节。因为抽象灵活性好,适应性广,只要抽象的合理,可以基本保持软件架构的稳定。而软件中易变的细节,我们用从抽象派生的实现类来进行扩展,当软件需要发生变化时,我们只需要根据需求重新派生一个实现类来扩展就可以了。当然前提是我们的抽象要合理,要对需求的变更有前瞻性和预见性才行。

  说到这里,再回想一下前面说的5项原则,恰恰是告诉我们用抽象构建框架,用实现扩展细节的注意事项而已:单一职责原则告诉我们实现类要职责单一;里氏替换原则告诉我们不要破坏继承体系;依赖倒置原则告诉我们要面向接口编程;接口隔离原则告诉我们在设计接口的时候要精简单一;迪米特法则告诉我们要降低耦合。而开闭原则是总纲,他告诉我们要对扩展开放,对修改关闭。

  最后说明一下如何去遵守这六个原则。对这六个原则的遵守并不是是和否的问题,而是多和少的问题,也就是说,我们一般不会说有没有遵守,而是说遵守程度的多少。任何事都是过犹不及,设计模式的六个设计原则也是一样,制定这六个原则的目的并不是要我们刻板的遵守他们,而需要根据实际情况灵活运用。对他们的遵守程度只要在一个合理的范围内,就算是良好的设计。我们用一幅图来说明一下。

  图中的每一条维度各代表一项原则,我们依据对这项原则的遵守程度在维度上画一个点,则如果对这项原则遵守的合理的话,这个点应该落在红色的同心圆内部;如果遵守的差,点将会在小圆内部;如果过度遵守,点将会落在大圆外部。一个良好的设计体现在图中,应该是六个顶点都在同心圆中的六边形。

  在上图中,设计1、设计2属于良好的设计,他们对六项原则的遵守程度都在合理的范围内;设计3、设计4设计虽然有些不足,但也基本可以接受;设计5则严重不足,对各项原则都没有很好的遵守;而设计6则遵守过渡了,设计5和设计6都是迫切需要重构的设计。

前端设计模式之迪米特法则(SRP)

译注:本文作者愤怒的韭菜

  定义:
  一个对象应该对其他对象保持最少的了解。

  问题由来:
  与类之间的关系越密切,耦合度越大,当一个类发生改变时,对另一个类的影响也越大。

  解决方案:
  尽量降低类与类之间的耦合。

  自从我们接触编程开始,就知道了软件编程的总的原则:低耦合,高内聚。无论是面向过程编程还是面向对象编程,只有使各个模块之间的耦合尽量的低,才能提高代码的复用率。低耦合的优点不言而喻,但是怎么样编程才能做到低耦合呢?那正是迪米特法则要去完成的。

  迪米特法则又叫最少知道原则,最早是在1987年由美国Northeastern University的Ian Holland提出。通俗的来讲,就是一个类对自己依赖的类知道的越少越好。也就是说,对于被依赖的类来说,无论逻辑多么复杂,都尽量地的将逻辑封装在类的内部,对外除了提供的public方法,不对外泄漏任何信息。迪米特法则还有一个更简单的定义:只与直接的朋友通信。首先来解释一下什么是直接的朋友:每个对象都会与其他对象有耦合关系,只要两个对象之间有耦合关系,我们就说这两个对象之间是朋友关系。耦合的方式很多,依赖、关联、组合、聚合等。其中,我们称出现成员变量、方法参数、方法返回值中的类为直接的朋友,而出现在局部变量中的类则不是直接的朋友。也就是说,陌生的类最好不要作为局部变量的形式出现在类的内部。

  举一个例子:有一个集团公司,下属单位有分公司和直属部门,现在要求打印出所有下属单位的员工ID。先来看一下违反迪米特法则的设计。

  定义1:

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
//总公司员工
class Employee{
private String id;
public void setId(String id){
this.id = id;
}
public String getId(){
return id;
}
}

//分公司员工
class SubEmployee{
private String id;
public void setId(String id){
this.id = id;
}
public String getId(){
return id;
}
}

class SubCompanyManager{
public List<SubEmployee> getAllEmployee(){
List<SubEmployee> list = new ArrayList<SubEmployee>();
for(int i=0; i<100; i++){
SubEmployee emp = new SubEmployee();
//为分公司人员按顺序分配一个ID
emp.setId("分公司"+i);
list.add(emp);
}
return list;
}
}

class CompanyManager{
public List<Employee> getAllEmployee(){
List<Employee> list = new ArrayList<Employee>();
for(int i=0; i<30; i++){
Employee emp = new Employee();
//为总公司人员按顺序分配一个ID
emp.setId("总公司"+i);
list.add(emp);
}
return list;
}
}

public void printAllEmployee(SubCompanyManager sub){
List<SubEmployee> list1 = sub.getAllEmployee();
for(SubEmployee e:list1){
System.out.println(e.getId());
}

List<Employee> list2 = this.getAllEmployee();
for(Employee e:list2){
System.out.println(e.getId());
}

}

public class Client{
public static void main(String[] args){
CompanyManager e = new CompanyManager();
e.printAllEmployee(new SubCompanyManager());
}
}

  现在这个设计的主要问题出在CompanyManager中,根据迪米特法则,只与直接的朋友发生通信,而SubEmployee类并不是CompanyManager类的直接朋友(以局部变量出现的耦合不属于直接朋友),从逻辑上讲总公司只与他的分公司耦合就行了,与分公司的员工并没有任何联系,这样设计显然是增加了不必要的耦合。按照迪米特法则,应该避免类中出现这样非直接朋友关系的耦合。修改后的代码如下:

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
class SubCompanyManager{
public List<SubEmployee> getAllEmployee(){
List<SubEmployee> list = new ArrayList<SubEmployee>();
for(int i=0; i<100; i++){
SubEmployee emp = new SubEmployee();
//为分公司人员按顺序分配一个ID
emp.setId("分公司"+i);
list.add(emp);
}
return list;
}
public void printEmployee(){
List<SubEmployee> list = this.getAllEmployee();
for(SubEmployee e:list){
System.out.println(e.getId());
}
}
}

class CompanyManager{
public List<Employee> getAllEmployee(){
List<Employee> list = new ArrayList<Employee>();
for(int i=0; i<30; i++){
Employee emp = new Employee();
//为总公司人员按顺序分配一个ID
emp.setId("总公司"+i);
list.add(emp);
}
return list;
}

public void printAllEmployee(SubCompanyManager sub){
sub.printEmployee();
List<Employee> list2 = this.getAllEmployee();
for(Employee e:list2){
System.out.println(e.getId());
}
}
}

  修改后,为分公司增加了打印人员ID的方法,总公司直接调用来打印,从而避免了与分公司的员工发生耦合。

  迪米特法则的初衷是降低类之间的耦合,由于每个类都减少了不必要的依赖,因此的确可以降低耦合关系。但是凡事都有度,虽然可以避免与非直接的类通信,但是要通信,必然会通过一个“中介”来发生联系,例如本例中,总公司就是通过分公司这个“中介”来与分公司的员工发生联系的。过分的使用迪米特原则,会产生大量这样的中介和传递类,导致系统复杂度变大。所以在采用迪米特法则时要反复权衡,既做到结构清晰,又要高内聚低耦合。

前端设计模式之接口隔离原则(ISP)

译注:本文作者愤怒的韭菜

  定义:
  客户端不应该依赖它不需要的接口;一个类对另一个类的依赖应该建立在最小的接口上。

  问题由来:
  类A通过接口I依赖类B,类C通过接口I依赖类D,如果接口I对于类A和类B来说不是最小接口,则类B和类D必须去实现他们不需要的方法。

  解决方案:
  将臃肿的接口I拆分为独立的几个接口,类A和类C分别与他们需要的接口建立依赖关系。也就是采用接口隔离原则。

  举例来说明接口隔离原则:


(图1 未遵循接口隔离原则的设计)

  这个图的意思是:类A依赖接口I中的方法1、方法2、方法3,类B是对类A依赖的实现。类C依赖接口I中的方法1、方法4、方法5,类D是对类C依赖的实现。对于类B和类D来说,虽然他们都存在着用不到的方法(也就是图中红色字体标记的方法),但由于实现了接口I,所以也必须要实现这些用不到的方法。对类图不熟悉的可以参照程序代码来理解,代码如下:

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
  interface I{
public void method1();
public void method2();
public void method3();
public void method4();
public void method5();
}

class A{
public void depend1(I i){
i.method1();
}
public void depend1(I i){
i.method2();
}
public void depend1(I i){
i.method3();
}
}
class B implements I{
public void method1(){
System.out.println("类B实现接口I的方法1");
}
public void method2(){
System.out.println("类B实现接口I的方法2");
}
public void method3(){
System.out.println("类B实现接口I的方法3");
}
public void method4() {}
public void method5() {}
}
class C{
public void method1(){
i.method1();
}
public void method2(){
i.method4();
}
public void method3(){
i.method5();
}
}
class D implements I{
public void method1(){
System.out.println("类D实现接口I的方法1");
}
public void method2() {}
public void method3() {}
public void method4() {
System.out.println("类D实现接口I的方法4");
}
public void method5() {
System.out.println("类D实现接口I的方法5");
}
}

public class Client{
public static void main(String[] args){
A a = new A();
a.depend1(new B());
a.depend2(new B());
a.depend3(new B());
}

C c = new C();
c.depend1(new D());
c.depend2(new D());
c.depend3(new D());
}

  可以看到,如果接口过于臃肿,只要接口中出现的方法,不管对依赖于它的类有没有用处,实现类中都必须去实现这些方法,这显然不是好的设计。如果将这个设计修改为符合接口隔离原则,就必须对接口I进行拆分。在这里我们将原有的接口I拆分为三个接口,拆分后的设计如图2所示


(图2 遵循接口隔离原则的设计)

  照例贴出程序的代码,供不熟悉类图的朋友参考:

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
interface I1 {
public void method1();
}
interface I2 {
public void method2();
public void method3();
}
interface I3 {
public void method4();
public void method5();
}

class A{
public void depend1(I1 i){
i.method1();
}
public void depend2(I2 i){
i.method2();
}
public void depend3(I2 i){
i.method3();
}
}

class B implements I1, I2{
public void method1() {
System.out.println("类B实现接口I1的方法1");
}
public void method2() {
System.out.println("类B实现接口I2的方法2");
}
public void method3() {
System.out.println("类B实现接口I2的方法3");
}
}

class C{
public void depend1(I1 i){
i.method1();
}
public void depend2(I3 i){
i.method4();
}
public void depend3(I3 i){
i.method5();
}
}

class D implements I1, I3{
public void method1() {
System.out.println("类D实现接口I1的方法1");
}
public void method4() {
System.out.println("类D实现接口I3的方法4");
}
public void method5() {
System.out.println("类D实现接口I3的方法5");
}
}

  接口隔离原则的含义是:建立单一接口,不要建立庞大臃肿的接口,尽量细化接口,接口中的方法尽量少。也就是说,我们要为各个类建立专用的接口,而不要试图去建立一个很庞大的接口供所有依赖它的类去调用。本文例子中,将一个庞大的接口变更为3个专用的接口所采用的就是接口隔离原则。在程序设计中,依赖几个专用的接口要比依赖一个综合的接口更灵活。接口是设计时对外部设定的“契约”,通过分散定义多个接口,可以预防外来变更的扩散,提高系统的灵活性和可维护性。

  说到这里,很多人会觉的接口隔离原则跟之前的单一职责原则很相似,其实不然。其一,单一职责原则原注重的是职责;而接口隔离原则注重对接口依赖的隔离。其二,单一职责原则主要是约束类,其次才是接口和方法,它针对的是程序中的实现和细节;而接口隔离原则主要约束接口,主要针对抽象,针对程序整体框架的构建。

  采用接口隔离原则对接口进行约束时,要注意以下几点:

  > 接口尽量小,但是要有限度。对接口进行细化可以提高程序设计灵活性是不挣的事实,但是如果过小,则会造成接口数量过多,使设计复杂化。所以一定要适度。
  > 为依赖接口的类定制服务,只暴露给调用的类它需要的方法,它不需要的方法则隐藏起来。只有专注地为一个模块提供定制服务,才能建立最小的依赖关系。
  > 提高内聚,减少对外交互。使接口用最少的方法去完成最多的事情。

  运用接口隔离原则,一定要适度,接口设计的过大或过小都不好。设计接口的时候,只有多花些时间去思考和筹划,才能准确地实践这一原则。

前端设计模式之依赖倒置原则(DIP)

译注:本文作者愤怒的韭菜

  定义:
  高层模块不应该依赖低层模块,二者都应该依赖其抽象;抽象不应该依赖细节;细节应该依赖抽象。

  问题由来:
  类A直接依赖类B,假如要将类A改为依赖类C,则必须通过修改类A的代码来达成。这种场景下,类A一般是高层模块,负责复杂的业务逻辑;类B和类C是低层模块,负责基本的原子操作;假如修改类A,会给程序带来不必要的风险。

  解决方案:
  将类A修改为依赖接口I,类B和类C各自实现接口I,类A通过接口I间接与类B或者类C发生联系,则会大大降低修改类A的几率。

  依赖倒置原则基于这样一个事实:相对于细节的多变性,抽象的东西要稳定的多。以抽象为基础搭建起来的架构比以细节为基础搭建起来的架构要稳定的多。在java中,抽象指的是接口或者抽象类,细节就是具体的实现类,使用接口或者抽象类的目的是制定好规范和契约,而不去涉及任何具体的操作,把展现细节的任务交给他们的实现类去完成。

  依赖倒置原则的核心思想是面向接口编程,我们依旧用一个例子来说明面向接口编程比相对于面向实现编程好在什么地方。场景是这样的,母亲给孩子讲故事,只要给她一本书,她就可以照着书给孩子讲故事了。代码如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
class Book {
public String getContent(){
return '很久很久以前有一个阿拉伯的故事...';
}
}

class Mother{
public void narrate(Book book){
System.out.println("妈妈开始讲故事");
System.out.println(book.getContent());
}
}

public class Client{
public static void main(String[] args){
Mother month = new Month();
moth.narrate(new Book());
}
}

  运行结果:

1
2
妈妈开始讲故事
很久很久以前有一个阿拉伯的故事...

  运行良好,假如有一天,需求变成这样:不是给书而是给一份报纸,让这位母亲讲一下报纸上的故事,报纸的代码如下:

1
2
3
4
5
class Newspaper{
public String getContent(){
return '林书豪38+7领导尼克斯击败湖人……';
}
}

  这位母亲却办不到,因为她居然不会读报纸上的故事,这太荒唐了,只是将书换成报纸,居然必须要修改Mother才能读。假如以后需求换成杂志呢?换成网页呢?还要不断地修改Mother,这显然不是好的设计。原因就是Mother与Book之间的耦合性太高了,必须降低他们之间的耦合度才行。

  我们引入一个抽象的接口IReader。读物,只要是带字的都属于读物:

1
2
3
interface IReader{
public String getContent();
}

  Mother类与接口IReader发生依赖关系,而Book和Newspaper都属于读物的范畴,他们各自都去实现IReader接口,这样就符合依赖倒置原则了,代码修改为:

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
class Newspaper implements IReader{
public String getContent(){
return '林书豪38+7领导尼克斯击败湖人……';
}
}

class Book implements IReader{
public String getContent(){
return '很久很久以前有一个阿拉伯的故事...';
}
}

class Month{
public void narrate(IReader reader){
System.out.println("妈妈开始讲故事");
System.out.println(reader.getContent());
}
}

public class Client{
public static void main(String[] args){
Month month = new Month();
mother.narrate(new Book());
month.getContent(new Newspaper());
}
}

  运行结果:

1
2
3
4
妈妈开始讲故事
很久很久以前有一个阿拉伯的故事……
妈妈开始讲故事
林书豪17+9助尼克斯击败老鹰……

  这样修改后,无论以后怎样扩展Client类,都不需要再修改Mother类了。这只是一个简单的例子,实际情况中,代表高层模块的Mother类将负责完成主要的业务逻辑,一旦需要对它进行修改,引入错误的风险极大。所以遵循依赖倒置原则可以降低类之间的耦合性,提高系统的稳定性,降低修改程序造成的风险。

  采用依赖倒置原则给多人并行开发带来了极大的便利,比如上例中,原本Mother类与Book类直接耦合时,Mother类必须等Book类编码完成后才可以进行编码,因为Mother类依赖于Book类。修改后的程序则可以同时开工,互不影响,因为Mother与Book类一点关系也没有。参与协作开发的人越多、项目越庞大,采用依赖导致原则的意义就越重大。现在很流行的TDD开发模式就是依赖倒置原则最成功的应用

  传递依赖关系有三种方式,以上的例子中使用的方法是接口传递,另外还有两种传递方式:构造方法传递和setter方法传递,相信用过Spring框架的,对依赖的传递方式一定不会陌生。

  在实际编程中,我们一般需要做到如下3点:

  > 低层模块尽量都要有抽象类或接口,或者两者都有。
  > 变量的声明类型尽量是抽象类或接口。
  > 使用继承时遵循里氏替换原则。
  依赖倒置原则的核心就是要我们面向接口编程,理解了面向接口编程,也就理解了依赖倒置。

前端设计模式之单一职责原则(SRP)

译注:本文作者愤怒的韭菜

  定义:
  不要存在多于一个导致类变更的原因。通俗的说,即一个类只负责一项职责。

  问题由来:
  类T负责两个不同的职责:职责P1,职责P2。当由于职责P1需求发生改变而需要修改类T时,有可能会导致原本运行正常的职责P2功能发生故障。

  解决方案:
  遵循单一职责原则。分别建立两个类T1、T2,使T1完成职责P1功能,T2完成职责P2功能。这样,当修改类T1时,不会使职责P2发生故障风险;同理,当修改T2时,也不会使职责P1发生故障风险。

  说到单一职责原则,很多人都会不屑一顾。因为它太简单了。稍有经验的程序员即使从来没有读过设计模式、从来没有听说过单一职责原则,在设计软件时也会自觉的遵守这一重要原则,因为这是常识。在软件编程中,谁也不希望因为修改了一个功能导致其他的功能发生故障。而避免出现这一问题的方法便是遵循单一职责原则。虽然单一职责原则如此简单,并且被认为是常识,但是即便是经验丰富的程序员写出的程序,也会有违背这一原则的代码存在。为什么会出现这种现象呢?因为有职责扩散。所谓职责扩散,就是因为某种原因,职责P被分化为粒度更细的职责P1和P2。

  比如:类T只负责一个职责P,这样设计是符合单一职责原则的。后来由于某种原因,也许是需求变更了,也许是程序的设计者境界提高了,需要将职责P细分为粒度更细的职责P1,P2,这时如果要使程序遵循单一职责原则,需要将类T也分解为两个类T1和T2,分别负责P1、P2两个职责。但是在程序已经写好的情况下,这样做简直太费时间了。所以,简单的修改类T,用它来负责两个职责是一个比较不错的选择,虽然这样做有悖于单一职责原则。(这样做的风险在于职责扩散的不确定性,因为我们不会想到这个职责P,在未来可能会扩散为P1,P2,P3,P4……Pn。所以记住,在职责扩散到我们无法控制的程度之前,立刻对代码进行重构。)

  举例说明,用一个类描述动物呼吸这个场景:

1
2
3
4
5
6
7
8
9
10
11
12
13
class Animal{
public void breathe(String animal){
System.out.println(animal+"呼吸空气");
}}

public class Client{
public static void main(String[] args){
Animal animal = new Animal();
animal.breathe("牛");
animal.breathe("羊");
animal.breathe("猪");
}
}

  运行结果:

1
2
3
牛呼吸空气
羊呼吸空气
猪呼吸空气

  程序上线后,发现问题了,并不是所有的动物都呼吸空气的,比如鱼就是呼吸水的。修改时如果遵循单一职责原则,需要将Animal类细分为陆生动物类Terrestrial,水生动物Aquatic,代码如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
class Terrestrial{
public void breathe(String animal){
System.out.println(animal+"呼吸空气");
}
}

class Aquatic{
public void breathe(String animal){
System.out.println(animal+"呼吸水");
}
}

public class Client{
public static void main(String[] args){
Terrestrial terrestrial = new Terrestrial();
terrestrial.breathe("牛");
terrestrial.breathe("羊");
terrestrial.breathe("猪");
Aquatic aquatic = new Aquatic();
aquatic.breathe("鱼");
}
}

  运行结果:

1
2
3
4
牛呼吸空气
羊呼吸空气
猪呼吸空气
鱼呼吸水

  我们会发现如果这样修改花销是很大的,除了将原来的类分解之外,还需要修改客户端。而直接修改类Animal来达成目的虽然违背了单一职责原则,但花销却小的多,代码如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
class Animal{
public void breathe(String animal){
if("鱼".equals(animal)){
System.out.println(animal+"呼吸水");
}else{
System.out.println(animal+"呼吸空气");
}
}
}
public class Client{
public static void main(String[] args){
Animal animal = new Animal();
animal.breathe("牛");
animal.breathe("羊");
animal.breathe("猪");
animal.breathe("鱼");
}
}

  可以看到,这种修改方式要简单的多。但是却存在着隐患:有一天需要将鱼分为呼吸淡水的鱼和呼吸海水的鱼,则又需要修改Animal类的breathe方法,而对原有代码的修改会对调用“猪”“牛”“羊”等相关功能带来风险,也许某一天你会发现程序运行的结果变为“牛呼吸水”了。这种修改方式直接在代码级别上违背了单一职责原则,虽然修改起来最简单,但隐患却是最大的。还有一种修改方式:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
class Animal{
public void breathe(String animal){
System.out.println(animal+"呼吸空气");
}
public void breathe2(String animal){
System.out.println(animal+"呼吸水");
}
}

public class Client{
public static void main(String[] args){
Animal animal = new Animal();
animal.breathe("牛");
animal.breathe("羊");
animal.breathe("猪");
animal.breathe2("鱼");
}
}

  可以看到,这种修改方式没有改动原来的方法,而是在类中新加了一个方法,这样虽然也违背了单一职责原则,但在方法级别上却是符合单一职责原则的,因为它并没有动原来方法的代码。这三种方式各有优缺点,那么在实际编程中,采用哪一中呢?其实这真的比较难说,需要根据实际情况来确定。我的原则是:只有逻辑足够简单,才可以在代码级别上违反单一职责原则;只有类中方法数量足够少,才可以在方法级别上违反单一职责原则;

  例如本文所举的这个例子,它太简单了,它只有一个方法,所以,无论是在代码级别上违反单一职责原则,还是在方法级别上违反,都不会造成太大的影响。实际应用中的类都要复杂的多,一旦发生职责扩散而需要修改类时,除非这个类本身非常简单,否则还是遵循单一职责原则的好。

  遵循单一职责原的优点有:

  > 可以降低类的复杂度,一个类只负责一项职责,其逻辑肯定要比负责多项职责简单的多;
  > 提高类的可读性,提高系统的可维护性;
  > 变更引起的风险降低,变更是必然的,如果单一职责原则遵守的好,当修改一个功能时,可以显著降低对其他功能的影响。

  需要说明的一点是单一职责原则不只是面向对象编程思想所特有的,只要是模块化的程序设计,都适用单一职责原则。

前端设计模式之里氏替换原则(LSP)

译注:本文作者愤怒的韭菜

  肯定有不少人跟我刚看到这项原则的时候一样,对这个原则的名字充满疑惑。其实原因就是这项原则最早是在1988年,由麻省理工学院的一位姓里的女士(Barbara Liskov)提出来的。

  定义1:
  如果对每一个类型为 T1的对象 o1,都有类型为 T2 的对象o2,使得以 T1定义的所有程序 P 在所有的对象 o1 都代换成 o2 时,程序 P 的行为没有发生变化,那么类型 T2 是类型 T1 的子类型。

  定义2:
  所有引用基类的地方必须能透明地使用其子类的对象。

  问题由来:
  有一功能P1,由类A完成。现需要将功能P1进行扩展,扩展后的功能为P,其中P由原有功能P1与新功能P2组成。新功能P由类A的子类B来完成,则子类B在完成新功能P2的同时,有可能会导致原有功能P1发生故障。

  解决方案:
  当使用继承时,遵循里氏替换原则。类B继承类A时,除添加新的方法完成新增功能P2外,尽量不要重写父类A的方法,也尽量不要重载父类A的方法。

  继承包含这样一层含义:父类中凡是已经实现好的方法(相对于抽象方法而言),实际上是在设定一系列的规范和契约,虽然它不强制要求所有的子类必须遵从这些契约,但是如果子类对这些非抽象方法任意修改,就会对整个继承体系造成破坏。而里氏替换原则就是表达了这一层含义。

  继承作为面向对象三大特性之一,在给程序设计带来巨大便利的同时,也带来了弊端。比如使用继承会给程序带来侵入性,程序的可移植性降低,增加了对象间的耦合性,如果一个类被其他的类所继承,则当这个类需要修改时,必须考虑到所有的子类,并且父类修改后,所有涉及到子类的功能都有可能会产生故障。

  举例说明继承的风险,我们需要完成一个两数相减的功能,由类A来负责。

1
2
3
4
5
6
7
8
9
10
11
12
13
class A{
public int func1(int a,int b){
return a-b;
}
}

public class Client{
public static void main(String[] args){
A a = new A();
System.out.println("100-50="+a.func1(100, 50));
System.out.println("100-80="+a.func1(100, 80));
}
}

  运行结果:

1
2
100-50=50
100-80=20

  后来,我们需要增加一个新的功能:完成两数相加,然后再与100求和,由类B来负责。即类B需要完成两个功能:

   > 两数相减。
   > 两数相加,然后再加100。

  由于类A已经实现了第一个功能,所以类B继承类A后,只需要再完成第二个功能就可以了,代码如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
class B extends A{
public int func1(int a, int b){
return a+b;
}

public int func2(int a, int b){
return func1(a,b)+100;
}
}

public class Client{
public static void main(String[] args){
B b = new B();
System.out.println("100-50="+b.func1(100, 50));
System.out.println("100-80="+b.func1(100, 80));
System.out.println("100+20+100="+b.func2(100, 20));
}
}

  类B完成后,运行结果:

1
2
3
100-50=150
100-80=180
100+20+100=220

  我们发现原本运行正常的相减功能发生了错误。原因就是类B在给方法起名时无意中重写了父类的方法,造成所有运行相减功能的代码全部调用了类B重写后的方法,造成原本运行正常的功能出现了错误。在本例中,引用基类A完成的功能,换成子类B之后,发生了异常。在实际编程中,我们常常会通过重写父类的方法来完成新的功能,这样写起来虽然简单,但是整个继承体系的可复用性会比较差,特别是运用多态比较频繁时,程序运行出错的几率非常大。如果非要重写父类的方法,比较通用的做法是:原来的父类和子类都继承一个更通俗的基类,原有的继承关系去掉,采用依赖、聚合,组合等关系代替。

  > 里氏替换原则通俗的来讲就是:子类可以扩展父类的功能,但不能改变父类原有的功能。它包含以下4层含义
  > 子类可以实现父类的抽象方法,但不能覆盖父类的非抽象方法。
  > 子类中可以增加自己特有的方法。
  > 当子类的方法重载父类的方法时,方法的前置条件(即方法的形参)要比父类方法的输入参数更宽松。
  > 当子类的方法实现父类的抽象方法时,方法的后置条件(即方法的返回值)要比父类更严格。

  看上去很不可思议,因为我们会发现在自己编程中常常会违反里氏替换原则,程序照样跑的好好的。所以大家都会产生这样的疑问,假如我非要不遵循里氏替换原则会有什么后果?

  后果就是:你写的代码出问题的几率将会大大增加。

Vim入门基础

[TOC]

@(welcome)[前端菜鸟|掘金中]

1. 简介

  Vim(Vi[Improved])编辑器是功能强大的跨平台文本文件编辑工具,继承自Unix系统的Vi编辑器,支持Linux/Mac OS X/Windows系统,利用它可以建立、修改文本文件。进入Vim编辑程序,可以在终端输入下面的命令:

1
$vim [filename]

  其中filename是要编辑器的文件的路径名。如果文件不存在,它将为你建立一个新文件。Vim编辑程序有三种操作模式,分别称为 编辑模式、插入模式 和 命令模式,当运行Vim时,首先进入编辑模式。

2. 编辑模式

  Vim编辑方式的主要用途是在被编辑的文件中移动光标的位置。一旦光标移到到所要的位置,就可以进行剪切和粘贴正文块,删除正文和插入新的正文。当完成所有的编辑工作后,需要保存编辑器结果,退出编辑程序回到终端,可以发出ZZ命令,连续按两次大写的Z键。

2.1 跳转

  如果键盘上有上、下、左、右箭头的导航键,就由这些键来完成光标的移动。另外,可以用下面的键完成同样的 按字符移动 功能:

1
2
3
4
k               上移;
j 下移;
h 左移;
l 右移。

  上面这4个键将光标位置每次移动一行或一个 字符 。Vim还提供稍大范围移动光标的命令:

1
2
ctrl+f      在文件中前移一页(相当于 page down);
ctrl+b 在文件中后移一页(相当于 page up);

  更大范围的移动:

1
2
3
4
5
6
7
8
9
10
11
12
*         当光标停留在一个单词上,* 键会在文件内搜索该单词,并跳转到下一处;
# 当光标停留在一个单词上,# 在文件内搜索该单词,并跳转到上一处;
(/) 移动到 前/后 句 的开始;
{/} 跳转到 当前/下一个 段落 的开始。
g_ 到本行最后一个不是 blank 字符的位置。
fa 到下一个为 a 的字符处,你也可以fs到下一个为s的字符。
t, 到逗号前的第一个字符。逗号可以变成其它字符。
3fa 在当前行查找第三个出现的 a。
F/T 和 f 和 t 一样,只不过是相反方向;
gg 将光标定位到文件第一行起始位置;
G 将光标定位到文件最后一行起始位置;
NG或Ngg 将光标定位到第 N 行的起始位置。

  在屏幕中找到需要的 一页 时,可以用下面的命令快速移动光标:

1
2
3
H               将光标移到屏幕上的起始行(或最上行);
M 将光标移到屏幕中间;
L 将光标移到屏幕最后一行。

  同样需要注意字母的大小写。HL命令还可以加数字。如2H表示将光标移到屏幕的第2行,3L表示将光标移到屏幕的倒数第3行。

  当将光标移到所要的行是,行内移动 光标可以用下面的命令来实现:

1
2
3
4
5
6
w               右移光标到下一个字的开头;
e 右移光标到一个字的末尾;
b 左移光标到前一个字的开头;
0 数字0,左移光标到本行的开始;
$ 右移光标,到本行的末尾;
^ 移动光标,到本行的第一个非空字符。

2.2 搜索匹配

  和许多先进的编辑器一样,Vim 提供了强大的字符串搜索功能。要查找文件中指定字或短语出现的位置,可以用Vim直接进行搜索,而不必以手工方式进行。搜索方法是:键入字符/,后面跟以要搜索的字符串,然后按回车键。编辑程序执行正向搜索(即朝文件末尾方向),并在找到指定字符串后,将光标停到该字符串的开头;键入n命令可以继续执行搜索,找出这一字符串下次出现的位置。用字符?取代/,可以实现反向搜索(朝文件开头方向)。例如:

1
2
3
4
/str1               正向搜索字符串 str1;
n 继续搜索,找出 str1 字符串下次出现的位置;
N 继续搜索,找出 str1 字符串上一次出现的位置;
?str2 反向搜索字符串 str2 。

  无论搜索方向如何,当到达文件末尾或开头时,搜索工作会循环到文件的另一端并继续执行。
Vim中执行搜索匹配最强大的地方是结合 正则表达式 来搜索,后续将会介绍。

2.3 替换和删除

  Vim常规的删除命令是 dx(前者删除 ,后者删除字符 ),结合Vim的其他特性可以实现基础的删除功能。将光标定位于文件内指定位置后,可以用其他字符来替换光标所指向的字符,或从当前光标位置删除一个或多个字符或一行、多行。例如:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
rc                用 c 替换光标所指向的当前字符;
nrc 用 c 替换光标所指向的前 n 个字符;
5rA 用 A 替换光标所指向的前 5 个字符;
x 删除光标所指向的当前字符;
nx 删除光标所指向的前 n 个字符;
3x 删除光标所指向的前 3 个字符;
dw 删除光标右侧的字;
ndw 删除光标右侧的 n 个字;
3dw 删除光标右侧的 3 个字;
db 删除光标左侧的字;
ndb 删除光标左侧的 n 个字;
5db 删除光标左侧的 5 个字;
dd 删除光标所在行,并去除空隙;
ndd 删除(剪切) n 行内容,并去除空隙;
3dd 删除(剪切) 3 行内容,并去除空隙;

  其他常用的删除命令有:

1
2
3
d$              从当前光标起删除字符直到行的结束;
d0 从当前光标起删除字符直到行的开始;
J 删除本行的回车符(CR),并和下一行合并。

  Vim常规的替换命令有cs,结合Vim的其他特性可以实现基础的替换功能,不过替换命令执行以后,通常会由 编辑模式 进入 插入模式

1
2
3
4
5
6
7
8
9
10
11
12
13
s              用输入的正文替换光标所指向的字符;
S 删除当前行,并进入插入模式;
ns 用输入的正文替换光标右侧 n 个字符;
nS 删除当前行在内的 n 行,并进入插入模式;
cw 用输入的正文替换光标右侧的字;
cW 用输入的正文替换从光标到行尾的所有字符(同 c$ );
ncw 用输入的正文替换光标右侧的 n 个字;
cb 用输入的正文替换光标左侧的字;
ncb 用输入的正文替换光标左侧的 n 个字;
cd 用输入的正文替换光标的所在行;
ncd 用输入的正文替换光标下面的 n 行;
c$ 用输入的正文替换从光标开始到本行末尾的所有字符;
c0 用输入的正文替换从本行开头到光标的所有字符。

2.4 复制粘贴

  从正文中删除的内容(如字符、字或行)并没有真正丢失,而是被剪切并复制到了一个内存缓冲区中。用户可将其粘贴到正文中的指定位置。完成这一操作的命令是:

1
2
p               小写字母 p,将缓冲区的内容粘贴到光标的后面;
P 大写字母 P,将缓冲区的内容粘贴到光标的前面。

  如果缓冲区的内容是字符或字,直接粘贴在光标的前面或后面;如果缓冲区的内容为整行正文,执行上述粘贴命令将会粘贴在当前光标所在行的上一行或下一行。

  注意上述两个命令中字母的大小写。Vim 编辑器经常以一对大、小写字母(如pP)来提供一对相似的功能。通常,小写命令在光标的后面进行操作,大写命令在光标的前面进行操作。

  有时需要复制一段正文到新位置,同时保留原有位置的内容。这种情况下,首先应当把指定内容复制(而不是剪切)到内存缓冲区。完成这一操作的命令是:

1
2
3
4
5
yy              复制当前行到内存缓冲区;
nyy 复制 n 行内容到内存缓冲区;
5yy 复制 5 行内容到内存缓冲区;
“+y 复制 1 行到操作系统的粘贴板;
“+nyy 复制 n 行到操作系统的粘贴板。

2.5 撤销和重复

  在编辑文档的过程中,为消除某个错误的编辑命令造成的后果,可以用撤消命令。另外,如果用户希望在新的光标位置重复前面执行过的编辑命令,可用重复命令。

1
2
u               撤消前一条命令的结果;
. 重复最后一条修改正文的命令。

3. 插入模式

3.1 进入插入模式

  在编辑模式下正确定位光标之后,可用以下命令切换到插入模式:

1
2
3
4
5
6
i            在光标左侧插入正文
a 在光标右侧插入正文
o 在光标所在行的下一行增添新行
O 在光标所在行的上一行增添新行
I 在光标所在行的开头插入
A 在光标所在行的末尾插入

3.2 退出插入模式

  退出插入模式的方法是,按 ESC 键或组合键 Ctrl+[ ,退出插入模式之后,将会进入编辑模式 。

4. 命令模式

  在已经启动的Vim中打开一个文件需要用 :e命令:

1
:e path_to_file/filename

  保存当前编辑的文件需要用 :w命令(单词 write 的缩写):

1
:w

  将当前文件另存为 file_temp 则:

1
:w file_temp

  在编辑模式下可以用 ZZ 命令退出Vim编辑程序,该命令保存对正文所作的修改,覆盖原始文件。如果只需要退出编辑程序,而不打算保存编辑的内容,可用下面的命令:

1
2
: q             在未作修改的情况下退出;
: q! 放弃所有修改,退出编辑程序。

  保存并退出则可以讲两条命令结合起来使用(注意命令顺序,先保存,后退出):

4.2 行号与文件

  编辑中的每一行正文都有自己的行号,用下列命令可以移动光标到指定行(效果与 编辑模式 下的 nggnG 相同):

1
: n             将光标移到第 n 行

  命令模式下,可以规定命令操作的行号范围。数值用来指定绝对行号;字符“.”表示光标所在行的行号;字符符“$”表示正文最后一行的行号;简单的表达式,例如“.+5”表示当前行往下的第 5 行。例如:

1
2
3
4
5
6
:345                  将光标移到第 345 行
:345w file 将第 345 行写入 file 文件
:3,5w file 将第 3 行至第 5 行写入 file 文件
:1,.w file 将第 1 行至当前行写入 file 文件
:.,$w file 将当前行至最后一行写入 file 文件
:.,.+5w file 从当前行开始将 6 行内容写入 file 文件

  在命令模式下,允许从文件中读取正文,或将正文写入文件。例如:

1
2
3
4
5
6
7
8
:w                 将编辑的内容写入原始文件,用来保存编辑的中间结果
:wq 将编辑的内容写入原始文件并退出编辑程序(相当于 ZZ 命令)
:w file 将编辑的内容写入 file 文件,保持原有文件的内容不变
:a,bw file 将第 a 行至第 b 行的内容写入 file 文件
:r file 读取 file 文件的内容,插入当前光标所在行的后面
:e file 编辑新文件 file 代替原有内容
:f file 将当前文件重命名为 file
:f 打印当前文件名称和状态,如文件的行数、光标所在的行号等

4.3 字符串搜索

  在 编辑模式 讲过字符串的搜索,此处的 命令模式 也可以进行字符串搜索,给出一个字符串,可以通过搜索该字符串到达指定行。如果希望进行正向搜索,将待搜索的字符串置于两个/之间;如果希望反向搜索,则将字符串放在两个?之间。例如:

1
2
3
4
:/str/                  正向搜索,将光标移到下一个包含字符串 str 的行
:?str? 反向搜索,将光标移到上一个包含字符串 str 的行
:/str/w file 正向搜索,并将第一个包含字符串 str 的行写入 file 文件
:/str1/,/str2/w file 正向搜索,并将包含字符串 str1 的行至包含字符串 str2 的行写

4.4 字符串搜索

  当给Vim指定搜索字符串时,可以包含具有特殊含义的字符。包含这些特殊字符的搜索字符串称为正则表达式(Regular Expressions)。例如,要搜索一行正文,这行正文的开头包含 struct 字。下面的命令做不到这一点:

1
:/struct/

  因为它只找出在行中任意位置包含struct的第一行,并不一定在行的开始包含struct。解决问题的办法是在搜索字符串前面加上特殊字符^:

1
:/^struct/

  ^字符比较每行开头的字符串。所以上面的命令表示:找出以字符串struct开头的行。

  也可以用类似办法在搜索字符串后面加上表示行的末尾的特殊字符 $ 来找出位于行末尾的字:

1
:/^struct/

  下表给出大多数特殊字符和它们的含义:

1
2
3
4
5
6
7
8
9
10
^               放在字符串前面,匹配行首的字;
$ 放在字符串后面,匹配行尾的字;
\< 匹配一个字的字头;
\> 匹配一个字的字尾;
. 匹配任何单个正文字符;
[str] 匹配 str 中的任何单个字符;
[^str] 匹配任何不在 str 中的单个字符;
[a-b] 匹配 a 到 b 之间的任一字符;
* 匹配前一个字符的 0 次或多次出现;
\ 转义后面的字符。

4.5 正文替换

  利用:s命令可以实现字符串的替换。具体的用法包括:

1
2
3
4
5
6
:%s/str1/str2/      用字符串 str2 替换行中首次出现的字符串 str1
:s/str1/str2/g 用字符串 str2 替换行中所有出现的字符串 str1
:.,$ s/str1/str2/g 用字符串 str2 替换正文当前行到末尾所有出现的字符串 str1
:1,$ s/str1/str2/g 用字符串 str2 替换正文中所有出现的字符串 str1
:g/str1/s//str2/g 功能同上
:m,ns/str1/str2/g 将从m行到n行的str1替换成str2

  从上述替换命令可以看到:

1
2
3
`g` 放在命令末尾,表示对搜索字符串的每次出现进行替换,不止匹配每行中的第一次出现;不加 `g`,表示只对搜索字符串的首次出现进行替换;`g` 放在命令开头,表示对正文中所有包含搜索字符串的行进行替换操作;
`s` 表示后面跟着一串替换的命令;
`%` 表示替换范围是所有行,即全文。

  另外一个实用的命令,在Vim中统计当前文件中字符串 str1 出现的次数,可用替换命令的变形:

1
:%s/str1/&/gn

4.6 删除正文

  在命令模式下,同样可以删除正文中的内容。例如:

1
2
3
4
5
6
7
8
:d                              删除光标所在行
:3d 删除 3 行
:.,$d 删除当前行至正文的末尾
:/str1/,/str2/d 删除从字符串 str1 到 str2 的所有行
:g/^\(.*\)$\n\1$/d 删除连续相同的行,保留最后一行
:g/\%(^\1$\n\)\@<=\(.*\)$/d 删除连续相同的行,保留最开始一行
:g/^\s*$\n\s*$/d 删除连续多个空行,只保留一行空行
:5,20s/^#//g 删除5到20行开头的 # 注释

  总之,Vim的初级删除命令是用 d ,高级删除命令可以用 正则替换

4.7 恢复文件

  Vim 在编辑某个文件时,会另外生成一个临时文件,这个文件的名称通常以.开头,并以.swp结尾。Vim 在正常退出时,该文件被删除,若意外退出,而没有保存文件的最新修改内容,则可以使用恢复命令:recover来恢复文件,也可以在启动Vim时用-r选项。

4.8 选项设置

  为控制不同的编辑功能,Vim 提供了很多内部选项。利用 :set 命令可以设置选项。基本语法为:

1
:set option         设置选项 option

  常见的功能选项包括:

1
2
3
4
5
6
autoindent      设置该选项,则正文自动缩进
ignorecase 设置该选项,则忽略规则表达式中大小写字母的区别
number 设置该选项,则显示正文行号
ruler 设置该选项,则在屏幕底部显示光标所在行、列的位置
tabstop 设置按 Tab 键跳过的空格数。例如 :set tabstop=n,n 默认值为 8
mk 将选项保存在当前目录的 .exrc 文件中

4.9 Shell切换

  当处于编辑的对话过程中时,可能需要执行一些Linux命令。如果需要保存当前的结果,退出编辑程序,再执行所需的Linux命令,然后再回头继续编辑过程,就显得十分累赘。如果能在编辑的环境中运行Linux命令就要省事得多。在Vim中,可以用下面的命令来做到这一点:

1
:!shell_command   执行完 shell_command 后回到Vim

  这称为Shell切换。它允许执行任何可以在标准的Shell提示符下执行的命令。当这条命令执行完毕,控制返回给编辑程序。又可以继续编辑对话过程。

4.10 分屏与标签页

分屏

  普通的Vim模式,打开一个Vim程序只能查看一个文件,如果想同时查看多个文件,就需要用到Vim分屏与标签页功能。

  Vim的分屏,主要有两种方式:上下分屏(水平分屏)和左右分屏(垂直分屏),在命令模式分别敲入以下命令即可

1
2
:split(可用缩写 :sp)            上下分屏;
:vsplit(可用缩写 :vsp) 左右分屏。

  另外,也可以在终端里启动vim时就开启分屏操作:

1
2
vim -On file1 file2...   打开 file1 和 file2 ,垂直分屏
vim -on file1 file2... 打开 file1 和 file2 ,水平分屏

  理论上,一个Vim窗口,可以分为多个Vim屏幕,切换屏幕需要用键盘快捷键,命令分别有:

1
2
3
4
Ctrl+w+h            切换到当前分屏的左边一屏;
Ctrl+w+l 切换到当前分屏的右边一屏;
Ctrl+w+j 切换到当前分屏的下方一屏;
Ctrl+w+k 切换到当前分屏的上方一屏。

  即键盘上的h,j,k,l 四个Vim专用方向键,配合Ctrl键和w键(window的缩写),就能跳转到目标分屏。另外,也可以直接按 Ctrl+w+w来跳转分屏,不过跳转方向则是在当前Vim窗口所有分屏中,按照逆时针方向跳转。
  下面是改变尺寸的一些操作,主要是高度,对于宽度你可以使用 [Ctrl+W <] 或是 [Ctrl+W >] ,但这可能需要最新的版本才支持。

1
2
3
Ctrl+W =            让所有的屏都有一样的高度;
Ctrl+W + 增加高度;
Ctrl+W - 减少高度。

标签页

  Vim的标签(Tab)页,类似浏览器的标签页,一个标签页打开一个Vim的窗口,一个Vim的窗口可以支持N个分屏。

  在Vim中新建一个标签的命令是:

1
:tabnew

  如果要在新建标签页的同时打开一个文件,则可以在命令后面直接附带文件路径:

1
:tabnew filename

  Vim中的每个标签页有一个唯一的数字序号,第一个标签页的序号是0,从左向右依次加一。关于标签页有一系列操作命令,简介如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
:tN[ext]                跳转到上一个匹配的标签
:tabN[ext] 跳到上一个标签页
:tabc[lose] 关闭当前标签页
:tabdo 为每个标签页执行命令
:tabe[dit] 在新标签页里编辑文件
:tabf[ind] 寻找 'path' 里的文件,在新标签页里编辑之
:tabfir[st] 转到第一个标签页
:tabl[ast] 转到最后一个标签页
:tabm[ove] N 把标签页移到序号为N位置
:tabnew [filename] 在新标签页里编辑文件
:tabn[ext] 转到下一个标签页
:tabo[nly] 关闭所有除了当前标签页以外的所有标签页
:tabp[revious] 转到前一个标签页
:tabr[ewind] 转到第一个标签页

4.11 与外部工具集成

  Vim可以与许多外部程序集成,功能十分强大,比如 diff , ctags , sort , xxd 等等,下面选取几个简单介绍一下。

diff

  Linux命令diff用来对比两个文件的内容,不过对比结果显示在终端里,可读性比较差。结合Vim,在终端里可以直接输入命令vimdiff,后面跟两个文件名作为参数:

1
vimdiff file1 file2

  即可在Vim里分屏显示两个文件内容的对比结果,对文件内容差异部分进行高亮标记,还可以同步滚动两个文件内容,更可以实时修改文件内容,方便程度和用户体验大大提高。

1
vimdiff a.txt b.txt

  如果直接给 -d选项是一样的

1
vim -d a.txt b.txt

  除了在终端里开启vimdiff 功能,也可以在打开Vim后,在Vim的命令模式输入相关命令来开启 vimdiff 功能:

1
:diffsplit abc.txt

  如果你现在已经开启了一个文件,想Vim帮你区分你的文件跟 abc.txt 有什么区别,可以在Vim中用 diffsplit 的方式打开第二个文件,这个时 候Vim会用 split(分上下两屏)的方式开启第二个文件,并且通过颜色,fold 来显示两个文件的区别
  这样Vim就会用颜色帮你区分开2个文件的区别。如果文件比较大(源码)重复的部分会帮你折叠起来。

1
:diffpatch filename

  通过 :diffpatch你的patch的文件名,就可以以当前文件加上你的patch来显示。vim会split一个新的屏,显示patch后的信息并且用颜色标明区别。
  如果不喜欢上下对比,喜欢左右(比较符合视觉)可以在前面加 vert ,例如:

1
2
:vert diffsplit abc.txt
:vert diffpatch abc.txt

  看完diff,用:only 回到原本编辑的文件,觉得diff的讨厌颜色还是在哪里,只要用:diffoff 关闭就好了。
  还有个常用的diff中的就是 :diffu,这个是 :diffupdate 的简写,更新的时候用。

sort

  Linux命令 sort 可以对文本内容进行按行中的字符比较、排序,但在终端里使用 sort 命令处理文件,并不能实时查看文件内容。具体用法请自查手册。

xxd

  vim+xxd 是Linux下最常用的二进制文本编辑工具,xxd其实是Vim外部的一个转换程序,随Vim一起发布,在Vim里调用它来编辑二进制文本非常方便。
  首先以二进制模式在终端里打开一个文件:

1
vim -b filename

  Vim 的 -b 选项是告诉 Vim 打开的是一个二进制文件,不指定的话,会在后面加上 0x0a ,即一个换行符。
  然后在Vim的命令模式下键入:

1
:%!xxd

  即可看到二进制模式显示出来的文本,看起来像这样:

1
2
3
0000000: 1f8b 0808 39d7 173b 0203 7474 002b 4e49  ....9..;..tt.+NI
0000010: 4b2c 8660 eb9c ecac c462 eb94 345e 2e30 K,......b..4^.0
0000020: 373b 2731 0b22 0ca6 c1a2 d669 1035 39d9 7;'1.".....i.59

  然后就可以在二进制模式下编辑该文件,编辑后保存,然后用下面命令从二进制模式转换到普通模式:

1
:%!xxd -r

  另外,也可以调整二进制的显示模式,默认是 2 个字节为一组,可以通过 g 参数调整每组字节数:

1
2
3
:%!xxd -g 1         表示每1个字节为1组
:%!xxd -g 2 表示每2个字节为1组(默认)
:%!xxd -g 4 表示每4个字节为1组

5. Vim配置

  最初安装的Vim功能、特性支持比较少,用起来比较费劲,想要稍微“好用”一点,需做一些初步的配置。Vim的配置主要分为Vim本身特性的配置和外部插件的配置两部分。
  Vim的配置是通常是存放在用户主目录的 .vimrc 的隐藏文件中的。就Vim本身特性来说,基础的配置有编程语言语法高亮、缩进设置、行号显示、搜索高亮、TAB键设置、字体设置、Vim主题设置等等,稍微高级一些的有编程语言缩进、自动补全设置等,具体配置项可以自行查资料,全面详细的配置项介绍可以参考:
  《Vim Options》

6. Vim插件

  Vim“编辑器之神”的称号并不是浪得虚名,然而,这个荣誉的背后,或许近半的功劳要归功于强大的插件支持特性,以及社区开发的各种各样功能强大的插件。
  平时开发人员常用插件主要是目录(文件)查看和管理、编程语言缩进与自动补全、编程语言Docs支持、函数跳转、项目管理等等,简单配置可以参考下面:
  《Vim插件简单介绍》:
  《手把手教你把Vim改装成一个IDE编程环境(图文)》
  《将Vim改造为强大的IDE》

  当然,这些插件都是拜Vim本身的插件支持特性所赐。Vim为了支持丰富的第三方插件,自身定义了一套简单的脚本开发语言,供程序员自行开发自己所需要的插件,插件开发介绍可以参考:

  (《Writing Vim Plugins》)[http://stevelosh.com/blog/2011/09/writing-vim-plugins/]

7. Vim完整文档

  Vim官方文档
  Vim中文用户手册7_3.pdf