超简单组织AngularJS模块

去年下半年接触前端开发和AngularJS,一路跌跌撞撞,尤以模块化代码组织的教训最深刻。

最开始代码量小也没经验,直接在html引用所有js文件。后来搞得html文件越来越大,js的顺序一乱,就报奇奇怪怪的错误,找半天。

第二个项目,我就想着要改进,直奔声名显赫的RequireJS去了。但RequireJS真的很麻烦有木有!平添了许多代码,和AngularJS的Dependency Injection长得还挺像,一不小心就搞混。时不时报个Script Error出来,根本不知道问题在哪里。

有没有更简单的方法呢?正想着呢,ng-newsletter一声炮响,送来了这篇文章。作者Jeff Dickey介绍了用模块来组织代码的四种方法,依照推荐程度,依次为:

  • Require.js (Implementation of AMD)
  • Browserify (Implementation of CommonJS)
  • Angular dependency injection
  • ES6 modules

作者着重写了在第三种基础上,组织代码的简化方法(捂脸,我才用到第一种)。

模块的功用,首先是要隔离命名空间。Angular的模块机制很好地解决了。除了angular这个对象本身,没有任何暴露在Global里的对象。

然后是处理依赖关系。Angular的模块同样指定了依赖关系,而Dependency Injection在更细的粒度上做了类似的事。

更棒的是,Angular模块的定义顺序可以随便。各个service、controller、directive注册到模块的顺序,也没有限制。唯一的要求只是:模块要先定义,后使用。请看下面的例子:

// 模块可以按任意的顺序定义
angular.module('app', ['ctrl']);
angular.module('ctrl', ['svc']);
angular.module('svc', []);

// 使用尚未注册的GithubSvc
angular.module('ctrl')
.controller('GithubCtrl', function ($scope, GithubSvc) {
  GithubSvc.fetchStories().success(function (users) {
    $scope.users = users;
  });
});

angular.module('svc')
.factory('GithubSvc', function ($http) {
  return {
    fetchStories: function () {
      return $http.get('https://api.github.com/users');
    }
  };
});

可运行的代码在这个jsFiddle

Angular没有帮我们解决的,就剩下文件加载了。既然加载顺序无关紧要,那直接把文件合并起来不就好了?反正最终都要合并的。

gulp.task('js', function () {
  gulp.src(['src/**/module.js', 'src/**/*.js'])
    .pipe(concat('app.js'))
    .pipe(gulp.dest('.'))
})

无论是按业务还是按功能划分目录,只要把每个模块的定义都放在目录下的module.js里,保证所有模块在使用之前都已经定义过了,直接concat毫无问题。html里却只有一行:

<script src="app.js"></script>

编写、测试还是按模块分目录和文件,代码组织清晰利落。拼接到一起在浏览器上跑。发布时,再ngAnnotateuglify一下就好。

库的代码,再拼出一个vender.js就行了。gulp-bower-files这个插件,可以分析bower.json,把依赖的每个库里的main属性组合起来,创建gulp.src()

gulp.task('vendor', function () {
  gulpBowerFiles()
    .pipe(concat('vendor.js'))
    .pipe(gulp.dest('.'))
})

每次手工gulp js不方便?gulp watch起来。

gulp.task('watch', ['js'], function () {
  gulp.watch('src/**/*.js', ['js'])
})

当然,这些都是权宜之计,因为传说中的ES6和Angular 2.0,将搞定这些问题。不过在此之前,不妨试试这个超简单的方法咯。


[补充]

  1. gulp-bower-files已被main-bower-files取代。
  2. moduleconfig阶段是有顺序依赖的。比如,要定义route里的controller,就要求该controller必须存在。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,839评论 6 482
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,543评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,116评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,371评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,384评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,111评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,416评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,053评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,558评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,007评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,117评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,756评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,324评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,315评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,539评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,578评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,877评论 2 345

推荐阅读更多精彩内容

  • 返回导航 This document aims to explain all mechanisms include...
    Transnet2014阅读 473评论 0 1
  • gulpjs是一个前端构建工具,与gruntjs相比,gulpjs无需写一大堆繁杂的配置参数,API也非常简单,学...
    井皮皮阅读 1,291评论 0 10
  • awesome-gulp中文版 一份gulp的资源,插件和使用实例清单, 致力于打造更好的前端工程构建流程。 被老...
    Pines_Cheng阅读 5,514评论 10 117
  • 对网站资源进行优化,并使用不同浏览器测试并不是网站设计过程中最有意思的部分,但是这个过程中的很多重复的任务能够使用...
    懵逼js阅读 1,057评论 0 8
  • 第一主持自我介绍和介绍老师(调动气氛) 第二群规规则(宣布爬楼密码) 第三引导 第四主题介绍 第五各种方法依次介绍小标题
    知心_b443阅读 398评论 0 0