├── .gitignore ├── .gitmodules ├── LICENSE ├── README.rst ├── backbonejs_第二版.pdf ├── chapters ├── 00-preface.rst ├── 01-hello-backbonejs.rst ├── 02-backbonejs-model.rst ├── 03-backbonejs-collection.rst ├── 04-backbonejs-router.rst ├── 05-backbonejs-view.rst ├── 06-backbonejs-todos-1.rst ├── 07-backbonejs-todos-2.rst ├── 08-backbonejs-todos-3.rst ├── 09-intro-webpy.rst ├── 10-expand-todos-with-server.rst ├── 11-web-chatroom-base-on-backbonejs-1.rst ├── 12-web-chatroom-base-on-backbonejs-2.rst ├── 13-web-chatroom-base-on-backbonejs-3.rst ├── 14-web-chatroom-base-on-backbonejs-4.rst ├── 15-import-requirejs.rst ├── 16-exception-in-backbone.rst ├── 17-customize-backbonejs-sync.rst ├── 18-backbone-summary.rst ├── 19-backbone-js-resource.rst └── rst_to_md.sh ├── code ├── 01-hello-backbonejs.html ├── 02-backbonejs-model-server.py ├── 02-backbonejs-model.html ├── 03-backbonejs-collection-server.py ├── 03-backbonejs-collection.html ├── 04-backbonejs-router.html ├── 05-backbonejs-view.html ├── requirejs-demo │ ├── hello-backbonejs-requirejs.html │ └── static │ │ ├── js │ │ └── app.js │ │ ├── lib │ │ ├── backbone.js │ │ ├── jquery.js │ │ ├── require.js │ │ └── underscore.js │ │ └── main.js └── seajs-demo │ ├── hello-backbonejs-seajs.html │ └── static │ ├── js │ └── app.js │ ├── lib │ ├── backbone.js │ ├── jquery.js │ ├── sea-debug.js │ └── underscore.js │ └── main.js ├── images ├── backbonejs-cover.png ├── donate-alipay.png ├── login.png ├── message.png ├── topics.png └── wechat-arch.png ├── md_chapters ├── 00-preface.md ├── 01-hello-backbonejs.md ├── 02-backbonejs-model.md ├── 03-backbonejs-collection.md ├── 04-backbonejs-router.md ├── 05-backbonejs-view.md ├── 06-backbonejs-todos-1.md ├── 07-backbonejs-todos-2.md ├── 08-backbonejs-todos-3.md ├── 09-intro-webpy.md ├── 10-expand-todos-with-server.md ├── 11-web-chatroom-base-on-backbonejs-1.md ├── 12-web-chatroom-base-on-backbonejs-2.md ├── 13-web-chatroom-base-on-backbonejs-3.md ├── 14-web-chatroom-base-on-backbonejs-4.md ├── 15-import-requirejs.md ├── 16-exception-in-backbone.md ├── 17-customize-backbonejs-sync.md ├── 18-backbone-summary.md └── 19-backbone-js-resource.md ├── sites-baseon-backbonejs.rst ├── sponsor.rst └── 反馈.rst /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | .DS_Store 3 | -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "code/webpy-todos"] 2 | path = code/webpy-todos 3 | url = git@github.com:the5fire/onlinetodos.git 4 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2013 the5fire 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy of 6 | this software and associated documentation files (the "Software"), to deal in 7 | the Software without restriction, including without limitation the rights to 8 | use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of 9 | the Software, and to permit persons to whom the Software is furnished to do so, 10 | subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS 17 | FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR 18 | COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 19 | IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 20 | CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 21 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | Backbone.js入门教程第二版 2 | ========================= 3 | 4 | * 作者：the5fire 5 | * blog: http://the5fire.com 6 | * 制作日期：2013-08-05 7 | 8 | 电子版 9 | ----------------------------- 10 | 11 | `《Backbonejs入门教程第二版》 `_ 12 | 13 | 对于百度阅读上已经购买的读者表示抱歉，我在百度阅读上修改后重新提交电子版，被判定为盗版，并且没有告知具体细节。百度阅读上次团队调整后似乎已经不再考虑原创作者了。 14 | 15 | 关于 16 | ------------------------ 17 | 18 | 之前在学习backbonejs的时候写了一系列的文章： `backbonejs入门笔记 `_ ,最后生成pdf放到网上，有很多网友看完之后发消息给我，说对自己学习backbonejs很有帮助。我自己的博客也有大部分的流量来自backbonejs的搜索。 19 | 20 | 在写第一版教程的时候没有注意版本问题，对于前端框架算是从零起步，很多东西没有注意到。让很多网友产生疑惑： 为何我按照你的代码写完之后一直报错，无法运行？诸如此类吧。究其原因有两点，一是只是copy了js部分代码，htmlscript的引用是自己找的;二是我用的backbonejs版本也不唯一，有很多地方也是自己不求甚解，能执行就行。 21 | 22 | 随着自己对前端框架的理解，以及网友提问的驱动，让我觉得有必要把版本这个坑填上。也对自己近一年来关于前端上的学习做一个整理，虽然我不是专门做前端开发，但多多少少都会用到一些。 23 | 24 | 这本书除了对之前原有内容的升级之外，还打算添加一些新的内容，如用backbonejs做点实际的应用和模块化的东西。另外也打算通过新版的电子书尝试下新的东西。 25 | 26 | 放到这里，算是给自己又挖了一个坑。能不能填上，我也不知道，毕竟我大多数的学习时间都在后端Python、Django等框架上。 27 | 28 | 看过第一本书，想给作者（the5fire）加把油的同学，可以提供赞助，赞助后你的名字会出现在这里: `关于赞助及赞助者名单 `_ 29 | 30 | 支付宝扫码赞助: 31 | 32 | .. image:: images/donate-alipay.png 33 | 34 | 35 | 反馈 36 | ------------------------ 37 | 看这里 `反馈 <反馈.rst>`_ 38 | 39 | 40 | 国内哪些网站在用backbonejs 41 | -------------------------- 42 | `sites-baseon-backbonejs `_ 43 | 44 | 45 | 目录 46 | -------------------------- 47 | * 00 `前言 `_ 48 | * 01 `Hello Backbonejs `_ 49 | * 02 `Backbonejs中的Model实践 `_ 50 | * 03 `Backbonejs中的Collections实践 `_ 51 | * 04 `Backbonejs中的Router实践 `_ 52 | * 05 `Backbonejs中的View实践 `_ 53 | * 06 `实战演练：todos分析（一） `_ 54 | * 07 `实战演练：todos分析（二）View的应用 `_ 55 | * 08 `实战演练：todos分析（三）总结 `_ 56 | * 09 `后端环境搭建：web.py的使用 `_ 57 | * 10 `实战演练：扩展todos到Server端（backbonejs+webpy） `_ 58 | * 11 `前后端实战演练：Web聊天室-功能分析 `_ 59 | * 12 `前后端实战演练：Web聊天室-详细设计 `_ 60 | * 13 `前后端实战演练：Web聊天室-服务端开发 `_ 61 | * 14 `前后端实战演练：Web聊天室-前端开发 `_ 62 | * 15 `引入requirejs `_ 63 | * 16 `补充异常处理 `_ 64 | * 17 `定制Backbonejs `_ 65 | * 18 `再次总结的说 `_ 66 | * 19 `Backbonejs相关资源 `_ 67 | 68 | ``暂定目录如上 , 压力相当的山大`` 69 | 70 | ``压力解除`` 71 | 72 | happy coding!! 73 | 74 | Backbonejs交流群：308466740 75 | -------------------------------------------------------------------------------- /backbonejs_第二版.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/the5fire/backbonejs-learning-note/6d9147898ca948613ce0d7c6e44dac7fd1b313aa/backbonejs_第二版.pdf -------------------------------------------------------------------------------- /chapters/00-preface.rst: -------------------------------------------------------------------------------- 1 | 第一版前言 2 | ------------------------- 3 | 4 | **写在前面的话** 5 | 这一系列的文章写了这么久，也算是告一段落了，为了方便大家查看，制作成PDF格式的放到网上，待有兴趣学习 backbone.js的同学参考。 6 | 7 | 第一次写完一系列的东西，以前有过很多写系列文章的冲动，不过都是写了一段时间就因为一些事放下了，如：设计模式，还有tomcat源码。 8 | 9 | 其实这一系列文章的主要目的还是让初学backbone.js的人，能够快速的把它用到项目上。写backbone的原因是，在我搜索查找关于它的学习资料时，发现中文的资料比较少也比较散，虽然看到有网友在博客上说打算写，但毕竟只是打算，因此 ，我就一边学习 ，一边把里面的东西大概的梳理了一下，写成文章。 10 | 11 | 把这些东西写出来，不是说明我有多厉害，而只是表现我渴望学习、提高、分享。对于这些东西我未必完全掌握，但是我尽量把我知道的东西写出来，分享出去。 12 | 13 | 任何一个人都是从菜鸟慢慢成长起来的，而你成长过程中的所有经历恰恰又是下一代或者说你后面菜鸟所渴望知道的，同时也是对你以后成长大有帮助的。所以不管你觉得自己有多菜，你都应该把你学到的，思考的东西写下来，哪怕只有一点。 14 | 15 | 所有的文章中会有很多不足的地方，你如果发现错误，欢迎到对应的博文链接上拍砖。每篇文章都给了链接，方便大家快速跳转到网页。 16 | 17 | 最后，写上一句话，以显示我的文学水平（表拍砖）：没有开始，怎么会有成长;没有总结，怎么会有收获;没有分享，怎么会有升华。 18 | 19 | 20 | 第二版前言 21 | --------------------------- 22 | 一年前写的东西，当时写完之后工作中用不到也就不再看了，谁想后来越来越多的人通过搜索backbonejs来到我的博客，有表示感谢的，有吐槽的，有帮忙改bug的。在之前接触时只是为了能让代码运行，因此很多实例没有考虑版本问题。在backbonejs更新到1.0.0之后，我的很多代码实例都出现了问题，于是我不得不去更新其中的东西。但是这样一点点的更新总是不能覆盖全面，随想不如在搞个第二版，把之前的坑填上，然后再补充点我新学到的东西，尽可能的让有机会看到这本电子书的人有点收获。 23 | 24 | 说起这一年，学习了angularjs，还没有来得及实践。用backbonejs实践了我博客的手机版:m.the5fire.com功能，比较简陋。 25 | 26 | 在qq群里聊天时@wrongway兄调侃说backbonejs属于远古时期的框架了，关于这一点，相比于angularjs确实显的有些落后。在我看来，两个的思路或者哲学并不相同，backbonejs就如其官网所说提供了一个web应用的结构，而angularjs则是对html的增强。 27 | 28 | 大概就闲扯这么多，总之主要的目的是填上一版的一些坑，然后或许会留下新的坑。 29 | 30 | *后续补充（2014-4-18）*: 31 | 32 | 从去年8月份开始到现在，最初的目的算是完成了。但是随着不断的和正在学习Backbonejs的人交流发现，有些人虽然已经掌握了Backbonejs基本模型、视图以及其他模块的使用，但是却无法把已掌握的内容转化到实际项目中。 33 | 34 | 另外大家也看厌了到处在分析的Todos这个实例，希望看到真实点的项目。虽然对大家看待优秀项目代码的态度不太认同，但我很理解初学者的这种心情——不要给我Demo，我要真实的东西。 35 | 36 | 但真实的东西往往需要太多其他方面的知识，比如我在最后的项目中用到了socket.io来实现实时的交流。这些东西都算是超出Backbonejs这个框架内容之外的。 37 | 38 | 要学习一个东西，和结识一个新的朋友一样。如果你总是站在远处想看风景一般看着他/她，那他/她对你来说只能是风景。对于Backbonejs来说也一样，不要停留在看完书、觉得会用的阶段，拉起Ta的手，一起来做一些东西。 39 | 40 | 基于此，最后的那个项目是打算放到线上来运行的，也让读完本书的读者能有一个地方体验一下你在本书看到的东西，最终是如何转化为被用户可用的网站的。 41 | 42 | 43 | :) happy coding 44 | 45 | **导航** 46 | 47 | * 下一章： `01 hello backbonejs <01-hello-backbonejs.rst>`_ 48 | -------------------------------------------------------------------------------- /chapters/01-hello-backbonejs.rst: -------------------------------------------------------------------------------- 1 | 第一章 Hello Backbonejs 2 | ======================================================================= 3 | 4 | 1.1 基础概念 5 | -------------------- 6 | Backbone，英文意思是：勇气， 脊骨，但是在程序里面，尤其是在Backbone后面加上后缀js之后，它就变成了一个框架，一个js库。 7 | 8 | Backbone.js，不知道作者是以什么样的目的来对其命名的，可能是希望这个库会成为web端开发中脊梁骨。 9 | 10 | 好了，八卦完了开始正题。 11 | 12 | Backbone.js提供了一套web开发的框架，通过Models进行key-value绑定及自定义事件处理，通过Collections提供一套丰富的API用于枚举功能，通过Views来进行事件处理及与现有的Application通过RESTful JSON接口进行交互.它是基于jQuery和underscore的一个前端js框架。 13 | 14 | 整体上来说，Backbone.js是一个web端javascript的MVC框架，算是轻量级的框架。它能让你像写Java（后端）代码组织js代码，定义类，类的属性以及方法。更重要的是它能够优雅的把原本无逻辑的javascript代码进行组织，并且提供数据和逻辑相互分离的方法，减少代码开发过程中的数据和逻辑混乱。 15 | 16 | 在Backbonejs有几个重要的概念，先介绍一下:Model，Collection，View，Router。其中Model是根据现实数据建立的抽象，比如人（People）；Collection是Model的一个集合，比如一群人；View是对Model和Collection中数据的展示，把数据渲染（Render）到页面上；Router是对路由的处理，就像传统网站通过url现实不同的页面，在单页面应用（SPA）中通过Router来控制前面说的View的展示。 17 | 18 | 通过Backbone，你可以把你的数据当作Models，通过Models你可以创建数据，进行数据验证，销毁或者保存到服务器上。当界面上的操作引起model中属性的变化时，model会触发change的事件。那些用来显示model状态的views会接受到model触发change的消息，进而发出对应的响应，并且重新渲染新的数据到界面。在一个完整的Backbone应用中，你不需要写那些胶水代码来从DOM中通过特殊的id来获取节点，或者手工的更新HTML页面，因为在model发生变化时，views会很简单的进行自我更新。 19 | 20 | 上面是一个简单的介绍，关于backbone我看完他的介绍和简单的教程之后，第一印象是它为前端开发制定了一套自己的规则，在这个规则下，我们可以像使用django组织python代码一样的组织js代码，它很优雅，能够使前端和server的交互变得简单。 21 | 22 | 在查backbone资料的时候，发现没有很系统的中文入门资料和更多的实例，所以我打算自己边学边实践边写，争取能让大家通过一系列文章能快速的用上Backbone.js。 23 | 24 | 关于backbone的更多介绍参看这个： 25 | 26 | http://documentcloud.github.com/backbone/ 27 | 28 | http://backbonetutorials.com/ 29 | 30 | 31 | 1.2 backbone的应用范围： 32 | ------------------------------ 33 | 34 | 它虽然是轻量级框架，但是框架这东西也不是随便什么地方都能用的，不然就会出现杀鸡用牛刀，费力不讨好的结果。那么适用在哪些地方呢？ 35 | 36 | 根据我的理解，以及Backbone的功能，如果单个网页上有非常复杂的业务逻辑，那么用它很合适，它可以很容易的操作DOM和组织js代码。 37 | 38 | 豆瓣的阿尔法城是一个极好的例子——纯单页、复杂的前端逻辑。 39 | 40 | 当然，除了我自己分析的应用范围之外，在Backbone的文档上看到了很多使用它的外国站点，有很多，说明Backbonejs还是很易用的。 41 | 42 | 稍稍列一下国内用到Backbonejs的站点： 43 | 44 | *1. 豆瓣阿尔法城* 45 | 链接：http://alphatown.com/ 46 | 47 | *2. 豆瓣阅读* 48 | 链接：http://read.douban.com/ 主要用在图书的正文页 49 | 50 | *3. 百度开发者中心* 51 | 链接：http://developer.baidu.com/ 52 | 53 | *4. 手机搜狐直播间* 54 | 链接：http://zhibo.m.sohu.com/ 55 | 56 | *5. OATOS企业网盘* 57 | 链接：http://app.oatos.com 58 | 59 | 60 | 1.3 学以致用 61 | ----------------- 62 | 现在，我们就要开始学习Backbonejs了，我假设你没有看过我的第一版，那一版有很多很多问题，在博客上也有很多人反馈。但是如果你把那一版看明白了，这新版的教程你可以粗略的浏览一遍，不过后面新补充的实践是要自己写出来、跑起来的。 63 | 64 | 先说我们为什么要学习这新的东西呢？简单说来是为了掌握更加先进的工具。那为什么要掌握先进的工具呢？简单来说就是为了让我们能够以更合理、优雅的方式完成工作，反应到代码上就是让代码变得可维护，易扩展。如果从复杂的方向来说的话，这俩话题都够我写好几天的博客了。 65 | 66 | 学以致用，最直接有效的就是用起来，光学是没用的，尤其是编程这样的实践科学。新手最常犯的一个错误就是喜欢不停的去看书，看过了就以为会了，然后就开始疯狂的学下一本。殊不知看懂和写出来能运行是两种完全不同的状态。因此建议新手——编程新手还是踏踏实实的把代码都敲了，执行了，成功了才是。 67 | 68 | 下面直接给一个简单的Demo出来，用到了Backbonejs的三个主要模块：Views，Collection，Model。通过执行这个例子，了解这个例子的运行过程，快速对要做的东西有一个感觉，然后再逐步击破。 69 | 70 | 71 | 1.4 完整DEMO 72 | ---------------- 73 | 这个demo的主要功能是点击页面上得“新手报到”按钮，弹出对话框，输入内容之后，把内容拼上固定的字符串显示到页面上。事件触发的逻辑是： click 触发checkIn方法，然后checkIn构造World对象放到已经初始化worlds这个collection中。 74 | 75 | 来看完整的代码: 76 | 77 | .. code:: html 78 | 79 | 80 | 81 | 82 | the5fire.com-backbone.js-Hello World 83 | 84 | 85 | 86 |
    87 |
