分享 一个人的"Github"

mvj3 · 2013年08月06日 · 最后由 wormful 回复于 2013年08月06日 · 5059 次阅读

Github 不是一个人做的,三个核心创始人在创业时都是写代码的,其中两个人作为程序员也十分有名,是不少有名开源项目的作者。对比这个星球上其他伟大的 IT 公司,Github 网站的代码是能开源就尽量开源的,包括操作 Git 的 grit,用作消息队列的 resque,等。

Github 自然不是我做的,但作为一个自诩有好品味的程序员,我在努力向 Github 学习和实践它的精神和有益的工作方式,我要构建一个自己的” github”,在此也感谢我所处的公司 eoe 能给我自己去选择技术架构和工作进度这样相对灵活的工作方式的机 Github 不是一个人做的,三个核心创始人在创业时都是写代码的,其中两个人作为程序员也十分有名,是不少有名开源项目的作者。对比这个星球上其他伟大的 IT 公司,Github 网站的代码是能开源就尽量开源的,包括操作 Git 的 grit,用作消息队列的 resque,等。Github 自然不是我做的,但作为一个自诩有好品味的程序员,我在努力向 Github 学习和实践它的精神和有益的工作方式,我要构建一个自己的"github",在此也感谢我所处的公司 eoe 能给我自己去选择技术架构和工作进度这样相对灵活的工作方式的机会。

缘起

今年上半年我的主要工作内容是负责一个专注在线学习编程的单页面应用网站的技术部分。从缘起来说,eoe 本身主要是做以 Android 为主的移动开发者服务的,应用市场,移动应用 SDK 统计,开发者大会活动等都有涉猎,正式的尝试进入 IT 培训从去年 2012 年中就开始了(当然想法会更早些)。

当时 CEO @ 靳岩 让我调研公司进入类似 codecademy.com 在线编程领域方案的可能性,这对于当时刚做完优亿市场应用海量下载统计分析 的算法与数据挖掘工程师无疑是一个很刺激的技术点。codecademy, codeschool 等这些国外在线编程网站毫无意外的展示了他们的创新性,codecademy 既支持 JavaScript, HTML, CSS 这些浏览器本身就提供编程环境的技术,也提供相对初级的 Ruby, Python 等后端语言在浏览器的模拟实现,他们用的相关技术包括用 LLVM 把代码编译成 JavaScript 执行的编译器 Emscripten。codeschool 里有个 很有意思的地方 就是,它支持在浏览器里按照他们的规则去用 Objective-C 写 iOS 程序,编译是在服务器进行的,并通过 base64 编码不断传回截图,然后模拟成仿佛浏览器真的成了完美的 IDE 一样,包括编译信息和出错栈。 对于我们要实现在浏览器里用 Java 编写 Android 程序,一般方案是采用传送到服务器编译执行,但是这样涉及到复杂的沙盒模型,且对服务器端资源消耗过大。我知道有一家真的实现了,他们前端用的是 flash 技术,但是这个只能针对简单快速编译的项目,而且我觉得这个脱离了要教会对方学习的本质,因为以后的实际演练肯定是在 Eclipse 等 IDE 里进行的,而你的浏览器在现有技术情况下肯定无法全部模拟。后来我也想到了可以以 IDE 插件的形式解决把线下教学搬到线上的基本构思,技术难度降低一半,这是后话。在教学中三环节 教问练 中,真正把教和练做好的公司大概就这几家了,问的话去是程序员都上的 stackoverflow 等网站就好了。

去年下半年做了偏前端的 技能测评,和偏后端的 gist.github.com 克隆网站 。前者算基本没用过,后者不温不火,这让我明白了一个道理,如果我仅仅沉迷于技术实现,自己却无法分身去从事数种自己不熟悉或不太愿意实际执行的工作,那么它的命运就完全取决于组织的决定,因为一个真实产品的成长它需要不同职责的人的参与。前段时间听 @teahour 的一期 和 knewone 的李路聊聊技术和精益创业 也聊到类似的情况,很有共鸣。

