forked from SangKa/MobX-Docs-CN
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
1258 lines (714 loc) · 89.2 KB
/
index.html
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
<!DOCTYPE HTML>
<html lang="" >
<head>
<meta charset="UTF-8">
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<title>1. MobX 介绍 · MobX 中文文档</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="description" content="">
<meta name="generator" content="GitBook 3.2.2">
<link rel="stylesheet" href="gitbook/style.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-anchors/plugin.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-highlight/website.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-search/search.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-fontsettings/website.css">
<meta name="HandheldFriendly" content="true"/>
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<link rel="apple-touch-icon-precomposed" sizes="152x152" href="gitbook/images/apple-touch-icon-precomposed-152.png">
<link rel="shortcut icon" href="gitbook/images/favicon.ico" type="image/x-icon">
<link rel="next" href="intro/overview.html" />
<style>
@media only screen and (max-width: 640px) {
.book-header .hidden-mobile {
display: none;
}
}
</style>
<script>
window["gitbook-plugin-github-buttons"] = {"buttons":[{"user":"SangKa","repo":"MobX-Docs-CN","type":"star","size":"small","count":true},{"user":"SangKa","repo":"MobX-Docs-CN","type":"fork","size":"small","count":true}]};
</script>
</head>
<body>
<div class="book">
<div class="book-summary">
<div id="book-search-input" role="search">
<input type="text" placeholder="Type to search" />
</div>
<nav role="navigation">
<ul class="summary">
<li class="chapter active" data-level="1.1" data-path="./">
<a href="./">
1. MobX 介绍
</a>
<ul class="articles">
<li class="chapter " data-level="1.1.1" data-path="intro/overview.html">
<a href="intro/overview.html">
1.1. MobX 要点
</a>
</li>
<li class="chapter " data-level="1.1.2" data-path="intro/concepts.html">
<a href="intro/concepts.html">
1.2. 概念与原则
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.2" data-path="refguide/api.html">
<a href="refguide/api.html">
2. API概览
</a>
</li>
<li class="chapter " data-level="1.3" >
<span>
3. observable 相关
</span>
<ul class="articles">
<li class="chapter " data-level="1.3.1" data-path="refguide/observable.html">
<a href="refguide/observable.html">
3.1. observable
</a>
</li>
<li class="chapter " data-level="1.3.2" data-path="refguide/observable-decorator.html">
<a href="refguide/observable-decorator.html">
3.2. @observable
</a>
</li>
<li class="chapter " data-level="1.3.3" data-path="refguide/object.html">
<a href="refguide/object.html">
3.3. objects
</a>
</li>
<li class="chapter " data-level="1.3.4" data-path="refguide/array.html">
<a href="refguide/array.html">
3.4. arrays
</a>
</li>
<li class="chapter " data-level="1.3.5" data-path="refguide/map.html">
<a href="refguide/map.html">
3.5. maps
</a>
</li>
<li class="chapter " data-level="1.3.6" data-path="refguide/boxed.html">
<a href="refguide/boxed.html">
3.6. boxed values
</a>
</li>
<li class="chapter " data-level="1.3.7" data-path="refguide/modifiers.html">
<a href="refguide/modifiers.html">
3.7 decorators
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.4" >
<span>
4. 对 observables 作出响应
</span>
<ul class="articles">
<li class="chapter " data-level="1.4.1" data-path="refguide/computed-decorator.html">
<a href="refguide/computed-decorator.html">
4.1. (@)computed
</a>
</li>
<li class="chapter " data-level="1.4.2" data-path="refguide/autorun.html">
<a href="refguide/autorun.html">
4.2. autorun
</a>
</li>
<li class="chapter " data-level="1.4.3" data-path="refguide/when.html">
<a href="refguide/when.html">
4.3. when
</a>
</li>
<li class="chapter " data-level="1.4.4" data-path="refguide/reaction.html">
<a href="refguide/reaction.html">
4.4. reaction
</a>
</li>
<li class="chapter " data-level="1.4.5" data-path="refguide/observer-component.html">
<a href="refguide/observer-component.html">
4.5. (@)observer
</a>
</li>
<li class="chapter " data-level="1.4.6" data-path="best/react.html">
<a href="best/react.html">
4.6. 理解 MobX 对何作出响应
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.5" >
<span>
5. 改变 observables
</span>
<ul class="articles">
<li class="chapter " data-level="1.5.1" data-path="refguide/action.html">
<a href="refguide/action.html">
5.1. action
</a>
</li>
<li class="chapter " data-level="1.5.2" data-path="best/actions.html">
<a href="best/actions.html">
5.2. async actions & flows
</a>
</li>
<li class="chapter " data-level="1.5.3" data-path="refguide/object-api.html">
<a href="refguide/object-api.html">
5.3. Object api
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.6" >
<span>
6. 工具函数
</span>
<ul class="articles">
<li class="chapter " data-level="1.6.1" data-path="refguide/tojson.html">
<a href="refguide/tojson.html">
6.1. toJS
</a>
</li>
<li class="chapter " data-level="1.6.2" data-path="refguide/extend-observable.html">
<a href="refguide/extend-observable.html">
6.2. extendObservable
</a>
</li>
<li class="chapter " data-level="1.6.3" data-path="refguide/extending.html">
<a href="refguide/extending.html">
6.3. createAtom
</a>
</li>
<li class="chapter " data-level="1.6.4" data-path="refguide/observe.html">
<a href="refguide/observe.html">
6.4. intercept & observe
</a>
</li>
<li class="chapter " data-level="1.6.5" >
<a target="_blank" href="https://github.com/mobxjs/mobx-utils#frompromise">
6.5. mobxUtils.fromPromise
</a>
</li>
<li class="chapter " data-level="1.6.6" >
<a target="_blank" href="https://github.com/mobxjs/mobx-utils#fromresource">
6.6. mobxUtils.fromResource
</a>
</li>
<li class="chapter " data-level="1.6.7" >
<a target="_blank" href="https://github.com/mobxjs/mobx-utils#tostream">
6.7. mobxUtils.toStream
</a>
</li>
<li class="chapter " data-level="1.6.8" >
<a target="_blank" href="https://github.com/mobxjs/mobx-utils#fromstream">
6.8. mobxUtils.fromStream
</a>
</li>
<li class="chapter " data-level="1.6.9" >
<a target="_blank" href="https://github.com/mobxjs/mobx-utils#now">
6.9. mobxUtils.now
</a>
</li>
<li class="chapter " data-level="1.6.10" data-path="refguide/create-transformer.html">
<a href="refguide/create-transformer.html">
6.10. mobxUtils.createTransformer
</a>
</li>
<li class="chapter " data-level="1.6.11" data-path="refguide/expr.html">
<a href="refguide/expr.html">
6.11. mobxUtils.expr
</a>
</li>
<li class="chapter " data-level="1.6.12" data-path="refguide/api.html">
<a href="refguide/api.html">
6.12. complete api overview
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.7" >
<a target="_blank" href="https://github.com/mobxjs/awesome-mobx#examples">
7. 博客、 视频及相关项目
</a>
</li>
<li class="chapter " data-level="1.8" >
<span>
8. 贴士与技巧
</span>
<ul class="articles">
<li class="chapter " data-level="1.8.1" data-path="faq/faq.html">
<a href="faq/faq.html">
8.1. 常见问题解答
</a>
</li>
<li class="chapter " data-level="1.8.2" data-path="best/pitfalls.html">
<a href="best/pitfalls.html">
8.2. 常见陷阱与最佳实践
</a>
</li>
<li class="chapter " data-level="1.8.3" data-path="best/decorators.html">
<a href="best/decorators.html">
8.3. 如何(不)使用装饰器
</a>
</li>
<li class="chapter " data-level="1.8.4" data-path="best/trace.html">
<a href="best/trace.html">
8.4. 使用 trace 进行调试
</a>
</li>
<li class="chapter " data-level="1.8.5" data-path="best/store.html">
<a href="best/store.html">
8.5. 定义数据存储
</a>
</li>
<li class="chapter " data-level="1.8.6" data-path="best/react-performance.html">
<a href="best/react-performance.html">
8.6. 优化 React 组件
</a>
</li>
<li class="chapter " data-level="1.8.7" data-path="best/devtools.html">
<a href="best/devtools.html">
8.7. 开发工具
</a>
</li>
<li class="chapter " data-level="1.8.8" data-path="refguide/spy.html">
<a href="refguide/spy.html">
8.8. spy
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.9" data-path="donating.html">
<a href="donating.html">
9. 捐赠
</a>
</li>
<li class="divider"></li>
<li>
<a href="https://www.gitbook.com" target="blank" class="gitbook-link">
Published with GitBook
</a>
</li>
</ul>
</nav>
</div>
<div class="book-body">
<div class="body-inner">
<div class="book-header" role="navigation">
<!-- Title -->
<h1>
<i class="fa fa-circle-o-notch fa-spin"></i>
<a href="." >1. MobX 介绍</a>
</h1>
</div>
<div class="page-wrapper" tabindex="-1" role="main">
<div class="page-inner">
<div id="book-search-results">
<div class="search-noresults">
<section class="normal markdown-section">
<blockquote>
<p>此中文文档会与官网文档保持同步</p>
<p>欢迎大家共同来完善此文档,为国内 MobX 爱好者提供一个更好的学习环境</p>
<p>Github 仓库: <a href="https://github.com/SangKa/mobx-docs-cn" target="_blank">https://github.com/SangKa/mobx-docs-cn</a></p>
<p>目前文档已同步至 MobX 5,旧版文档链接: <a href="https://github.com/SangKa/MobX-Docs-CN/tree/4.0.0/docs" target="_blank">MobX 4 (LTS)</a>、<a href="https://github.com/SangKa/MobX-Docs-CN/tree/3.0.0/docs" target="_blank">MobX 3</a></p>
</blockquote>
<p><img src="mobx.png" alt="logo" height="120" align="right"></p>
<h1 id="mobx"><a name="mobx" class="plugin-anchor" href="#mobx"><i class="fa fa-link" aria-hidden="true"></i></a>MobX</h1>
<p><em>简单、可扩展的状态管理</em></p>
<p><a href="https://travis-ci.org/mobxjs/mobx" target="_blank"><img src="https://travis-ci.org/mobxjs/mobx.svg?branch=master" alt="Build Status"></a>
<a href="https://coveralls.io/github/mobxjs/mobx?branch=master" target="_blank"><img src="https://coveralls.io/repos/mobxjs/mobx/badge.svg?branch=master&service=github" alt="Coverage Status"></a>
<a href="https://gitter.im/mobxjs/mobx?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge" target="_blank"><img src="https://badges.gitter.im/Join%20Chat.svg" alt="Join the chat at https://gitter.im/mobxjs/mobx"></a>
<a href="https://hashnode.com/n/mobx" target="_blank"><img src="https://hashnode.github.io/badges/mobx.svg" alt="Discuss MobX on Hashnode"></a>
<a href="#backers"><img src="https://opencollective.com/mobx/backers/badge.svg" alt="OpenCollective"></a>
<a href="#sponsors"><img src="https://opencollective.com/mobx/sponsors/badge.svg" alt="OpenCollective"></a>
<a href="https://github.com/prettier/prettier" target="_blank"><img src="https://img.shields.io/badge/styled_with-prettier-ff69b4.svg" alt="styled with prettier"></a></p>
<p>MobX 是由 Mendix、Coinbase、Facebook 开源和众多<a href="#backers">个人赞助商</a>所赞助的。</p>
<p><img src="mendix-logo.png" align="center" width="100" title="Mendix" alt="Mendix"> <img src="coinbase.jpeg" align="center" width="100" title="Coinbase" alt="Coinbase"> <img src="fbos.jpeg" align="center" width="100" title="Facebook Open Source" alt="Facebook Open Source"></p>
<h1 id="安装"><a name="安装" class="plugin-anchor" href="#安装"><i class="fa fa-link" aria-hidden="true"></i></a>安装</h1>
<ul>
<li>安装: <code>npm install mobx --save</code>。 React 绑定库: <code>npm install mobx-react --save</code>。 要启用 ESNext 的装饰器 (可选), 参见下面。</li>
<li>CDN:<ul>
<li><a href="https://unpkg.com/mobx/lib/mobx.umd.js" target="_blank">https://unpkg.com/mobx/lib/mobx.umd.js</a></li>
<li><a href="https://cdnjs.com/libraries/mobx" target="_blank">https://cdnjs.com/libraries/mobx</a></li>
</ul>
</li>
</ul>
<h1 id="浏览器支持"><a name="浏览器支持" class="plugin-anchor" href="#浏览器支持"><i class="fa fa-link" aria-hidden="true"></i></a>浏览器支持</h1>
<ul>
<li>MobX >=5 版本运行在任何<a href="https://kangax.github.io/compat-table/es6/#test-Proxy" target="_blank">支持 ES6 proxy</a> 的浏览器。如果运行在像 IE11、Node.js 6 以下版本或依靠与较旧的 JavaScripCore 的安卓端的 React Native (<a href="https://github.com/react-community/jsc-android-buildscripts#how-to-use-it-with-my-react-native-app" target="_blank">点击查看如何升级]</a>)。</li>
<li>MobX 4 可以运行在任何支持 ES5 的浏览器上,而且也将进行持续地维护。MobX 4 和 5 的 API 是相同的,并且语义上也能达到相同的效果,只是 MobX 4 存在一些 <a href="#mobx-4-vs-mobx-5">局限性</a>。</li>
</ul>
<p><em>小贴士: MobX 5 包的主入口点附带 ES5 代码,以便向后兼容所有构建工具。但因为 MobX 5 只能运行在现代浏览器上,所以可以考虑使用速度最快、体积最小的 ES6 构建: <code>lib/mobx.es6.js</code> 。例如,通过设置 webpack 的别名: <code>resolve: { alias: { mobx: __dirname + "/node_modules/mobx/lib/mobx.es6.js" }}</code></em></p>
<h2 id="入门指南"><a name="入门指南" class="plugin-anchor" href="#入门指南"><i class="fa fa-link" aria-hidden="true"></i></a>入门指南</h2>
<ul>
<li><i><a style="color: white; background:green;padding:5px;margin:5px;border-radius:2px" href="https://egghead.io/courses/manage-complex-state-in-react-apps-with-mobx" target="_blank">egghead.io 课程</a></i></li>
<li><a href="https://mobxjs.github.io/mobx/getting-started.html" target="_blank">十分钟交互式的 MobX + React 教程</a></li>
<li><img src="images/book.jpg" height="80px"> 由 Pavan Podila 和 Michel Weststrate 撰写的 <a href="https://books.google.nl/books?id=ALFmDwAAQBAJ&pg=PP1&lpg=PP1&dq=michel+weststrate+mobx+quick+start+guide:+supercharge+the+client+state+in+your+react+apps+with+mobx&source=bl&ots=D460fxti0F&sig=ivDGTxsPNwlOjLHrpKF1nweZFl8&hl=nl&sa=X&ved=2ahUKEwiwl8XO--ncAhWPmbQKHWOYBqIQ6AEwAnoECAkQAQ#v=onepage&q=michel%20weststrate%20mobx%20quick%20start%20guide%3A%20supercharge%20the%20client%20state%20in%20your%20react%20apps%20with%20mobx&f=false" target="_blank">MobX 书籍</a> (非常不喜欢xx深入的书名!)</li>
<li><a href="http://cn.mobx.js.org/refguide/api.html" target="_blank">MobX 4官方文档和API概览</a> (<a href="https://github.com/mobxjs/mobx/blob/54557dc319b04e92e31cb87427bef194ec1c549c/docs/refguide/api.md" target="_blank">MobX 3</a>, <a href="https://github.com/mobxjs/mobx/blob/7c9e7c86e0c6ead141bb0539d33143d0e1f576dd/docs/refguide/api.md" target="_blank">MobX 2</a>)</li>
<li>视频:<ul>
<li><a href="https://www.youtube.com/watch?v=Aws40KOx90U" target="_blank">ReactNext 2016: 真实世界的 MobX</a> - 40分钟 <a href="https://docs.google.com/presentation/d/1DrI6Hc2xIPTLBkfNH8YczOcPXQTOaCIcDESdyVfG_bE/edit?usp=sharing" target="_blank">幻灯片</a></li>
<li><a href="https://www.youtube.com/watch?v=XGwuM_u7UeQ" target="_blank">React 和 MobX 实战</a>. OpenSourceNorth 开发者大会上,Matt Ruby 深入介绍和说明如何使用MobX和React(ES5版本) - 42分钟</li>
<li>LearnCode.academy MobX 教程 <a href="https://www.youtube.com/watch?v=_q50BXqkAfI" target="_blank">第一部分: MobX + React 太棒了 (7分钟)</a> <a href="https://www.youtube.com/watch?v=nYvNqKrl69s" target="_blank">第二部分: Computed Values and 嵌套/引用的 Observables (12分钟)</a></li>
<li><a href="https://www.youtube.com/watch?v=K8dr8BMU7-8" target="_blank">录播: MobX 介绍</a> - 8分钟</li>
<li><a href="https://www.youtube.com/watch?v=ApmSsu3qnf0&feature=youtu.be" target="_blank">访谈: 状态管理很容易 - React Amsterdam 2016 开发者大会</a> (<a href="https://speakerdeck.com/mweststrate/state-management-is-easy-introduction-to-mobx" target="_blank">幻灯片</a>)</li>
</ul>
</li>
<li><a href="http://mobxjs.github.io/mobx/faq/boilerplates.html" target="_blank">样板文件和相关项目</a></li>
<li>更多教程、博客和视频尽在 <a href="http://mobxjs.github.io/mobx/faq/blogs.html" target="_blank">MobX 主页</a></li>
<li>更多教程、博客、视频和其他有用的资源尽在 <a href="https://github.com/mobxjs/awesome-mobx/blob/master/README-CN.md" target="_blank">Awesome MobX</a></li>
</ul>
<h2 id="入门"><a name="入门" class="plugin-anchor" href="#入门"><i class="fa fa-link" aria-hidden="true"></i></a>入门</h2>
<p>MobX 是一个经过战火洗礼的库,它通过透明的函数响应式编程(transparently applying functional reactive programming - TFRP)使得状态管理变得简单和可扩展。MobX背后的哲学很简单:</p>
<p><em>任何源自应用状态的东西都应该自动地获得。</em></p>
<p>其中包括UI、数据序列化、服务器通讯,等等。</p>
<p><img alt="MobX unidirectional flow" src="flow.png" align="center"></p>
<p>React 和 MobX 是一对强力组合。React 通过提供机制把应用状态转换为可渲染组件树并对其进行渲染。而MobX提供机制来存储和更新应用状态供 React 使用。</p>
<p>对于应用开发中的常见问题,React 和 MobX 都提供了最优和独特的解决方案。React 提供了优化UI渲染的机制, 这种机制就是通过使用虚拟DOM来减少昂贵的DOM变化的数量。MobX 提供了优化应用状态与 React 组件同步的机制,这种机制就是使用响应式虚拟依赖状态图表,它只有在真正需要的时候才更新并且永远保持是最新的。</p>
<h2 id="核心概念"><a name="核心概念" class="plugin-anchor" href="#核心概念"><i class="fa fa-link" aria-hidden="true"></i></a>核心概念</h2>
<p>MobX 的核心概念不多。 下面的代码片段可以在 <a href="https://codesandbox.io/s/v3v0my2370" target="_blank">codesandbox 示例</a>中在线试用。</p>
<h3 id="observable-state可观察的状态"><a name="observable-state可观察的状态" class="plugin-anchor" href="#observable-state可观察的状态"><i class="fa fa-link" aria-hidden="true"></i></a>Observable state(可观察的状态)</h3>
<p><i><a style="color: white; background:green;padding:5px;margin:5px;border-radius:2px" href="https://egghead.io/lessons/javascript-sync-the-ui-with-the-app-state-using-mobx-observable-and-observer-in-react" target="_blank">Egghead.io 第1课: observable & observer</a></i></p>
<p>MobX 为现有的数据结构(如对象,数组和类实例)添加了可观察的功能。
通过使用 <a href="http://cn.mobx.js.org/refguide/observable-decorator.html" target="_blank">@observable</a> 装饰器(ES.Next)来给你的类属性添加注解就可以简单地完成这一切。</p>
<pre><code class="lang-javascript"><span class="hljs-keyword">import</span> { observable } <span class="hljs-keyword">from</span> <span class="hljs-string">"mobx"</span>;
<span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Todo</span> </span>{
id = <span class="hljs-built_in">Math</span>.random();
@observable title = <span class="hljs-string">""</span>;
@observable finished = <span class="hljs-literal">false</span>;
}
</code></pre>
<p>使用 <code>observable</code> 很像把对象的属性变成excel的单元格。
但和单元格不同的是,这些值不只是原始值,还可以是引用值,比如对象和数组。</p>
<p>如果你的环境不支持装饰器语法,也不必担心。
你可以点击<a href="best/decorators.html">这里</a>查看如何进行设置。
或者你可以直接跳过设置,因为 MobX 可以通过 <em>decorate</em> 工具在不支持装饰器语法的情况加使用。
尽管如此,多数 MobX 用户更喜欢装饰器语法,因为它更简洁。</p>
<p>例如,上面一段代码的ES5版本应该是这样:</p>
<pre><code class="lang-javascript"><span class="hljs-keyword">import</span> { decorate, observable } <span class="hljs-keyword">from</span> <span class="hljs-string">"mobx"</span>;
<span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Todo</span> </span>{
id = <span class="hljs-built_in">Math</span>.random();
title = <span class="hljs-string">""</span>;
finished = <span class="hljs-literal">false</span>;
}
decorate(Todo, {
title: observable,
finished: observable
})
</code></pre>
<h3 id="computed-values计算值"><a name="computed-values计算值" class="plugin-anchor" href="#computed-values计算值"><i class="fa fa-link" aria-hidden="true"></i></a>Computed values(计算值)</h3>
<p><i><a style="color: white; background:green;padding:5px;margin:5px;border-radius:2px" href="https://egghead.io/lessons/javascript-derive-computed-values-and-manage-side-effects-with-mobx-reactions" target="_blank">Egghead.io 第3课: 计算值</a></i></p>
<p>使用 MobX, 你可以定义在相关数据发生变化时自动更新的值。
通过<a href="http://cn.mobx.js.org/refguide/computed-decorator.html" target="_blank"><code>@computed</code></a> 装饰器或者利用 <code>(extend)Observable</code> 时调用 的getter / setter 函数来进行使用。(当然,这里也可以再次使用 <code>decorate</code> 来替代 <code>@</code> 语法)。</p>
<pre><code class="lang-javascript"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">TodoList</span> </span>{
@observable todos = [];
@computed get unfinishedTodoCount() {
<span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>.todos.filter(todo => !todo.finished).length;
}
}
</code></pre>
<p>当添加了一个新的todo或者某个todo的 <code>finished</code> 属性发生变化时,MobX 会确保 <code>unfinishedTodoCount</code> 自动更新。
像这样的计算可以类似于 MS Excel 这样电子表格程序中的公式。每当只有在需要它们的时候,它们才会自动更新。</p>
<h3 id="reactions反应"><a name="reactions反应" class="plugin-anchor" href="#reactions反应"><i class="fa fa-link" aria-hidden="true"></i></a>Reactions(反应)</h3>
<p><i><a style="color: white; background:green;padding:5px;margin:5px;border-radius:2px" href="https://egghead.io/lessons/react-write-custom-mobx-reactions-with-when-and-autorun" target="_blank">Egghead.io 第9课: 自定义反应</a></i></p>
<p>Reactions 和计算值很像,但它不是产生一个新的值,而是会产生一些副作用,比如打印到控制台、网络请求、递增地更新 React 组件树以修补DOM、等等。
简而言之,reactions 在 <a href="https://en.wikipedia.org/wiki/Reactive_programming" target="_blank">响应式编程</a>和<a href="https://en.wikipedia.org/wiki/Imperative_programming" target="_blank">命令式编程</a>之间建立沟通的桥梁。</p>
<h4 id="react-组件"><a name="react-组件" class="plugin-anchor" href="#react-组件"><i class="fa fa-link" aria-hidden="true"></i></a>React 组件</h4>
<p><i><a style="color: white; background:green;padding:5px;margin:5px;border-radius:2px" href="https://egghead.io/courses/manage-complex-state-in-react-apps-with-mobx" target="_blank">Egghead.io 第1课: observable & observer</a></i></p>
<p>如果你用 React 的话,可以把你的(无状态函数)组件变成响应式组件,方法是在组件上添加 <a href="http://cn.mobx.js.org/refguide/observable-decorator.html" target="_blank"><code>observer</code></a> 函数/ 装饰器. <code>observer</code>由 <code>mobx-react</code> 包提供的。</p>
<pre><code class="lang-javascript"><span class="hljs-keyword">import</span> React, {Component} <span class="hljs-keyword">from</span> <span class="hljs-string">'react'</span>;
<span class="hljs-keyword">import</span> ReactDOM <span class="hljs-keyword">from</span> <span class="hljs-string">'react-dom'</span>;
<span class="hljs-keyword">import</span> {observer} <span class="hljs-keyword">from</span> <span class="hljs-string">'mobx-react'</span>;
@observer
<span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">TodoListView</span> <span class="hljs-keyword">extends</span> <span class="hljs-title">Component</span> </span>{
render() {
<span class="hljs-keyword">return</span> <div>
<ul>
{this.props.todoList.todos.map(todo =>
<TodoView todo={todo} key={todo.id} />
)}
</ul>
Tasks left: {this.props.todoList.unfinishedTodoCount}
</div>
}
}
const TodoView = observer(({todo}) =>
<li>
<input
type="checkbox"
checked={todo.finished}
onClick={() => todo.finished = !todo.finished}
/>{todo.title}
</li>
)
const store = new TodoList();
ReactDOM.render(<TodoListView todoList={store} />, document.getElementById('mount'));
</code></pre>
<p><code>observer</code> 会将 React (函数)组件转换为它们需要渲染的数据的衍生。
使用 MobX 时没有所谓的智能和无脑组件。
所有的组件都会以巧妙的方式进行渲染,而只需要一种简单无脑的方式来定义它们。MobX 会确保组件总是在需要的时重新渲染,但仅此而已。所以上面例子中的 <code>onClick</code> 处理方法会强制对应的 <code>TodoView</code> 进行渲染,如果未完成任务的数量(unfinishedTodoCount)已经改变,它将导致 <code>TodoListView</code> 进行渲染。
可是,如果移除 <code>Tasks left</code> 这行代码(或者将它放到另一个组件中),当点击 <code>checkbox</code> 的时候 <code>TodoListView</code> 就不再重新渲染。你可以在 <a href="https://jsfiddle.net/mweststrate/wv3yopo0/" target="_blank">JSFiddle</a> 中自己动手来验证这点。</p>
<h4 id="自定义-reactions"><a name="自定义-reactions" class="plugin-anchor" href="#自定义-reactions"><i class="fa fa-link" aria-hidden="true"></i></a>自定义 reactions</h4>
<p>使用<a href="http://cn.mobx.js.org/refguide/autorun.html" target="_blank"><code>autorun</code></a>、<a href="http://cn.mobx.js.org/refguide/reaction.html" target="_blank"><code>reaction</code></a> 和 <a href="http://cn.mobx.js.org/refguide/when.html" target="_blank"><code>when</code></a> 函数即可简单的创建自定义 reactions,以满足你的具体场景。</p>
<p>例如,每当 <code>unfinishedTodoCount</code> 的数量发生变化时,下面的 <code>autorun</code> 会打印日志消息:</p>
<pre><code class="lang-javascript">autorun(() => {
<span class="hljs-built_in">console</span>.log(<span class="hljs-string">"Tasks left: "</span> + todos.unfinishedTodoCount)
})
</code></pre>
<h3 id="mobx-会对什么作出响应"><a name="mobx-会对什么作出响应" class="plugin-anchor" href="#mobx-会对什么作出响应"><i class="fa fa-link" aria-hidden="true"></i></a>MobX 会对什么作出响应?</h3>
<p>为什么每次 <code>unfinishedTodoCount</code> 变化时都会打印一条新消息?答案就是下面这条经验法则:</p>
<p><em>MobX 会对在执行跟踪函数期间读取的任何现有的可观察属性做出反应</em>。</p>
<p>想深入了解 MobX 是如何知道需要对哪个可观察属性进行响应,请查阅 <a href="http://cn.mobx.js.org/best/react.html" target="_blank">理解 MobX 对什么有反应</a>。</p>
<h3 id="actions动作"><a name="actions动作" class="plugin-anchor" href="#actions动作"><i class="fa fa-link" aria-hidden="true"></i></a>Actions(动作)</h3>
<p><i><a style="color: white; background:green;padding:5px;margin:5px;border-radius:2px" href="https://egghead.io/lessons/react-use-mobx-actions-to-change-and-guard-state" target="_blank">Egghead.io 第5课: actions</a></i></p>
<p>不同于 flux 系的一些框架,MobX 对于如何处理用户事件是完全开明的。</p>
<ul>
<li>可以用类似 Flux 的方式完成</li>
<li>或者使用 RxJS 来处理事件</li>
<li>或者用最直观、最简单的方式来处理事件,正如上面演示所用的 <code>onClick</code></li>
</ul>
<p>最后全部归纳为: 状态应该以某种方式来更新。</p>
<p>当状态更新后,<code>MobX</code> 会以一种高效且无障碍的方式处理好剩下的事情。像下面如此简单的语句,已经足够用来自动更新用户界面了。</p>
<p>从技术上层面来讲,并不需要触发事件、调用分派程序或者类似的工作。归根究底 React 组件只是状态的华丽展示,而状态的衍生由 MobX 来管理。</p>
<pre><code class="lang-javascript">store.todos.push(
<span class="hljs-keyword">new</span> Todo(<span class="hljs-string">"Get Coffee"</span>),
<span class="hljs-keyword">new</span> Todo(<span class="hljs-string">"Write simpler code"</span>)
);
store.todos[<span class="hljs-number">0</span>].finished = <span class="hljs-literal">true</span>;
</code></pre>
<p>尽管如此,MobX 还是提供了 <a href="http://cn.mobx.js.org/refguide/action.html" target="_blank"><code>actions</code></a> 这个可选的内置概念。
如果你现在就想要了解如何编写 actions,请阅读 Actions 章节。很简单!
使用 <code>actions</code> 是有优势的: 它们可以帮助你把代码组织的更好,还能在状态何时何地应该被修改这个问题上帮助你做出明智的决定。</p>
<h2 id="mobx-简单且可扩展"><a name="mobx-简单且可扩展" class="plugin-anchor" href="#mobx-简单且可扩展"><i class="fa fa-link" aria-hidden="true"></i></a>MobX: 简单且可扩展</h2>
<p>MobX 是状态管理库中侵入性最小的之一。这使得 <code>MobX</code>的方法不但简单,而且可扩展性也非常好:</p>
<h3 id="使用类和真正的引用"><a name="使用类和真正的引用" class="plugin-anchor" href="#使用类和真正的引用"><i class="fa fa-link" aria-hidden="true"></i></a>使用类和真正的引用</h3>
<p>使用 MobX 不需要使数据标准化。这使得库十分适合那些异常复杂的领域模型(以 Mendix 为例: 一个应用中有大约500个领域类)。</p>
<h3 id="保证参照完整性"><a name="保证参照完整性" class="plugin-anchor" href="#保证参照完整性"><i class="fa fa-link" aria-hidden="true"></i></a>保证参照完整性</h3>
<p>因为数据不需要标准化,所以 MobX 会自动跟踪状态和衍生之间的关系,你可以免费获得参照完整性。渲染通过三级间接寻址访问的数据?</p>
<p>没有问题,MobX 会跟踪它们,一旦其中一个引用发生了变化,就会重新渲染。作为回报,陈年的老bug已不复存在。作为一个程序员,你可能记不住修改的一些数据可能会影响到的某个角落里看起来毫不相关的组件,但 MobX 不会。</p>
<h3 id="更简单的-actions-更便于维护"><a name="更简单的-actions-更便于维护" class="plugin-anchor" href="#更简单的-actions-更便于维护"><i class="fa fa-link" aria-hidden="true"></i></a>更简单的 actions 更便于维护</h3>
<p>正如上面所演示的,使用 MobX 修改状态是非常简单的。你只需简单的写出你的目的。MobX 会替你处理好剩下的事情。</p>
<h3 id="细粒度的可观测性是高效的"><a name="细粒度的可观测性是高效的" class="plugin-anchor" href="#细粒度的可观测性是高效的"><i class="fa fa-link" aria-hidden="true"></i></a>细粒度的可观测性是高效的</h3>
<p>MobX 构建应用中所有衍生的图形,以找到保持最新状态所需的重新计算的最少次数。“衍生一切”或许听上去开销很昂贵,但 MobX 构建虚拟衍生图以保持衍生与状态同步所需的重计算的数量最小化。</p>
<p>事实上,在 Mendix 测试 MobX 时我们发现使用这个库跟踪代码中的关系通常会更有效,而不是通过使用手写事件或基于容器组件的“智能”选择器来推送更改。</p>
<p>简单来说,是因为 MobX 会在数据上建立更细粒度的“监听器”,而不是通过程序来控制。</p>
<p>其次, MobX 看到衍生之间的因果关系,因此它可以为衍生排序,使得衍生不会运行多次或引入缺陷。</p>
<p>想了解这是如何工作的? 请参见 <a href="https://medium.com/@mweststrate/becoming-fully-reactive-an-in-depth-explanation-of-mobservable-55995262a254" target="_blank">深入剖析 MobX</a>。</p>
<h3 id="易操作性"><a name="易操作性" class="plugin-anchor" href="#易操作性"><i class="fa fa-link" aria-hidden="true"></i></a>易操作性</h3>
<p>MobX 使用原生 javascript 。由于它的侵入性不强,它可以和绝大部分 javascript 库共同使用,而不需要特定的 MobX 风格库。</p>
<p>所以你可以继续使用你的路由,数据获取和工具库,比如<code>react-router</code>、 <code>director</code>、 <code>superagent</code>、 <code>lodash</code>,等等。</p>
<p>出于同样的原因,你可以在服务器端和客户端使用它,也可以在 react-native 这样的同构应用中使用。</p>
<p>结论就是: 相比其它状态管理解决方案,当使用 MobX 时通常只需学习更少的新概念。</p>
<h2 id="赞誉"><a name="赞誉" class="plugin-anchor" href="#赞誉"><i class="fa fa-link" aria-hidden="true"></i></a>赞誉</h2>
<p>MobX 的灵感来自excel表格中的反应式编程原理。同样也受到像 MeteorJS、knockout和Vue.js这样的 MVVM 框架的启发。但是 MobX 把透明的函数响应式编程(Transparent Functional Reactive Programming)提升到了一个更好的水平并且提供了独立的实现。它以一种无障碍、同步、可预见和高效的方式实现了 TFRP。</p>
<p>更多的赞誉给<a href="https://github.com/mendix" target="_blank">Mendix</a> ,它为维护 MobX 给予了灵活性和支持,并提供机会在真实、复杂、性能关键的应用程序中证明 MobX 的哲学。</p>
<p>最终的赞誉属于所有的选择相信、不断尝试、不断验证、乃至<a href="https://github.com/mobxjs/mobx/blob/master/sponsors.md" target="_blank">赞助</a> MobX 的人们。</p>
<h2 id="更多资源及文档"><a name="更多资源及文档" class="plugin-anchor" href="#更多资源及文档"><i class="fa fa-link" aria-hidden="true"></i></a>更多资源及文档</h2>
<ul>