88 | 更多教程 89 | 90 | 91 | 92 | 131 | 132 | 133 | 134 | 这里面涉及到backbone的三个部分，View、Model、Collection，其中Model代表一个数据模型，Collection是模型的一个集合，而View是用来处理页面以及简单的页面逻辑的。 135 | 136 | 动手把代码放到你的编辑器中吧，成功执行，然后修改某个地方，再次尝试。 137 | 138 | 139 | **导航** 140 | 141 | * 上一章 `00 前言 <00-preface.rst>`_ 142 | * 下一章 `02 Backbone中Model实践 <02-backbonejs-model.rst>`_ 143 | -------------------------------------------------------------------------------- /chapters/02-backbonejs-model.rst: -------------------------------------------------------------------------------- 1 | 第二章 Backbonejs中的Model实践 2 | ======================================================================= 3 | 4 | 上一章主要是通过简单的代码对Backbonejs做了一个概括的展示，这一章开始从Model层说起，详细解释Backbonejs中的Model这个东西。 5 | 6 | 对于Model这一部分，其官网是这么说的：“Model是js应用的核心，包括基础的数据以及围绕着这些数据的逻辑：数据转换、验证、属性计算和访问控制”。这句话基本上高度概括了Model在一个项目中的作用。实际上，不仅仅是js应用，在任何以数据收集和处理的项目中Model都是很重要的一块内容。 7 | 8 | Model这个概念在我的印象中是来自于MVC这个东西，Model在其中的作用，除了是对业务中实体对象的抽象，另外的作用就是做持久化，所谓持久化就是把数据存储到磁盘上——文件形式、数据库形式。在web端也有对应的操作，比如存入LocalStorage，或者Cookie。 9 | 10 | 在web端，Model还有一个重要的功能就是和服务器端进行数据交互，就像是服务器端的程序需要和数据库交互一样。因此Model应该是携带数据流窜于各个模块之间的东西。 11 | 12 | 下面让我们通过一个一个的实例来逐步了解Model。 13 | 14 | 先定义一个页面结构，实践时须在注释的地方填上各小节的代码 15 | 16 | .. code:: html 17 | 18 | 19 | 20 | 21 | the5fire-backbone-model 22 | 23 | 24 | 25 | 26 | 27 | 28 | 35 | 36 | 37 | 2.1 最简单的对象 38 | -------------------------- 39 | 40 | .. code:: javascript 41 | 42 | var Man = Backbone.Model.extend({ 43 | initialize: function(){ 44 | alert('Hey, you create me!'); 45 | } 46 | }); 47 | var man = new Man; 48 | 49 | 这个确实很简单了，只是定义了一个最基础的Model，只是实现了initialize这个初始化方法，也称构造函数。这个函数会在Model被实例化时调用。 50 | 51 | 2.2 对象属性赋值的两种方法 52 | ------------------------------------ 53 | 第一种，直接定义，设置默认值。 54 | 55 | .. code:: javascript 56 | 57 | var Man = Backbone.Model.extend({ 58 | initialize: function(){ 59 | alert('Hey, you create me!'); 60 | }, 61 | defaults: { 62 | name:'张三', 63 | age: '38' 64 | } 65 | }); 66 | 67 | var man = new Man; 68 | alert(man.get('name')); 69 | 70 | 第二种，赋值时定义 71 | 72 | .. code:: javascript 73 | 74 | var Man = Backbone.Model.extend({ 75 | initialize: function(){ 76 | alert('Hey, you create me!'); 77 | } 78 | }); 79 | var man = new Man; 80 | man.set({name:'the5fire',age:'10'}); 81 | alert(man.get('name')); 82 | 83 | 从这个对象的取值方式可以知道，属性在一个Model是以字典（或者类似字典）的方式存在的，第一种设定默认值的方式，只不过是实现了Backbone的defaults这个方法，或者是给defaults进行了赋值。 84 | 85 | 86 | 2.3 对象中的方法 87 | ----------------------------- 88 | 89 | .. code:: javascript 90 | 91 | var Man = Backbone.Model.extend({ 92 | initialize: function(){ 93 | alert('Hey, you create me!'); 94 | }, 95 | defaults: { 96 | name:'张三', 97 | age: '38' 98 | }, 99 | aboutMe: function(){ 100 | return '我叫' + this.get('name') + ',今年' + this.get('age') + '岁'; 101 | } 102 | }); 103 | var man = new Man; 104 | alert(man.aboutMe()); 105 | 106 | 也是比较简单，只是增加了一个新的属性，值是一个function。说到这，不知道你是否发现，在所有的定义或者赋值操作中，都是通过字典的方式来完成的，比如extend Backbone的Model，以及定义方法，定义默认值。方法的调用和其他的语言一样，直接 ``.`` 即可，参数的定义和传递也一样。 107 | 108 | 109 | 2.4 监听对象中属性的变化 110 | -------------------------------- 111 | 112 | 假设你有在对象的某个属性发生变化时去处理一些业务的话，下面的示例会有帮助。依然是定义那个类，不同的是我们在构造函数中绑定了name属性的change事件。这样当name发生变化时，就会触发这个function。 113 | 114 | .. code:: javascript 115 | 116 | var Man = Backbone.Model.extend({ 117 | initialize: function(){ 118 | alert('Hey, you create me!'); 119 | //初始化时绑定监听 120 | this.bind("change:name",function(){ 121 | var name = this.get("name"); 122 | alert("你改变了name属性为：" + name); 123 | }); 124 | }, 125 | defaults: { 126 | name:'张三', 127 | age: '38' 128 | }, 129 | aboutMe: function(){ 130 | return '我叫' + this.get('name') + ',今年' + this.get('age') + '岁'; 131 | } 132 | }); 133 | var man = new Man; 134 | //触发绑定的change事件，alert。 135 | man.set({name:'the5fire'}); 136 | 137 | //触发绑定的change事件，alert。 138 | man.set({name:'the5fire.com'}); 139 | 140 | 141 | 2.5 为对象添加验证规则，以及错误提示 142 | ---------------------------------------------- 143 | 144 | .. code:: javascript 145 | 146 | var Man = Backbone.Model.extend({ 147 | initialize: function(){ 148 | alert('Hey, you create me!'); 149 | //初始化时绑定监听, change事件会先于validate发生 150 | this.bind("change:name",function(){ 151 | var name = this.get("name"); 152 | alert("你改变了name属性为：" + name); 153 | }); 154 | this.bind("invalid",function(model,error){ 155 | alert(error); 156 | }); 157 | }, 158 | defaults: { 159 | name:'张三', 160 | age: '38' 161 | }, 162 | validate:function(attributes){ 163 | if(attributes.name == '') { 164 | return "name不能为空！"; 165 | } 166 | }, 167 | aboutMe: function(){ 168 | return '我叫' + this.get('name') + ',今年' + this.get('age') + '岁'; 169 | } 170 | }); 171 | var man = new Man; 172 | // 这种方式添加错误处理也行 173 | // man.on('invalid', function(model, error){ 174 | // alert(error); 175 | // }); 176 | 177 | //默认set时不进行验证 178 | man.set({name:''}); 179 | //手动触发验证, set时会触发 180 | //man.set({name:''}, {'validate':true}); 181 | //save时触发验证。根据验证规则，弹出错误提示。 182 | man.save(); 183 | 184 | 2.6 和服务器进行交互，对象的保存和获取 185 | --------------------------------------------------- 186 | 首先需要声明的是，这个例子需要后端配合，可以在 `code <../code>`_ 目录中找到对应的py文件，需要webpy和mako这两个库。 187 | 这里需要为对象定义一个url属性，调用save方法时会post对象的所有属性到server端，调用fetch方法是又会发送get请求到server端。接受数据和发送数据均为json格式: 188 | 189 | .. code:: javascript 190 | 191 | var Man = Backbone.Model.extend({ 192 | url:'/man/', 193 | initialize: function(){ 194 | alert('Hey, you create me!'); 195 | //初始化时绑定监听 196 | this.bind("change:name",function(){ 197 | var name = this.get("name"); 198 | alert("你改变了name属性为：" + name); 199 | }); 200 | this.bind("error",function(model,error){ 201 | alert(error); 202 | }); 203 | }, 204 | defaults: { 205 | name:'张三', 206 | age: '38' 207 | }, 208 | validate:function(attributes){ 209 | if(attributes.name == '') { 210 | return "name不能为空！"; 211 | } 212 | }, 213 | aboutMe: function(){ 214 | return '我叫' + this.get('name') + ',今年' + this.get('age') + '岁'; 215 | } 216 | }); 217 | var man = new Man;; 218 | man.set({name:'the5fire'}); 219 | 220 | //会发送POST到模型对应的url，数据格式为json{"name":"the5fire","age":38} 221 | man.save(); 222 | 223 | //然后接着就是从服务器端获取数据使用方法fetch([options]) 224 | var man1 = new Man; 225 | //第一种情况，如果直接使用fetch方法， 226 | //那么他会发送get请求到你model的url中， 227 | //你在服务器端可以通过判断是get还是post来进行对应的操作。 228 | man1.fetch(); 229 | //第二种情况，在fetch中加入参数，如下： 230 | man1.fetch({url:'/man/'}); 231 | //这样，就会发送get请求到/man/这个url中， 232 | //服务器返回的结果样式应该是对应的json格式数据，同save时POST过去的格式。 233 | 234 | //不过接受服务器端返回的数据方法是这样的： 235 | man1.fetch({url:'/man/', 236 | success:function(model,response){ 237 | alert('success'); 238 | //model为获取到的数据 239 | alert(model.get('name')); 240 | },error:function(){ 241 | //当返回格式不正确或者是非json数据时，会执行此方法 242 | alert('error'); 243 | } 244 | }); 245 | 246 | 还有一点值得一提的是关于url和urlRoot的事情了，如果你设置了url，那么你的CRUD都会发送对应请求到这个url上，但是这样有一个问题，就是delete请求，发送了请求，但是却没有发送任何数据，那么你在服务器端就不知道应该删除哪个对象（记录），所以这里又一个urlRoot的概念，你设置了urlRoot之后，你发送PUT和DELETE请求的时候，其请求的url地址就是：/baseurl/[model.id]，这样你就可以在服务器端通过对url后面值的提取更新或者删除对应的对象（记录） 247 | 248 | 补充一点，就是关于服务器的异步操作都是通过Backbone.sync这个方法来完成的，调用这个方法的时候会自动的传递一个参数过去，根据参数向服务器端发送对应的请求。比如你save，backbone会判断你的这个对象是不是新的，如果是新创建的则参数为create，如果是已存在的对象只是进行了改变，那么参数就为update，如果你调用fetch方法，那参数就是read，如果是destory，那么参数就是delete。也就是所谓的CRUD ("create", "read", "update", or "delete")，而这四种参数对应的请求类型为POST，GET，PUT，DELETE。你可以在服务器根据这个request类型，来做出相应的CRUD操作。 249 | 250 | 关于Backbone.sync在后面会有如何自定义这一部分的章节。 251 | 252 | 上面服务器端的代码在 ``code`` 下可以找到，基于webpy和mako的。 253 | 254 | 255 | **导航** 256 | 257 | * 上一章 01 `Hello Backbonejs <01-hello-backbonejs.rst>`_ 258 | * 下一章 03 `Backbonejs中的Collections实践 <03-backbonejs-collection.rst>`_ 259 | -------------------------------------------------------------------------------- /chapters/03-backbonejs-collection.rst: -------------------------------------------------------------------------------- 1 | 第三章 Backbonejs中的Collections实践 2 | ======================================================================= 3 | 4 | 上一节介绍了model的使用，model算是对现实中某一物体的抽象，比如你可以定义一本书的model，具有书名（title）还有书页（page_num)等属性。仅仅用一个Model是不足以呈现现实世界的内容，因此基于Model，这节我们来看collection。collection是model对象的一个有序的集合，也可以理解为是model的容器。概念理解起来十分简单，在通过几个例子来看一下，会觉得更容易理解。 5 | 6 | 3.1 关于book和bookshelf的例子 7 | ----------------------------------------------------------- 8 | 9 | .. code:: javascript 10 | 11 | var Book = Backbone.Model.extend({ 12 | 13 | defaults : { 14 | title:'default' 15 | }, 16 | 17 | initialize: function(){ 18 | //alert('Hey, you create me!'); 19 | } 20 | 21 | }); 22 | 23 | var BookShelf = Backbone.Collection.extend({ 24 | model : Book 25 | }); 26 | 27 | var book1 = new Book({title : 'book1'}); 28 | var book2 = new Book({title : 'book2'}); 29 | var book3 = new Book({title : 'book3'}); 30 | 31 | //注意这里面是数组,或者使用add 32 | //var bookShelf = new BookShelf([book1, book2, book3]); 33 | 34 | var bookShelf = new BookShelf; 35 | 36 | bookShelf.add(book1); 37 | bookShelf.add(book2); 38 | bookShelf.add(book3); 39 | bookShelf.remove(book3); 40 | 41 | 42 | //基于underscore这个js库，还可以使用each的方法获取collection中的数据 43 | 44 | bookShelf.each(function(book){ 45 | alert(book.get('title')); 46 | }); 47 | 48 | 很容易理解吧。 49 | 50 | 3.2 使用fetch从服务器端获取数据 51 | ---------------------------------------------------------- 52 | 53 | 首先要在上面的的Bookshelf中定义url，注意collection中并没有urlRoot这个属性。或者你直接在fetch方法中定义url的值，如下： 54 | 55 | .. code:: javascript 56 | 57 | //注意这里 58 | bookShelf.url = '/books/'; 59 | bookShelf.fetch({ 60 | success:function(collection, response, options){ 61 | collection.each(function(book){ 62 | alert(book.get('title')); 63 | }); 64 | },error:function(collection, response, options){ 65 | alert('error'); 66 | } 67 | }); 68 | 69 | 其中也定义了两个接受返回值的方法，具体含义我想很容易理解，返回正确格式(json)的数据，就会调用success方法，错误格式的数据就会调用error方法，当然error方法也看添加和success方法一样的形参。 70 | 71 | 对应的BookShelf的返回格式如下：[{'title':'book0'},{'title':'book1'}.....] 72 | 73 | 3.3 reset方法 74 | ----------------------------- 75 | 76 | 使用这个方法的时候是要和上面的fetch进行配合的，collection在fetch到数据之后，默认情况会调用set方法(set方法向collection里面添加新model，如果该model之前存在则会合并，与此同时会触发collection的add事件)，可以通过参数{reset: true}来手动触发reset，reset会整个清空collection重新添加所有model。这时你就需要在collection中定义reset方法或者是绑定reset方法。这里使用绑定演示： 77 | 78 | .. code:: javascript 79 | 80 | var showAllBooks = function(){ 81 | bookShelf.each(function(book){ 82 | //将book数据渲染到页面的操作。 83 | document.writeln(book.get('title')); 84 | }); 85 | } 86 | 87 | bookShelf.bind('reset',showAllBooks); 88 | bookShelf.url = '/books/'; //注意这里 89 | bookShelf.fetch({ 90 | // 需要主动传递reset，才会触发reset 91 | reset: true, 92 | success:function(collection, response, options){ 93 | collection.each(function(book){ 94 | alert(book.get('title')); 95 | }); 96 | },error:function(collection, response, options){ 97 | alert('error'); 98 | } 99 | }); 100 | 101 | 绑定的步骤要在fetch之前进行。 102 | 103 | 3.4 发送数据到Server端 104 | ----------------------------- 105 | 106 | 创建数据，其实就是调用collection的create方法，POST对应的Model对象（json数据）到配置好的url上。之后会返回一个model的实例，如下面代码中的onebook。 107 | 108 | .. code:: javascript 109 | 110 | var NewBooks = Backbone.Collection.extend({ 111 | model: Book, 112 | url: '/books/' 113 | }); 114 | 115 | var books = new NewBooks; 116 | 117 | var onebook = books.create({ 118 | title: "I'm coming", 119 | }); 120 | 121 | 122 | 完整代码可以在 `code <../code>`_ 中找到, 服务器端的代码后面会介绍。 123 | 124 | 125 | **导航** 126 | 127 | * 上一章 02 `Backbone中Model实践 <02-backbonejs-model.rst>`_ 128 | * 下一章 04 `Backbonejs中的Router实践 <04-backbonejs-router.rst>`_ 129 | -------------------------------------------------------------------------------- /chapters/04-backbonejs-router.rst: -------------------------------------------------------------------------------- 1 | 第四章 Backbonejs中的Router实践 2 | ======================================================================= 3 | 4 | 前面介绍了Model和Collection，基本上属于程序中静态的数据部分。这一节介绍Backbone中的router，属于动态的部分，见名知意，router——路由的意思，显然是能够控制url指向哪个函数的。具体是怎么做的一会通过几个实例来看看。 5 | 6 | 在现在的单页应用中，所有的操作、内容都在一个页面上呈现，这意味着浏览器的url始终要定位到当前页面。那么一个页面中的所有的操作总不能都通过事件监听来完成，尤其是对于需要切换页面的场景以及需要分享、收藏固定链接的情况。因此就有了router，通过hash的方式（即#page）来完成。不过随着浏览器发展，大多数的浏览器已经可以通过history api来操控url的改变，可以直接使用 /page 来完成之前需要hash来完成的操作，这种方式看起来更为直观一些。下面提供过几个demo来切实体会一番。 7 | 8 | 4.1 一个简单的例子 9 | -------------------------------------------- 10 | 11 | .. code:: javascript 12 | 13 | var AppRouter = Backbone.Router.extend({ 14 | routes: { 15 | "*actions" : "defaultRoute" 16 | }, 17 | 18 | defaultRoute : function(actions){ 19 | alert(actions); 20 | } 21 | }); 22 | 23 | var app_router = new AppRouter; 24 | 25 | Backbone.history.start(); 26 | 27 | 28 | 需要通过调用Backbone.history.start()方法来初始化这个Router。 29 | 30 | 在页面上需要有这样的a标签： 31 | 32 | :: 33 | 34 | testActions 35 | 36 | 点击该链接时，便会触发defaultRouter这个方法。 37 | 38 | 39 | 4.2 这个routes映射要怎么传参数 40 | ----------------------------------------------------------- 41 | 42 | 看下面例子，立马你就知道了 43 | 44 | .. code:: javascript 45 | 46 | var AppRouter = Backbone.Router.extend({ 47 | 48 | routes: { 49 | "posts/:id" : "getPost", 50 | "*actions" : "defaultRoute" 51 | }, 52 | 53 | getPost: function(id) { 54 | alert(id); 55 | }, 56 | 57 | defaultRoute : function(actions){ 58 | alert(actions); 59 | } 60 | }); 61 | 62 | var app_router = new AppRouter; 63 | Backbone.history.start(); 64 | 65 | 对应的页面上应该有一个超链接： 66 | 67 | :: 68 | 69 | Post 120 70 | 71 | 从上面已经可以看到匹配#标签之后内容的方法，有两种：一种是用“:”来把#后面的对应的位置作为参数；还有一种是“*”，它可以匹配所有的url，下面再来演练一下。 72 | 73 | .. code:: javascript 74 | 75 | var AppRouter = Backbone.Router.extend({ 76 | 77 | routes: { 78 | "posts/:id" : "getPost", 79 | //下面对应的链接为download gif 80 | "download/*path": "downloadFile", 81 | //下面对应的链接为Load Route/Action View 82 | ":route/:action": "loadView", 83 | "*actions" : "defaultRoute" 84 | }, 85 | 86 | getPost: function(id) { 87 | alert(id); 88 | }, 89 | 90 | defaultRoute : function(actions){ 91 | alert(actions); 92 | }, 93 | 94 | downloadFile: function( path ){ 95 | alert(path); // user/images/hey.gif 96 | }, 97 | 98 | loadView: function( route, action ){ 99 | alert(route + "_" + action); // dashboard_graph 100 | } 101 | 102 | }); 103 | 104 | var app_router = new AppRouter; 105 | Backbone.history.start(); 106 | 107 | 4.3 手动触发router 108 | ---------------------------------- 109 | 上面的例子都是通过页面点击触发router到对应的方法上，在实际的使用中，还存在一种场景就是需要在某一个逻辑中触发某一个事件，就像是jQuery中得trigger一样，下面的代码展示怎么手动触发router。 110 | 111 | .. code:: javascript 112 | 113 | routes: { 114 | "posts/:id" : "getPost", 115 | "manual": "manual", 116 | "*actions": "defaultRoute", 117 | }, 118 | // 省略部分代码 119 | loadView: function( route, action ){ 120 | alert(route + "_" + action); // dashboard_graph 121 | }, 122 | manual: function() { 123 | alert("call manual"); 124 | app_router.navigate("/posts/" + 404, {trigger: true, replace: true}); 125 | } 126 | 127 | 对应着在页面添加一个a标签： ``manual`` 然后点击这个链接，便会触发posts/:id对应的方法。 128 | 129 | 这里需要解释的是navigate后面的两个参数。trigger表示触发事件，如果为false，则只是url变化，并不会触发事件，replace表示url替换，而不是前进到这个url，意味着启用该参数，浏览器的history不会记录这个变动。 130 | 131 | 完整代码依然在 ``code`` 中可以找到。 132 | 133 | 134 | **导航** 135 | 136 | * 上一章 03 `Backbonejs中的Collections实践 <03-backbonejs-collection.rst>`_ 137 | * 下一章 05 `Backbonejs中的View实践 <05-backbonejs-view.rst>`_ 138 | -------------------------------------------------------------------------------- /chapters/05-backbonejs-view.rst: -------------------------------------------------------------------------------- 1 | 第五章 Backbonejs中的View实践 2 | ======================================================================= 3 | 4 | 前面介绍了存放数据的Model和Collection以及对用户行为进行路由分发的Router（针对链接）。这一节终于可以往页面上放点东西来玩玩了。这节就介绍了Backbone中得View这个模块。Backbone的View是用来显示你的model中的数据到页面的，同时它也可用来监听DOM上的事件然后做出响应。但是这里要提一句的是，相比于Angularjs中model变化之后页面数据自动变化的特性，Backbone要手动来处理。至于这两种方式的对比，各有优劣，可以暂时不关心。 5 | 6 | 下面依然是通过几个示例来介绍下view的功能,首先给出页面的基本模板： 7 | 8 | .. code:: html 9 | 10 | 11 | 12 | 13 | the5fire-backbone-view 14 | 15 | 16 |
17 | 18 | 23 | 24 | 25 | 26 | 31 | 32 | 33 | 34 | 5.1 一个简单的view 35 | -------------------------------------------- 36 | 37 | .. code:: javascript 38 | 39 | var SearchView = Backbone.View.extend({ 40 | initialize: function(){ 41 | alert('init a SearchView'); 42 | } 43 | }); 44 | var searchView = new SearchView(); 45 | 46 | 是不是觉得很没有技术含量，所有的模块定义都一样。 47 | 48 | 49 | 5.2 el属性 50 | ------------------------------------- 51 | 52 | 这个属性用来引用DOM中的某个元素，每一个Backbone的view都会有这么个属性，如果没有显示声明，Backbone会默认的构造一个，表示一个空的div元素。el标签可以在定义view的时候在属性中声明，也可以在实例化view的时候通过参数传递。 53 | 54 | .. code:: javascript 55 | 56 | var SearchView = Backbone.View.extend({ 57 | initialize: function(){ 58 | alert('init a SearchView'); 59 | } 60 | }); 61 | 62 | var searchView = new SearchView({el: $("#search_container")}); 63 | 64 | 这段代码简单的演示了在实例化的时候传递el属性给View。下面我们来看看模板的渲染。 65 | 66 | .. code:: javascript 67 | 68 | var SearchView = Backbone.View.extend({ 69 | initialize: function(){ 70 | }, 71 | render: function(context) { 72 | //使用underscore这个库，来编译模板 73 | var template = _.template($("#search_template").html()); 74 | //加载模板到对应的el属性中 75 | $(this.el).html(template(context)); 76 | } 77 | }); 78 | var searchView = new SearchView({el: $("#search_container")}); 79 | 80 | //这个reander的方法可以放到view的构造函数中 81 | //这样初始化时就会自动渲染 82 | searchView.render({search_label: "搜索渲染"}); 83 | 84 | 运行页面之后，会发现script模板中的html代码已经添加到了我们定义的div中。 85 | 86 | *这里面需要注意的是在模板中定义的所有变量必须在render的时候传递参数过去，不然就会报错。* 87 | 关于el还有一个东西叫做$el,这个东西是对view中元素的缓存。 88 | 89 | 90 | 91 | 5.3 再来看view中event的使用 92 | -------------------------------------------------------------------------- 93 | 页面上的操作除了可以由之前的router来处理之外，在一个view中定义元素，还可以使用event来进行事件绑定。这里要注意的是在view中定义的dom元素是指你el标签所定义的那一部分dom节点，event进行事件绑定时会在该节点范围内查找。 94 | 95 | 来，继续看代码。 96 | 97 | .. code:: javascript 98 | 99 | var SearchView = Backbone.View.extend({ 100 | el: "#search_container", 101 | 102 | initialize: function(){ 103 | this.render({search_label: "搜索按钮"}); 104 | }, 105 | render: function(context) { 106 | //使用underscore这个库，来编译模板 107 | var template = _.template($("#search_template").html()); 108 | //加载模板到对应的el属性中 109 | $(this.el).html(template(context)); 110 | }, 111 | 112 | events:{ //就是在这里绑定的 113 | //定义类型为button的input标签的点击事件，触发函数doSearch 114 | 'click input[type=button]' : 'doSearch' 115 | 116 | }, 117 | 118 | doSearch: function(event){ 119 | alert("search for " + $("#search_input").val()); 120 | } 121 | 122 | }); 123 | 124 | var searchView = new SearchView(); 125 | 126 | 自己运行下，是不是比写$("input[type=button]").bind('click',function(){})好看多了。 127 | 128 | 129 | 130 | 5.4 View中的模板 131 | ---------------------------- 132 | 上面已经简单的演示了模板的用法，如果你用过django模板的话，你会发现模板差不多都是那么回事。上面只是简单的单个变量的渲染，那么逻辑部分怎么处理呢，下面来看下。 133 | 134 | 把最开始定义的模板中的内容换成下面这个。 135 | 136 | .. code:: html 137 | 138 |
    139 | <% _.each(labels, function(name) { %> 140 | <% if(name != "label2") {%> 141 |
  • <%= name %>
    • 142 | <% } %> 143 | <% }); %> 144 |
145 | 146 | 下面是js代码 147 | 148 | .. code:: javascript 149 | 150 | var SearchView = Backbone.View.extend({ 151 | el: "#search_container", 152 | 153 | initialize: function(){ 154 | var labels = ['label1', 'label2', 'label3']; 155 | this.render({labels: labels}); 156 | }, 157 | 158 | render: function(context) { 159 | //使用underscore这个库，来编译模板 160 | var template = _.template($("#search_template").html()); 161 | //加载模板到对应的el属性中 162 | $(this.el).html(template(context)); 163 | }, 164 | 165 | }); 166 | 167 | var searchView = new SearchView(); 168 | 169 | 再次运行，有木有觉得还不错，模板中使用的就基本的js语法。 170 | 171 | 总结一下，关于view中的东西就介绍这么多，文档上还有几个其他的属性，不过大体用法都一致。在以后的实践中用到在介绍。 172 | 173 | 174 | **导航** 175 | 176 | * 上一章 04 `Backbonejs中的Router实践 <04-backbonejs-router.rst>`_ 177 | * 下一章 06 `实战演练：todos分析（一） <06-backbonejs-todos-1.rst>`_ 178 | -------------------------------------------------------------------------------- /chapters/06-backbonejs-todos-1.rst: -------------------------------------------------------------------------------- 1 | 第六章 实战演练：todos分析（一） 2 | ======================================================================= 3 | 4 | 经过前面的几篇文章，Backbone中的Model, Collection，Router，View，都简单的介绍了一下，我觉得看完这几篇文章，差不多就能开始使用Backbone来做东西了，所有的项目无外乎对这几个模块的使用。不过对于实际项目经验少些的同学，要拿起来用估计会有些麻烦。因此这里就先找个现成的案例分析一下。 5 | 6 | 6.1 大家都来分析todos 7 | ------------------------------ 8 | 关于Backbonejs实例分析的文章网上真是一搜一大把，之所以这么多，第一是这东西需求简单，不用花时间到理解情景中；第二是代码就是官方的案例，顺手可得，也省得去找了，自己琢磨一个不得花时间吗。 9 | 10 | 于是就有人问了，丫们都在分析todos，能不能有点新意呢。这问题要我说，如果你真的能把todos搞明白了，那其他的也就不用去看了。不管是看谁的分析，把这个搞明白的。所有的项目大体思路都差不多。尤其是对于这样的MVC的模型，就是往对应的模块里填东西。因此，不管有多少人都在分析这玩意，自己弄懂了才是应该关心的。 11 | 12 | 话虽如此，不同于网络上的绝大部分的分析的是，the5fire除了分析这个，还是对其进行了扩充，另外在后面也会有真实的案例。但我也是从这些案例的代码中汲取的营养。 13 | 14 | 补充一下，新版的todos代码相较于之前简直清晰太多，完全可以当做一个前端的范本来学习、模仿。 15 | 16 | 17 | 6.2 获取代码 18 | -------------------- 19 | todos的代码这里下载：https://github.com/jashkenas/backbone/ ，建议自己clone一份到本地。线上的地址是：http://backbonejs.org/examples/todos/index.html 20 | 21 | clone下来之后可以在example中找到todos文件夹，文件结构如下：:: 22 | 23 | examples 24 | ├── backbone.localStorage.js 25 | └── todos 26 | ├── destroy.png 27 | ├── index.html 28 | ├── todos.css 29 | └── todos.js 30 | 31 | 1 directory, 5 files 32 | 33 | 用浏览器打开index.html文件，推荐使用chome浏览器，就可以看到和官网一样的界面了。关键代码都在todos.js这个文件里。 34 | 35 | 6.3 功能分析 36 | ---------------------- 37 | 首先来分析下页面上有哪些功能: 38 | 39 | .. image:: http://the5fireblog.b0.upaiyun.com/staticfile/todos.png 40 | 41 | 从这个界面我们可以总结出来,下面这些功能:: 42 | 43 | * 任务管理 44 | 添加任务 45 | 修改任务 46 | 删除任务 47 | * 统计 48 | 任务总计 49 | 已完成数目 50 | 51 | 总体上就这几个功能。 52 | 53 | 这个项目仅仅是在web端运行的，没有服务器进行支持，因此在项目中使用了一个叫做backbone-localstorage的js库，用来把数据存储到前端。 54 | 55 | 6.4 从模型下手 56 | ------------------------ 57 | 因为Backbone为MVC模式，根据对这种模式的使用经验，我们从模型开始分析。首先我们来看Model部分的代码: 58 | 59 | .. code:: javascript 60 | 61 | /** 62 | *基本的Todo模型，属性为：title,order,done。 63 | **/ 64 | var Todo = Backbone.Model.extend({ 65 | // 设置默认的属性 66 | defaults: { 67 | title: "empty todo...", 68 | order: Todos.nextOrder(), 69 | done: false 70 | }, 71 | 72 | // 设置任务完成状态 73 | toggle: function() { 74 | this.save({done: !this.get("done")}); 75 | } 76 | }); 77 | 78 | 这段代码是很好理解的，不过我依然是画蛇添足的加上了一些注释。这个Todo显然就是对应页面上的每一个任务条目。那么显然应该有一个collection来统治（管理）所有的任务，所以再来看collection： 79 | 80 | .. code:: javascript 81 | 82 | /** 83 | *Todo的一个集合，数据通过localStorage存储在本地。 84 | **/ 85 | 86 | var TodoList = Backbone.Collection.extend({ 87 | 88 | // 设置Collection的模型为Todo 89 | model: Todo, 90 | //存储到浏览器，以todos-backbone命名的空间中 91 | //此函数为Backbone插件提供 92 | //地址：https://github.com/jeromegn/Backbone.localStorage 93 | localStorage: new Backbone.LocalStorage("todos-backbone"), 94 | 95 | //获取所有已经完成的任务数组 96 | done: function() { 97 | return this.where({done: true}); 98 | }, 99 | 100 | //获取任务列表中未完成的任务数组 101 | //这里的where在之前是没有的，但是语法上更清晰了 102 | //参考文档：http://backbonejs.org/#Collection-where 103 | remaining: function() { 104 | return this.where({done: false}); 105 | }, 106 | 107 | //获得下一个任务的排序序号，通过数据库中的记录数加1实现。 108 | nextOrder: function() { 109 | if (!this.length) return 1; 110 | 111 | // last获取collection中最后一个元素 112 | return this.last().get('order') + 1; 113 | }, 114 | 115 | //Backbone内置属性，指明collection的排序规则。 116 | comparator: 'order' 117 | }); 118 | 119 | collection的主要功能有以下几个：:: 120 | 121 | 1、获取完成的任务; 122 | 2、获取未完成的任务; 123 | 3、获取下一个要插入数据的序号; 124 | 4、按序存放Todo对象。 125 | 126 | 如果你看过第一版的话，这里Backbone新的属性和方法(comparator和where)用起来更加符合语义了。 127 | 128 | 这篇文章先分析到这里，下篇文章继续分析。 129 | 130 | 131 | **导航** 132 | 133 | * 上一章 05 `Backbonejs中的View实践 <05-backbonejs-view.rst>`_ 134 | * 下一章 07 `实战演练：todos分析（二）View的应用 <07-backbonejs-todos-2.rst>`_ 135 | -------------------------------------------------------------------------------- /chapters/07-backbonejs-todos-2.rst: -------------------------------------------------------------------------------- 1 | 第七章 实战演练：todos分析（二）View的应用 2 | ======================================================================= 3 | 4 | 在上一篇文章中我们把todos这个实例的数据模型进行了简单的分析，有关于数据模型的操作也都知道了。接着我们来看剩下的两个view的模型，以及它们对页面的操作。 5 | 6 | 7.1 为什么要两个view 7 | ------------------------------ 8 | 首先要分析下，这俩view是用来干嘛的。有人可能会问了，这里不就是一个页面吗？一个view掌控全局不就完了？ 9 | 10 | 我觉得这就是新手和老手的主要区别之一，喜欢在一个方法里面搞定一切，喜欢把东西都拧到一块去，觉得这样看起来容易。熟不知，这样的代码对于日后的扩展会造成很大的麻烦。因此我们需要学习下优秀的设计，从好的代码中汲取营养。 11 | 12 | 这里面的精华就是，将对数据的操作和对页面的操作进行分离，也就是现在代码里面TodoView和AppView。前者的作用是对把Model中的数据渲染到模板中;后者是对已经渲染好的数据进行处理。两者各有分工，TodoView可以看做是加工后的数据，这个数据就是待使用的html数据。 13 | 14 | 7.2 TodoView的代码分析 15 | ------------------------- 16 | TodoView是和Model一对一的关系，在页面上一个View也就展示为一个item。除此之外，每个view上还有其他的功能，比如编辑模式，展示模式，还有对用户的输入的监听。详细还是来看下代码： 17 | 18 | .. code:: javascript 19 | 20 | // 首先是创建一个全局的Todo的collection对象 21 | 22 | var Todos = new TodoList; 23 | 24 | // 先来看TodoView，作用是控制任务列表 25 | var TodoView = Backbone.View.extend({ 26 | 27 | //下面这个标签的作用是，把template模板中获取到的html代码放到这标签中。 28 | tagName: "li", 29 | 30 | // 获取一个任务条目的模板,缓存到这个属性上。 31 | template: _.template($('#item-template').html()), 32 | 33 | // 为每一个任务条目绑定事件 34 | events: { 35 | "click .toggle" : "toggleDone", 36 | "dblclick .view" : "edit", 37 | "click a.destroy" : "clear", 38 | "keypress .edit" : "updateOnEnter", 39 | "blur .edit" : "close" 40 | }, 41 | 42 | //在初始化时设置对model的change事件的监听 43 | //设置对model的destroy的监听，保证页面数据和model数据一致 44 | initialize: function() { 45 | this.listenTo(this.model, 'change', this.render); 46 | //这个remove是view的中的方法，用来清除页面中的dom 47 | this.listenTo(this.model, 'destroy', this.remove); 48 | }, 49 | 50 | // 渲染todo中的数据到 item-template 中，然后返回对自己的引用this 51 | render: function() { 52 | this.$el.html(this.template(this.model.toJSON())); 53 | this.$el.toggleClass('done', this.model.get('done')); 54 | this.input = this.$('.edit'); 55 | return this; 56 | }, 57 | 58 | // 控制任务完成或者未完成 59 | toggleDone: function() { 60 | this.model.toggle(); 61 | }, 62 | 63 | // 修改任务条目的样式 64 | edit: function() { 65 | $(this.el).addClass("editing"); 66 | this.input.focus(); 67 | }, 68 | 69 | // 关闭编辑模式，并把修改内容同步到Model和界面 70 | close: function() { 71 | var value = this.input.val(); 72 | if (!value) { 73 | //无值内容直接从页面清除 74 | this.clear(); 75 | } else { 76 | this.model.save({title: value}); 77 | this.$el.removeClass("editing"); 78 | } 79 | }, 80 | 81 | // 按下回车之后，关闭编辑模式 82 | updateOnEnter: function(e) { 83 | if (e.keyCode == 13) this.close(); 84 | }, 85 | 86 | // 移除对应条目，以及对应的数据对象 87 | clear: function() { 88 | this.model.destroy(); 89 | } 90 | }); 91 | 92 | 7.3 AppView的代码分析 93 | -------------------------------- 94 | 再来看AppView，功能是显示所有任务列表，显示整体的列表状态（如：完成多少，未完成多少） 95 | 96 | .. code:: javascript 97 | 98 | //以及任务的添加。主要是整体上的一个控制 99 | var AppView = Backbone.View.extend({ 100 | 101 | //绑定页面上主要的DOM节点 102 | el: $("#todoapp"), 103 | 104 | // 在底部显示的统计数据模板 105 | statsTemplate: _.template($('#stats-template').html()), 106 | 107 | // 绑定dom节点上的事件 108 | events: { 109 | "keypress #new-todo": "createOnEnter", 110 | "click #clear-completed": "clearCompleted", 111 | "click #toggle-all": "toggleAllComplete" 112 | }, 113 | 114 | //在初始化过程中，绑定事件到Todos上， 115 | //当任务列表改变时会触发对应的事件。 116 | //最后从localStorage中fetch数据到Todos中。 117 | initialize: function() { 118 | this.input = this.$("#new-todo"); 119 | this.allCheckbox = this.$("#toggle-all")[0]; 120 | 121 | this.listenTo(Todos, 'add', this.addOne); 122 | this.listenTo(Todos, 'reset', this.addAll); 123 | this.listenTo(Todos, 'all', this.render); 124 | 125 | this.footer = this.$('footer'); 126 | this.main = $('#main'); 127 | 128 | Todos.fetch(); 129 | }, 130 | 131 | // 更改当前任务列表的状态 132 | render: function() { 133 | var done = Todos.done().length; 134 | var remaining = Todos.remaining().length; 135 | 136 | if (Todos.length) { 137 | this.main.show(); 138 | this.footer.show(); 139 | this.footer.html(this.statsTemplate({done: done, remaining: remaining})); 140 | } else { 141 | this.main.hide(); 142 | this.footer.hide(); 143 | } 144 | 145 | //根据剩余多少未完成确定标记全部完成的checkbox的显示 146 | this.allCheckbox.checked = !remaining; 147 | }, 148 | 149 | // 添加一个任务到页面id为todo-list的div/ul中 150 | addOne: function(todo) { 151 | var view = new TodoView({model: todo}); 152 | this.$("#todo-list").append(view.render().el); 153 | }, 154 | 155 | // 把Todos中的所有数据渲染到页面,页面加载的时候用到 156 | addAll: function() { 157 | Todos.each(this.addOne, this); 158 | }, 159 | 160 | //生成一个新Todo的所有属性的字典 161 | newAttributes: function() { 162 | return { 163 | title this.input.val(), 164 | order: Todos.nextOrder(), 165 | done: false 166 | }; 167 | }, 168 | 169 | //创建一个任务的方法，使用backbone.collection的create方法。 170 | //将数据保存到localStorage,这是一个html5的js库。 171 | //需要浏览器支持html5才能用。 172 | createOnEnter: function(e) { 173 | if (e.keyCode != 13) return; 174 | if (!this.input.val()) return; 175 | 176 | //创建一个对象之后会在backbone中动态调用Todos的add方法 177 | //该方法已绑定addOne。 178 | Todos.create({title: this.input.val()}); 179 | this.input.val(''); 180 | }, 181 | 182 | //去掉所有已经完成的任务 183 | clearCompleted: function() { 184 | // 调用underscore.js中的invoke方法 185 | //对过滤出来的todos调用destroy方法 186 | _.invoke(Todos.done(), 'destroy'); 187 | return false; 188 | }, 189 | 190 | //处理页面点击标记全部完成按钮 191 | //处理逻辑： 192 | // 如果标记全部按钮已选，则所有都完成 193 | // 如果未选，则所有的都未完成。 194 | toggleAllComplete: function () { 195 | var done = this.allCheckbox.checked; 196 | Todos.each(function (todo) { todo.save({'done': done}); }); 197 | } 198 | }); 199 | 200 | 通过上面的代码，以及其中的注释，我们认识里面每个方法的作用。下面来看最重要的，页面部分。 201 | 202 | 7.4 页面模板分析 203 | ----------------------- 204 | 在前几篇的view介绍中我们已经认识过了简单的模板使用，以及变量参数的传递，如： 205 | 206 | .. code:: html 207 | 208 | 215 | 216 | 217 | 既然能定义变量，那么就能使用语法，如同django模板，那来看下带有语法的模板，也是上面的两个view用到的模板，我想这个是很好理解的。 218 | 219 | .. code:: html 220 | 221 | 229 | 230 | 231 | 237 | 238 | 简单的语法，上面的那个对应TodoView。有木有觉得比之前的那一版简洁太多了，有木有！！啥叫代码的美感，对比一下就知道了。 239 | 240 | 这一篇文章就先到此为止，文章中我们了解到在todos这个实例中，view的使用，以及具体的TodoView和AppView中各个函数的作用，这意味着所有的肉和菜都已经放到你碗里了，下面就是如何吃下去的问题了。 241 | 242 | 下一篇我们一起来学习todos的整个流程。 243 | 244 | 245 | **导航** 246 | 247 | * 上一章 06 `实战演练：todos分析（一） <06-backbonejs-todos-1.rst>`_ 248 | * 下一章 08 `实战演练：todos分析（三）总结 <08-backbonejs-todos-3.rst>`_ 249 | -------------------------------------------------------------------------------- /chapters/08-backbonejs-todos-3.rst: -------------------------------------------------------------------------------- 1 | 第八章 实战演练：todos分析（三）总结 2 | ======================================================================= 3 | 4 | 在前两篇文章中，我们已经对这个todos的功能、数据模型以及各个模块的实现细节进行了分析，这篇文章我们要对前面的分析进行一个整合。 5 | 6 | 首先让我们来回顾一下我们分析的流程：1. 先对页面功能进行了分析；2. 然后又分析了数据模型；3. 最后又对view的功能和代码进行了详解。你是不是觉得这个分析里面少了点什么？没错，就知道经验丰富的你已经看出来了，这里面少了对于流程的分析。这篇文章就对整体流程进行分析。 7 | 8 | 所以从我的分析中可以看的出来，我是先对各个原材料进行分析，然后再整体的分析（当然前提是我是理解流程的），这并不是分析代码的唯一方法，有时我也会采用跟着流程分析代码的方法。当然还有很多其他的分析方法，大家都有自己的套路嘛。 9 | 10 | 下面简单的说说流程分析的方法。记得多年前在学vb的时候，分析一个完整项目代码的时候，习惯从程序的入口点开始分析。虽然web网站和桌面软件的实现不同，但是大致思路是一样的（同时也有网站即软件的说法，在RESTful架构中）。所以我们要先找到网站的入口点所在。 11 | 12 | 和桌面应用项目的分析一样，网站的入口点就在于网页加载的时候。对于todos，自然就是在页面加载完之后执行的操作了，然后就看到下面的代码。 13 | 14 | 首先是对AppView的一个实例化： 15 | 16 | .. code:: javascript 17 | 18 | var App = new AppView; 19 | 20 | 21 | 实例化，自然就会调用构造函数： 22 | 23 | .. code:: javascript 24 | 25 | //在初始化过程中，绑定事件到Todos上， 26 | //当任务列表改变时会触发对应的事件。 27 | //最后从localStorage中fetch数据到Todos中。 28 | initialize: function() { 29 | this.input = this.$("#new-todo"); 30 | this.allCheckbox = this.$("#toggle-all")[0]; 31 | 32 | this.listenTo(Todos, 'add', this.addOne); 33 | this.listenTo(Todos, 'reset', this.addAll); 34 | this.listenTo(Todos, 'all', this.render); 35 | 36 | this.footer = this.$('footer'); 37 | this.main = $('#main'); 38 | 39 | Todos.fetch(); 40 | }, 41 | 42 | 注意其中的Todos.fetch()方法，前面说过，这个项目是在客户端保存数据，所以使用fetch方法并不会发送请求到服务器。另外在前面关于collection的单独讲解中我们也介绍了fetch执行完成之后，会调用set（默认）或者reset（需要手动设置 ``{reset: true}`` ）。所以在没有指明fetch的reset参数的情况下，backbonejs的Collection中的set方法会遍历Todos的内容并且调用add方法。 43 | 44 | 在initialize中我们绑定了add到addOne上，因此在fetch的时候会Backbonejs会帮我们调用addOne（其实也是在collection的set方法中）。和collection中的set类似的，我们可以自定义reset方法，自行来处理fetch到得数据，但是需要在fetch时手动添加reset参数。 45 | 46 | PS: 感谢网友指正 47 | 48 | 这里先来看下我们绑定到reset上的addAll方法是如何处理fetch过来的数据的: 49 | 50 | .. code:: javascript 51 | 52 | // 添加一个任务到页面id为todo-list的div/ul中 53 | addOne: function(todo) { 54 | var view = new TodoView({model: todo}); 55 | this.$("#todo-list").append(view.render().el); 56 | }, 57 | 58 | // 把Todos中的所有数据渲染到页面,页面加载的时候用到 59 | addAll: function() { 60 | Todos.each(this.addOne, this); 61 | }, 62 | 63 | 在addAll中调用addOne方法，关于Todos.each很好理解，就是语法糖（简化的for循环）。关于addOne方法的细节下面介绍。 64 | 65 | 然后再来看添加任务的流程，一个良好的代码命名风格始终是让人满心欢喜的。因此很显然，添加一个任务，自然就是addOne,其实你看events中的绑定也能知道，先看一下绑定： 66 | 67 | .. code:: javascript 68 | 69 | // 绑定dom节点上的事件 70 | events: { 71 | "keypress #new-todo": "createOnEnter", 72 | "click #clear-completed": "clearCompleted", 73 | "click #toggle-all": "toggleAllComplete" 74 | }, 75 | 76 | 这里并没有addOne方法的绑定，但是却有createOnEnter，语意其实一样的。来看主线，createOnEnter这个方法： 77 | 78 | .. code:: javascript 79 | 80 | /* 创建一个任务的方法，使用backbone.collection的create方法。将数据保存到localStorage,这是一个html5的js库。需要浏览器支持html5才能用。 */ 81 | createOnEnter: function(e) { 82 | if (e.keyCode != 13) return; 83 | if (!this.input.val()) return; 84 | 85 | //创建一个对象之后会在backbone中动态调用Todos的add方法，该方法已绑定addOne。 86 | Todos.create({title: this.input.val()}); 87 | this.input.val(''); 88 | }, 89 | 90 | 注释已写明，Todos.create会调用addOne这个方法。由此顺理成章的来到addOne里面： 91 | 92 | .. code:: javascript 93 | 94 | //添加一个任务到页面id为todo-list的div/ul中 95 | addOne: function(todo) { 96 | var view = new TodoView({model: todo}); 97 | this.$("#todo-list").append(view.render().el); 98 | }, 99 | 100 | 在里面实例化了一个TodoView类，前面我们说过，这个类是主管各个任务的显示的。具体代码就不细说了。 101 | 102 | 有了添加再来看更新，关于单个任务的操作，我们直接找TodoView就ok了。所以直接找到 103 | 104 | .. code:: javascript 105 | 106 | // 为每一个任务条目绑定事件 107 | events: { 108 | "click .toggle" : "toggleDone", 109 | "dblclick .view" : "edit", 110 | "click a.destroy" : "clear", 111 | "keypress .edit" : "updateOnEnter", 112 | "blur .edit" : "close" 113 | }, 114 | 115 | 其中的edit事件的绑定就是更新的一个开头，而updateOnEnter就是更新的具体动作。所以只要搞清楚这俩方法的作用一切就明了了。这里同样不用细说。 116 | 117 | 在往后还有删除一条记录以及清楚已有记录的功能，根据上面的分析过程，我想大家都很容易的去‘顺藤模瓜’。 118 | 119 | 关于Todos的分析到此就算完成了。 120 | 121 | 在下一篇文章中我们将一起来学习通过web.py来搭建web服务器，以及简单的数据库的使用。 122 | 123 | 124 | **导航** 125 | 126 | * 上一章 07 `实战演练：todos分析（二）view的应用 <07-backbonejs-todos-2.rst>`_ 127 | * 下一章 09 `后端环境搭建：web.py的使用 <09-intro-webpy.rst>`_ 128 | -------------------------------------------------------------------------------- /chapters/09-intro-webpy.rst: -------------------------------------------------------------------------------- 1 | 第九章 后端环境搭建：web.py的使用 2 | ======================================================================= 3 | 4 | 前面都是前端的一些内容，但是要想做出一个能用的东西，始终是不能脱离后端的。因此这一节主要介绍如何使用python的一个web框架webpy。我想读我这个教程的同学大多都是前端，对后端没有什么感觉。因此关于后端的介绍以能用为主，不涉及太多的后端的东西。 5 | 6 | 9.1 python是什么 7 | ---------------------- 8 | 简单来说Python和JavaScript一样，是一个动态语言，运行在服务器端。语法类似于程序伪码，或者说类似于自然语言。过多的语法和关键字就不再介绍。只需要记住Python是用缩进来判断语法块的，不像js用大括号。 9 | 10 | 9.2 webpy是什么 11 | ---------------------- 12 | 和Backbonejs是js的一个框架一样，webpy是python的一个简单的web开发的框架。可以通过简单的几行代码启动一个web服务（虽然只是输出helloworld ^_^）。用它可以简单的满足咱们的开发需求。 13 | 14 | 因为是基于Python的框架，因此需要先安装Python环境，具体怎么装就不细说了，到http://python.org/download/ 安装python2.7.6这个版本。 15 | 16 | 之后按照 `webpy `_ 官网的说明，通过命令安装webpy： :: 17 | 18 | pip install web.py 19 | 或者 20 | easy_install web.py 21 | 22 | 注意：linux下非root用户需要sudo 23 | 24 | 9.3 来一个Helloworld 25 | ----------------------------- 26 | 安装好之后，直接把webpy网站上的那段代码，贴到的用编辑器打开的文件中，保存为server.py。webpy网站代码如下： 27 | 28 | .. code:: python 29 | 30 | import web 31 | 32 | urls = ( 33 | '/', 'index' 34 | ) 35 | app = web.application(urls, globals()) 36 | 37 | class index: 38 | def GET(self): 39 | return 'Hello, World!' 40 | 41 | if __name__ == "__main__": 42 | app.run() 43 | 44 | 然后在server.py的同目录下执行:: 45 | 46 | python server.py 47 | 48 | 之后命令行会输出:: 49 | 50 | http://0.0.0.0:8080/ 51 | 52 | 这个提示，现在你在浏览器访问 http://127.0.0.1:8080 ，就会看到熟悉的helloworld，是不是超级简单。 53 | 54 | 9.4 简单构建api接口 55 | ---------------------------- 56 | 在上面代码的基础上，按照前面backboneModel的定义，我们需要一个todo这模型的对应的链接，这个链接应该返回json格式的数据。并且能够支持post、put、get、delete这四个请求。现在来看接口部分的代码： 57 | 58 | .. code:: python 59 | 60 | #添加todo相关的urls 61 | urls = ( 62 | '/', 'index', #返回首页 63 | # 处理前端todo的请求,操作对应的todo 64 | '/todo/(\d+)/', 'todo', 65 | # 处理前端todo的整体请求,主要是获取所有的todo数据 66 | '/todo/', 'todos', 67 | ) 68 | 69 | .. code:: python 70 | 71 | #添加接口的处理代码 72 | class todo: 73 | def GET(self, todo_id=None): 74 | context = { 75 | "title": "下午3点,coding", 76 | "order": 0, 77 | "done": False, 78 | } 79 | return json.dumps(context) 80 | 81 | #处理整体的请求 82 | class todos: 83 | def GET(self): 84 | result = [] 85 | result.append({ 86 | "title": "下午3点,coding", 87 | "order": 0, 88 | "done": False, 89 | }) 90 | return json.dumps(result) 91 | 92 | 添加完这部分代码之后，启动server.py。访问 http://localhost:8080/todo/ 就能看到数据了，这里只是实现了get方法，其他的方法在下一篇中介绍。 93 | 94 | 9.5 加入数据库sqlite 95 | ------------------------------- 96 | 关于数据存储部分，我们使用sqlite数据库。sqlite的好处就是不需要安装即可使用。这样可以省去在数据库安装方面的折腾。 97 | 98 | sqlite的介绍就不多说了，感兴趣的同学想必已经在查sqlite相关的东西了。这里只是演示在webpy中如何操作sqlite。 99 | 100 | 具体依然看代码: 101 | 102 | .. code:: python 103 | 104 | #使用sqlite3操作数据库 105 | import sqlite3 106 | conn = sqlite3.connect('todos.db') 107 | 108 | #把todo改为这样： 109 | class todo: 110 | def GET(self, todo_id=None): 111 | cur = conn.cursor() 112 | cur.execute(sql_query + ' where id=?', (todo_id, )) 113 | todo = cur.fetchone() 114 | cur.close() 115 | 116 | # 先用这种比较傻的方式 117 | context = { 118 | "id": todo[0], 119 | "title": todo[1], 120 | "order": todo[2], 121 | "done": todo[3], 122 | } 123 | return json.dumps(context) 124 | 125 | class todos: 126 | def GET(self): 127 | result = [] 128 | cur = conn.cursor() 129 | cur.execute(sql_query) 130 | todos = cur.fetchall() 131 | cur.close() 132 | 133 | for todo in todos: 134 | result.append({ 135 | "id": todo[0], 136 | "title": todo[1], 137 | "order": todo[2], 138 | "done": todo[3], 139 | }) 140 | return json.dumps(result) 141 | 142 | 完整代码可以在 `code` 文件夹找到。使用时，先运行init_sqlite.py这个文件，会帮你创建一个sqlite的数据库，并且插入一条数据，然后运行server.py就可以在浏览器访问 http://localhost:8080/todo/ 或者http://localhost:8080/todo/1/ 看到输出数据了。 143 | 144 | 9.6 总结 145 | ------------------------- 146 | 这里打算用webpy+sqlite来完成后台主要是想到这个东西比Django+Mysql那一套搭建起来比较容易。有兴趣看Django后台搭建的可以看这篇文章： `django开发环境搭建及使用 `_ 。 147 | 148 | 这里没有使用webpy自带的db模块进行数据的操作，主要是文档和案例都不全，并且源码看起来挺绕。用Python自带的模块显然操作起来有点笨拙，之后会对这个数据操作部分进行简单的封装。 149 | 150 | 151 | **导航** 152 | 153 | * 上一章 08 `实战演练：todos分析（三）总结 <08-backbonejs-todos-3.rst>`_ 154 | * 下一章 10 `实战演练：扩展todos到Server端（backbonejs+webpy） <10-expand-todos-with-server.rst>`_ 155 | -------------------------------------------------------------------------------- /chapters/10-expand-todos-with-server.rst: -------------------------------------------------------------------------------- 1 | 第十章 实战演练：扩展todos到Server端（backbonejs+webpy） 2 | ======================================================================= 3 | 4 | 上一节简单介绍了怎么使用webpy搭建一个后端的接口服务，这一节就来简单实现一下。 5 | 6 | 10.1 项目结构 7 | ------------------------------------ 8 | 首先还是来看下项目的结构，然后再一步一步的分析，结构如下:: 9 | 10 | src 11 | ├── index.html 12 | ├── init_sqlite.py 13 | ├── models.py 14 | ├── server.py 15 | ├── static 16 | │   ├── backbone.js 17 | │   ├── destroy.png 18 | │   ├── jquery.js 19 | │   ├── json2.js 20 | │   ├── todos.css 21 | │   ├── todos.js 22 | │   └── underscore.js 23 | └── todos.db 24 | 25 | 以上结构可以分为四个部分：模板、静态资源、后端逻辑处理、后端数据处理，其实最后两个都属于后端部分。 26 | 27 | 因为模板和静态资源和之前没有太大差异，因此合并在一起介绍。首先来看后端的接口。 28 | 29 | 10.2 后端接口 30 | ---------------------- 31 | 相对于前端的各种model、collection和view，后端显得比较简单。只需要提供可访问的接口，并且根据POST、PUT、DELETE、GET这四种操作完成对数据库的CRUD即可（Create,Read,Update,Delete)。 32 | 33 | 先来看models中的代码，这里对todo表的操作进行了简单的封装: 34 | 35 | .. code:: python 36 | 37 | #coding:utf-8 38 | import web 39 | 40 | db = web.database(dbn='sqlite', db="todos.db") 41 | 42 | class Todos(object): 43 | @staticmethod 44 | def get_by_id(id): 45 | return db.select('todos', where="id=$id", vars=locals()) 46 | 47 | @staticmethod 48 | def get_all(): 49 | return db.select('todos') 50 | 51 | @staticmethod 52 | def create(**kwargs): 53 | db.insert('todos', **kwargs) 54 | 55 | @staticmethod 56 | def update(**kwargs): 57 | db.update('todos', where="id=$id", vars={"id": kwargs.pop('id')}, **kwargs) 58 | 59 | @staticmethod 60 | def delete(id): 61 | db.delete('todos', where="id=$id", vars=locals()) 62 | 63 | 代码很简单，从方法的命名上就知道要完成的功能是什么，这里不得不说一句，任何语言中好的变量或方法的命名，胜过大段的注释。 64 | 65 | model部分没有具体的业务逻辑，只是针对数据库进行CRUD操作。下面来看给浏览器提供接口的部分。 66 | 67 | server部分，提供了前端浏览器需要访问的接口，同时也提供了页面初始加载时的渲染页面的功能。server.py的代码如下: 68 | 69 | .. code:: python 70 | 71 | #coding:utf-8 72 | import json 73 | 74 | import web 75 | from models import Todos 76 | 77 | urls = ( 78 | '/', 'index', #返回首页 79 | # 处理POST请求 80 | '/todo', 'todo', 81 | # 处理前端todo的请求,对指定记录进行操作 82 | '/todo/(\d*)', 'todo', 83 | # 处理前端todo的请求，返回所有数据 84 | '/todos/', 'todos', 85 | ) 86 | 87 | app = web.application(urls, globals()) 88 | 89 | render = web.template.render('') 90 | 91 | # 首页 92 | class index: 93 | def GET(self): 94 | # 渲染首页到浏览器 95 | return render.index() 96 | 97 | class todo: 98 | def GET(self, todo_id=None): 99 | result = None 100 | itertodo = Todos.get_by_id(id=todo_id) 101 | for todo in itertodo: 102 | result = { 103 | "id": todo.id, 104 | "title": todo.title, 105 | "order": todo._order, 106 | "done": todo.done == 1, 107 | } 108 | return json.dumps(result) 109 | 110 | def POST(self): 111 | data = web.data() 112 | todo = json.loads(data) 113 | # 转换成_order, order是数据库关键字, sqlite3报错 114 | todo['_order'] = todo.pop('order') 115 | Todos.create(**todo) 116 | 117 | def PUT(self, todo_id=None): 118 | data = web.data() 119 | todo = json.loads(data) 120 | todo['_order'] = todo.pop('order') 121 | Todos.update(**todo) 122 | 123 | def DELETE(self, todo_id=None): 124 | Todos.delete(id=todo_id) 125 | 126 | 127 | class todos: 128 | def GET(self): 129 | todos = [] 130 | itertodos = Todos.get_all() 131 | for todo in itertodos: 132 | todos.append({ 133 | "id": todo.id, 134 | "title": todo.title, 135 | "order": todo._order, 136 | "done": todo.done == 1, 137 | }) 138 | return json.dumps(todos) 139 | 140 | if __name__ == "__main__": 141 | app.run() 142 | 143 | 相对于model.py来说，这里做了些数据转换的操作，如前端backbone通过ajax发过来的数据需要转换之后才能存入数据库，而从数据库取出的数据也要稍加处理才能符合前端todos.js中定义的model的要求。 144 | 145 | 在这个server中，提供了三个四个url，依次功能为：首页加载、单个todo创建、单个todo查询修改和删除、查询全部。分成四个也主要是依据所选框架webpy的特性。 146 | 147 | 在url之后，是对应一个具体的class，url接受到的请求将有对应的class来处理，比如说 ``/todo`` 这个url，对应的处理请求的class就是todo。另外对应浏览器端发过来的POST、GET、PUT、DELETE请求，class对应的也是相应的方法。这也是选webpy的一个原因。 148 | 149 | 说我了后端提供的接口，以及如何进行处理的原理。我们来看如何修改前端的代码，才能让数据发送到后端来。 150 | 151 | 10.3 修改todos，发送数据到后端 152 | -------------------------------------------- 153 | 这个部分改动比较小，就不贴代码了。有需要的可以到 ``code`` 中看。 154 | 155 | 之前的数据是存在localstorage中，是因为引用了localStorage.js文件，并且在collection中声明了 ``localStorage: new Backbone.LocalStorage("todos-backbone")`` 。 156 | 157 | 在修改的时候有三个地方需要修改，第一是model的定义，部分代码： 158 | 159 | .. code:: javascript 160 | 161 | var Todo = Backbone.Model.extend({ 162 | urlRoot: '/todo', 163 | ...... 164 | 165 | 第二个就是collection的修改，去掉了localStorage的声明，并添加url： 166 | 167 | .. code:: javascript 168 | 169 | var TodoList = Backbone.Collection.extend({ 170 | url: '/todos/', 171 | ...... 172 | 173 | 这样就搞定了。 174 | 175 | 10.4 Demo的使用 176 | ---------------------------- 177 | 在 ``code`` 中，如果想要把我的demo在本地运行的话，需要首先运行下 ``python init_sqlite.py`` 来初始化sqlite3的数据库，运行完之后会在本地生成一个todos.db的数据库文件。 178 | 179 | 之后，就可以通过运行 ``python server.py`` ，然后访问命令行提示的网址就可以使用了。 180 | 181 | 182 | 183 | 最后稍稍总结一下，我觉得到这一章为止，对技术比较认真、比较有追求的同学应该知道怎么通过backbonejs和webpy把前后端连起来了。所有的这些文章只是为了帮你打开一扇门，或者仅仅只是一盏灯，具体你的业务逻辑还是需要通过自己的思考来解决。妄图让别人帮你实现业务逻辑的人都是切实的不思上进的菜鸟。 184 | 185 | 另外，关于这个Todos的案例，是你在打算把Backbonejs应用于实践时必须要参考和思考的。虽然到网上搜罗一下 ``Backbonejs项目实例`` 比思考要省心，但是别人的始终是别人的，你不转化成自己的，始终无法灵活运用。借此告诫那些觉得这个Todo案例没啥用的同学们。 186 | 187 | 188 | 189 | **导航** 190 | 191 | * 上一章 09 `后端环境搭建：web.py的使用 <09-intro-webpy.rst>`_ 192 | * 下一章 11 `前后端实战演练：Web聊天室-功能分析 <11-web-chatroom-base-on-backbonejs-1.rst>`_ 193 | -------------------------------------------------------------------------------- /chapters/11-web-chatroom-base-on-backbonejs-1.rst: -------------------------------------------------------------------------------- 1 | 第十一章 前后端实战演练：Web聊天室-功能分析 2 | ======================================================================= 3 | 4 | 上面的一个简单的项目完成之后，对python感兴趣的应该已经把web.py这个东西熟悉的差不多了，说不定也像我这样把项目放到服务器上跑了起来。对于没有动手去做的同学，我只能表示很遗憾，作为观众的你一定体会不到参与的乐趣，当然也不会有切身的收获。 5 | 6 | 11.1 项目目标 7 | --------------------------- 8 | 相比于之前那个项目，这个项目的目标是按照专业前端的方法搭建一个我自己凭空想出来的需求。最后把这个需求完成，然后注册域名放到网络上，可以真实使用。这样也可以持续改进。 9 | 10 | 上线其实只是一个开始，希望有兴趣参与的同学可以主动参与进来，体会下实际的开发过程。 11 | 12 | 11.2 功能需求 13 | --------------------------- 14 | 这个项目的名字叫做聊天室，那肯定是在线聊天用的了，因为不是朝着Demo方向做的，因此需要多用户管理。 15 | 16 | 按照这个需求分析下功能大体有:: 17 | 18 | 1. 多用户管理 19 | 1.1 用户注册 20 | 1.2 多用户登陆 21 | 2. 话题管理 22 | 2.1 创建话题 23 | 2.2 浏览话题 24 | 3. 消息管理 25 | 3.1 发送消息 26 | 3.2 删除消息 27 | 3.3 回复消息 28 | 3.4 浏览消息 29 | 30 | 大概这么几个功能 31 | 32 | 11.3 技术选型 33 | -------------------------- 34 | 因为是关于Backbonejs的教程，因此必然是基于Backbonejs的。技术选型暂定如下:: 35 | 36 | /* 前端技术 */ 37 | backbone.js 38 | bootstrap.css 39 | requirejs 40 | 41 | /* 后端技术 */ 42 | web.py 43 | sqlite3 44 | 45 | 暂时先估计用到这些，说不定真实情况用的更多。 46 | 47 | **导航** 48 | 49 | * 上一章 10 `实战演练：扩展todos到Server端（backbonejs+webpy） <10-expand-todos-with-server.rst>`_ 50 | * 下一章 12 `前后端实战演练：Web聊天室-详细设计 <12-web-chatroom-base-on-backbonejs-2.rst>`_ 51 | -------------------------------------------------------------------------------- /chapters/12-web-chatroom-base-on-backbonejs-2.rst: -------------------------------------------------------------------------------- 1 | 第十二章 前后端实战演练：Web聊天室-详细设计 2 | ======================================================================= 3 | 4 | 上一章简单的介绍了这个聊天室的功能和要使用的技术，这一章的主要目的是为下一章的实现做准备。 5 | 任何一个项目从需求到最后的实现，都是要经历这么个过程的，不论这个过程是否显式存在于你自己或者团队的项目历程中。拿到需求后立马开始写代码的同学要么是大牛——（对付各种需求已经有相当多的经验，在理解需求的同时已然对项目进行了分析和设计），要么就是小白——（在这个阶段，对写代码充满了激情，渴望让自己的手指在键盘上得到释放，结果大多会走偏或者自己写到混乱）。 6 | 7 | 因此需要这么个过程，对已有的需求再次思考、规划 8 | 9 | 12.1 实体(Model)设计 10 | ------------------------- 11 | 所谓的实体，就是在项目中数据存放和被传输的对象，从定义上来说就是客观存在的事物。那么在这个项目中有哪些实体存在呢？ 12 | 13 | 从功能上分析，只有三个实体：用户，话题，消息。这三个实体也就是项目中的三个Model，剩下的所有业务都是围绕它们来运转的。 14 | 15 | 那么这三个实体中都应该存放什么样的数据呢？根据需求简单的列一下:: 16 | 17 | 用户(user): 18 | id 19 | username 20 | password 21 | registed_time 22 | 话题(topic): 23 | id 24 | title 25 | created_time 26 | owner 27 | 消息(message): 28 | id 29 | content 30 | topic_id 31 | user_id 32 | created_time 33 | 34 | 12.2 接口设计 35 | -------------------- 36 | 因为这个项目的重点是在前端，因此后端只是提供一个接口，先把需要的哪些接口整理清楚了，剩下的就好办了。 37 | 38 | 那么，需要哪些接口呢？ 39 | 40 | 依然是根据功能来： 41 | **用户管理** 42 | 1. 用户注册接口:: 43 | 44 | /user/ [POST] 45 | 46 | 2. 获取用户列表接口:: 47 | 48 | /user/ [GET] 49 | 50 | 3. 获取单个用户接口:: 51 | 52 | /user// [GET] 53 | 54 | 4. 用户登录:: 55 | 56 | /login/ [POST] 57 | 58 | 5. 用户登出:: 59 | 60 | /logout/ [GET] 61 | 62 | **话题管理** 63 | 1. 话题列表:: 64 | 65 | /topic/ [GET] 66 | 67 | 2. 创建话题:: 68 | 69 | /topic/ [POST] 70 | 71 | 3. 查看具体话题(相对于进入消息列表):: 72 | 73 | /topic// [GET] 74 | 75 | **消息管理** 76 | 1. 发送/回复消息:: 77 | 78 | /message/ [POST] 79 | 80 | 2. 删除消息:: 81 | 82 | /message// [DELETE] 83 | 84 | 3. 浏览消息:: 85 | 86 | /message/ [GET] 87 | 88 | 大体就这么些个接口，url后面表示的是HTTP的方法。 89 | 90 | 这样分析完之后，服务器的工作算是清晰了，下面在来分析页面上的工作。 91 | 92 | 12.3 页面设计 93 | --------------------------- 94 | 因为是单页应用，所有也就一个页面，但是这一个页面也是由多个视图来组成的——这里的视图可以理解为桌面程序的那种窗口。 95 | 96 | 为了有的放矢，这里我就先画几个草图，来看一下我们这个项目最终的结果可能是什么: 97 | 98 | **登录** 99 | 这个是直接截得现成的图。 100 | 101 | .. image:: ../images/login.png 102 | 103 | 注册界面和这个一样 104 | 105 | 106 | **话题界面** 107 | 108 | .. image:: ../images/topics.png 109 | 110 | **消息界面** 111 | 112 | .. image:: ../images/message.png 113 | 114 | 115 | 12.4 view的设计 116 | -------------------------------- 117 | 这里说的view，是指backbonejs中的view，按照之前的经验来说，大概需要划分的view和功能分别为： 118 | 119 | 1. 话题view(topic_view):: 120 | 121 | 功能: 122 | 根据话题接口获取所有话题数据，然后渲染模板 123 | 124 | 2. 消息view(message_view):: 125 | 126 | 功能: 127 | 根据消息接口返回的数据，渲染模板 128 | 129 | 3. 登录view(login_view):: 130 | 131 | 功能: 132 | 展示登录页面，发送用户数据到服务器端 133 | 134 | 4. 整体view（main_view):: 135 | 136 | 功能： 137 | 负责其他view的切换 138 | 139 | 140 | 12.5 总结 141 | ------------------- 142 | 这一章主要是对功能做了更进一步的处理，目的就是能够更好的开始编码。在详细设计完成之后具体实现就变得有迹可循了。 143 | 144 | 到目前为止，这个项目我也是边写边做，现在还没开始写代码。因此这篇文章的分析可能在之后还需要改动。但，即便如此，这个过程也是需要存在的，因为软件开发本身就是一个不断迭代的过程，你不可能一拍脑袋便出来一个完美方案，设计一个可行的方案，然后持续迭代才是最好的实践。 145 | 146 | 147 | **导航** 148 | 149 | * 上一章 11 `前后端实战演练：Web聊天室-功能分析 <11-web-chatroom-base-on-backbonejs-1.rst>`_ 150 | * 下一章 13 `前后端实战演练：Web聊天室-后端开发 <13-web-chatroom-base-on-backbonejs-3.rst>`_ 151 | -------------------------------------------------------------------------------- /chapters/13-web-chatroom-base-on-backbonejs-3.rst: -------------------------------------------------------------------------------- 1 | 第十三章 前后端实战演练：Web聊天室-服务器端开发 2 | ======================================================================= 3 | 4 | 在上一章中简单的进行了在开发中经常要经过的一个步骤——详细设计，在详细设计中定义了数据模型，有哪些接口，以及页面的长相。比较简单，并没有对服务器端Python项目的结构进行设计，也没有对前端文件的组织进行规划。但是这个详细设计的目的是达到了，在我个人的实际经验中，项目的开发很少有按照软件工程中的瀑布模型来做的。大部分都是明确阶段目标，然后开发，然后再次明确，再次开发，不断迭代。 5 | 6 | 因此说到前篇文章的目的也就是指导后端开发提供一个什么样的接口，输出什么样的数据结构。也是指导前端应该怎么获取数据。在日常工作中，设计到前后端甚至是服务器和客户端的这种模式也是一样，两方人员在项目初期只要协定好接口和数据结构就行，随着项目的进行不断的调整。当然这种情况是说内部人员之间的沟通，如果是和外部人员的沟通情况就不一样了。 7 | 8 | 回到正题，后端的开发主要功能是提供接口，要提供哪些接口一定定义好了，模型也建立好了，现在需要做的就是搭一个项目，实现接口。 9 | 10 | 11 | 13.1 项目结构 12 | ------------------------------ 13 | 14 | 项目使用了webpy这个微型的python框架，项目结构是依然按照之前对todos进行服务器端扩展时的结构, `onlinetodos `_ :: 15 | 16 | . 17 | ├── __init__.py 18 | ├── handlers.py 19 | ├── init_sqlite.py 20 | ├── models.py 21 | ├── server.py 22 | ├── static 23 | │   ├── css 24 | │   │   ├── body.css 25 | │   │   └── semantic.min.css 26 | │   ├── img 27 | │   │   └── bg.jpg 28 | │   └── js 29 | │   ├── backbone.js 30 | │   ├── jquery.js 31 | │   ├── json2.js 32 | │   └── underscore.js 33 | ├── templates 34 | │   └── index.html 35 | └── wechat.db 36 | 37 | 可以先忽略其中的静态文件的部分，下一章实现的时候会进行调整。只说后端的实现，主要分为三个部分：server部分、handler部分、和models部分，也就是上面对应的名字，这些名字本身就说明了这部分的功能。server主要是启动一个web服务器，其中进行了url的定义，对应url接受到的请求会传递到handlers中对应的类方法中，在方法中会调用Models中的Model类来获取数据，然后再返回给客户端（浏览器）。 38 | 39 | 13.2 server部分详解 40 | ----------------------------------- 41 | 42 | 这部分功能上已经介绍了，这里贴出代码详细介绍: 43 | 44 | .. code:: python 45 | 46 | #!/usr/bin/env python 47 | #coding:utf-8 48 | import web 49 | from web.httpserver import StaticMiddleware 50 | 51 | urls = ( 52 | '/', 'IndexHandler', # 返回首页 53 | '/topic', 'TopicHandler', 54 | '/topic/(\d+)', 'TopicHandler', 55 | '/message', 'MessageHandler', 56 | '/user', 'UserHandler', 57 | '/user/(\d+)', 'UserHandler', 58 | '/login', 'LoginHandler', 59 | '/logout', 'LogoutHandler', 60 | ) 61 | 62 | app = web.application(urls, globals()) 63 | application = app.wsgifunc(StaticMiddleware) 64 | 65 | if web.config.get('_session') is None: 66 | session = web.session.Session( 67 | app, 68 | web.session.DiskStore('sessions'), 69 | initializer={'login': False, 'user': None} 70 | ) 71 | web.config._session = session 72 | 73 | from handlers import ( # NOQA 74 | IndexHandler, RegisteHandler, 75 | LoginHandler, LogoutHandler, 76 | TopicHandler, MessageHandler 77 | ) 78 | 79 | 80 | def main(): 81 | app.run() 82 | 83 | if __name__ == "__main__": 84 | main() 85 | 86 | 这里首先是定义了url对应的handlers中的类，然后通过webpy的静态文件Middleware来处理静态文件的请求，接着初始化了项目的session。最后从handlers中引入所有用到的Handler。这里需要注意的是，handlers的引入需要在session定义的下面，因为handlers中需要用到session。 87 | 88 | 13.3 handler中的逻辑 89 | -------------------------------------------- 90 | 91 | 这里面主要逻辑是处理来自浏览器对相应的url的请求，因为项目需要处理用户登录，因此要引入前面定义的session来保存用户的状态。 92 | 93 | 来看代码: 94 | 95 | .. code:: python 96 | 97 | #coding:utf-8 98 | import copy 99 | import json 100 | import hashlib 101 | import sqlite3 102 | from datetime import datetime 103 | 104 | import web 105 | 106 | from models import Message, User, Topic 107 | 108 | session = web.config._session 109 | 110 | CACHE_USER = {} 111 | 112 | 113 | def sha1(data): 114 | return hashlib.sha1(data).hexdigest() 115 | 116 | 117 | def bad_request(message): 118 | raise web.BadRequest(message=message) 119 | 120 | 121 | # 首页 122 | class IndexHandler: 123 | def GET(self): 124 | render = web.template.render('templates/') 125 | return render.index() 126 | 127 | 128 | class UserHandler: 129 | def GET(self): 130 | # 获取当前登录的用户数据 131 | user = session.user 132 | return json.dumps(user) 133 | 134 | def POST(self): 135 | data = web.data() 136 | data = json.loads(data) 137 | username = data.get("username") 138 | password = data.get("password") 139 | password_repeat = data.get("password_repeat") 140 | 141 | if password != password_repeat: 142 | return bad_request('两次密码输入不一致') 143 | 144 | user_data = { 145 | "username": username, 146 | "password": sha1(password), 147 | "registed_time": datetime.now(), 148 | } 149 | 150 | try: 151 | user_id = User.create(**user_data) 152 | except sqlite3.IntegrityError: 153 | return bad_request('用户名已存在!') 154 | 155 | user = User.get_by_id(user_id) 156 | session.login = True 157 | session.user = user 158 | 159 | result = { 160 | 'id': user_id, 161 | 'username': username, 162 | } 163 | return json.dumps(result) 164 | 165 | 166 | class LoginHandler: 167 | def POST(self): 168 | data = web.data() 169 | data = json.loads(data) 170 | username = data.get("username") 171 | password = data.get("password") 172 | user = User.get_by_username_password( 173 | username=username, 174 | password=sha1(password) 175 | ) 176 | if not user: 177 | return bad_request('用户名或密码错误！') 178 | 179 | session.login = True 180 | session.user = user 181 | result = { 182 | 'id': user.get('id'), 183 | 'username': user.get('username'), 184 | } 185 | return json.dumps(result) 186 | 187 | 188 | class LogoutHandler: 189 | def GET(self): 190 | session.login = False 191 | session.user = None 192 | session.kill() 193 | return web.tempredirect('/#login') 194 | 195 | 196 | class TopicHandler: 197 | def GET(self, pk=None): 198 | if pk: 199 | topic = Topic.get_by_id(pk) 200 | return json.dumps(topic) 201 | 202 | topics = Topic.get_all() 203 | result = [] 204 | for t in topics: 205 | topic = dict(t) 206 | try: 207 | user = CACHE_USER[t.owner_id] 208 | except KeyError: 209 | user = User.get_by_id(t.owner_id) 210 | CACHE_USER[t.owner_id] = user 211 | topic['owner_name'] = user.username 212 | result.append(topic) 213 | return json.dumps(result) 214 | 215 | def POST(self): 216 | if not session.user or not session.user.id: 217 | return bad_request('请先登录！') 218 | 219 | data = web.data() 220 | data = json.loads(data) 221 | 222 | topic_data = { 223 | "title": data.get('title'), 224 | "owner_id": session.user.id, 225 | "created_time": datetime.now(), 226 | } 227 | 228 | try: 229 | topic_id = Topic.create(**topic_data) 230 | except sqlite3.IntegrityError: 231 | return bad_request('你已创建过该名称!') 232 | 233 | result = { 234 | "id": topic_id, 235 | "title": topic_data.get('title'), 236 | "owner_id": session.user.id, 237 | "owner_name": session.user.username, 238 | "created_time": str(topic_data.get('created_time')), 239 | } 240 | return json.dumps(result) 241 | 242 | def PUT(self, obj_id=None): 243 | pass 244 | 245 | def DELETE(self, obj_id=None): 246 | pass 247 | 248 | 249 | class MessageHandler: 250 | def GET(self): 251 | topic_id = web.input().get('topic_id') 252 | if topic_id: 253 | messages = Message.get_by_topic(topic_id) or [] 254 | else: 255 | messages = Message.get_all() 256 | 257 | result = [] 258 | current_user_id = session.user.id 259 | for m in messages: 260 | try: 261 | user = CACHE_USER[m.user_id] 262 | except KeyError: 263 | user = User.get_by_id(m.user_id) 264 | CACHE_USER[m.user_id] = user 265 | message = dict(m) 266 | message['user_name'] = user.username 267 | message['is_mine'] = (current_user_id == user.id) 268 | result.append(message) 269 | return json.dumps(result) 270 | 271 | def POST(self): 272 | data = web.data() 273 | data = json.loads(data) 274 | if not (session.user and session.user.id): 275 | return bad_request("请先登录！") 276 | 277 | message_data = { 278 | "content": data.get("content"), 279 | "topic_id": data.get("topic_id"), 280 | "user_id": session.user.id, 281 | "created_time": datetime.now(), 282 | } 283 | m_id = Message.create(**message_data) 284 | result = { 285 | "id": m_id, 286 | "content": message_data.get("content"), 287 | "topic_id": message_data.get("topic_id"), 288 | "user_id": session.user.id, 289 | "user_name": session.user.username, 290 | "created_time": str(message_data.get("created_time")), 291 | "is_mine": True, 292 | } 293 | return json.dumps(result) 294 | 295 | 别看代码这么多，所有的具体的Handler的处理逻辑都是一样的——接受post请求，验证用户状态，存储；或者是接受get请求，调用Model获取数据，组织成json，然后返回。相当简单了，对吧。 296 | 297 | 13.4 models中的实现 298 | -------------------------------------- 299 | 300 | 这部分功能就是现实数据库的增删改查，行为基本一致，因此提出一个基础类来完成基本的操作。如果基础类满足不了需求，需要在各子类中实现自己的逻辑。 301 | 302 | 来看下实现代码: 303 | 304 | .. code:: python 305 | 306 | #coding:utf-8 307 | import web 308 | 309 | db = web.database(dbn='sqlite', db="wechat.db") 310 | 311 | 312 | class DBManage(object): 313 | @classmethod 314 | def table(cls): 315 | return cls.__name__.lower() 316 | 317 | @classmethod 318 | def get_by_id(cls, id): 319 | itertodo = db.select(cls.table(), where="id=$id", vars=locals()) 320 | return next(iter(itertodo), None) 321 | 322 | 323 | @classmethod 324 | def get_all(cls): 325 | # inspect.ismethod(cls.get_all) 326 | return db.select(cls.table()) 327 | 328 | @classmethod 329 | def create(cls, **kwargs): 330 | return db.insert(cls.table(), **kwargs) 331 | 332 | @classmethod 333 | def update(cls, **kwargs): 334 | db.update(cls.table(), where="id=$id", vars={"id": kwargs.pop('id')}, **kwargs) 335 | 336 | @classmethod 337 | def delete(cls, id): 338 | db.delete(cls.table(), where="id=$id", vars=locals()) 339 | 340 | 341 | class User(DBManage): 342 | id = None 343 | username = None 344 | password = None 345 | registed_time = None 346 | 347 | @classmethod 348 | def get_by_username_password(cls, username, password): 349 | itertodo = db.select(cls.table(), where="username=$username and password=$password", vars=locals()) 350 | return next(iter(itertodo), None) 351 | 352 | 353 | class Topic(DBManage): 354 | id = None 355 | title = None 356 | created_time = None 357 | owner = None 358 | 359 | 360 | class Message(DBManage): 361 | id = None 362 | content = None 363 | top_id = None 364 | user_id = None 365 | reply_to = None 366 | 367 | @classmethod 368 | def get_by_topic(cls, topic_id): 369 | return db.select(cls.table(), where="topic_id=$topic_id", vars=locals()) 370 | 371 | 在操作的同时还是定义了模型的属性，不过目前并没有用的上，如果打算进一步抽象的话是要用到的。 372 | 373 | 13.5 总结 374 | --------------------------- 375 | 376 | 整个后端的实现并不复杂，只是简单的数据库CRUD操作，也没有进行更深一步的抽象，不过满足接口需求就好，等前端实现的时候可能需要调整。 377 | 378 | 这个项目已经托管在github上了: `wechat `_ ，欢迎围观以及贡献代码。 379 | 380 | **导航** 381 | 382 | * 上一章 12 `前后端实战演练：Web聊天室-详细设计 <12-web-chatroom-base-on-backbonejs-2.rst>`_ 383 | * 下一章 14 `前后端实战演练：Web聊天室-前端开发 <14-web-chatroom-base-on-backbonejs-4.rst>`_ 384 | -------------------------------------------------------------------------------- /chapters/16-exception-in-backbone.rst: -------------------------------------------------------------------------------- 1 | 第十六章 补充异常处理 2 | ============================== 3 | 4 | 忘了之前定这么个题目是要表达什么内容，就简单介绍下wechat项目中的错误处理。 5 | 6 | 7 | 16.1 error的使用 8 | --------------------------------- 9 | 10 | 说这个错误处理其实很简单，有过JavaScript经验的同学应该看到Backbonejs中定义的回调函数选项中的error参数就知道怎么写了。 11 | 12 | 需要处理错误的场景都是在客户端和服务器端通信时，在wechat中主要是save和fetch时。有一段代码展示下就是: 13 | 14 | .. code:: javascript 15 | 16 | registe: function(evt){ 17 | var reg_username_input = $('#reg_username'); 18 | var reg_pwd_input = $('#reg_pwd'); 19 | var reg_pwd_repeat_input = $('#reg_pwd_repeat'); 20 | var u = new User({ 21 | username: reg_username_input.val(), 22 | password: reg_pwd_input.val(), 23 | password_repeat: reg_pwd_repeat_input.val(), 24 | }); 25 | u.save(null, { 26 | success: function(model, resp, options){ 27 | g_user = resp; 28 | // 跳转到index 29 | appRouter.navigate('index', {trigger: true}); 30 | }, 31 | error: function(model, resp, options) { 32 | alert(resp.responseText); 33 | } 34 | }); 35 | }, 36 | 37 | 这是用户注册时的代码，在save的参数的第二个参数部分添加了error的处理，具体功能就是alert出服务器端传回来的response的内容。 38 | 39 | 那么这么错误是什么时候触发的呢？正常情况下是触发success对应的function，那么什么是正常呢？正常和错误在Backbone.js中是通过返回的HTTP状态码来区分的（应该说是jQuery或者zepto这样下一层处理ajax的库），jQuery中错误判断的代码是这样的: ``if ( status >= 200 && status < 300 || status === 304 ) {`` 。 40 | 41 | 因此，对应着服务端的处理就是返回非20x 和304的错误就行，一般客户端的错误都会返回400（40x系列）这样的错误，服务器端的错误一般都是500以上的错误。 42 | 43 | 对应上面的的错误，服务器端在使用web.py框架要这么处理: 44 | 45 | .. code:: python 46 | 47 | def POST(self): 48 | data = web.data() 49 | data = json.loads(data) 50 | username = data.get("username") 51 | password = data.get("password") 52 | password_repeat = data.get("password_repeat") 53 | 54 | if password != password_repeat: 55 | # 会返回HTTP400的错误，内容是message的内容 56 | raise web.BadRequest(message='两次密码输入不一致') 57 | 58 | user_data = { 59 | "username": username, 60 | "password": sha1(password), 61 | "registed_time": datetime.now(), 62 | } 63 | 64 | try: 65 | user_id = User.create(**user_data) 66 | except sqlite3.IntegrityError: 67 | raise web.BadRequest(message="用户名已存在!") 68 | 69 | user = User.get_by_id(user_id) 70 | session.login = True 71 | session.user = user 72 | 73 | result = { 74 | 'id': user_id, 75 | 'username': username, 76 | } 77 | return json.dumps(result) 78 | 79 | 这样就ok了。看起来都是基本的东西。 80 | 81 | 82 | 参考： `HTTP状态码 `_ 83 | 84 | 85 | **导航** 86 | 87 | * 上一章 15 `引入requirejs <15-import-requirejs.rst>`_ 88 | * 下一章 17 `自定义Backbonejs <17-customize-backbonejs-sync.rst>`_ 89 | -------------------------------------------------------------------------------- /chapters/17-customize-backbonejs-sync.rst: -------------------------------------------------------------------------------- 1 | 第十七章 定制Backbonejs 2 | ========================================= 3 | 4 | 这里说的定制Backbonejs，主要是定制Backbone中的sync部分，也就是最后和服务器端通信的部分。 5 | 6 | 17.1 三个级别的定制 7 | ------------------------------------- 8 | 9 | 首先得说，在Backbone里面和后端能通信的对象也就两个——Model和Collection。这俩的主要工作就是从服务器拉取数据，保存到实例中，或者把实例中的属性发送到服务器端。 10 | 11 | 上面两中类型的对象都是基于Backbone.sync来进行通信的，同时也可以定义各自的sync方法，类似这样： 12 | 13 | *Model级别的* 14 | 15 | .. code:: javascript 16 | 17 | var Message = Backbone.Model.extend({ 18 | urlRoot: '/message', 19 | // 这么写, 打印要操作的实体, 调用系统的sync 20 | sync: function(method, model, options){ 21 | console.log(model); 22 | return Backbone.sync(method, model, options); 23 | }, 24 | }); 25 | 26 | *Collection级别的* 27 | 28 | .. code:: javascript 29 | 30 | var Messages = Backbone.Collection.extend({ 31 | url: '/message', 32 | model: Message, 33 | // 这么写, 打印要操作的实体, 调用系统的sync 34 | sync: function(method, collection, options){ 35 | console.log(collection); 36 | return Backbone.sync(method, collection, options); 37 | }, 38 | }); 39 | 40 | 当然，也会存在这样的需求，要修改全局的sync： 41 | 42 | .. code:: javascript 43 | 44 | var old_sync = Backbone.sync; 45 | Backbone.sync = function(method, model, options) { 46 | console.log(model); 47 | return old_sync(method, model, options); 48 | } 49 | 50 | 所谓定制，是Backbonejs给开发者提供的可以被重写的接口。因此定制过程也得符合Backbone对sync的定义。 51 | 52 | 17.2 简单实例，用socketio通信 53 | --------------------------------------------------------- 54 | 55 | 在 `wechat `_ 这个项目中为了保证聊天的实时性，我引入了socketio，后端使用gevent-socketio，（socketio这个东西不打算写，和主题关系不大，有需求的可以题issue）。 56 | 57 | 实时聊天的需求主要是在Message上，用户A发送一个请求，在同一聊天室内的其他用户应该立马能看见。之前有两个版本： 58 | 59 | * 第一版是发送message时会调用messages的fetch方法，也就是用户只有发言才能看到别人发的聊天内容，代码如下： 60 | 61 | .. code:: javascript 62 | 63 | message.save(null, { 64 | success: function(model, response, options){ 65 | comment_box.val(''); 66 | // 重新获取，看服务器端是否有更新 67 | // 比较丑陋的更新机制 68 | messages.fetch({ 69 | data: {topic_id: topic_id}, 70 | success: function(){ 71 | self.message_list.scrollTop(self.message_list_div.scrollHeight); 72 | messages.add(response); 73 | }, 74 | }); 75 | }, 76 | }); 77 | 78 | * 第二版是引入socketio之后，在save完数据之后，通过socket把数据再次发送到服务器上的socket端，服务器再挨个发送数据到各个客户端，代码如下： 79 | 80 | .. code:: javascript 81 | 82 | message.save(null, { 83 | success: function(model, response, options){ 84 | comment_box.val(''); 85 | messages.add(response); 86 | // 发送成功之后，通过socket再次发送 87 | // FIXME: 最后可通过socket直接通信并保存 88 | socket.emit('message', response); 89 | }, 90 | }); 91 | 92 | // 对应着有一个socket监听, 监听服务器发来的消息 93 | // 监听message事件，添加对话到messages中 94 | socket.on('message', function(response) { 95 | messages.add(response); 96 | }); 97 | 98 | 可以看得出来，上面的第二版算是比较合适了，但是还是有些别扭，数据要重复发送。因此终于到了需要定制的时刻了。 99 | 100 | 上面说了，有三种级别的定制。根据我的需求，只需要定制Model级别的就可以了，怎么定制呢？ 101 | 102 | 和一开头的示例代码类似： 103 | 104 | .. code:: javascript 105 | 106 | var Message = Backbone.Model.extend({ 107 | urlRoot: '/message', 108 | 109 | sync: function(method, model, options){ 110 | if (method === 'create') { 111 | socket.emit('message', model.attributes); 112 | $('#comment').val(''); 113 | } else { 114 | return Backbone.sync(method, model, options); 115 | }; 116 | }, 117 | }); 118 | 119 | // 对应着上面的那个message.save后的一堆东西都可以去掉了，直接 120 | message.save(); 121 | 122 | 这样就好了，客户端只需要发送一次数据。但要记得在服务器端的监听message的接口上添加保存message的逻辑。 123 | 124 | 好了，定制就介绍这么多。关于上面提到的代码想了解上下文的，可以到我的wechat这个项目的master分支查看。 125 | 126 | 127 | **导航** 128 | 129 | * 上一章 16 `补充异常处理 <16-exception-in-backbone.rst>`_ 130 | * 下一章 18 `再次总结的说 <18-backbone-summary.rst>`_ 131 | -------------------------------------------------------------------------------- /chapters/18-backbone-summary.rst: -------------------------------------------------------------------------------- 1 | 第十八章 再次总结的说 2 | ====================================== 3 | 4 | 终于又到了写着一篇的时候了，从去年（2013）8月份决定再更新一版Backbonejs入门教程。原因在前言中已经介绍过了，主要是填一些坑。 5 | 6 | 看看上一版的那个总结 `16、总结的说 `_ 的时间——2012.4.18。再看看这一篇的时间——2014.4.15，差不多刚好两年的时间。之前的状态是刚接触前端框架方面的东西，像是在迷雾中行走，摸摸探探的总算知道这是条什么样的路。 7 | 8 | 现在的这一本更多的是希望从一个实用的角度出发，在长期的实践开发中总结出来的经验是：如果你学了一个东西，最终没有把它用到实际应用中，那么你学习这个东西最终产生的价值就抵不上你所花得成本。软件开发这东西，大部分情况下你只有切身的经历了技术对最终产品的作用，你才会对如何运用这一技术有些感觉，不然的话真的是纸上谈兵。 9 | 10 | 因此在这一版中我一开始写的时候就确定了一个最终的目标，那就是要做一个上线的系统，能够让互联网用户访问得到。另外还希望所有用心看了这一系列教程的Backbonejs初学者能够把学到的东西运用进来。 11 | 12 | 在最开始确定要不要刨这么一个坑的时候我犹豫了很久。这个框架在实际的工作中并没有用到，这意味着我对Backbonejs的再次学习和整理对工作上的事情没有太大帮助，虽然我会据此同我们的前端同学进行交流。 13 | 14 | 时间成本是最大的成本，在后端的世界里也有很多东西值得我去探索。犹豫几天之后我写了这篇文章 `心存恐惧便无自由 `_ 。我觉得应该去做一些自己想做的事情，心里不受任何约束的。 15 | 16 | 一些牢骚完之后，再说些技术的东西。 17 | 18 | Backbonejs学习最大的难点在于你需要有以一个前端MVC框架的概念。一旦有了这么一个概念之后，你就会意识到，所有的前端框架只是填充了MVC中的各个部分，然后提供给你一个工具，让你可以按这种方式来组织你的代码。 19 | 20 | 因此在学习过程中，你也只需要掌握里面的几个概念：Model、Collection、View、Router，剩下的东西就和框架无关了，都是你软件开发经验的运用。新手的话建议去参透官网的那个todos案例，关于这个案例的事情这里不再赘述了。 21 | 22 | 好了，就写这么多。这个持久的工程总算是到了尾声了。 23 | 24 | 基于这个wechat这个项目，我创建了http://bb-js.org 这样一个可实时交流的社区，也是读者在练习完Backbonejs可以参与社区开发中的一个项目。有兴趣的读者可以在读完本书，向我申请，申请条件是你得了解所有wechat项目的代码，并且知道如何添加新功能。 25 | 26 | 27 | **导航** 28 | 29 | * 上一章 17 `自定义Backbonejs <17-customize-backbonejs-sync.rst>`_ 30 | * 下一章 19 `Backbone资源整理 <19-backbone-js-resource.rst>`_ 31 | -------------------------------------------------------------------------------- /chapters/19-backbone-js-resource.rst: -------------------------------------------------------------------------------- 1 | Backbonejs相关资源 2 | =============================== 3 | 4 | 这次没有参考太多资源，主要还是官方的东西： 5 | 6 | 官网： 7 | http://backbonejs.org/ 8 | 9 | 能让你大概认识backbone.js是什么以及怎么用的网站： 10 | http://backbonetutorials.com/ 11 | 12 | 源码： 13 | https://github.com/jashkenas/backbone/blob/master/backbone.js 14 | 15 | todos代码： 16 | http://backbonejs.org/examples/todos/index.html 17 | 18 | 另外还有几篇中文的博客也不错： 19 | http://weakfi.iteye.com/blog/1391990 20 | 21 | http://blog.csdn.net/soasme/article/details/6581029 22 | 23 | http://www.cnblogs.com/nuysoft/archive/2012/03/19/2404274.html 24 | 25 | 当你对这个东西有一个感觉之后，去看最本质的东西才是王道！ 26 | -------------------------------------------------------------------------------- /chapters/rst_to_md.sh: -------------------------------------------------------------------------------- 1 | FILES=*.rst 2 | for f in $FILES 3 | do 4 | filename="${f%.*}" 5 | echo "Converting $f to $filename.md" 6 | `pandoc $f -f rst -t markdown -o $filename.md` 7 | done 8 | -------------------------------------------------------------------------------- /code/01-hello-backbonejs.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | the5fire.com-backbone.js-Hello World 5 | 6 | 7 | 8 |
    9 |
10 | 更多教程 11 | 12 | 13 | 14 | 51 | 52 | 53 | -------------------------------------------------------------------------------- /code/02-backbonejs-model-server.py: -------------------------------------------------------------------------------- 1 | #coding:utf-8 2 | 3 | __author__ = 'the5fire' 4 | 5 | import json 6 | 7 | import web 8 | from mako.template import Template 9 | 10 | urls = ( 11 | '/', 'index', 12 | '/man/', 'Man', 13 | ) 14 | 15 | class index: 16 | def GET(self): 17 | t = Template(filename='02-backbonejs-model.html', input_encoding='utf-8') 18 | return t.render() 19 | 20 | class Man: 21 | def GET(self): 22 | return json.dumps({"name":"the5fire-server", "age": 10}) 23 | 24 | def POST(self): 25 | data = web.data() 26 | print data 27 | return "success" 28 | 29 | if __name__ == "__main__": 30 | app = web.application(urls, globals()) 31 | app.run() 32 | -------------------------------------------------------------------------------- /code/02-backbonejs-model.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | the5fire-backbone-model 6 | 7 | 8 | 9 | 10 | 11 | 12 | 183 | 184 | 185 | -------------------------------------------------------------------------------- /code/03-backbonejs-collection-server.py: -------------------------------------------------------------------------------- 1 | #coding:utf-8 2 | 3 | __author__ = 'the5fire' 4 | 5 | import json 6 | 7 | import web 8 | from mako.template import Template 9 | 10 | urls = ( 11 | '/', 'index', 12 | '/books/', 'Books', 13 | ) 14 | 15 | class index: 16 | def GET(self): 17 | t = Template(filename='03-backbonejs-collection.html', input_encoding='utf-8') 18 | return t.render() 19 | 20 | class Books: 21 | def GET(self): 22 | result = [] 23 | for i in range(5): 24 | result.append({"title": "book%s" % i}) 25 | #return '' #raise error 26 | return json.dumps(result) 27 | 28 | def POST(self): 29 | data = web.data() 30 | print data 31 | return "success" 32 | 33 | 34 | if __name__ == "__main__": 35 | app = web.application(urls, globals()) 36 | app.run() 37 | -------------------------------------------------------------------------------- /code/03-backbonejs-collection.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | the5fire-backbone-collection 5 | 6 | 7 | 8 | 9 | 10 | 77 | 78 | 79 | -------------------------------------------------------------------------------- /code/04-backbonejs-router.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | the5fire-backbone-router 5 | 6 | 7 | 8 | 9 | 10 | default 11 | Post 120 12 | download gif 13 | Load Route/Action View 14 |
15 | Manual 16 | 51 | 52 | 53 | -------------------------------------------------------------------------------- /code/05-backbonejs-view.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | the5fire-backbone-view 5 | 6 | 7 |
8 | 9 | 10 | 11 | 12 | 13 | 14 | 23 | 24 | 25 | 26 | 93 | 94 | 95 | -------------------------------------------------------------------------------- /code/requirejs-demo/hello-backbonejs-requirejs.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | the5fire.com-backbone.js-Hello World 5 | 6 | 7 | 8 |
    9 |
10 | 更多教程 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /code/requirejs-demo/static/js/app.js: -------------------------------------------------------------------------------- 1 | define(['jquery', 'backbone'], function($, Backbone) { 2 | var World = Backbone.Model.extend({ 3 | //创建一个World的对象，拥有name属性 4 | name: null 5 | }); 6 | 7 | var Worlds = Backbone.Collection.extend({ 8 | //World对象的集合 9 | initialize: function (models, options) { 10 | this.bind("add", options.view.addOneWorld); 11 | } 12 | }); 13 | 14 | var WorldView = Backbone.View.extend({ 15 | el: $("body"), 16 | initialize: function () { 17 | //构造函数，实例化一个World集合类，并且以字典方式传入AppView的对象 18 | this.worlds = new Worlds(null, { view : this }) 19 | }, 20 | events: { 21 | "click #check": "checkIn", //事件绑定，绑定Dom中id为check的元素 22 | }, 23 | checkIn: function (event) { 24 | var world_name = prompt("请问，您是哪星人?"); 25 | if(world_name == "") world_name = '未知'; 26 | var world = new World({ name: world_name }); 27 | this.worlds.add(world); 28 | }, 29 | addOneWorld: function(model) { 30 | $("#world-list").append("
  • 这里是来自 " + model.get('name') + " 星球的问候：hello world！
    • "); 31 | } 32 | }); 33 | return WorldView; 34 | }); 35 | -------------------------------------------------------------------------------- /code/requirejs-demo/static/main.js: -------------------------------------------------------------------------------- 1 | require.config({ 2 | baseUrl: 'static/', 3 | // ref: http://www.ruanyifeng.com/blog/2012/11/require_js.html 4 | shim: { 5 | underscore: { 6 | exports: '_' 7 | }, 8 | backbone: { 9 | deps: [ 10 | 'underscore', 11 | 'jquery' 12 | ], 13 | exports: 'Backbone' 14 | }, 15 | backboneLocalstorage: { 16 | deps: ['backbone'], 17 | exports: 'Store' 18 | } 19 | }, 20 | paths: { 21 | jquery: 'lib/jquery', 22 | underscore: 'lib/underscore', 23 | backbone: 'lib/backbone' 24 | } 25 | }); 26 | 27 | require(['jquery', 'backbone', 'js/app'], function($, Backbone, AppView) { 28 | var appView = new AppView(); 29 | }); 30 | -------------------------------------------------------------------------------- /code/seajs-demo/hello-backbonejs-seajs.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | the5fire.com-backbone.js-Hello World 5 | 6 | 7 | 8 |
      9 |
    10 | 更多教程 11 | 12 | 25 | 26 | 27 | -------------------------------------------------------------------------------- /code/seajs-demo/static/js/app.js: -------------------------------------------------------------------------------- 1 | define(function(require, exports, module) { 2 | var $ = require('jquery'); 3 | var _ = require('underscore'); 4 | var Backbone = require('backbone'); 5 | 6 | var World = Backbone.Model.extend({ 7 | //创建一个World的对象，拥有name属性 8 | name: null 9 | }); 10 | 11 | var Worlds = Backbone.Collection.extend({ 12 | //World对象的集合 13 | initialize: function (models, options) { 14 | this.bind("add", options.view.addOneWorld); 15 | } 16 | }); 17 | 18 | var AppView = Backbone.View.extend({ 19 | el: $("body"), 20 | initialize: function () { 21 | //构造函数，实例化一个World集合类，并且以字典方式传入AppView的对象 22 | this.worlds = new Worlds(null, { view : this }) 23 | }, 24 | events: { 25 | "click #check": "checkIn", //事件绑定，绑定Dom中id为check的元素 26 | }, 27 | checkIn: function (event) { 28 | var world_name = prompt("请问，您是哪星人?"); 29 | if(world_name == "") world_name = '未知'; 30 | var world = new World({ name: world_name }); 31 | this.worlds.add(world); 32 | }, 33 | addOneWorld: function(model) { 34 | $("#world-list").append("
  • 这里是来自 " + model.get('name') + " 星球的问候：hello world！
    • "); 35 | } 36 | }); 37 | 38 | module.exports = AppView; 39 | // module.exports和exports区别参考：https://github.com/seajs/seajs/issues/242 40 | //exports.AppView = AppView; 41 | }); 42 | -------------------------------------------------------------------------------- /code/seajs-demo/static/main.js: -------------------------------------------------------------------------------- 1 | define(function(require) { 2 | var AppView = require('js/app'); 3 | var appView = new AppView(); 4 | }); 5 | -------------------------------------------------------------------------------- /images/backbonejs-cover.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/the5fire/backbonejs-learning-note/6d9147898ca948613ce0d7c6e44dac7fd1b313aa/images/backbonejs-cover.png -------------------------------------------------------------------------------- /images/donate-alipay.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/the5fire/backbonejs-learning-note/6d9147898ca948613ce0d7c6e44dac7fd1b313aa/images/donate-alipay.png -------------------------------------------------------------------------------- /images/login.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/the5fire/backbonejs-learning-note/6d9147898ca948613ce0d7c6e44dac7fd1b313aa/images/login.png -------------------------------------------------------------------------------- /images/message.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/the5fire/backbonejs-learning-note/6d9147898ca948613ce0d7c6e44dac7fd1b313aa/images/message.png -------------------------------------------------------------------------------- /images/topics.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/the5fire/backbonejs-learning-note/6d9147898ca948613ce0d7c6e44dac7fd1b313aa/images/topics.png -------------------------------------------------------------------------------- /images/wechat-arch.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/the5fire/backbonejs-learning-note/6d9147898ca948613ce0d7c6e44dac7fd1b313aa/images/wechat-arch.png -------------------------------------------------------------------------------- /md_chapters/00-preface.md: -------------------------------------------------------------------------------- 1 | 第一版前言 2 | ========== 3 | 4 | **写在前面的话** 5 | 6 | 这一系列的文章写了这么久，也算是告一段落了，为了方便大家查看，制作成PDF格式的放到网上，待有兴趣学习 7 | backbone.js的同学参考。 8 | 9 | 第一次写完一系列的东西，以前有过很多写系列文章的冲动，不过都是写了一段时间就因为一些事放下了，如：设计模式，还有tomcat源码。 10 | 11 | 其实这一系列文章的主要目的还是让初学backbone.js的人，能够快速的把它用到项目上。写backbone的原因是，在我搜索查找关于它的学习资料时，发现中文的资料比较少也比较散，虽然看到有网友在博客上说打算写，但毕竟只是打算，因此 12 | ，我就一边学习 ，一边把里面的东西大概的梳理了一下，写成文章。 13 | 14 | 把这些东西写出来，不是说明我有多厉害，而只是表现我渴望学习、提高、分享。对于这些东西我未必完全掌握，但是我尽量把我知道的东西写出来，分享出去。 15 | 16 | 任何一个人都是从菜鸟慢慢成长起来的，而你成长过程中的所有经历恰恰又是下一代或者说你后面菜鸟所渴望知道的，同时也是对你以后成长大有帮助的。所以不管你觉得自己有多菜，你都应该把你学到的，思考的东西写下来，哪怕只有一点。 17 | 18 | 所有的文章中会有很多不足的地方，你如果发现错误，欢迎到对应的博文链接上拍砖。每篇文章都给了链接，方便大家快速跳转到网页。 19 | 20 | 最后，写上一句话，以显示我的文学水平（表拍砖）：没有开始，怎么会有成长;没有总结，怎么会有收获;没有分享，怎么会有升华。 21 | 22 | 第二版前言 23 | ========== 24 | 25 | 一年前写的东西，当时写完之后工作中用不到也就不再看了，谁想后来越来越多的人通过搜索backbonejs来到我的博客，有表示感谢的，有吐槽的，有帮忙改bug的。在之前接触时只是为了能让代码运行，因此很多实例没有考虑版本问题。在backbonejs更新到1.0.0之后，我的很多代码实例都出现了问题，于是我不得不去更新其中的东西。但是这样一点点的更新总是不能覆盖全面，随想不如在搞个第二版，把之前的坑填上，然后再补充点我新学到的东西，尽可能的让有机会看到这本电子书的人有点收获。 26 | 27 | 说起这一年，学习了angularjs，还没有来得及实践。用backbonejs实践了我博客的手机版:m.the5fire.com功能，比较简陋。 28 | 29 | 在qq群里聊天时@wrongway兄调侃说backbonejs属于远古时期的框架了，关于这一点，相比于angularjs确实显的有些落后。在我看来，两个的思路或者哲学并不相同，backbonejs就如其官网所说提供了一个web应用的结构，而angularjs则是对html的增强。 30 | 31 | 大概就闲扯这么多，总之主要的目的是填上一版的一些坑，然后或许会留下新的坑。 32 | 33 | *后续补充（2014-4-18）*: 34 | 35 | 从去年8月份开始到现在，最初的目的算是完成了。但是随着不断的和正在学习Backbonejs的人交流发现，有些人虽然已经掌握了Backbonejs基本模型、视图以及其他模块的使用，但是却无法把已掌握的内容转化到实际项目中。 36 | 37 | 另外大家也看厌了到处在分析的Todos这个实例，希望看到真实点的项目。虽然对大家看待优秀项目代码的态度不太认同，但我很理解初学者的这种心情------不要给我Demo，我要真实的东西。 38 | 39 | 但真实的东西往往需要太多其他方面的知识，比如我在最后的项目中用到了socket.io来实现实时的交流。这些东西都算是超出Backbonejs这个框架内容之外的。 40 | 41 | 要学习一个东西，和结识一个新的朋友一样。如果你总是站在远处想看风景一般看着他/她，那他/她对你来说只能是风景。对于Backbonejs来说也一样，不要停留在看完书、觉得会用的阶段，拉起Ta的手，一起来做一些东西。 42 | 43 | 基于此，最后的那个项目是打算放到线上来运行的，也让读完本书的读者能有一个地方体验一下你在本书看到的东西，最终是如何转化为被用户可用的网站的。 44 | 45 | :) happy coding 46 | 47 | **导航** 48 | 49 | - 下一章： [01 hello backbonejs](01-hello-backbonejs.rst) 50 | -------------------------------------------------------------------------------- /md_chapters/01-hello-backbonejs.md: -------------------------------------------------------------------------------- 1 | 第一章 Hello Backbonejs 2 | ======================= 3 | 4 | 1.1 基础概念 5 | ------------ 6 | 7 | Backbone，英文意思是：勇气， 8 | 脊骨，但是在程序里面，尤其是在Backbone后面加上后缀js之后，它就变成了一个框架，一个js库。 9 | 10 | Backbone.js，不知道作者是以什么样的目的来对其命名的，可能是希望这个库会成为web端开发中脊梁骨。 11 | 12 | 好了，八卦完了开始正题。 13 | 14 | Backbone.js提供了一套web开发的框架，通过Models进行key-value绑定及自定义事件处理，通过Collections提供一套丰富的API用于枚举功能，通过Views来进行事件处理及与现有的Application通过RESTful 15 | JSON接口进行交互.它是基于jQuery和underscore的一个前端js框架。 16 | 17 | 整体上来说，Backbone.js是一个web端javascript的MVC框架，算是轻量级的框架。它能让你像写Java（后端）代码组织js代码，定义类，类的属性以及方法。更重要的是它能够优雅的把原本无逻辑的javascript代码进行组织，并且提供数据和逻辑相互分离的方法，减少代码开发过程中的数据和逻辑混乱。 18 | 19 | 在Backbonejs有几个重要的概念，先介绍一下:Model，Collection，View，Router。其中Model是根据现实数据建立的抽象，比如人（People）；Collection是Model的一个集合，比如一群人；View是对Model和Collection中数据的展示，把数据渲染（Render）到页面上；Router是对路由的处理，就像传统网站通过url现实不同的页面，在单页面应用（SPA）中通过Router来控制前面说的View的展示。 20 | 21 | 通过Backbone，你可以把你的数据当作Models，通过Models你可以创建数据，进行数据验证，销毁或者保存到服务器上。当界面上的操作引起model中属性的变化时，model会触发change的事件。那些用来显示model状态的views会接受到model触发change的消息，进而发出对应的响应，并且重新渲染新的数据到界面。在一个完整的Backbone应用中，你不需要写那些胶水代码来从DOM中通过特殊的id来获取节点，或者手工的更新HTML页面，因为在model发生变化时，views会很简单的进行自我更新。 22 | 23 | 上面是一个简单的介绍，关于backbone我看完他的介绍和简单的教程之后，第一印象是它为前端开发制定了一套自己的规则，在这个规则下，我们可以像使用django组织python代码一样的组织js代码，它很优雅，能够使前端和server的交互变得简单。 24 | 25 | 在查backbone资料的时候，发现没有很系统的中文入门资料和更多的实例，所以我打算自己边学边实践边写，争取能让大家通过一系列文章能快速的用上Backbone.js。 26 | 27 | 关于backbone的更多介绍参看这个： 28 | 29 | 30 | 31 | 32 | 33 | 1.2 backbone的应用范围： 34 | ------------------------ 35 | 36 | 它虽然是轻量级框架，但是框架这东西也不是随便什么地方都能用的，不然就会出现杀鸡用牛刀，费力不讨好的结果。那么适用在哪些地方呢？ 37 | 38 | 根据我的理解，以及Backbone的功能，如果单个网页上有非常复杂的业务逻辑，那么用它很合适，它可以很容易的操作DOM和组织js代码。 39 | 40 | 豆瓣的阿尔法城是一个极好的例子------纯单页、复杂的前端逻辑。 41 | 42 | 当然，除了我自己分析的应用范围之外，在Backbone的文档上看到了很多使用它的外国站点，有很多，说明Backbonejs还是很易用的。 43 | 44 | 稍稍列一下国内用到Backbonejs的站点： 45 | 46 | *1. 豆瓣阿尔法城* 链接：http://alphatown.com/ 47 | 48 | *2. 豆瓣阅读* 链接：http://read.douban.com/ 主要用在图书的正文页 49 | 50 | *3. 百度开发者中心* 链接：http://developer.baidu.com/ 51 | 52 | *4. 手机搜狐直播间* 链接：http://zhibo.m.sohu.com/ 53 | 54 | *5. OATOS企业网盘* 链接：http://app.oatos.com 55 | 56 | 1.3 学以致用 57 | ------------ 58 | 59 | 现在，我们就要开始学习Backbonejs了，我假设你没有看过我的第一版，那一版有很多很多问题，在博客上也有很多人反馈。但是如果你把那一版看明白了，这新版的教程你可以粗略的浏览一遍，不过后面新补充的实践是要自己写出来、跑起来的。 60 | 61 | 先说我们为什么要学习这新的东西呢？简单说来是为了掌握更加先进的工具。那为什么要掌握先进的工具呢？简单来说就是为了让我们能够以更合理、优雅的方式完成工作，反应到代码上就是让代码变得可维护，易扩展。如果从复杂的方向来说的话，这俩话题都够我写好几天的博客了。 62 | 63 | 学以致用，最直接有效的就是用起来，光学是没用的，尤其是编程这样的实践科学。新手最常犯的一个错误就是喜欢不停的去看书，看过了就以为会了，然后就开始疯狂的学下一本。殊不知看懂和写出来能运行是两种完全不同的状态。因此建议新手------编程新手还是踏踏实实的把代码都敲了，执行了，成功了才是。 64 | 65 | 下面直接给一个简单的Demo出来，用到了Backbonejs的三个主要模块：Views，Collection，Model。通过执行这个例子，了解这个例子的运行过程，快速对要做的东西有一个感觉，然后再逐步击破。 66 | 67 | 1.4 完整DEMO 68 | ------------ 69 | 70 | 这个demo的主要功能是点击页面上得"新手报到"按钮，弹出对话框，输入内容之后，把内容拼上固定的字符串显示到页面上。事件触发的逻辑是： 71 | click 72 | 触发checkIn方法，然后checkIn构造World对象放到已经初始化worlds这个collection中。 73 | 74 | 来看完整的代码: 75 | 76 | 77 | 78 | 79 | the5fire.com-backbone.js-Hello World 80 | 81 | 82 | 83 |
      84 |
    85 | 更多教程 86 | 87 | 88 | 89 | 128 | 129 | 130 | 131 | 这里面涉及到backbone的三个部分，View、Model、Collection，其中Model代表一个数据模型，Collection是模型的一个集合，而View是用来处理页面以及简单的页面逻辑的。 132 | 133 | 动手把代码放到你的编辑器中吧，成功执行，然后修改某个地方，再次尝试。 134 | 135 | **导航** 136 | 137 | - 上一章 [00 前言](00-preface.md) 138 | - 下一章 [02 Backbone中Model实践](02-backbonejs-model.md) 139 | -------------------------------------------------------------------------------- /md_chapters/02-backbonejs-model.md: -------------------------------------------------------------------------------- 1 | 第二章 Backbonejs中的Model实践 2 | ============================== 3 | 4 | 上一章主要是通过简单的代码对Backbonejs做了一个概括的展示，这一章开始从Model层说起，详细解释Backbonejs中的Model这个东西。 5 | 6 | 对于Model这一部分，其官网是这么说的："Model是js应用的核心，包括基础的数据以及围绕着这些数据的逻辑：数据转换、验证、属性计算和访问控制"。这句话基本上高度概括了Model在一个项目中的作用。实际上，不仅仅是js应用，在任何以数据收集和处理的项目中Model都是很重要的一块内容。 7 | 8 | Model这个概念在我的印象中是来自于MVC这个东西，Model在其中的作用，除了是对业务中实体对象的抽象，另外的作用就是做持久化，所谓持久化就是把数据存储到磁盘上------文件形式、数据库形式。在web端也有对应的操作，比如存入LocalStorage，或者Cookie。 9 | 10 | 在web端，Model还有一个重要的功能就是和服务器端进行数据交互，就像是服务器端的程序需要和数据库交互一样。因此Model应该是携带数据流窜于各个模块之间的东西。 11 | 12 | 下面让我们通过一个一个的实例来逐步了解Model。 13 | 14 | 先定义一个页面结构，实践时须在注释的地方填上各小节的代码 15 | 16 | 17 | 18 | 19 | the5fire-backbone-model 20 | 21 | 22 | 23 | 24 | 25 | 26 | 33 | 34 | 35 | 2.1 最简单的对象 36 | ---------------- 37 | 38 | var Man = Backbone.Model.extend({ 39 | initialize: function(){ 40 | alert('Hey, you create me!'); 41 | } 42 | }); 43 | var man = new Man; 44 | 45 | 这个确实很简单了，只是定义了一个最基础的Model，只是实现了initialize这个初始化方法，也称构造函数。这个函数会在Model被实例化时调用。 46 | 47 | 2.2 对象属性赋值的两种方法 48 | -------------------------- 49 | 50 | 第一种，直接定义，设置默认值。 51 | 52 | var Man = Backbone.Model.extend({ 53 | initialize: function(){ 54 | alert('Hey, you create me!'); 55 | }, 56 | defaults: { 57 | name:'张三', 58 | age: '38' 59 | } 60 | }); 61 | 62 | var man = new Man; 63 | alert(man.get('name')); 64 | 65 | 第二种，赋值时定义 66 | 67 | var Man = Backbone.Model.extend({ 68 | initialize: function(){ 69 | alert('Hey, you create me!'); 70 | } 71 | }); 72 | var man = new Man; 73 | man.set({name:'the5fire',age:'10'}); 74 | alert(man.get('name')); 75 | 76 | 从这个对象的取值方式可以知道，属性在一个Model是以字典（或者类似字典）的方式存在的，第一种设定默认值的方式，只不过是实现了Backbone的defaults这个方法，或者是给defaults进行了赋值。 77 | 78 | 2.3 对象中的方法 79 | ---------------- 80 | 81 | var Man = Backbone.Model.extend({ 82 | initialize: function(){ 83 | alert('Hey, you create me!'); 84 | }, 85 | defaults: { 86 | name:'张三', 87 | age: '38' 88 | }, 89 | aboutMe: function(){ 90 | return '我叫' + this.get('name') + ',今年' + this.get('age') + '岁'; 91 | } 92 | }); 93 | var man = new Man; 94 | alert(man.aboutMe()); 95 | 96 | 也是比较简单，只是增加了一个新的属性，值是一个function。说到这，不知道你是否发现，在所有的定义或者赋值操作中，都是通过字典的方式来完成的，比如extend 97 | Backbone的Model，以及定义方法，定义默认值。方法的调用和其他的语言一样，直接 98 | `.` 即可，参数的定义和传递也一样。 99 | 100 | 2.4 监听对象中属性的变化 101 | ------------------------ 102 | 103 | 假设你有在对象的某个属性发生变化时去处理一些业务的话，下面的示例会有帮助。依然是定义那个类，不同的是我们在构造函数中绑定了name属性的change事件。这样当name发生变化时，就会触发这个function。 104 | 105 | var Man = Backbone.Model.extend({ 106 | initialize: function(){ 107 | alert('Hey, you create me!'); 108 | //初始化时绑定监听 109 | this.bind("change:name",function(){ 110 | var name = this.get("name"); 111 | alert("你改变了name属性为：" + name); 112 | }); 113 | }, 114 | defaults: { 115 | name:'张三', 116 | age: '38' 117 | }, 118 | aboutMe: function(){ 119 | return '我叫' + this.get('name') + ',今年' + this.get('age') + '岁'; 120 | } 121 | }); 122 | var man = new Man; 123 | //触发绑定的change事件，alert。 124 | man.set({name:'the5fire'}); 125 | 126 | //触发绑定的change事件，alert。 127 | man.set({name:'the5fire.com'}); 128 | 129 | 2.5 为对象添加验证规则，以及错误提示 130 | ------------------------------------ 131 | 132 | var Man = Backbone.Model.extend({ 133 | initialize: function(){ 134 | alert('Hey, you create me!'); 135 | //初始化时绑定监听, change事件会先于validate发生 136 | this.bind("change:name",function(){ 137 | var name = this.get("name"); 138 | alert("你改变了name属性为：" + name); 139 | }); 140 | this.bind("invalid",function(model,error){ 141 | alert(error); 142 | }); 143 | }, 144 | defaults: { 145 | name:'张三', 146 | age: '38' 147 | }, 148 | validate:function(attributes){ 149 | if(attributes.name == '') { 150 | return "name不能为空！"; 151 | } 152 | }, 153 | aboutMe: function(){ 154 | return '我叫' + this.get('name') + ',今年' + this.get('age') + '岁'; 155 | } 156 | }); 157 | var man = new Man; 158 | // 这种方式添加错误处理也行 159 | // man.on('invalid', function(model, error){ 160 | // alert(error); 161 | // }); 162 | 163 | //默认set时不进行验证 164 | man.set({name:''}); 165 | //手动触发验证, set时会触发 166 | //man.set({name:''}, {'validate':true}); 167 | //save时触发验证。根据验证规则，弹出错误提示。 168 | man.save(); 169 | 170 | 2.6 和服务器进行交互，对象的保存和获取 171 | -------------------------------------- 172 | 173 | 首先需要声明的是，这个例子需要后端配合，可以在 [code] 目录中找到对应的py文件，需要webpy和mako这两个库。 174 | 这里需要为对象定义一个url属性，调用save方法时会post对象的所有属性到server端，调用fetch方法是又会发送get请求到server端。接受数据和发送数据均为json格式: 175 | 176 | var Man = Backbone.Model.extend({ 177 | url:'/man/', 178 | initialize: function(){ 179 | alert('Hey, you create me!'); 180 | //初始化时绑定监听 181 | this.bind("change:name",function(){ 182 | var name = this.get("name"); 183 | alert("你改变了name属性为：" + name); 184 | }); 185 | this.bind("error",function(model,error){ 186 | alert(error); 187 | }); 188 | }, 189 | defaults: { 190 | name:'张三', 191 | age: '38' 192 | }, 193 | validate:function(attributes){ 194 | if(attributes.name == '') { 195 | return "name不能为空！"; 196 | } 197 | }, 198 | aboutMe: function(){ 199 | return '我叫' + this.get('name') + ',今年' + this.get('age') + '岁'; 200 | } 201 | }); 202 | var man = new Man;; 203 | man.set({name:'the5fire'}); 204 | 205 | //会发送POST到模型对应的url，数据格式为json{"name":"the5fire","age":38} 206 | man.save(); 207 | 208 | //然后接着就是从服务器端获取数据使用方法fetch([options]) 209 | var man1 = new Man; 210 | //第一种情况，如果直接使用fetch方法， 211 | //那么他会发送get请求到你model的url中， 212 | //你在服务器端可以通过判断是get还是post来进行对应的操作。 213 | man1.fetch(); 214 | //第二种情况，在fetch中加入参数，如下： 215 | man1.fetch({url:'/man/'}); 216 | //这样，就会发送get请求到/getmans/这个url中， 217 | //服务器返回的结果样式应该是对应的json格式数据，同save时POST过去的格式。 218 | 219 | //不过接受服务器端返回的数据方法是这样的： 220 | man1.fetch({url:'/man/', 221 | success:function(model,response){ 222 | alert('success'); 223 | //model为获取到的数据 224 | alert(model.get('name')); 225 | },error:function(){ 226 | //当返回格式不正确或者是非json数据时，会执行此方法 227 | alert('error'); 228 | } 229 | }); 230 | 231 | 还有一点值得一提的是关于url和urlRoot的事情了，如果你设置了url，那么你的CRUD都会发送对应请求到这个url上，但是这样有一个问题，就是delete请求，发送了请求，但是却没有发送任何数据，那么你在服务器端就不知道应该删除哪个对象（记录），所以这里又一个urlRoot的概念，你设置了urlRoot之后，你发送PUT和DELETE请求的时候，其请求的url地址就是：/baseurl/[model.id]，这样你就可以在服务器端通过对url后面值的提取更新或者删除对应的对象（记录） 232 | 233 | 补充一点，就是关于服务器的异步操作都是通过Backbone.sync这个方法来完成的，调用这个方法的时候会自动的传递一个参数过去，根据参数向服务器端发送对应的请求。比如你save，backbone会判断你的这个对象是不是新的，如果是新创建的则参数为create，如果是已存在的对象只是进行了改变，那么参数就为update，如果你调用fetch方法，那参数就是read，如果是destory，那么参数就是delete。也就是所谓的CRUD 234 | (\"create\", \"read\", \"update\", or 235 | \"delete\")，而这四种参数对应的请求类型为POST，GET，PUT，DELETE。你可以在服务器根据这个request类型，来做出相应的CRUD操作。 236 | 237 | 关于Backbone.sync在后面会有如何自定义这一部分的章节。 238 | 239 | 上面服务器端的代码在 `code` 下可以找到，基于webpy和mako的。 240 | 241 | **导航** 242 | 243 | - 上一章 01 [Hello Backbonejs](01-hello-backbonejs.md) 244 | - 下一章 03 [Backbonejs中的Collections实践](03-backbonejs-collection.md) 245 | -------------------------------------------------------------------------------- /md_chapters/03-backbonejs-collection.md: -------------------------------------------------------------------------------- 1 | 第三章 Backbonejs中的Collections实践 2 | ==================================== 3 | 4 | 上一节介绍了model的使用，model算是对现实中某一物体的抽象，比如你可以定义一本书的model，具有书名（title）还有书页（page\_num)等属性。仅仅用一个Model是不足以呈现现实世界的内容，因此基于Model，这节我们来看collection。collection是model对象的一个有序的集合，也可以理解为是model的容器。概念理解起来十分简单，在通过几个例子来看一下，会觉得更容易理解。 5 | 6 | 3.1 关于book和bookshelf的例子 7 | ----------------------------- 8 | 9 | var Book = Backbone.Model.extend({ 10 | 11 | defaults : { 12 | title:'default' 13 | }, 14 | 15 | initialize: function(){ 16 | //alert('Hey, you create me!'); 17 | } 18 | 19 | }); 20 | 21 | var BookShelf = Backbone.Collection.extend({ 22 | model : Book 23 | }); 24 | 25 | var book1 = new Book({title : 'book1'}); 26 | var book2 = new Book({title : 'book2'}); 27 | var book3 = new Book({title : 'book3'}); 28 | 29 | //注意这里面是数组,或者使用add 30 | //var bookShelf = new BookShelf([book1, book2, book3]); 31 | 32 | var bookShelf = new BookShelf; 33 | 34 | bookShelf.add(book1); 35 | bookShelf.add(book2); 36 | bookShelf.add(book3); 37 | bookShelf.remove(book3); 38 | 39 | 40 | //基于underscore这个js库，还可以使用each的方法获取collection中的数据 41 | 42 | bookShelf.each(function(book){ 43 | alert(book.get('title')); 44 | }); 45 | 46 | 很容易理解吧。 47 | 48 | 3.2 使用fetch从服务器端获取数据 49 | ------------------------------- 50 | 51 | 首先要在上面的的Bookshelf中定义url，注意collection中并没有urlRoot这个属性。或者你直接在fetch方法中定义url的值，如下： 52 | 53 | //注意这里 54 | bookShelf.url = '/books/'; 55 | bookShelf.fetch({ 56 | success:function(collection, response, options){ 57 | collection.each(function(book){ 58 | alert(book.get('title')); 59 | }); 60 | },error:function(collection, response, options){ 61 | alert('error'); 62 | } 63 | }); 64 | 65 | 其中也定义了两个接受返回值的方法，具体含义我想很容易理解，返回正确格式(json)的数据，就会调用success方法，错误格式的数据就会调用error方法，当然error方法也看添加和success方法一样的形参。 66 | 67 | 对应的BookShelf的返回格式如下：``[{'title':'book0'},{'title':'book1'}....]`` 68 | 69 | 3.3 reset方法 70 | ------------- 71 | 72 | 使用这个方法的时候是要和上面的fetch进行配合的，collection在fetch到数据之后，默认情况会调用set方法(set方法向collection里面添加新model，如果该model之前存在则会合并，与此同时会触发collection的add事件)，可以通过参数{reset: 73 | true}来手动触发reset，reset会整个清空collection重新添加所有model。这时你就需要在collection中定义reset方法或者是绑定reset方法。这里使用绑定演示： 74 | 75 | var showAllBooks = function(){ 76 | bookShelf.each(function(book){ 77 | //将book数据渲染到页面的操作。 78 | document.writeln(book.get('title')); 79 | }); 80 | } 81 | 82 | bookShelf.bind('reset',showAllBooks); 83 | bookShelf.url = '/books/'; //注意这里 84 | bookShelf.fetch({ 85 | // 需要主动传递reset，才会触发reset 86 | reset: true, 87 | success:function(collection, response, options){ 88 | collection.each(function(book){ 89 | alert(book.get('title')); 90 | }); 91 | },error:function(collection, response, options){ 92 | alert('error'); 93 | } 94 | }); 95 | 96 | 绑定的步骤要在fetch之前进行。 97 | 98 | 3.4 发送数据到Server端 99 | ---------------------- 100 | 101 | 创建数据，其实就是调用collection的create方法，POST对应的Model对象（json数据）到配置好的url上。之后会返回一个model的实例，如下面代码中的onebook。 102 | 103 | var NewBooks = Backbone.Collection.extend({ 104 | model: Book, 105 | url: '/books/' 106 | }); 107 | 108 | var books = new NewBooks; 109 | 110 | var onebook = books.create({ 111 | title: "I'm coming", 112 | }); 113 | 114 | 完整代码可以在 [code] 中找到, 服务器端的代码后面会介绍。 115 | 116 | **导航** 117 | 118 | - 上一章 02 [Backbone中Model实践](02-backbonejs-model.md) 119 | - 下一章 04 [Backbonejs中的Router实践](04-backbonejs-router.md) 120 | -------------------------------------------------------------------------------- /md_chapters/04-backbonejs-router.md: -------------------------------------------------------------------------------- 1 | 第四章 Backbonejs中的Router实践 2 | =============================== 3 | 4 | 前面介绍了Model和Collection，基本上属于程序中静态的数据部分。这一节介绍Backbone中的router，属于动态的部分，见名知意，router------路由的意思，显然是能够控制url指向哪个函数的。具体是怎么做的一会通过几个实例来看看。 5 | 6 | 在现在的单页应用中，所有的操作、内容都在一个页面上呈现，这意味着浏览器的url始终要定位到当前页面。那么一个页面中的左右的操作总不能都通过事件监听来完成，尤其是对于需要切换页面的场景以及需要分享、收藏固定链接的情况。因此就有了router，通过hash的方式（即\#page）来完成。不过随着浏览器发展，大多数的浏览器已经可以通过history 7 | api来操控url的改变，可以直接使用 /page 8 | 来完成之前需要hash来完成的操作，这种方式看起来更为直观一些。下面提供过几个demo来切实体会一番。 9 | 10 | 4.1 一个简单的例子 11 | ------------------ 12 | 13 | var AppRouter = Backbone.Router.extend({ 14 | routes: { 15 | "*actions" : "defaultRoute" 16 | }, 17 | 18 | defaultRoute : function(actions){ 19 | alert(actions); 20 | } 21 | }); 22 | 23 | var app_router = new AppRouter; 24 | 25 | Backbone.history.start(); 26 | 27 | 需要通过调用Backbone.history.start()方法来初始化这个Router。 28 | 29 | 在页面上需要有这样的a标签： 30 | 31 | testActions 32 | 33 | 点击该链接时，便会触发defaultRouter这个方法。 34 | 35 | 4.2 这个routes映射要怎么传参数 36 | ------------------------------ 37 | 38 | 看下面例子，立马你就知道了 39 | 40 | var AppRouter = Backbone.Router.extend({ 41 | 42 | routes: { 43 | "posts/:id" : "getPost", 44 | "*actions" : "defaultRoute" 45 | }, 46 | 47 | getPost: function(id) { 48 | alert(id); 49 | }, 50 | 51 | defaultRoute : function(actions){ 52 | alert(actions); 53 | } 54 | }); 55 | 56 | var app_router = new AppRouter; 57 | Backbone.history.start(); 58 | 59 | 对应的页面上应该有一个超链接： 60 | 61 | Post 120 62 | 63 | 从上面已经可以看到匹配\#标签之后内容的方法，有两种：一种是用":"来把\#后面的对应的位置作为参数；还有一种是"\*"，它可以匹配所有的url，下面再来演练一下。 64 | 65 | var AppRouter = Backbone.Router.extend({ 66 | 67 | routes: { 68 | "posts/:id" : "getPost", 69 | //下面对应的链接为download gif 70 | "download/*path": "downloadFile", 71 | //下面对应的链接为Load Route/Action View 72 | ":route/:action": "loadView", 73 | "*actions" : "defaultRoute" 74 | }, 75 | 76 | getPost: function(id) { 77 | alert(id); 78 | }, 79 | 80 | defaultRoute : function(actions){ 81 | alert(actions); 82 | }, 83 | 84 | downloadFile: function( path ){ 85 | alert(path); // user/images/hey.gif 86 | }, 87 | 88 | loadView: function( route, action ){ 89 | alert(route + "_" + action); // dashboard_graph 90 | } 91 | 92 | }); 93 | 94 | var app_router = new AppRouter; 95 | Backbone.history.start(); 96 | 97 | 4.3 手动触发router 98 | ------------------ 99 | 100 | 上面的例子都是通过页面点击触发router到对应的方法上，在实际的使用中，还存在一种场景就是需要在某一个逻辑中触发某一个事件，就像是jQuery中得trigger一样，下面的代码展示怎么手动触发router。 101 | 102 | routes: { 103 | "posts/:id" : "getPost", 104 | "manual": "manual", 105 | "*actions": "defaultRoute", 106 | }, 107 | // 省略部分代码 108 | loadView: function( route, action ){ 109 | alert(route + "_" + action); // dashboard_graph 110 | }, 111 | manual: function() { 112 | alert("call manual"); 113 | app_router.navigate("/posts/" + 404, {trigger: true, replace: true}); 114 | } 115 | 116 | 对应着在页面添加一个a标签： `manual` 117 | 然后点击这个链接，便会触发posts/:id对应的方法。 118 | 119 | 这里需要解释的是navigate后面的两个参数。trigger表示触发事件，如果为false，则只是url变化，并不会触发事件，replace表示url替换，而不是前进到这个url，意味着启用该参数，浏览器的history不会记录这个变动。 120 | 121 | 完整代码依然在 `code` 中可以找到。 122 | 123 | **导航** 124 | 125 | - 上一章 03 [Backbonejs中的Collections实践](03-backbonejs-collection.md) 126 | - 下一章 05 [Backbonejs中的View实践](05-backbonejs-view.md) 127 | -------------------------------------------------------------------------------- /md_chapters/05-backbonejs-view.md: -------------------------------------------------------------------------------- 1 | 第五章 Backbonejs中的View实践 2 | ============================= 3 | 4 | 前面介绍了存放数据的Model和Collection以及对用户行为进行路由分发的Router（针对链接）。这一节终于可以往页面上放点东西来玩玩了。这节就介绍了Backbone中得View这个模块。Backbone的View是用来显示你的model中的数据到页面的，同时它也可用来监听DOM上的事件然后做出响应。但是这里要提一句的是，相比于Angularjs中model变化之后页面数据自动变化的特性，Backbone要手动来处理。至于这两种方式的对比，各有优劣，可以暂时不关心。 5 | 6 | 下面依然是通过几个示例来介绍下view的功能,首先给出页面的基本模板： 7 | 8 | 9 | 10 | 11 | the5fire-backbone-view 12 | 13 | 14 |
    15 | 16 | 21 | 22 | 23 | 24 | 29 | 30 | 31 | 32 | 5.1 一个简单的view 33 | ------------------ 34 | 35 | var SearchView = Backbone.View.extend({ 36 | initialize: function(){ 37 | alert('init a SearchView'); 38 | } 39 | }); 40 | var searchView = new SearchView(); 41 | 42 | 是不是觉得很没有技术含量，所有的模块定义都一样。 43 | 44 | 5.2 el属性 45 | ---------- 46 | 47 | 这个属性用来引用DOM中的某个元素，每一个Backbone的view都会有这么个属性，如果没有显示声明，Backbone会默认的构造一个，表示一个空的div元素。el标签可以在定义view的时候在属性中声明，也可以在实例化view的时候通过参数传递。 48 | 49 | var SearchView = Backbone.View.extend({ 50 | initialize: function(){ 51 | alert('init a SearchView'); 52 | } 53 | }); 54 | 55 | var searchView = new SearchView({el: $("#search_container")}); 56 | 57 | 这段代码简单的演示了在实例化的时候传递el属性给View。下面我们来看看模板的渲染。 58 | 59 | var SearchView = Backbone.View.extend({ 60 | initialize: function(){ 61 | }, 62 | render: function(context) { 63 | //使用underscore这个库，来编译模板 64 | var template = _.template($("#search_template").html()); 65 | //加载模板到对应的el属性中 66 | $(this.el).html(template(context)); 67 | } 68 | }); 69 | var searchView = new SearchView({el: $("#search_container")}); 70 | 71 | //这个reander的方法可以放到view的构造函数中 72 | //这样初始化时就会自动渲染 73 | searchView.render({search_label: "搜索渲染"}); 74 | 75 | 运行页面之后，会发现script模板中的html代码已经添加到了我们定义的div中。 76 | 77 | *这里面需要注意的是在模板中定义的所有变量必须在render的时候传递参数过去，不然就会报错。* 78 | 关于el还有一个东西叫做\$el,这个东西是对view中元素的缓存。 79 | 80 | 5.3 再来看view中event的使用 81 | --------------------------- 82 | 83 | 页面上的操作除了可以由之前的router来处理之外，在一个view中定义元素，还可以使用event来进行事件绑定。这里要注意的是在view中定义的dom元素是指你el标签所定义的那一部分dom节点，event进行事件绑定时会在该节点范围内查找。 84 | 85 | 来，继续看代码。 86 | 87 | var SearchView = Backbone.View.extend({ 88 | el: "#search_container", 89 | 90 | initialize: function(){ 91 | this.render({search_label: "搜索按钮"}); 92 | }, 93 | render: function(context) { 94 | //使用underscore这个库，来编译模板 95 | var template = _.template($("#search_template").html()); 96 | //加载模板到对应的el属性中 97 | $(this.el).html(template(context)); 98 | }, 99 | 100 | events:{ //就是在这里绑定的 101 | //定义类型为button的input标签的点击事件，触发函数doSearch 102 | 'click input[type=button]' : 'doSearch' 103 | 104 | }, 105 | 106 | doSearch: function(event){ 107 | alert("search for " + $("#search_input").val()); 108 | } 109 | 110 | }); 111 | 112 | var searchView = new SearchView(); 113 | 114 | 自己运行下，是不是比写``$("input[type=button]").bind('click',function(){})``好看多了。 115 | 116 | 5.4 View中的模板 117 | ---------------- 118 | 119 | 上面已经简单的演示了模板的用法，如果你用过django模板的话，你会发现模板差不多都是那么回事。上面只是简单的单个变量的渲染，那么逻辑部分怎么处理呢，下面来看下。 120 | 121 | 把最开始定义的模板中的内容换成下面这个。 122 | 123 |
      124 | <% _.each(labels, function(name) { %> 125 | <% if(name != "label2") {%> 126 |
    • <%= name %>
      • 127 | <% } %> 128 | <% }); %> 129 |
    130 | 131 | 下面是js代码 132 | 133 | var SearchView = Backbone.View.extend({ 134 | el: "#search_container", 135 | 136 | initialize: function(){ 137 | var labels = ['label1', 'label2', 'label3']; 138 | this.render({labels: labels}); 139 | }, 140 | 141 | render: function(context) { 142 | //使用underscore这个库，来编译模板 143 | var template = _.template($("#search_template").html()); 144 | //加载模板到对应的el属性中 145 | $(this.el).html(template(context)); 146 | }, 147 | 148 | }); 149 | 150 | var searchView = new SearchView(); 151 | 152 | 再次运行，有木有觉得还不错，模板中使用的就基本的js语法。 153 | 154 | 总结一下，关于view中的东西就介绍这么多，文档上还有几个其他的属性，不过大体用法都一致。在以后的实践中用到在介绍。 155 | 156 | **导航** 157 | 158 | - 上一章 04 [Backbonejs中的Router实践](04-backbonejs-router.md) 159 | - 下一章 06 [实战演练：todos分析（一）](06-backbonejs-todos-1.md) 160 | -------------------------------------------------------------------------------- /md_chapters/06-backbonejs-todos-1.md: -------------------------------------------------------------------------------- 1 | 第六章 实战演练：todos分析（一） 2 | ================================ 3 | 4 | 经过前面的几篇文章，Backbone中的Model, 5 | Collection，Router，View，都简单的介绍了一下，我觉得看完这几篇文章，差不多就能开始使用Backbone来做东西了，所有的项目无外乎对这几个模块的使用。不过对于实际项目经验少些的同学，要拿起来用估计会有些麻烦。因此这里就先找个现成的案例分析一下。 6 | 7 | 6.1 大家都来分析todos 8 | --------------------- 9 | 10 | 关于Backbonejs实例分析的文章网上真是一搜一大把，之所以这么多，第一是这东西需求简单，不用花时间到理解情景中；第二是代码就是官方的案例，顺手可得，也省得去找了，自己琢磨一个不得花时间吗。 11 | 12 | 于是就有人问了，丫们都在分析todos，能不能有点新意呢。这问题要我说，如果你真的能把todos搞明白了，那其他的也就不用去看了。不管是看谁的分析，把这个搞明白的。所有的项目大体思路都差不多。尤其是对于这样的MVC的模型，就是往对应的模块里填东西。因此，不管有多少人都在分析这玩意，自己弄懂了才是应该关心的。 13 | 14 | 话虽如此，不同于网络上的绝大部分的分析的是，the5fire除了分析这个，还是对其进行了扩充，另外在后面也会有真实的案例。但我也是从这些案例的代码中汲取的营养。 15 | 16 | 补充一下，新版的todos代码相较于之前简直清晰太多，完全可以当做一个前端的范本来学习、模仿。 17 | 18 | 6.2 获取代码 19 | ------------ 20 | 21 | todos的代码这里下载：https://github.com/jashkenas/backbone/ 22 | ，建议自己clone一份到本地。线上的地址是：http://backbonejs.org/examples/todos/index.html 23 | 24 | clone下来之后可以在example中找到todos文件夹，文件结构如下：: 25 | 26 | examples 27 | ├── backbone.localStorage.js 28 | └── todos 29 | ├── destroy.png 30 | ├── index.html 31 | ├── todos.css 32 | └── todos.js 33 | 34 | 1 directory, 5 files 35 | 36 | 用浏览器打开index.html文件，推荐使用chome浏览器，就可以看到和官网一样的界面了。关键代码都在todos.js这个文件里。 37 | 38 | 6.3 功能分析 39 | ------------ 40 | 41 | 首先来分析下页面上有哪些功能: 42 | 43 | ![image](http://the5fireblog.b0.upaiyun.com/staticfile/todos.png) 44 | 45 | 从这个界面我们可以总结出来,下面这些功能: 46 | 47 | * 任务管理 48 | 添加任务 49 | 修改任务 50 | 删除任务 51 | * 统计 52 | 任务总计 53 | 已完成数目 54 | 55 | 总体上就这几个功能。 56 | 57 | 这个项目仅仅是在web端运行的，没有服务器进行支持，因此在项目中使用了一个叫做backbone-localstorage的js库，用来把数据存储到前端。 58 | 59 | 6.4 从模型下手 60 | -------------- 61 | 62 | 因为Backbone为MVC模式，根据对这种模式的使用经验，我们从模型开始分析。首先我们来看Model部分的代码: 63 | 64 | /** 65 | *基本的Todo模型，属性为：title,order,done。 66 | **/ 67 | var Todo = Backbone.Model.extend({ 68 | // 设置默认的属性 69 | defaults: { 70 | title: "empty todo...", 71 | order: Todos.nextOrder(), 72 | done: false 73 | }, 74 | 75 | // 设置任务完成状态 76 | toggle: function() { 77 | this.save({done: !this.get("done")}); 78 | } 79 | }); 80 | 81 | 这段代码是很好理解的，不过我依然是画蛇添足的加上了一些注释。这个Todo显然就是对应页面上的每一个任务条目。那么显然应该有一个collection来统治（管理）所有的任务，所以再来看collection： 82 | 83 | /** 84 | *Todo的一个集合，数据通过localStorage存储在本地。 85 | **/ 86 | 87 | var TodoList = Backbone.Collection.extend({ 88 | 89 | // 设置Collection的模型为Todo 90 | model: Todo, 91 | //存储到浏览器，以todos-backbone命名的空间中 92 | //此函数为Backbone插件提供 93 | //地址：https://github.com/jeromegn/Backbone.localStorage 94 | localStorage: new Backbone.LocalStorage("todos-backbone"), 95 | 96 | //获取所有已经完成的任务数组 97 | done: function() { 98 | return this.where({done: true}); 99 | }, 100 | 101 | //获取任务列表中未完成的任务数组 102 | //这里的where在之前是没有的，但是语法上更清晰了 103 | //参考文档：http://backbonejs.org/#Collection-where 104 | remaining: function() { 105 | return this.where({done: false}); 106 | }, 107 | 108 | //获得下一个任务的排序序号，通过数据库中的记录数加1实现。 109 | nextOrder: function() { 110 | if (!this.length) return 1; 111 | 112 | // last获取collection中最后一个元素 113 | return this.last().get('order') + 1; 114 | }, 115 | 116 | //Backbone内置属性，指明collection的排序规则。 117 | comparator: 'order' 118 | }); 119 | 120 | collection的主要功能有以下几个：: 121 | 122 | 1、获取完成的任务; 123 | 2、获取未完成的任务; 124 | 3、获取下一个要插入数据的序号; 125 | 4、按序存放Todo对象。 126 | 127 | 如果你看过第一版的话，这里Backbone新的属性和方法(comparator和where)用起来更加符合语义了。 128 | 129 | 这篇文章先分析到这里，下篇文章继续分析。 130 | 131 | **导航** 132 | 133 | - 上一章 05 [Backbonejs中的View实践](05-backbonejs-view.md) 134 | - 下一章 07 [实战演练：todos分析（二）View的应用](07-backbonejs-todos-2.md) 135 | -------------------------------------------------------------------------------- /md_chapters/07-backbonejs-todos-2.md: -------------------------------------------------------------------------------- 1 | 第七章 实战演练：todos分析（二）View的应用 2 | ========================================== 3 | 4 | 在上一篇文章中我们把todos这个实例的数据模型进行了简单的分析，有关于数据模型的操作也都知道了。接着我们来看剩下的两个view的模型，以及它们对页面的操作。 5 | 6 | 7.1 为什么要两个view 7 | -------------------- 8 | 9 | 首先要分析下，这俩view是用来干嘛的。有人可能会问了，这里不就是一个页面吗？一个view掌控全局不就完了？ 10 | 11 | 我觉得这就是新手和老手的主要区别之一，喜欢在一个方法里面搞定一切，喜欢把东西都拧到一块去，觉得这样看起来容易。熟不知，这样的代码对于日后的扩展会造成很大的麻烦。因此我们需要学习下优秀的设计，从好的代码中汲取营养。 12 | 13 | 这里面的精华就是，将对数据的操作和对页面的操作进行分离，也就是现在代码里面TodoView和AppView。前者的作用是对把Model中的数据渲染到模板中;后者是对已经渲染好的数据进行处理。两者各有分工，TodoView可以看做是加工后的数据，这个数据就是待使用的html数据。 14 | 15 | 7.2 TodoView的代码分析 16 | ---------------------- 17 | 18 | TodoView是和Model一对一的关系，在页面上一个View也就展示为一个item。除此之外，每个view上还有其他的功能，比如编辑模式，展示模式，还有对用户的输入的监听。详细还是来看下代码： 19 | 20 | // 首先是创建一个全局的Todo的collection对象 21 | 22 | var Todos = new TodoList; 23 | 24 | // 先来看TodoView，作用是控制任务列表 25 | var TodoView = Backbone.View.extend({ 26 | 27 | //下面这个标签的作用是，把template模板中获取到的html代码放到这标签中。 28 | tagName: "li", 29 | 30 | // 获取一个任务条目的模板,缓存到这个属性上。 31 | template: _.template($('#item-template').html()), 32 | 33 | // 为每一个任务条目绑定事件 34 | events: { 35 | "click .toggle" : "toggleDone", 36 | "dblclick .view" : "edit", 37 | "click a.destroy" : "clear", 38 | "keypress .edit" : "updateOnEnter", 39 | "blur .edit" : "close" 40 | }, 41 | 42 | //在初始化时设置对model的change事件的监听 43 | //设置对model的destroy的监听，保证页面数据和model数据一致 44 | initialize: function() { 45 | this.listenTo(this.model, 'change', this.render); 46 | //这个remove是view的中的方法，用来清除页面中的dom 47 | this.listenTo(this.model, 'destroy', this.remove); 48 | }, 49 | 50 | // 渲染todo中的数据到 item-template 中，然后返回对自己的引用this 51 | render: function() { 52 | this.$el.html(this.template(this.model.toJSON())); 53 | this.$el.toggleClass('done', this.model.get('done')); 54 | this.input = this.$('.edit'); 55 | return this; 56 | }, 57 | 58 | // 控制任务完成或者未完成 59 | toggleDone: function() { 60 | this.model.toggle(); 61 | }, 62 | 63 | // 修改任务条目的样式 64 | edit: function() { 65 | $(this.el).addClass("editing"); 66 | this.input.focus(); 67 | }, 68 | 69 | // 关闭编辑模式，并把修改内容同步到Model和界面 70 | close: function() { 71 | var value = this.input.val(); 72 | if (!value) { 73 | //无值内容直接从页面清除 74 | this.clear(); 75 | } else { 76 | this.model.save({title: value}); 77 | this.$el.removeClass("editing"); 78 | } 79 | }, 80 | 81 | // 按下回车之后，关闭编辑模式 82 | updateOnEnter: function(e) { 83 | if (e.keyCode == 13) this.close(); 84 | }, 85 | 86 | // 移除对应条目，以及对应的数据对象 87 | clear: function() { 88 | this.model.destroy(); 89 | } 90 | }); 91 | 92 | 7.3 AppView的代码分析 93 | --------------------- 94 | 95 | 再来看AppView，功能是显示所有任务列表，显示整体的列表状态（如：完成多少，未完成多少） 96 | 97 | //以及任务的添加。主要是整体上的一个控制 98 | var AppView = Backbone.View.extend({ 99 | 100 | //绑定页面上主要的DOM节点 101 | el: $("#todoapp"), 102 | 103 | // 在底部显示的统计数据模板 104 | statsTemplate: _.template($('#stats-template').html()), 105 | 106 | // 绑定dom节点上的事件 107 | events: { 108 | "keypress #new-todo": "createOnEnter", 109 | "click #clear-completed": "clearCompleted", 110 | "click #toggle-all": "toggleAllComplete" 111 | }, 112 | 113 | //在初始化过程中，绑定事件到Todos上， 114 | //当任务列表改变时会触发对应的事件。 115 | //最后从localStorage中fetch数据到Todos中。 116 | initialize: function() { 117 | this.input = this.$("#new-todo"); 118 | this.allCheckbox = this.$("#toggle-all")[0]; 119 | 120 | this.listenTo(Todos, 'add', this.addOne); 121 | this.listenTo(Todos, 'reset', this.addAll); 122 | this.listenTo(Todos, 'all', this.render); 123 | 124 | this.footer = this.$('footer'); 125 | this.main = $('#main'); 126 | 127 | Todos.fetch(); 128 | }, 129 | 130 | // 更改当前任务列表的状态 131 | render: function() { 132 | var done = Todos.done().length; 133 | var remaining = Todos.remaining().length; 134 | 135 | if (Todos.length) { 136 | this.main.show(); 137 | this.footer.show(); 138 | this.footer.html(this.statsTemplate({done: done, remaining: remaining})); 139 | } else { 140 | this.main.hide(); 141 | this.footer.hide(); 142 | } 143 | 144 | //根据剩余多少未完成确定标记全部完成的checkbox的显示 145 | this.allCheckbox.checked = !remaining; 146 | }, 147 | 148 | // 添加一个任务到页面id为todo-list的div/ul中 149 | addOne: function(todo) { 150 | var view = new TodoView({model: todo}); 151 | this.$("#todo-list").append(view.render().el); 152 | }, 153 | 154 | // 把Todos中的所有数据渲染到页面,页面加载的时候用到 155 | addAll: function() { 156 | Todos.each(this.addOne, this); 157 | }, 158 | 159 | //生成一个新Todo的所有属性的字典 160 | newAttributes: function() { 161 | return { 162 | title this.input.val(), 163 | order: Todos.nextOrder(), 164 | done: false 165 | }; 166 | }, 167 | 168 | //创建一个任务的方法，使用backbone.collection的create方法。 169 | //将数据保存到localStorage,这是一个html5的js库。 170 | //需要浏览器支持html5才能用。 171 | createOnEnter: function(e) { 172 | if (e.keyCode != 13) return; 173 | if (!this.input.val()) return; 174 | 175 | //创建一个对象之后会在backbone中动态调用Todos的add方法 176 | //该方法已绑定addOne。 177 | Todos.create({title: this.input.val()}); 178 | this.input.val(''); 179 | }, 180 | 181 | //去掉所有已经完成的任务 182 | clearCompleted: function() { 183 | // 调用underscore.js中的invoke方法 184 | //对过滤出来的todos调用destroy方法 185 | _.invoke(Todos.done(), 'destroy'); 186 | return false; 187 | }, 188 | 189 | //处理页面点击标记全部完成按钮 190 | //处理逻辑： 191 | // 如果标记全部按钮已选，则所有都完成 192 | // 如果未选，则所有的都未完成。 193 | toggleAllComplete: function () { 194 | var done = this.allCheckbox.checked; 195 | Todos.each(function (todo) { todo.save({'done': done}); }); 196 | } 197 | }); 198 | 199 | 通过上面的代码，以及其中的注释，我们认识里面每个方法的作用。下面来看最重要的，页面部分。 200 | 201 | 7.4 页面模板分析 202 | ---------------- 203 | 204 | 在前几篇的view介绍中我们已经认识过了简单的模板使用，以及变量参数的传递，如： 205 | 206 | 213 | 214 | 既然能定义变量，那么就能使用语法，如同django模板，那来看下带有语法的模板，也是上面的两个view用到的模板，我想这个是很好理解的。 215 | 216 | 224 | 225 | 226 | 232 | 233 | 简单的语法，上面的那个对应TodoView。有木有觉得比之前的那一版简洁太多了，有木有！！啥叫代码的美感，对比一下就知道了。 234 | 235 | 这一篇文章就先到此为止，文章中我们了解到在todos这个实例中，view的使用，以及具体的TodoView和AppView中各个函数的作用，这意味着所有的肉和菜都已经放到你碗里了，下面就是如何吃下去的问题了。 236 | 237 | 下一篇我们一起来学习todos的整个流程。 238 | 239 | **导航** 240 | 241 | - 上一章 06 [实战演练：todos分析（一）](06-backbonejs-todos-1.md) 242 | - 下一章 08 [实战演练：todos分析（三）总结](08-backbonejs-todos-3.md) 243 | -------------------------------------------------------------------------------- /md_chapters/08-backbonejs-todos-3.md: -------------------------------------------------------------------------------- 1 | 第八章 实战演练：todos分析（三）总结 2 | ==================================== 3 | 4 | 在前两篇文章中，我们已经对这个todos的功能、数据模型以及各个模块的实现细节进行了分析，这篇文章我们要对前面的分析进行一个整合。 5 | 6 | 首先让我们来回顾一下我们分析的流程：1. 先对页面功能进行了分析；2. 7 | 然后又分析了数据模型；3. 8 | 最后又对view的功能和代码进行了详解。你是不是觉得这个分析里面少了点什么？没错，就知道经验丰富的你已经看出来了，这里面少了对于流程的分析。这篇文章就对整体流程进行分析。 9 | 10 | 所以从我的分析中可以看的出来，我是先对各个原材料进行分析，然后再整体的分析（当然前提是我是理解流程的），这并不是分析代码的唯一方法，有时我也会采用跟着流程分析代码的方法。当然还有很多其他的分析方法，大家都有自己的套路嘛。 11 | 12 | 下面简单的说说流程分析的方法。记得多年前在学vb的时候，分析一个完整项目代码的时候，习惯从程序的入口点开始分析。虽然web网站和桌面软件的实现不同，但是大致思路是一样的（同时也有网站即软件的说法，在RESTful架构中）。所以我们要先找到网站的入口点所在。 13 | 14 | 和桌面应用项目的分析一样，网站的入口点就在于网页加载的时候。对于todos，自然就是在页面加载完之后执行的操作了，然后就看到下面的代码。 15 | 16 | 首先是对AppView的一个实例化： 17 | 18 | var App = new AppView; 19 | 20 | 实例化，自然就会调用构造函数： 21 | 22 | //在初始化过程中，绑定事件到Todos上， 23 | //当任务列表改变时会触发对应的事件。 24 | //最后从localStorage中fetch数据到Todos中。 25 | initialize: function() { 26 | this.input = this.$("#new-todo"); 27 | this.allCheckbox = this.$("#toggle-all")[0]; 28 | 29 | this.listenTo(Todos, 'add', this.addOne); 30 | this.listenTo(Todos, 'reset', this.addAll); 31 | this.listenTo(Todos, 'all', this.render); 32 | 33 | this.footer = this.$('footer'); 34 | this.main = $('#main'); 35 | 36 | Todos.fetch(); 37 | }, 38 | 39 | 注意其中的Todos.fetch()方法，前面说过，这个项目是在客户端保存数据，所以使用fetch方法并不会发送请求到服务器。另外在前面关于collection的单独讲解中我们也介绍了fetch执行完成之后，会调用set（默认）或者reset（需要手动设置 40 | `{reset: true}` 41 | ）。所以在没有指明fetch的reset参数的情况下，backbonejs的Collection中的set方法会遍历Todos的内容并且调用add方法。 42 | 43 | 在initialize中我们绑定了add到addOne上，因此在fetch的时候会Backbonejs会帮我们调用addOne（其实也是在collection的set方法中）。和collection中的set类似的，我们可以自定义reset方法，自行来处理fetch到得数据，但是需要在fetch时手动添加reset参数。 44 | 45 | PS: 感谢网友指正 46 | 47 | 这里先来看下我们绑定到reset上的addAll方法是如何处理fetch过来的数据的: 48 | 49 | // 添加一个任务到页面id为todo-list的div/ul中 50 | addOne: function(todo) { 51 | var view = new TodoView({model: todo}); 52 | this.$("#todo-list").append(view.render().el); 53 | }, 54 | 55 | // 把Todos中的所有数据渲染到页面,页面加载的时候用到 56 | addAll: function() { 57 | Todos.each(this.addOne, this); 58 | }, 59 | 60 | 在addAll中调用addOne方法，关于Todos.each很好理解，就是语法糖（简化的for循环）。关于addOne方法的细节下面介绍。 61 | 62 | 然后再来看添加任务的流程，一个良好的代码命名风格始终是让人满心欢喜的。因此很显然，添加一个任务，自然就是addOne,其实你看events中的绑定也能知道，先看一下绑定： 63 | 64 | // 绑定dom节点上的事件 65 | events: { 66 | "keypress #new-todo": "createOnEnter", 67 | "click #clear-completed": "clearCompleted", 68 | "click #toggle-all": "toggleAllComplete" 69 | }, 70 | 71 | 这里并没有addOne方法的绑定，但是却有createOnEnter，语意其实一样的。来看主线，createOnEnter这个方法： 72 | 73 | /* 创建一个任务的方法，使用backbone.collection的create方法。将数据保存到localStorage,这是一个html5的js库。需要浏览器支持html5才能用。 */ 74 | createOnEnter: function(e) { 75 | if (e.keyCode != 13) return; 76 | if (!this.input.val()) return; 77 | 78 | //创建一个对象之后会在backbone中动态调用Todos的add方法，该方法已绑定addOne。 79 | Todos.create({title: this.input.val()}); 80 | this.input.val(''); 81 | }, 82 | 83 | 注释已写明，Todos.create会调用addOne这个方法。由此顺理成章的来到addOne里面： 84 | 85 | //添加一个任务到页面id为todo-list的div/ul中 86 | addOne: function(todo) { 87 | var view = new TodoView({model: todo}); 88 | this.$("#todo-list").append(view.render().el); 89 | }, 90 | 91 | 在里面实例化了一个TodoView类，前面我们说过，这个类是主管各个任务的显示的。具体代码就不细说了。 92 | 93 | 有了添加再来看更新，关于单个任务的操作，我们直接找TodoView就ok了。所以直接找到 94 | 95 | // 为每一个任务条目绑定事件 96 | events: { 97 | "click .toggle" : "toggleDone", 98 | "dblclick .view" : "edit", 99 | "click a.destroy" : "clear", 100 | "keypress .edit" : "updateOnEnter", 101 | "blur .edit" : "close" 102 | }, 103 | 104 | 其中的edit事件的绑定就是更新的一个开头，而updateOnEnter就是更新的具体动作。所以只要搞清楚这俩方法的作用一切就明了了。这里同样不用细说。 105 | 106 | 在往后还有删除一条记录以及清楚已有记录的功能，根据上面的分析过程，我想大家都很容易的去'顺藤模瓜'。 107 | 108 | 关于Todos的分析到此就算完成了。 109 | 110 | 在下一篇文章中我们将一起来学习通过web.py来搭建web服务器，以及简单的数据库的使用。 111 | 112 | **导航** 113 | 114 | - 上一章 07 [实战演练：todos分析（二）view的应用](07-backbonejs-todos-2.md) 115 | - 下一章 09 [后端环境搭建：web.py的使用](09-intro-webpy.md) 116 | -------------------------------------------------------------------------------- /md_chapters/09-intro-webpy.md: -------------------------------------------------------------------------------- 1 | 第九章 后端环境搭建：web.py的使用 2 | ================================= 3 | 4 | 前面都是前端的一些内容，但是要想做出一个能用的东西，始终是不能脱离后端的。因此这一节主要介绍如何使用python的一个web框架webpy。我想读我这个教程的同学大多都是前端，对后端没有什么感觉。因此关于后端的介绍以能用为主，不涉及太多的后端的东西。 5 | 6 | 9.1 python是什么 7 | ---------------- 8 | 9 | 简单来说Python和JavaScript一样，是一个动态语言，运行在服务器端。语法类似于程序伪码，或者说类似于自然语言。过多的语法和关键字就不再介绍。只需要记住Python是用缩进来判断语法块的，不像js用大括号。 10 | 11 | 9.2 webpy是什么 12 | --------------- 13 | 14 | 和Backbonejs是js的一个框架一样，webpy是python的一个简单的web开发的框架。可以通过简单的几行代码启动一个web服务（虽然只是输出helloworld 15 | \^\_\^）。用它可以简单的满足咱们的开发需求。 16 | 17 | 因为是基于Python的框架，因此需要先安装Python环境，具体怎么装就不细说了，到http://python.org/download/ 18 | 安装python2.7.6这个版本。 19 | 20 | 之后按照 [webpy](http://webpy.org/) 官网的说明，通过命令安装webpy： : 21 | 22 | pip install web.py 23 | 或者 24 | easy_install web.py 25 | 26 | 注意：linux下非root用户需要sudo 27 | 28 | 9.3 来一个Helloworld 29 | -------------------- 30 | 31 | 安装好之后，直接把webpy网站上的那段代码，贴到的用编辑器打开的文件中，保存为server.py。webpy网站代码如下： 32 | 33 | import web 34 | 35 | urls = ( 36 | '/', 'index' 37 | ) 38 | app = web.application(urls, globals()) 39 | 40 | class index: 41 | def GET(self): 42 | return 'Hello, World!' 43 | 44 | if __name__ == "__main__": 45 | app.run() 46 | 47 | 然后在server.py的同目录下执行: 48 | 49 | python server.py 50 | 51 | 之后命令行会输出: 52 | 53 | http://0.0.0.0:8080/ 54 | 55 | 这个提示，现在你在浏览器访问 56 | ，就会看到熟悉的helloworld，是不是超级简单。 57 | 58 | 9.4 简单构建api接口 59 | ------------------- 60 | 61 | 在上面代码的基础上，按照前面backboneModel的定义，我们需要一个todo这模型的对应的链接，这个链接应该返回json格式的数据。并且能够支持post、put、get、delete这四个请求。现在来看接口部分的代码： 62 | 63 | #添加todo相关的urls 64 | urls = ( 65 | '/', 'index', #返回首页 66 | # 处理前端todo的请求,操作对应的todo 67 | '/todo/(\d+)/', 'todo', 68 | # 处理前端todo的整体请求,主要是获取所有的todo数据 69 | '/todo/', 'todos', 70 | ) 71 | 72 | #添加接口的处理代码 73 | class todo: 74 | def GET(self, todo_id=None): 75 | context = { 76 | "title": "下午3点,coding", 77 | "order": 0, 78 | "done": False, 79 | } 80 | return json.dumps(context) 81 | 82 | #处理整体的请求 83 | class todos: 84 | def GET(self): 85 | result = [] 86 | result.append({ 87 | "title": "下午3点,coding", 88 | "order": 0, 89 | "done": False, 90 | }) 91 | return json.dumps(result) 92 | 93 | 添加完这部分代码之后，启动server.py。访问 94 | 就能看到数据了，这里只是实现了get方法，其他的方法在下一篇中介绍。 95 | 96 | 9.5 加入数据库sqlite 97 | -------------------- 98 | 99 | 关于数据存储部分，我们使用sqlite数据库。sqlite的好处就是不需要安装即可使用。这样可以省去在数据库安装方面的折腾。 100 | 101 | sqlite的介绍就不多说了，感兴趣的同学想必已经在查sqlite相关的东西了。这里只是演示在webpy中如何操作sqlite。 102 | 103 | 具体依然看代码: 104 | 105 | #使用sqlite3操作数据库 106 | import sqlite3 107 | conn = sqlite3.connect('todos.db') 108 | 109 | #把todo改为这样： 110 | class todo: 111 | def GET(self, todo_id=None): 112 | cur = conn.cursor() 113 | cur.execute(sql_query + ' where id=?', (todo_id, )) 114 | todo = cur.fetchone() 115 | cur.close() 116 | 117 | # 先用这种比较傻的方式 118 | context = { 119 | "id": todo[0], 120 | "title": todo[1], 121 | "order": todo[2], 122 | "done": todo[3], 123 | } 124 | return json.dumps(context) 125 | 126 | class todos: 127 | def GET(self): 128 | result = [] 129 | cur = conn.cursor() 130 | cur.execute(sql_query) 131 | todos = cur.fetchall() 132 | cur.close() 133 | 134 | for todo in todos: 135 | result.append({ 136 | "id": todo[0], 137 | "title": todo[1], 138 | "order": todo[2], 139 | "done": todo[3], 140 | }) 141 | return json.dumps(result) 142 | 143 | 完整代码可以在 code 144 | 文件夹找到。使用时，先运行init_sqlite.py这个文件，会帮你创建一个sqlite的数据库，并且插入一条数据，然后运行server.py就可以在浏览器访问 145 | 或者http://localhost:8080/todo/1/ 146 | 看到输出数据了。 147 | 148 | 9.6 总结 149 | -------- 150 | 151 | 这里打算用webpy+sqlite来完成后台主要是想到这个东西比Django+Mysql那一套搭建起来比较容易。有兴趣看Django后台搭建的可以看这篇文章： 152 | [django开发环境搭建及使用](http://www.the5fire.com/10-django-dev-env.html) 153 | 。 154 | 155 | 这里没有使用webpy自带的db模块进行数据的操作，主要是文档和案例都不全，并且源码看起来挺绕。用Python自带的模块显然操作起来有点笨拙，之后会对这个数据操作部分进行简单的封装。 156 | 157 | **导航** 158 | 159 | - 上一章 08 [实战演练：todos分析（三）总结](08-backbonejs-todos-3.md) 160 | - 下一章 10 [实战演练：扩展todos到Server端（backbonejs+webpy）](10-expand-todos-with-server.md) 161 | -------------------------------------------------------------------------------- /md_chapters/10-expand-todos-with-server.md: -------------------------------------------------------------------------------- 1 | 第十章 实战演练：扩展todos到Server端（backbonejs+webpy） 2 | ======================================================== 3 | 4 | 上一节简单介绍了怎么使用webpy搭建一个后端的接口服务，这一节就来简单实现一下。 5 | 6 | 10.1 项目结构 7 | ------------- 8 | 9 | 首先还是来看下项目的结构，然后再一步一步的分析，结构如下: 10 | 11 | src 12 | ├── index.html 13 | ├── init_sqlite.py 14 | ├── models.py 15 | ├── server.py 16 | ├── static 17 | │   ├── backbone.js 18 | │   ├── destroy.png 19 | │   ├── jquery.js 20 | │   ├── json2.js 21 | │   ├── todos.css 22 | │   ├── todos.js 23 | │   └── underscore.js 24 | └── todos.db 25 | 26 | 以上结构可以分为四个部分：模板、静态资源、后端逻辑处理、后端数据处理，其实最后两个都属于后端部分。 27 | 28 | 因为模板和静态资源和之前没有太大差异，因此合并在一起介绍。首先来看后端的接口。 29 | 30 | 10.2 后端接口 31 | ------------- 32 | 33 | 相对于前端的各种model、collection和view，后端显得比较简单。只需要提供可访问的接口，并且根据POST、PUT、DELETE、GET这四种操作完成对数据库的CRUD即可（Create,Read,Update,Delete)。 34 | 35 | 先来看models中的代码，这里对todo表的操作进行了简单的封装: 36 | 37 | #coding:utf-8 38 | import web 39 | 40 | db = web.database(dbn='sqlite', db="todos.db") 41 | 42 | class Todos(object): 43 | @staticmethod 44 | def get_by_id(id): 45 | return db.select('todos', where="id=$id", vars=locals()) 46 | 47 | @staticmethod 48 | def get_all(): 49 | return db.select('todos') 50 | 51 | @staticmethod 52 | def create(**kwargs): 53 | db.insert('todos', **kwargs) 54 | 55 | @staticmethod 56 | def update(**kwargs): 57 | db.update('todos', where="id=$id", vars={"id": kwargs.pop('id')}, **kwargs) 58 | 59 | @staticmethod 60 | def delete(id): 61 | db.delete('todos', where="id=$id", vars=locals()) 62 | 63 | 代码很简单，从方法的命名上就知道要完成的功能是什么，这里不得不说一句，任何语言中好的变量或方法的命名，胜过大段的注释。 64 | 65 | model部分没有具体的业务逻辑，只是针对数据库进行CRUD操作。下面来看给浏览器提供接口的部分。 66 | 67 | server部分，提供了前端浏览器需要访问的接口，同时也提供了页面初始加载时的渲染页面的功能。server.py的代码如下: 68 | 69 | #coding:utf-8 70 | import json 71 | 72 | import web 73 | from models import Todos 74 | 75 | urls = ( 76 | '/', 'index', #返回首页 77 | # 处理POST请求 78 | '/todo', 'todo', 79 | # 处理前端todo的请求,对指定记录进行操作 80 | '/todo/(\d*)', 'todo', 81 | # 处理前端todo的请求，返回所有数据 82 | '/todos/', 'todos', 83 | ) 84 | 85 | app = web.application(urls, globals()) 86 | 87 | render = web.template.render('') 88 | 89 | # 首页 90 | class index: 91 | def GET(self): 92 | # 渲染首页到浏览器 93 | return render.index() 94 | 95 | class todo: 96 | def GET(self, todo_id=None): 97 | result = None 98 | itertodo = Todos.get_by_id(id=todo_id) 99 | for todo in itertodo: 100 | result = { 101 | "id": todo.id, 102 | "title": todo.title, 103 | "order": todo._order, 104 | "done": todo.done == 1, 105 | } 106 | return json.dumps(result) 107 | 108 | def POST(self): 109 | data = web.data() 110 | todo = json.loads(data) 111 | # 转换成_order, order是数据库关键字, sqlite3报错 112 | todo['_order'] = todo.pop('order') 113 | Todos.create(**todo) 114 | 115 | def PUT(self, todo_id=None): 116 | data = web.data() 117 | todo = json.loads(data) 118 | todo['_order'] = todo.pop('order') 119 | Todos.update(**todo) 120 | 121 | def DELETE(self, todo_id=None): 122 | Todos.delete(id=todo_id) 123 | 124 | 125 | class todos: 126 | def GET(self): 127 | todos = [] 128 | itertodos = Todos.get_all() 129 | for todo in itertodos: 130 | todos.append({ 131 | "id": todo.id, 132 | "title": todo.title, 133 | "order": todo._order, 134 | "done": todo.done == 1, 135 | }) 136 | return json.dumps(todos) 137 | 138 | if __name__ == "__main__": 139 | app.run() 140 | 141 | 相对于model.py来说，这里做了些数据转换的操作，如前端backbone通过ajax发过来的数据需要转换之后才能存入数据库，而从数据库取出的数据也要稍加处理才能符合前端todos.js中定义的model的要求。 142 | 143 | 在这个server中，提供了三个四个url，依次功能为：首页加载、单个todo创建、单个todo查询修改和删除、查询全部。分成四个也主要是依据所选框架webpy的特性。 144 | 145 | 在url之后，是对应一个具体的class，url接受到的请求将有对应的class来处理，比如说 146 | `/todo` 147 | 这个url，对应的处理请求的class就是todo。另外对应浏览器端发过来的POST、GET、PUT、DELETE请求，class对应的也是相应的方法。这也是选webpy的一个原因。 148 | 149 | 说我了后端提供的接口，以及如何进行处理的原理。我们来看如何修改前端的代码，才能让数据发送到后端来。 150 | 151 | 10.3 修改todos，发送数据到后端 152 | ------------------------------ 153 | 154 | 这个部分改动比较小，就不贴代码了。有需要的可以到 `code` 中看。 155 | 156 | 之前的数据是存在localstorage中，是因为引用了localStorage.js文件，并且在collection中声明了 157 | `localStorage: new Backbone.LocalStorage("todos-backbone")` 。 158 | 159 | 在修改的时候有三个地方需要修改，第一是model的定义，部分代码： 160 | 161 | var Todo = Backbone.Model.extend({ 162 | urlRoot: '/todo', 163 | ...... 164 | 165 | 第二个就是collection的修改，去掉了localStorage的声明，并添加url： 166 | 167 | var TodoList = Backbone.Collection.extend({ 168 | url: '/todos/', 169 | ...... 170 | 171 | 这样就搞定了。 172 | 173 | 10.4 Demo的使用 174 | --------------- 175 | 176 | 在 `code` 中，如果想要把我的demo在本地运行的话，需要首先运行下 177 | `python init_sqlite.py` 178 | 来初始化sqlite3的数据库，运行完之后会在本地生成一个todos.db的数据库文件。 179 | 180 | 之后，就可以通过运行 `python server.py` 181 | ，然后访问命令行提示的网址就可以使用了。 182 | 183 | 最后稍稍总结一下，我觉得到这一章为止，对技术比较认真、比较有追求的同学应该知道怎么通过backbonejs和webpy把前后端连起来了。所有的这些文章只是为了帮你打开一扇门，或者仅仅只是一盏灯，具体你的业务逻辑还是需要通过自己的思考来解决。妄图让别人帮你实现业务逻辑的人都是切实的不思上进的菜鸟。 184 | 185 | 另外，关于这个Todos的案例，是你在打算把Backbonejs应用于实践时必须要参考和思考的。虽然到网上搜罗一下 186 | `Backbonejs项目实例` 187 | 比思考要省心，但是别人的始终是别人的，你不转化成自己的，始终无法灵活运用。借此告诫那些觉得这个Todo案例没啥用的同学们。 188 | 189 | **导航** 190 | 191 | - 上一章 09 [后端环境搭建：web.py的使用](09-intro-webpy.md) 192 | - 下一章 11 [前后端实战演练：Web聊天室-功能分析](11-web-chatroom-base-on-backbonejs-1.md) 193 | -------------------------------------------------------------------------------- /md_chapters/11-web-chatroom-base-on-backbonejs-1.md: -------------------------------------------------------------------------------- 1 | 第十一章 前后端实战演练：Web聊天室-功能分析 2 | =========================================== 3 | 4 | 上面的一个简单的项目完成之后，对python感兴趣的应该已经把web.py这个东西熟悉的差不多了，说不定也像我这样把项目放到服务器上跑了起来。对于没有动手去做的同学，我只能表示很遗憾，作为观众的你一定体会不到参与的乐趣，当然也不会有切身的收获。 5 | 6 | 11.1 项目目标 7 | ------------- 8 | 9 | 相比于之前那个项目，这个项目的目标是按照专业前端的方法搭建一个我自己凭空想出来的需求。最后把这个需求完成，然后注册域名放到网络上，可以真实使用。这样也可以持续改进。 10 | 11 | 上线其实只是一个开始，希望有兴趣参与的同学可以主动参与进来，体会下实际的开发过程。 12 | 13 | 11.2 功能需求 14 | ------------- 15 | 16 | 这个项目的名字叫做聊天室，那肯定是在线聊天用的了，因为不是朝着Demo方向做的，因此需要多用户管理。 17 | 18 | 按照这个需求分析下功能大体有: 19 | 20 | 1. 多用户管理 21 | 1.1 用户注册 22 | 1.2 多用户登陆 23 | 2. 话题管理 24 | 2.1 创建话题 25 | 2.2 浏览话题 26 | 3. 消息管理 27 | 3.1 发送消息 28 | 3.2 删除消息 29 | 3.3 回复消息 30 | 3.4 浏览消息 31 | 32 | 大概这么几个功能 33 | 34 | 11.3 技术选型 35 | ------------- 36 | 37 | 因为是关于Backbonejs的教程，因此必然是基于Backbonejs的。技术选型暂定如下: 38 | 39 | /* 前端技术 */ 40 | backbone.js 41 | bootstrap.css 42 | requirejs 43 | 44 | /* 后端技术 */ 45 | web.py 46 | sqlite3 47 | 48 | 暂时先估计用到这些，说不定真实情况用的更多。 49 | 50 | **导航** 51 | 52 | - 上一章 10 [实战演练：扩展todos到Server端（backbonejs+webpy）](10-expand-todos-with-server.md) 53 | - 下一章 12 [前后端实战演练：Web聊天室-详细设计](12-web-chatroom-base-on-backbonejs-2.md) 54 | -------------------------------------------------------------------------------- /md_chapters/12-web-chatroom-base-on-backbonejs-2.md: -------------------------------------------------------------------------------- 1 | 第十二章 前后端实战演练：Web聊天室-详细设计 2 | =========================================== 3 | 4 | 上一章简单的介绍了这个聊天室的功能和要使用的技术，这一章的主要目的是为下一章的实现做准备。 5 | 任何一个项目从需求到最后的实现，都是要经历这么个过程的，不论这个过程是否显式存在于你自己或者团队的项目历程中。拿到需求后立马开始写代码的同学要么是大牛------（对付各种需求已经有相当多的经验，在理解需求的同时已然对项目进行了分析和设计），要么就是小白------（在这个阶段，对写代码充满了激情，渴望让自己的手指在键盘上得到释放，结果大多会走偏或者自己写到混乱）。 6 | 7 | 因此需要这么个过程，对已有的需求再次思考、规划 8 | 9 | 12.1 实体(Model)设计 10 | -------------------- 11 | 12 | 所谓的实体，就是在项目中数据存放和被传输的对象，从定义上来说就是客观存在的事物。那么在这个项目中有哪些实体存在呢？ 13 | 14 | 从功能上分析，只有三个实体：用户，话题，消息。这三个实体也就是项目中的三个Model，剩下的所有业务都是围绕它们来运转的。 15 | 16 | 那么这三个实体中都应该存放什么样的数据呢？根据需求简单的列一下: 17 | 18 | 用户(user): 19 | id 20 | username 21 | password 22 | registed_time 23 | 话题(topic): 24 | id 25 | title 26 | created_time 27 | owner 28 | 消息(message): 29 | id 30 | content 31 | topic_id 32 | user_id 33 | created_time 34 | 35 | 12.2 接口设计 36 | ------------- 37 | 38 | 因为这个项目的重点是在前端，因此后端只是提供一个接口，先把需要的哪些接口整理清楚了，剩下的就好办了。 39 | 40 | 那么，需要哪些接口呢？ 41 | 42 | 依然是根据功能来： **用户管理** 1. 用户注册接口: 43 | 44 | /user/ [POST] 45 | 46 | 2. 获取用户列表接口: 47 | 48 | /user/ [GET] 49 | 50 | 3. 获取单个用户接口: 51 | 52 | /user// [GET] 53 | 54 | 4. 用户登录: 55 | 56 | /login/ [POST] 57 | 58 | 5. 用户登出: 59 | 60 | /logout/ [GET] 61 | 62 | **话题管理** 1. 话题列表: 63 | 64 | /topic/ [GET] 65 | 66 | 2. 创建话题: 67 | 68 | /topic/ [POST] 69 | 70 | 3. 查看具体话题(相对于进入消息列表): 71 | 72 | /topic// [GET] 73 | 74 | **消息管理** 1. 发送/回复消息: 75 | 76 | /message/ [POST] 77 | 78 | 2. 删除消息: 79 | 80 | /message// [DELETE] 81 | 82 | 3. 浏览消息: 83 | 84 | /message/ [GET] 85 | 86 | 大体就这么些个接口，url后面表示的是HTTP的方法。 87 | 88 | 这样分析完之后，服务器的工作算是清晰了，下面在来分析页面上的工作。 89 | 90 | 12.3 页面设计 91 | ------------- 92 | 93 | 因为是单页应用，所有也就一个页面，但是这一个页面也是由多个视图来组成的------这里的视图可以理解为桌面程序的那种窗口。 94 | 95 | 为了有的放矢，这里我就先画几个草图，来看一下我们这个项目最终的结果可能是什么: 96 | 97 | **登录** 这个是直接截得现成的图。 98 | 99 | ![image](../images/login.png) 100 | 101 | 注册界面和这个一样 102 | 103 | **话题界面** 104 | 105 | ![image](../images/topics.png) 106 | 107 | **消息界面** 108 | 109 | ![image](../images/message.png) 110 | 111 | 12.4 view的设计 112 | --------------- 113 | 114 | 这里说的view，是指backbonejs中的view，按照之前的经验来说，大概需要划分的view和功能分别为： 115 | 116 | 1. 话题view(topic\_view): 117 | 118 | 功能: 119 | 根据话题接口获取所有话题数据，然后渲染模板 120 | 121 | 2. 消息view(message\_view): 122 | 123 | 功能: 124 | 根据消息接口返回的数据，渲染模板 125 | 126 | 3. 登录view(login\_view): 127 | 128 | 功能: 129 | 展示登录页面，发送用户数据到服务器端 130 | 131 | 4. 整体view（main\_view): 132 | 133 | 功能： 134 | 负责其他view的切换 135 | 136 | 12.5 总结 137 | --------- 138 | 139 | 这一章主要是对功能做了更进一步的处理，目的就是能够更好的开始编码。在详细设计完成之后具体实现就变得有迹可循了。 140 | 141 | 到目前为止，这个项目我也是边写边做，现在还没开始写代码。因此这篇文章的分析可能在之后还需要改动。但，即便如此，这个过程也是需要存在的，因为软件开发本身就是一个不断迭代的过程，你不可能一拍脑袋便出来一个完美方案，设计一个可行的方案，然后持续迭代才是最好的实践。 142 | 143 | **导航** 144 | 145 | - 上一章 11 [前后端实战演练：Web聊天室-功能分析](11-web-chatroom-base-on-backbonejs-1.md) 146 | - 下一章 13 [前后端实战演练：Web聊天室-后端开发](13-web-chatroom-base-on-backbonejs-3.md) 147 | -------------------------------------------------------------------------------- /md_chapters/13-web-chatroom-base-on-backbonejs-3.md: -------------------------------------------------------------------------------- 1 | 第十三章 前后端实战演练：Web聊天室-服务器端开发 2 | =============================================== 3 | 4 | 在上一章中简单的进行了在开发中经常要经过的一个步骤------详细设计，在详细设计中定义了数据模型，有哪些接口，以及页面的长相。比较简单，并没有对服务器端Python项目的结构进行设计，也没有对前端文件的组织进行规划。但是这个详细设计的目的是达到了，在我个人的实际经验中，项目的开发很少有按照软件工程中的瀑布模型来做的。大部分都是明确阶段目标，然后开发，然后再次明确，再次开发，不断迭代。 5 | 6 | 因此说到前篇文章的目的也就是指导后端开发提供一个什么样的接口，输出什么样的数据结构。也是指导前端应该怎么获取数据。在日常工作中，设计到前后端甚至是服务器和客户端的这种模式也是一样，两方人员在项目初期只要协定好接口和数据结构就行，随着项目的进行不断的调整。当然这种情况是说内部人员之间的沟通，如果是和外部人员的沟通情况就不一样了。 7 | 8 | 回到正题，后端的开发主要功能是提供接口，要提供哪些接口一定定义好了，模型也建立好了，现在需要做的就是搭一个项目，实现接口。 9 | 10 | 13.1 项目结构 11 | ------------- 12 | 13 | 项目使用了webpy这个微型的python框架，项目结构是依然按照之前对todos进行服务器端扩展时的结构, 14 | [onlinetodos](https://github.com/the5fire/onlinetodos) : 15 | 16 | . 17 | ├── __init__.py 18 | ├── handlers.py 19 | ├── init_sqlite.py 20 | ├── models.py 21 | ├── server.py 22 | ├── static 23 | │   ├── css 24 | │   │   ├── body.css 25 | │   │   └── semantic.min.css 26 | │   ├── img 27 | │   │   └── bg.jpg 28 | │   └── js 29 | │   ├── backbone.js 30 | │   ├── jquery.js 31 | │   ├── json2.js 32 | │   └── underscore.js 33 | ├── templates 34 | │   └── index.html 35 | └── wechat.db 36 | 37 | 可以先忽略其中的静态文件的部分，下一章实现的时候会进行调整。只说后端的实现，主要分为三个部分：server部分、handler部分、和models部分，也就是上面对应的名字，这些名字本身就说明了这部分的功能。server主要是启动一个web服务器，其中进行了url的定义，对应url接受到的请求会传递到handlers中对应的类方法中，在方法中会调用Models中的Model类来获取数据，然后再返回给客户端（浏览器）。 38 | 39 | 13.2 server部分详解 40 | ------------------- 41 | 42 | 这部分功能上已经介绍了，这里贴出代码详细介绍: 43 | 44 | #!/usr/bin/env python 45 | #coding:utf-8 46 | import web 47 | from web.httpserver import StaticMiddleware 48 | 49 | urls = ( 50 | '/', 'IndexHandler', # 返回首页 51 | '/topic', 'TopicHandler', 52 | '/topic/(\d+)', 'TopicHandler', 53 | '/message', 'MessageHandler', 54 | '/user', 'UserHandler', 55 | '/user/(\d+)', 'UserHandler', 56 | '/login', 'LoginHandler', 57 | '/logout', 'LogoutHandler', 58 | ) 59 | 60 | app = web.application(urls, globals()) 61 | application = app.wsgifunc(StaticMiddleware) 62 | 63 | if web.config.get('_session') is None: 64 | session = web.session.Session( 65 | app, 66 | web.session.DiskStore('sessions'), 67 | initializer={'login': False, 'user': None} 68 | ) 69 | web.config._session = session 70 | 71 | from handlers import ( # NOQA 72 | IndexHandler, RegisteHandler, 73 | LoginHandler, LogoutHandler, 74 | TopicHandler, MessageHandler 75 | ) 76 | 77 | 78 | def main(): 79 | app.run() 80 | 81 | if __name__ == "__main__": 82 | main() 83 | 84 | 这里首先是定义了url对应的handlers中的类，然后通过webpy的静态文件Middleware来处理静态文件的请求，接着初始化了项目的session。最后从handlers中引入所有用到的Handler。这里需要注意的是，handlers的引入需要在session定义的下面，因为handlers中需要用到session。 85 | 86 | 13.3 handler中的逻辑 87 | -------------------- 88 | 89 | 这里面主要逻辑是处理来自浏览器对相应的url的请求，因为项目需要处理用户登录，因此要引入前面定义的session来保存用户的状态。 90 | 91 | 来看代码: 92 | 93 | #coding:utf-8 94 | import copy 95 | import json 96 | import hashlib 97 | import sqlite3 98 | from datetime import datetime 99 | 100 | import web 101 | 102 | from models import Message, User, Topic 103 | 104 | session = web.config._session 105 | 106 | CACHE_USER = {} 107 | 108 | 109 | def sha1(data): 110 | return hashlib.sha1(data).hexdigest() 111 | 112 | 113 | def bad_request(message): 114 | raise web.BadRequest(message=message) 115 | 116 | 117 | # 首页 118 | class IndexHandler: 119 | def GET(self): 120 | render = web.template.render('templates/') 121 | return render.index() 122 | 123 | 124 | class UserHandler: 125 | def GET(self): 126 | # 获取当前登录的用户数据 127 | user = session.user 128 | return json.dumps(user) 129 | 130 | def POST(self): 131 | data = web.data() 132 | data = json.loads(data) 133 | username = data.get("username") 134 | password = data.get("password") 135 | password_repeat = data.get("password_repeat") 136 | 137 | if password != password_repeat: 138 | return bad_request('两次密码输入不一致') 139 | 140 | user_data = { 141 | "username": username, 142 | "password": sha1(password), 143 | "registed_time": datetime.now(), 144 | } 145 | 146 | try: 147 | user_id = User.create(**user_data) 148 | except sqlite3.IntegrityError: 149 | return bad_request('用户名已存在!') 150 | 151 | user = User.get_by_id(user_id) 152 | session.login = True 153 | session.user = user 154 | 155 | result = { 156 | 'id': user_id, 157 | 'username': username, 158 | } 159 | return json.dumps(result) 160 | 161 | 162 | class LoginHandler: 163 | def POST(self): 164 | data = web.data() 165 | data = json.loads(data) 166 | username = data.get("username") 167 | password = data.get("password") 168 | user = User.get_by_username_password( 169 | username=username, 170 | password=sha1(password) 171 | ) 172 | if not user: 173 | return bad_request('用户名或密码错误！') 174 | 175 | session.login = True 176 | session.user = user 177 | result = { 178 | 'id': user.get('id'), 179 | 'username': user.get('username'), 180 | } 181 | return json.dumps(result) 182 | 183 | 184 | class LogoutHandler: 185 | def GET(self): 186 | session.login = False 187 | session.user = None 188 | session.kill() 189 | return web.tempredirect('/#login') 190 | 191 | 192 | class TopicHandler: 193 | def GET(self, pk=None): 194 | if pk: 195 | topic = Topic.get_by_id(pk) 196 | return json.dumps(topic) 197 | 198 | topics = Topic.get_all() 199 | result = [] 200 | for t in topics: 201 | topic = dict(t) 202 | try: 203 | user = CACHE_USER[t.owner_id] 204 | except KeyError: 205 | user = User.get_by_id(t.owner_id) 206 | CACHE_USER[t.owner_id] = user 207 | topic['owner_name'] = user.username 208 | result.append(topic) 209 | return json.dumps(result) 210 | 211 | def POST(self): 212 | if not session.user or not session.user.id: 213 | return bad_request('请先登录！') 214 | 215 | data = web.data() 216 | data = json.loads(data) 217 | 218 | topic_data = { 219 | "title": data.get('title'), 220 | "owner_id": session.user.id, 221 | "created_time": datetime.now(), 222 | } 223 | 224 | try: 225 | topic_id = Topic.create(**topic_data) 226 | except sqlite3.IntegrityError: 227 | return bad_request('你已创建过该名称!') 228 | 229 | result = { 230 | "id": topic_id, 231 | "title": topic_data.get('title'), 232 | "owner_id": session.user.id, 233 | "owner_name": session.user.username, 234 | "created_time": str(topic_data.get('created_time')), 235 | } 236 | return json.dumps(result) 237 | 238 | def PUT(self, obj_id=None): 239 | pass 240 | 241 | def DELETE(self, obj_id=None): 242 | pass 243 | 244 | 245 | class MessageHandler: 246 | def GET(self): 247 | topic_id = web.input().get('topic_id') 248 | if topic_id: 249 | messages = Message.get_by_topic(topic_id) or [] 250 | else: 251 | messages = Message.get_all() 252 | 253 | result = [] 254 | current_user_id = session.user.id 255 | for m in messages: 256 | try: 257 | user = CACHE_USER[m.user_id] 258 | except KeyError: 259 | user = User.get_by_id(m.user_id) 260 | CACHE_USER[m.user_id] = user 261 | message = dict(m) 262 | message['user_name'] = user.username 263 | message['is_mine'] = (current_user_id == user.id) 264 | result.append(message) 265 | return json.dumps(result) 266 | 267 | def POST(self): 268 | data = web.data() 269 | data = json.loads(data) 270 | if not (session.user and session.user.id): 271 | return bad_request("请先登录！") 272 | 273 | message_data = { 274 | "content": data.get("content"), 275 | "topic_id": data.get("topic_id"), 276 | "user_id": session.user.id, 277 | "created_time": datetime.now(), 278 | } 279 | m_id = Message.create(**message_data) 280 | result = { 281 | "id": m_id, 282 | "content": message_data.get("content"), 283 | "topic_id": message_data.get("topic_id"), 284 | "user_id": session.user.id, 285 | "user_name": session.user.username, 286 | "created_time": str(message_data.get("created_time")), 287 | "is_mine": True, 288 | } 289 | return json.dumps(result) 290 | 291 | 别看代码这么多，所有的具体的Handler的处理逻辑都是一样的------接受post请求，验证用户状态，存储；或者是接受get请求，调用Model获取数据，组织成json，然后返回。相当简单了，对吧。 292 | 293 | 13.4 models中的实现 294 | ------------------- 295 | 296 | 这部分功能就是现实数据库的增删改查，行为基本一致，因此提出一个基础类来完成基本的操作。如果基础类满足不了需求，需要在各子类中实现自己的逻辑。 297 | 298 | 来看下实现代码: 299 | 300 | #coding:utf-8 301 | import web 302 | 303 | db = web.database(dbn='sqlite', db="wechat.db") 304 | 305 | 306 | class DBManage(object): 307 | @classmethod 308 | def table(cls): 309 | return cls.__name__.lower() 310 | 311 | @classmethod 312 | def get_by_id(cls, id): 313 | itertodo = db.select(cls.table(), where="id=$id", vars=locals()) 314 | return next(iter(itertodo), None) 315 | 316 | 317 | @classmethod 318 | def get_all(cls): 319 | # inspect.ismethod(cls.get_all) 320 | return db.select(cls.table()) 321 | 322 | @classmethod 323 | def create(cls, **kwargs): 324 | return db.insert(cls.table(), **kwargs) 325 | 326 | @classmethod 327 | def update(cls, **kwargs): 328 | db.update(cls.table(), where="id=$id", vars={"id": kwargs.pop('id')}, **kwargs) 329 | 330 | @classmethod 331 | def delete(cls, id): 332 | db.delete(cls.table(), where="id=$id", vars=locals()) 333 | 334 | 335 | class User(DBManage): 336 | id = None 337 | username = None 338 | password = None 339 | registed_time = None 340 | 341 | @classmethod 342 | def get_by_username_password(cls, username, password): 343 | itertodo = db.select(cls.table(), where="username=$username and password=$password", vars=locals()) 344 | return next(iter(itertodo), None) 345 | 346 | 347 | class Topic(DBManage): 348 | id = None 349 | title = None 350 | created_time = None 351 | owner = None 352 | 353 | 354 | class Message(DBManage): 355 | id = None 356 | content = None 357 | top_id = None 358 | user_id = None 359 | reply_to = None 360 | 361 | @classmethod 362 | def get_by_topic(cls, topic_id): 363 | return db.select(cls.table(), where="topic_id=$topic_id", vars=locals()) 364 | 365 | 在操作的同时还是定义了模型的属性，不过目前并没有用的上，如果打算进一步抽象的话是要用到的。 366 | 367 | 13.5 总结 368 | --------- 369 | 370 | 整个后端的实现并不复杂，只是简单的数据库CRUD操作，也没有进行更深一步的抽象，不过满足接口需求就好，等前端实现的时候可能需要调整。 371 | 372 | 这个项目已经托管在github上了: 373 | [wechat](https://github.com/the5fire/wechat) ，欢迎围观以及贡献代码。 374 | 375 | **导航** 376 | 377 | - 上一章 12 [前后端实战演练：Web聊天室-详细设计](12-web-chatroom-base-on-backbonejs-2.md) 378 | - 下一章 14 [前后端实战演练：Web聊天室-前端开发](14-web-chatroom-base-on-backbonejs-4.md) 379 | -------------------------------------------------------------------------------- /md_chapters/14-web-chatroom-base-on-backbonejs-4.md: -------------------------------------------------------------------------------- 1 | 第十四章 前后端实战演练：Web聊天室-前端开发 2 | =========================================== 3 | 4 | 在上一章的 [服务器端开发](13-web-chatroom-base-on-backbonejs-3.rst) 5 | 中我们定义了模型，实现了几个实体增删改查得功能，也提供了前端访问数据的接口。但在前端的实现过程中又对接口进行了调整，以更符合前端的使用。在真实的开发中也是如此，定义的接口合不合适只有在开发时才知道。 6 | 7 | 目前代码并没有进行模块的划分，在单js文件(chat.js)中实现了所有逻辑。下一步会进行通过seajs或者requirejs来进行模块管理。 8 | 9 | 关于前端样式的设计和开发并不在这个系列的计划中，因此就不多做介绍了，只是基于semantic进行了简单的设计，有兴趣的可以自己去看： 10 | [wechat项目](https://github.com/the5fire/wechat) 。 11 | 12 | 14.1 前端文件结构 13 | ----------------- 14 | 15 | 前端的结构和前面的项目结构一样，只是添加了chat.js和自定义样式的chat.css文件，我们所有的代码都在这个文件中编写。 16 | 17 | ├── static 18 | │   ├── css 19 | │   │   ├── body.css 20 | │   │   ├── chat.css 21 | │   │   └── semantic.min.css 22 | │   ├── fonts 23 | │   │   ├── basic.icons.svg 24 | │   │   ├── basic.icons.woff 25 | │   │   ├── icons.svg 26 | │   │   └── icons.woff 27 | │   ├── img 28 | │   │   └── bg.jpg 29 | │   └── js 30 | │   ├── backbone.js 31 | │   ├── chat.js 32 | │   ├── jquery.js 33 | │   ├── json2.js 34 | │   └── underscore.js 35 | ├── templates 36 | │   └── index.html 37 | 38 | 14.2 Model和Collection定义 39 | -------------------------- 40 | 41 | 我们还是先来定义Model的实现，前端的Model应该和后端的Model定义一样，不然数据传递就会有问题。因为在后端已经明确定义了Model有哪些属性，这里的定义就简单多了。当然这也是动态语言的优势------动态的添加属性。 42 | 43 | 我们要定义三个Model和两个Collection，因为User这个对象在前端只会存在一份，不需要定义集合。来看具体实现: 44 | 45 | var User = Backbone.Model.extend({ 46 | urlRoot: '/user', 47 | }); 48 | 49 | var Topic = Backbone.Model.extend({ 50 | urlRoot: '/topic', 51 | }); 52 | 53 | var Message = Backbone.Model.extend({ 54 | urlRoot: '/message', 55 | }); 56 | 57 | var Topics = Backbone.Collection.extend({ 58 | url: '/topic', 59 | model: Topic, 60 | }); 61 | 62 | var Messages = Backbone.Collection.extend({ 63 | url: '/message', 64 | model: Message, 65 | }); 66 | 67 | 我们之定义了基本的属性，这些属性保证了我们可以可以直接通过collection或者model获取到后端的数据。 68 | 69 | 14.3 视图和模板的定义 70 | --------------------- 71 | 72 | 定义了基本的Model之后，就相当于是有了数据的获取方式，下一步就是如何显示这些数据了。因此就需要用Backbonejs中的view和template来定义我们的具体显示了。 73 | 74 | 首先来定义view: 75 | 76 | var TopicView = Backbone.View.extend({ 77 | tagName: "div class='column'", 78 | templ: _.template($('#topic-template').html()), 79 | 80 | // 渲染列表页模板 81 | render: function() { 82 | $(this.el).html(this.templ(this.model.toJSON())); 83 | return this; 84 | }, 85 | }); 86 | 87 | var MessageView = Backbone.View.extend({ 88 | tagName: "div class='comment'", 89 | templ: _.template($('#message-template').html()), 90 | 91 | // 渲染列表页模板 92 | render: function() { 93 | $(this.el).html(this.templ(this.model.toJSON())); 94 | return this; 95 | }, 96 | }); 97 | 98 | var UserView = Backbone.View.extend({ 99 | el: "#user_info", 100 | username: $('#username'), 101 | 102 | show: function(username) { 103 | this.username.html(username); 104 | this.$el.show(); 105 | }, 106 | }); 107 | 108 | 根据定义的三个Model，定义了把数据渲染到模板的方式，对应的模块是什么样的呢，我们来看下: 109 | 110 | 125 | 126 | 140 | 141 | 这里并没有定义user的模板，因为目前对user只是做了简单的展现，即仅在顶部栏上加了一个用户名，通过: 142 | `user_name` 这个Dom节点的id添加数据。 143 | 144 | 到目前已经介绍了所有的基础数据：从model到collection，到用来显示数据的view，再到定义的页面模板template。每部分的数据都可以单独的从后台获取，并且渲染。好了，材料都准备好了就差什么了？当然是流程。不过还有一个东西得先说一下，这些数据被塞到页面之后到底长成什么样还不知道。因此得先来看下页面结构。 145 | 146 | 下面先来看看上面的那些数据最终要被填充到页面的什么部位，然后再来说流程的事。 147 | 148 | 14.4 页面结构 149 | ------------- 150 | 151 | 这里还是从代码上说事，但是最终效果图已经在 152 | [wechat](https://github.com/the5fire/wechat) 153 | 的readme中贴出来了，你可以跳过去看看长相先。 154 | 155 | 欣赏完外表，来看看内部的骨架，这里只贴主要代码。 156 | 157 | *顶部的固定栏:* 158 | 159 | 160 |
    161 |
    162 |
    163 | We Chat 在线聊天系统 164 |
    165 | 166 |
    167 |
    168 | Backbonejs交流群：308466740 169 |
    170 |
    171 | 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 |
    Add
    248 |
    249 |
    250 | 251 | 252 | 273 |
    274 | 275 | 页面布局大概介绍了一下，如果你熟悉html，并且也看了我上面链接里给的最终效果， 276 | 上面的这些理解上面的这些代码应该很Easy了。如果不熟悉的也没问题，只要关注于我写了注释的地方就行了，这些地方就是上面我们定义的那些模板被渲染好之后的归宿。 277 | 278 | 14.5 view管理和router管理 279 | ------------------------- 280 | 281 | 上面占了点篇幅介绍了页面的布局，以便对我们数据最终的处理有一个感觉。 282 | 283 | 有了数据，也有了最后数据的去处，最后当然要说流程了。所谓的流程就是说我要怎么把Model渲染好的模板给塞到对于的页面div节点中，我要怎么来控制不同Model的展示。毕竟是SPA(单页应用), 284 | 也只有这一个页面来供数据的展示。因此需要在一个页面上切换的展示不同的视图。 285 | 286 | 这里我们是通过Backbone的Route和View来做。Route用来做路由分发（也就是URI的匹配，比如：\#index匹配到首页）。另外不同于上面用来把Model数据传到Template中的View，这里的View是用来管理其他具体View和Collection的,可以比喻为管家View，就是用来控制这个视图什么时候显示，那个Collection的数据什么时候获取。 287 | 288 | 但是，需要注意，这个View需要被Route来控制，也就是通过路由控制（根据URI），因此View在具备上述功能的情况下也要提供接口（方法）给Route。 289 | 290 | 上面介绍了一堆，仿佛说不太清晰，没关系，Talk is cheap, Show you my 291 | code。 292 | 293 | 先来看View管家-AppView, 294 | 主要功能就是获取Topic和Message的数据到Collection中，调用Model对应的View把数据填到模板中，然后把最终拼好的数据放到上面介绍的页面对应div中。 295 | 296 | var AppView = Backbone.View.extend({ 297 | el: "#main", 298 | topic_list: $("#topic_list"), 299 | topic_section: $("#topic_section"), 300 | message_section: $("#message_section"), 301 | message_list: $("#message_list"), 302 | message_head: $("#message_head"), 303 | 304 | events: { 305 | 'click .submit': 'saveMessage', // 发送消息 306 | 'click .submit_topic': 'saveTopic', // 新建主题 307 | 'keypress #comment': 'saveMessageEvent', // 键盘事件 308 | }, 309 | 310 | initialize: function() { 311 | _.bindAll(this, 'addTopic', 'addMessage'); 312 | 313 | topics.bind('add', this.addTopic); 314 | 315 | // 定义消息列表池，每个topic有自己的message collection 316 | // 这样保证每个主题下得消息不冲突 317 | this.message_pool = {}; 318 | 319 | this.message_list_div = document.getElementById('message_list'); 320 | }, 321 | 322 | addTopic: function(topic) { 323 | var view = new TopicView({model: topic}); 324 | this.topic_list.append(view.render().el); 325 | }, 326 | 327 | addMessage: function(message) { 328 | var view = new MessageView({model: message}); 329 | this.message_list.append(view.render().el); 330 | }, 331 | 332 | saveMessageEvent: function(evt) { 333 | if (evt.keyCode == 13) { 334 | this.saveMessage(evt); 335 | } 336 | }, 337 | saveMessage: function(evt) { 338 | var comment_box = $('#comment') 339 | var content = comment_box.val(); 340 | if (content == '') { 341 | alert('内容不能为空'); 342 | return false; 343 | } 344 | var topic_id = comment_box.attr('topic_id'); 345 | var message = new Message({ 346 | content: content, 347 | topic_id: topic_id, 348 | }); 349 | self = this; 350 | var messages = this.message_pool[topic_id]; 351 | message.save(null, { 352 | success: function(model, response, options){ 353 | comment_box.val(''); 354 | // 重新获取，看服务器端是否有更新 355 | // 比较丑陋的更新机制 356 | messages.fetch({ 357 | data: {topic_id: topic_id}, 358 | success: function(){ 359 | self.message_list.scrollTop(self.message_list_div.scrollHeight); 360 | messages.add(response); 361 | }, 362 | }); 363 | }, 364 | }); 365 | }, 366 | 367 | saveTopic: function(evt) { 368 | var topic_title = $('#topic_title'); 369 | if (topic_title.val() == '') { 370 | alert('主题不能为空！'); 371 | return false 372 | } 373 | var topic = new Topic({ 374 | title: topic_title.val(), 375 | }); 376 | self = this; 377 | topic.save(null, { 378 | success: function(model, response, options){ 379 | topics.add(response); 380 | topic_title.val(''); 381 | }, 382 | }); 383 | }, 384 | 385 | showTopic: function(){ 386 | // 获取所有主题 387 | topics.fetch(); 388 | this.topic_section.show(); 389 | this.message_section.hide(); 390 | this.message_list.html(''); 391 | }, 392 | 393 | initMessage: function(topic_id) { 394 | // 初始化消息集合，并放到消息池中 395 | var messages = new Messages; 396 | messages.bind('add', this.addMessage); 397 | this.message_pool[topic_id] = messages; 398 | }, 399 | 400 | showMessage: function(topic_id) { 401 | this.initMessage(topic_id); 402 | 403 | this.message_section.show(); 404 | this.topic_section.hide(); 405 | 406 | this.showMessageHead(topic_id); 407 | $('#comment').attr('topic_id', topic_id); 408 | 409 | var messages = this.message_pool[topic_id]; 410 | messages.fetch({ 411 | data: {topic_id: topic_id}, 412 | success: function(resp) { 413 | self.message_list.scrollTop(self.message_list_div.scrollHeight) 414 | } 415 | }); 416 | }, 417 | 418 | showMessageHead: function(topic_id) { 419 | var topic = new Topic({id: topic_id}); 420 | self = this; 421 | topic.fetch({ 422 | success: function(resp, model, options){ 423 | self.message_head.html(model.title); 424 | } 425 | }); 426 | }, 427 | }); 428 | 429 | 上面是所有数据视图的展示的逻辑控制部分，虽然代码很多，但没有复杂逻辑，很直观。这里只是Topic和Message的展示。但是这些所有的数据都是需要用户登录之后才能看到的，那么用户登录和注册部分的逻辑在哪呢？在上面的页面布局部分已经展示了登录注册的页面，下面展示下具体逻辑。 430 | 431 | 登录注册-LoginView: 432 | 433 | var LoginView = Backbone.View.extend({ 434 | el: "#login", 435 | wrapper: $('#wrapper'), 436 | 437 | events: { 438 | 'keypress #login_pwd': 'loginEvent', 439 | 'click .login_submit': 'login', 440 | 'keypress #reg_pwd_repeat': 'registeEvent', 441 | 'click .registe_submit': 'registe', 442 | }, 443 | 444 | hide: function() { 445 | this.wrapper.hide(); 446 | }, 447 | 448 | show: function() { 449 | this.wrapper.show(); 450 | }, 451 | 452 | loginEvent: function(evt) { 453 | if (evt.keyCode == 13) { 454 | this.login(evt); 455 | } 456 | }, 457 | 458 | login: function(evt){ 459 | var username_input = $('#login_username'); 460 | var pwd_input = $('#login_pwd'); 461 | var u = new User({ 462 | username: username_input.val(), 463 | password: pwd_input.val(), 464 | }); 465 | u.save(null, { 466 | url: '/login', 467 | success: function(model, resp, options){ 468 | g_user = resp; 469 | // 跳转到index 470 | appRouter.navigate('index', {trigger: true}); 471 | } 472 | }); 473 | }, 474 | 475 | registeEvent: function(evt) { 476 | if (evt.keyCode == 13) { 477 | this.registe(evt); 478 | } 479 | }, 480 | 481 | registe: function(evt){ 482 | var reg_username_input = $('#reg_username'); 483 | var reg_pwd_input = $('#reg_pwd'); 484 | var reg_pwd_repeat_input = $('#reg_pwd_repeat'); 485 | var u = new User({ 486 | username: reg_username_input.val(), 487 | password: reg_pwd_input.val(), 488 | password_repeat: reg_pwd_repeat_input.val(), 489 | }); 490 | u.save(null, { 491 | success: function(model, resp, options){ 492 | g_user = resp; 493 | // 跳转到index 494 | appRouter.navigate('index', {trigger: true}); 495 | } 496 | }); 497 | }, 498 | }); 499 | 500 | 这里的View的主要功能是：注册（保存user数据到后台），登录（发送用户请求到后台,成功则跳到首页)，事件监听和处理。很基础的功能。 501 | 502 | 从上面两部分我们知道了如何控制不同Model对应视图的展示，也知道了如何处理用户登录。下面再来看些Route部分是如何把url匹配到对应的方法上的。 503 | 504 | 路由部分代码-AppRouter: 505 | 506 | var AppRouter = Backbone.Router.extend({ 507 | routes: { 508 | "login": "login", 509 | "index": "index", 510 | "topic/:id" : "topic", 511 | }, 512 | 513 | initialize: function(){ 514 | // 初始化项目, 显示首页 515 | this.appView = new AppView(); 516 | this.loginView = new LoginView(); 517 | this.userView = new UserView(); 518 | this.indexFlag = false; 519 | }, 520 | 521 | login: function(){ 522 | this.loginView.show(); 523 | }, 524 | 525 | index: function(){ 526 | if (g_user && g_user.id != undefined) { 527 | this.appView.showTopic(); 528 | this.userView.show(g_user.username); 529 | this.loginView.hide(); 530 | this.indexFlag = true; // 标志已经到达主页了 531 | } 532 | }, 533 | 534 | topic: function(topic_id) { 535 | if (g_user && g_user.id != undefined) { 536 | this.appView.showMessage(topic_id); 537 | this.userView.show(g_user.username); 538 | this.loginView.hide(); 539 | this.indexFlag = true; // 标志已经到达主页了 540 | } 541 | }, 542 | }); 543 | 544 | 这里设定了三条路由：login，index，topic，分别对应这个登录视图（LoginView), 545 | 主题和Message的视图（由AppView管理）。 546 | 547 | 在不同的路由中的逻辑大致一样，就是根据当前的条件决定是否现实视图。 548 | 比如index中的 `if (g_user && g_user.id != undefined) {` 549 | 就是判断当前环境中是否有g_user这个对象（这个对象是用来存放已登录用户数据的，后面会介绍)，根据这个对象判断是否用户已经登录，进而决定是否现实首页------topic列表页。 550 | 551 | 14.6 启动 552 | --------- 553 | 554 | 当所有的逻辑都定义好之后，页面加载完毕首先要做的就是启动整个流程，怎么启动呢？按照我们的项目结构：AppRouter管理AppView和LoginView，AppView管理TopicView和MessageView，因此，只需要启动AppRouter即可。 555 | 556 | 启动代码如下: 557 | 558 | var appRouter = new AppRouter(); 559 | var g_user = new User(); 560 | g_user.fetch({ 561 | success: function(model, resp, options){ 562 | g_user = resp; 563 | Backbone.history.start({pustState: true}); 564 | 565 | if(g_user === null || g_user.id === undefined) { 566 | // 跳转到登录页面 567 | appRouter.navigate('login', {trigger: true}); 568 | } else if (appRouter.indexFlag == false){ 569 | // 跳转到首页 570 | appRouter.navigate('index', {trigger: true}); 571 | } 572 | }, 573 | }); // 获取当前用户 574 | 575 | 就是这一小段代码，程序可以正常运行了。这段代码中的逻辑是：声明一个全局的appRouter和g\_user，然后获取当前用户（服务器端会通过session保存对应浏览器的信息）， 576 | 之后根据获取到得用户状态做进一步操作（到登录页面或是到首页）。 577 | 578 | 这里需要注意的是，这段代码只有在页面加载（刷新或重新访问）的时候才会执行。 579 | 580 | 好了，到此为止整个项目已经介绍完毕了，不知道你是否看懂，或者这么问，我是否把这个项目讲明白了？ 581 | 582 | 14.7 总结 583 | --------- 584 | 585 | 这一篇看起篇幅很长，其实都是代码。而这些代码只有当你真正打算做这么个东西的时候才会主动去理解，因为那些走马观花的人会选择性的忽略代码。 586 | 587 | 最后还是补充一下整个流程，其实整个项目开始做的时候，项目的设计者就应该有一个具体的需求和用户使用的场景。对于这个项目我自己设想的用户使用流程： 588 | 589 | 用户打开浏览器，看到登录和注册页面------》输入用户名、密码进行登录（注册）操作------》展示主题列表视图，并显示用户名在顶部------》用户创建并进入某一主题（显示消息列表视图）------》用户发送消息，消息保存的同时获取服务器端的消息到当前视图。 590 | 591 | 另外一定要说的是，项目没有进行太多优化和代码的精简，还有很多改进的地方。在我写代码的这些年中我始终坚信并践行的一件事就是------获取知识最好的方法就是实践。因此如果你想掌握这个Backbone这个工具，最佳的方式是开始一个项目，并持续的做下去。或者参与一个项目，持续改善项目。 592 | 593 | 我在边写边实践中写了 [WeChat](https://github.com/the5fire/wechat) 594 | 这个项目，并且已经部署上线，相信会是一个好的开始，因为我没打算把它仅仅作为一个Demo来用。 595 | 本文涉及的所有代码均在该项目的basic-version分支可以看到。 596 | 597 | **导航** 598 | 599 | - 上一章 13 [前后端实战演练：Web聊天室-后端开发](13-web-chatroom-base-on-backbonejs-3.rst) 600 | - 下一章 15 [引入requirejs](15-import-requirejs.rst) 601 | -------------------------------------------------------------------------------- /md_chapters/16-exception-in-backbone.md: -------------------------------------------------------------------------------- 1 | 第十六章 补充异常处理 2 | ===================== 3 | 4 | 忘了之前定这么个题目是要表达什么内容，就简单介绍下wechat项目中的错误处理。 5 | 6 | 16.1 error的使用 7 | ---------------- 8 | 9 | 说这个错误处理其实很简单，有过JavaScript经验的同学应该看到Backbonejs中定义的回调函数选项中的error参数就知道怎么写了。 10 | 11 | 需要处理错误的场景都是在客户端和服务器端通信时，在wechat中主要是save和fetch时。有一段代码展示下就是: 12 | 13 | registe: function(evt){ 14 | var reg_username_input = $('#reg_username'); 15 | var reg_pwd_input = $('#reg_pwd'); 16 | var reg_pwd_repeat_input = $('#reg_pwd_repeat'); 17 | var u = new User({ 18 | username: reg_username_input.val(), 19 | password: reg_pwd_input.val(), 20 | password_repeat: reg_pwd_repeat_input.val(), 21 | }); 22 | u.save(null, { 23 | success: function(model, resp, options){ 24 | g_user = resp; 25 | // 跳转到index 26 | appRouter.navigate('index', {trigger: true}); 27 | }, 28 | error: function(model, resp, options) { 29 | alert(resp.responseText); 30 | } 31 | }); 32 | }, 33 | 34 | 这是用户注册时的代码，在save的参数的第二个参数部分添加了error的处理，具体功能就是alert出服务器端传回来的response的内容。 35 | 36 | 那么这么错误是什么时候触发的呢？正常情况下是触发success对应的function，那么什么是正常呢？正常和错误在Backbone.js中是通过返回的HTTP状态码来区分的（应该说是jQuery或者zepto这样下一层处理ajax的库），jQuery中错误判断的代码是这样的: 37 | `if ( status >= 200 && status < 300 || status === 304 ) {` 。 38 | 39 | 因此，对应着服务端的处理就是返回非20x 40 | 和304的错误就行，一般客户端的错误都会返回400（40x系列）这样的错误，服务器端的错误一般都是500以上的错误。 41 | 42 | 对应上面的的错误，服务器端在使用web.py框架要这么处理: 43 | 44 | def POST(self): 45 | data = web.data() 46 | data = json.loads(data) 47 | username = data.get("username") 48 | password = data.get("password") 49 | password_repeat = data.get("password_repeat") 50 | 51 | if password != password_repeat: 52 | # 会返回HTTP400的错误，内容是message的内容 53 | raise web.BadRequest(message='两次密码输入不一致') 54 | 55 | user_data = { 56 | "username": username, 57 | "password": sha1(password), 58 | "registed_time": datetime.now(), 59 | } 60 | 61 | try: 62 | user_id = User.create(**user_data) 63 | except sqlite3.IntegrityError: 64 | raise web.BadRequest(message="用户名已存在!") 65 | 66 | user = User.get_by_id(user_id) 67 | session.login = True 68 | session.user = user 69 | 70 | result = { 71 | 'id': user_id, 72 | 'username': username, 73 | } 74 | return json.dumps(result) 75 | 76 | 这样就ok了。看起来都是基本的东西。 77 | 78 | 参考： 79 | [HTTP状态码](http://zh.wikipedia.org/zh-cn/HTTP%E7%8A%B6%E6%80%81%E7%A0%81) 80 | 81 | **导航** 82 | 83 | - 上一章 15 [引入requirejs](15-import-requirejs.md) 84 | - 下一章 17 [自定义Backbonejs](17-customize-backbonejs-sync.md) 85 | -------------------------------------------------------------------------------- /md_chapters/17-customize-backbonejs-sync.md: -------------------------------------------------------------------------------- 1 | 第十七章 定制Backbonejs 2 | ======================= 3 | 4 | 这里说的定制Backbonejs，主要是定制Backbone中的sync部分，也就是最后和服务器端通信的部分。 5 | 6 | 17.1 三个级别的定制 7 | ------------------- 8 | 9 | 首先得说，在Backbone里面和后端能通信的对象也就两个------Model和Collection。这俩的主要工作就是从服务器拉取数据，保存到实例中，或者把实例中的属性发送到服务器端。 10 | 11 | 上面两中类型的对象都是基于Backbone.sync来进行通信的，同时也可以定义各自的sync方法，类似这样： 12 | 13 | *Model级别的* 14 | 15 | var Message = Backbone.Model.extend({ 16 | urlRoot: '/message', 17 | // 这么写, 打印要操作的实体, 调用系统的sync 18 | sync: function(method, model, options){ 19 | console.log(model); 20 | return Backbone.sync(method, model, options); 21 | }, 22 | }); 23 | 24 | *Collection级别的* 25 | 26 | var Messages = Backbone.Collection.extend({ 27 | url: '/message', 28 | model: Message, 29 | // 这么写, 打印要操作的实体, 调用系统的sync 30 | sync: function(method, collection, options){ 31 | console.log(collection); 32 | return Backbone.sync(method, collection, options); 33 | }, 34 | }); 35 | 36 | 当然，也会存在这样的需求，要修改全局的sync： 37 | 38 | var old_sync = Backbone.sync; 39 | Backbone.sync = function(method, model, options) { 40 | console.log(model); 41 | return old_sync(method, model, options); 42 | } 43 | 44 | 所谓定制，是Backbonejs给开发者提供的可以被重写的接口。因此定制过程也得符合Backbone对sync的定义。 45 | 46 | 17.2 简单实例，用socketio通信 47 | ----------------------------- 48 | 49 | 在 [wechat](https://github.com/the5fire/wechat) 50 | 这个项目中为了保证聊天的实时性，我引入了socketio，后端使用gevent-socketio，（socketio这个东西不打算写，和主题关系不大，有需求的可以题issue）。 51 | 52 | 实时聊天的需求主要是在Message上，用户A发送一个请求，在同一聊天室内的其他用户应该立马能看见。之前有两个版本： 53 | 54 | - 第一版是发送message时会调用messages的fetch方法，也就是用户只有发言才能看到别人发的聊天内容，代码如下： 55 | 56 | message.save(null, { 57 | success: function(model, response, options){ 58 | comment_box.val(''); 59 | // 重新获取，看服务器端是否有更新 60 | // 比较丑陋的更新机制 61 | messages.fetch({ 62 | data: {topic_id: topic_id}, 63 | success: function(){ 64 | self.message_list.scrollTop(self.message_list_div.scrollHeight); 65 | messages.add(response); 66 | }, 67 | }); 68 | }, 69 | }); 70 | 71 | - 第二版是引入socketio之后，在save完数据之后，通过socket把数据再次发送到服务器上的socket端，服务器再挨个发送数据到各个客户端，代码如下： 72 | 73 | message.save(null, { 74 | success: function(model, response, options){ 75 | comment_box.val(''); 76 | messages.add(response); 77 | // 发送成功之后，通过socket再次发送 78 | // FIXME: 最后可通过socket直接通信并保存 79 | socket.emit('message', response); 80 | }, 81 | }); 82 | 83 | // 对应着有一个socket监听, 监听服务器发来的消息 84 | // 监听message事件，添加对话到messages中 85 | socket.on('message', function(response) { 86 | messages.add(response); 87 | }); 88 | 89 | 可以看得出来，上面的第二版算是比较合适了，但是还是有些别扭，数据要重复发送。因此终于到了需要定制的时刻了。 90 | 91 | 上面说了，有三种级别的定制。根据我的需求，只需要定制Model级别的就可以了，怎么定制呢？ 92 | 93 | 和一开头的示例代码类似： 94 | 95 | var Message = Backbone.Model.extend({ 96 | urlRoot: '/message', 97 | 98 | sync: function(method, model, options){ 99 | if (method === 'create') { 100 | socket.emit('message', model.attributes); 101 | $('#comment').val(''); 102 | } else { 103 | return Backbone.sync(method, model, options); 104 | }; 105 | }, 106 | }); 107 | 108 | // 对应着上面的那个message.save后的一堆东西都可以去掉了，直接 109 | message.save(); 110 | 111 | 这样就好了，客户端只需要发送一次数据。但要记得在服务器端的监听message的接口上添加保存message的逻辑。 112 | 113 | 好了，定制就介绍这么多。关于上面提到的代码想了解上下文的，可以到我的wechat这个项目的master分支查看。 114 | 115 | **导航** 116 | 117 | - 上一章 16 [补充异常处理](16-exception-in-backbone.md) 118 | - 下一章 18 [再次总结的说](18-backbone-summary.md) 119 | -------------------------------------------------------------------------------- /md_chapters/18-backbone-summary.md: -------------------------------------------------------------------------------- 1 | 第十八章 再次总结的说 2 | ===================== 3 | 4 | 终于又到了写着一篇的时候了，从去年（2013）8月份决定再更新一版Backbonejs入门教程。原因在前言中已经介绍过了，主要是填一些坑。 5 | 6 | 看看上一版的那个总结 7 | [16、总结的说](http://www.the5fire.com/16-backbone-summary.html) 8 | 的时间------2012.4.18。再看看这一篇的时间------2014.4.15，差不多刚好两年的时间。之前的状态是刚接触前端框架方面的东西，像是在迷雾中行走，摸摸探探的总算知道这是条什么样的路。 9 | 10 | 现在的这一本更多的是希望从一个实用的角度出发，在长期的实践开发中总结出来的经验是：如果你学了一个东西，最终没有把它用到实际应用中，那么你学习这个东西最终产生的价值就抵不上你所花得成本。软件开发这东西，大部分情况下你只有切身的经历了技术对最终产品的作用，你才会对如何运用这一技术有些感觉，不然的话真的是纸上谈兵。 11 | 12 | 因此在这一版中我一开始写的时候就确定了一个最终的目标，那就是要做一个上线的系统，能够让互联网用户访问得到。另外还希望所有用心看了这一系列教程的Backbonejs初学者能够把学到的东西运用进来。 13 | 14 | 在最开始确定要不要刨这么一个坑的时候我犹豫了很久。这个框架在实际的工作中并没有用到，这意味着我对Backbonejs的再次学习和整理对工作上的事情没有太大帮助，虽然我会据此同我们的前端同学进行交流。 15 | 16 | 时间成本是最大的成本，在后端的世界里也有很多东西值得我去探索。犹豫几天之后我写了这篇文章 17 | [心存恐惧便无自由](http://www.the5fire.com/fear-lead-to-not-free.html) 18 | 。我觉得应该去做一些自己想做的事情，心里不受任何约束的。 19 | 20 | 一些牢骚完之后，再说些技术的东西。 21 | 22 | Backbonejs学习最大的难点在于你需要有以一个前端MVC框架的概念。一旦有了这么一个概念之后，你就会意识到，所有的前端框架只是填充了MVC中的各个部分，然后提供给你一个工具，让你可以按这种方式来组织你的代码。 23 | 24 | 因此在学习过程中，你也只需要掌握里面的几个概念：Model、Collection、View、Router，剩下的东西就和框架无关了，都是你软件开发经验的运用。新手的话建议去参透官网的那个todos案例，关于这个案例的事情这里不再赘述了。 25 | 26 | 好了，就写这么多。这个持久的工程总算是到了尾声了。 27 | 28 | 基于这个wechat这个项目，我创建了http://bb-js.org 29 | 这样一个可实时交流的社区，也是读者在练习完Backbonejs可以参与社区开发中的一个项目。有兴趣的读者可以在读完本书，向我申请，申请条件是你得了解所有wechat项目的代码，并且知道如何添加新功能。 30 | 31 | **导航** 32 | 33 | - 上一章 17 [自定义Backbonejs](17-customize-backbonejs-sync.md) 34 | - 下一章 19 [Backbone资源整理](19-backbone-js-resource.md) 35 | -------------------------------------------------------------------------------- /md_chapters/19-backbone-js-resource.md: -------------------------------------------------------------------------------- 1 | Backbonejs相关资源 2 | ================== 3 | 4 | 这次没有参考太多资源，主要还是官方的东西： 5 | 6 | 官网： 7 | 8 | 能让你大概认识backbone.js是什么以及怎么用的网站： 9 | 10 | 11 | 源码： 12 | 13 | todos代码： 14 | 15 | 另外还有几篇中文的博客也不错： 16 | 17 | 18 | 19 | 20 | 21 | 当你对这个东西有一个感觉之后，去看最本质的东西才是王道！ 22 | -------------------------------------------------------------------------------- /sites-baseon-backbonejs.rst: -------------------------------------------------------------------------------- 1 | 官网上那些国外的网站咱就不说了，主要说说国内我知道的比较著名的网站哪些在使用backbonejs，如果恰好你是了解该公司是如何运用backbonejs的，欢迎提交pull-request。 2 | 3 | 1. 豆瓣阿尔法城 4 | -------------------------------- 5 | 链接：http://alphatown.com/ 6 | 7 | 8 | 2. 豆瓣阅读 9 | --------------------------- 10 | 链接：http://read.douban.com/ 主要用在图书的正文页 11 | 12 | 13 | 3. 百度开发者中心 14 | -------------------------------- 15 | 链接：http://developer.baidu.com/ 16 | 17 | 18 | 4. 手机搜狐直播间 19 | --------------------------------------- 20 | 链接：http://zhibo.m.sohu.com/ 21 | 22 | 5. OATOS企业网盘 23 | --------------------------------------- 24 | 链接：http://app.oatos.com 25 | -------------------------------------------------------------------------------- /sponsor.rst: -------------------------------------------------------------------------------- 1 | 写完第十三章，突然想起来要整理一个赞助者名单，感谢那些赞助the5fire的人。每一分钱都是我坚持完成并持续完善我所做的东西的动力。 2 | 3 | 一系列东西，写到现在已经快两年了，回头想想能坚持这么久也出乎我的意料。唯一的遗憾是两年的时间并没有在backbonejs上有太多的实践。希望在完成这第二版时能开始行动。 4 | 5 | 在开始接收赞助的半年中，虽然没有多少赞助，每一分钱的赞助，已经读者的鼓励的留言，也足以让我高兴一两天，不是因为钱(一分钱能让谁笑两天？)，而是因为这让我觉得我写的东西还是有些价值的（这是传说中的存在感吗 :)）。 6 | 7 | 下面整理下名单, 喜欢匿名赞助的童鞋在备注中说明。 8 | 9 | +-----------+--------+ 10 | |赞助者 |金额 | 11 | +===========+========+ 12 | |黄* |20 | 13 | +-----------+--------+ 14 | |毛*海 |5 | 15 | +-----------+--------+ 16 | |justjavac |20 | 17 | +-----------+--------+ 18 | |冯*影 |1 | 19 | +-----------+--------+ 20 | |周* |0.01 | 21 | +-----------+--------+ 22 | |王*康 |10 | 23 | +-----------+--------+ 24 | |刘*灿 |1 | 25 | +-----------+--------+ 26 | |林*雄 |0.01 | 27 | +-----------+--------+ 28 | |阿良 |18.88 | 29 | +-----------+--------+ 30 | 31 | 当然也很感谢那些有心赞助，但是没有完成交易的同学，每一份留言都是一份动力。 32 | 33 | 欢迎继续赞助 34 | 35 | .. image:: https://img.alipay.com/sys/personalprod/style/mc/btn-index.png 36 | :target: http://me.alipay.com/the5fire 37 | 38 | -------------------------------------------------------------------------------- /反馈.rst: -------------------------------------------------------------------------------- 1 | 问题反馈 2 | ==================================== 3 | 4 | 前几天和前端的同事聊backbonejs的书，同事说看过我写的那本backbonejs电子书，但是里面有些地方（mvc）不是很明白，是后来看 `backbone-fundamentals `_ 的翻译版: `翻译版 `_ 才明白的。 5 | 6 | 这本书的英文原版我也看了，在博客上也做了推荐，翻译版这几天也在看，主要是想看看别人怎么翻译的。不过如果不是技术水平和英文水平都比较高的人，翻译过来的东西总是读起来很生硬，我自己在翻译Django的部分文档时也有这个感觉，完全是字面翻译的话生硬无比，而意译的话又怕不能完全表达原文的意思。但意译的东西读起来是比较通畅的，等于是你理解了这个东西，然后用自己的话描述，这样必然就符合中文思维了。 7 | 8 | 说了翻译的事情，现在我还是比较推荐大家看英文原版。 9 | 10 | 其实这篇文章的目的是让大家踊跃发表意见，主要针对第一版中不足之处，还有那些东西是你没弄明白的。 11 | 12 | 来吧，参与开源，欢迎提交issues： `创建问题 `_ 13 | 14 | --------------------------------------------------------------------------------