而公司在这半年也陆续做了些小规模的 Android 培训。今年 2013 春节后,正式开启线上教育项目,产品设计由 @iceskysl 主导和驱动,我开始做聊天技术的预演,内容运营部门则调动内外部资源继续制作教程内容。

研发

单页面学习应用 learn.eoe.cn 和 报名支付宣传 xuexie.eoe.cn 及后台管理的整体开发上线共历时大概三四个月,我负责的是 learn.eoe.cn(一位前端同事负责写 CSS),其他的都是 php 项目组负责实施。

@iceskysl 设计好产品基本原型后,确认学习过程中为单页面应用,因为里面的聊天,问答,考试等的一些操作应该是尽量避免重载页面的。我自告奋勇去设计了学习系统的数据库设计,基本思想上按模块做命名空间切分,课程大纲设计为一个课程包含多个课时,一个课时包含多个小节,小节可以为视频,资料,测评等多种类型,这是内容部分。对应的学生数据则是一个学习数据表绑定一个课程,并关联观看视频监控记录,考试记录,和计时等。这期间,项目组内关于数据结构,或者说课程具体的产品设计需求,经过多次讨论,终于达成思路上的一致。

以下是现在上线后测试服务器里学习页面的多个模块的截图。 learn_video learn_qa learn_exam

我对架构设计的原则是技术模块化,业务流程化,两者互相解耦。

业务流程化

对于一个学生来说,TA 面对的主体是课程和 TA 的学习数据,其他都是依附于其之上。

对于内容管理人员来说,课程是标准的层级关联,视频和其他也只是依附于其之上。

对于我作为学习页面的技术负责人来说,用户是否付款和加入某个班级只是一个是非状态。用户的学习状态依赖于业务需求,可能需要结合多个数据源做操作判断,比如是否可以测评要保证你起码观看过教学视频及教学资料,是否学习完成也依赖于你对该课程所有课时的学习状态。

技术模块化

想清楚好以上清晰的业务流程骨架后,我开始本人 4 年技术生涯里最彻底的模块拆解,并开源出十多个模块。

跨子域名用户登陆,用的是 PHP 写的单点登陆解决方案 UCenter,我整理了 @iceskysl 从 PHP 改写的 Ruby 代码,并开源出来。在应用时,有次遇到误把对方一个每次都变的 cookies 作为这边的唯一身份认证,这个在单域名操作体现不出来,而访问多个子域名后这边 session 就失效了。

视频播放用的 VIDEO.JS 框架,不需要太多配置代码。另外我想了个开源的视频监控的方案,就是把用户对不同时间段的观看频次对应的以秒为单位的数组里,播放一次是 1, 最大是 9,以此观察视频具体效果,和单个学生的学习疑点。从最近遇到的一个 BUG 来看,浏览器缓存了视频,但是网络是随时可断的,导致某些网络不太稳定的用户的监控数据可能是部分缺失的。所以监控数据还是得与业务逻辑彻底分开的,前者只应该作为业务判断参考之一。(有人可能会提到放在 cookie 里,但是其最大长度是 4K,那么一个小时的视频 1*2*3600=7200 就放不下了)。

参考资料用的是 markdown 编辑和渲染,我抽取了 ruby-china 的 markdown 渲染代码,并 自动识别程序语言,文件名,别名等多种格式

问答讨论是个太标准的 CRUD 应用,一个论坛无非是主题和回复,里面显示的用户名和头像其实都是可以在前端用 JavaScript 去组装的, 用 Backbones 这个 Javascript MVC 框架实现模版和事件绑定 ,添加完数据表后,直接用一个 Rails Helper 配置下即可,我把它取名为 qa-rails

测评是个相对独立的业务,鉴于去年做过差不多的,这次实现更加精炼了些,JavaScript 239 行,HAML 两个模版 60 行。这块限于业务特殊无法作到开源。

班级讨论是基于 Faye 消息订阅发布系统 做的,并实现了 在线用户显示和计时,原理是绑定了 Faye 提供用户登入和登出的事件接口。 这里要特别感谢我们的一个女产品 (条理清晰的黑盒测试),是她用心的测试出了有这个用户的电脑非正常关闭浏览器造成服务器端一直在计时的错误。Faye 检测用户退出有两种方法,一种是服务器端的 EventMachine 定期检测 client 是否失去连接;另一种是客户端在浏览器关闭前发送 disconnect 请求 (对应的配置选项是 autodisconnect),如果正常关闭那是 ok 的,但是如果用户取消关闭,那么这个 faye client 就死掉了,也就无法聊天,更新在线用户和计时。然后我想到了一种方案是,就是关闭 autodisconnect,把这个事件改为发送让服务器三秒后才去检测这个 client 是否继续存活的请求,这样无论浏览器是否关掉,服务器 都照样主动检测。聊天室的弊端在于它的特点是需要中央服务器,无法支持过大的聊天室,这里暗示的一个信息是系统架构是可以按聊天室拆分做负载均衡的。

上面说的大部分都是从前端角度分析的,现在来说说后端。

随着项目不断迭代,我发现几乎大部分操作都直接绑定到用户学习状态表 LearnIssue 了,关联的课时和学习状态,每门课时对应的视频观看数据和考试信息都是代理过去,这样逻辑相对还是很清晰的。

在写单页面应用时,虽然像问答和聊天都独立出去用 JavaScript 载入了,但是还是需要同时载入几十个变量。一般人都会反应为什么不整合到 Model 里去呢 ,原因是我还把十多个数据合法验证加入到 Controller 里去了,这里包括后台人员录入的数据不规范和用户访问权限等,出错方式是给出带参数说明的 redirect_to URL ,比如 ?reason=course_invalid ,这样后台可以随时调整并在前端验证。在调整业务的时候,我经常要去调整变量位置,所以就写了类似 rake 步骤依赖的 stepstepstep.gem 去生成自动排序执行的 14 个 before_filters,里面涉及一个图论算法。

这个项目一个很大的特色之一是对 JSON 的运用,比如学习状态,课程信息等。大部分是直接用 json_record 配置的,效果等同于 Mongodb 文档存储(当然副作用是不能直接用 SQL 做字段本身的操作了),但是运维只需面对 MySQL 即可。我把项目设计成基本都是单表操作,现在一个学习页面的载入包含着近 50 条 SQL 查询,而响应时间却都还在 300ms 左右。

最后为了给大家一个相对直观的项目复杂度的理解,我运行 bundle exec rake stats 对 Ruby 源码情况做了简单统计,并对比由牛人 @huacnlee 主导开发的 Ruby China 专业社区论坛。

learn.eoe.cn
+----------------------+-------+-------+---------+---------+-----+-------+
| Name                 | Lines |   LOC | Classes | Methods | M/C | LOC/M |
+----------------------+-------+-------+---------+---------+-----+-------+
| Controllers          |   558 |   356 |       9 |      24 |   2 |    12 |
| Helpers              |    26 |    19 |       0 |       4 |   0 |     2 |
| Models               |   690 |   529 |      17 |      54 |   3 |     7 |
| Libraries            |   114 |    86 |       1 |       2 |   2 |    41 |
| Integration tests    |     0 |     0 |       0 |       0 |   0 |     0 |
| Functional tests     |    11 |     6 |       2 |       0 |   0 |     0 |
| Unit tests           |     8 |     6 |       2 |       0 |   0 |     0 |
+----------------------+-------+-------+---------+---------+-----+-------+
| Total                |  1407 |  1002 |      31 |      84 |   2 |     9 |
+----------------------+-------+-------+---------+---------+-----+-------+
  Code LOC: 990     Test LOC: 12     Code to Test Ratio: 1:0.0

ruby-china
+----------------------+-------+-------+---------+---------+-----+-------+
| Name                 | Lines |   LOC | Classes | Methods | M/C | LOC/M |
+----------------------+-------+-------+---------+---------+-----+-------+
| Controllers          |  1587 |  1251 |      32 |     182 |   5 |     4 |
| Helpers              |   365 |   301 |       0 |      41 |   0 |     5 |
| Models               |  1542 |  1166 |      24 |     106 |   4 |     9 |
| Mailers              |    18 |    15 |       2 |       1 |   0 |    13 |
| Javascripts          |  6908 |  5006 |       1 |     546 | 546 |     7 |
| Libraries            |   552 |   411 |       6 |      41 |   6 |     8 |
| Api specs            |   171 |   148 |       0 |       2 |   0 |    72 |
| Cell specs           |   127 |   106 |       0 |       0 |   0 |     0 |
| Controller specs     |   678 |   572 |       0 |       0 |   0 |     0 |
| Helper specs         |   364 |   290 |       0 |       0 |   0 |     0 |
| Lib specs            |   229 |   173 |       0 |       0 |   0 |     0 |
| Model specs          |  1034 |   859 |       3 |       0 |   0 |     0 |
| Request specs        |    40 |    33 |       0 |       0 |   0 |     0 |
| Routing specs        |    58 |    43 |       0 |       0 |   0 |     0 |
| View specs           |    34 |    26 |       0 |       0 |   0 |     0 |
+----------------------+-------+-------+---------+---------+-----+-------+
| Total                | 13707 | 10400 |      68 |     919 |  13 |     9 |
+----------------------+-------+-------+---------+---------+-----+-------+
  Code LOC: 8150     Test LOC: 2250     Code to Test Ratio: 1:0.3

假设代码质量和风格差不多的话,从代码量来说 learn.eoe.cn 主体 Ruby 部分的复杂度是 ruby-china.org 的三分之一(从 Models 和 Controllers 占比来说也是差不多的),对于一个单页应用来说这差不多了。唯一的区别是 learn.eoe.cn 的控制器方法行数比 ruby-china.org 大三倍,这和业务逻辑更加复杂有关。(Ruby China 得排除基本都是外部静态 js 的这 6908 行统计数据。)

另外上午我写了一段 Ruby 脚本来统计 learn.eoe.cn Rails 项目及其开源项目源码行数 ,结果为:

[rails_engine_eoe]  Ruby:884 | JavaScript:15 | HAML:0
[ucenter_authcode]  Ruby:78 | JavaScript:0 | HAML:0
[rack_image_assets_cache_control]  Ruby:28 | JavaScript:0 | HAML:0
[faye-online]  Ruby:678 | JavaScript:52 | HAML:0
[qa-rails]  Ruby:259 | JavaScript:280 | HAML:183
[videojs_user_track]  Ruby:140 | JavaScript:84 | HAML:0
[stepstepstep]  Ruby:271 | JavaScript:0 | HAML:0
[cross_time_calculation]  Ruby:143 | JavaScript:0 | HAML:0
[/Users/mvj3/eoemobile/code/learn]  Ruby:4113 | JavaScript:1108 | HAML:517

[total] Ruby:6721 | JavaScript:1539 | HAML:700

可以看到 Ruby 和 JavaScript 有三分之一左右是开源的,Ruby 更多些。另外一个数据是 git 提交日志, 1,347 commits / 21,477 ++ / 12,354 --

这项目最大的遗憾就是没有测试,和互联网创业产品风格及资源配备等都很有关系,不过抽取的外部库比较重要或重逻辑的地方都写了必要的测试了。

注明: 本文仅代表个人观点,与实际所涉公司无关。

原始地址在: http://mvj3.github.io/2013/08/04/a-man-github/

需要 登录 后方可回复, 如果你还没有账号请 注册新账号