js大项目代码的多人合作处理方法

开发 前端
js大项目代码组织多人合作时会出现种种问题,编写规范的随意性 ,编写风格的个性化,是js项目维护成本的很大一部分原因。

Js开发在整个行业的现状主要的有两点

维护成本高

多人协作项目的困境

Js项目维护成本过高

经历过10年的ie统治时期的浏览器世界一成不变,和06年开始ajax的兴起带动垂死的javascript的复兴,浏览器市场也开始翻天覆地的快速变化,排版引擎和js脚本引擎开始得到不断的优化,js的执行效率不断的得到提高,但是………..

我们的js一直没变过. 现在所有的主流 Web 浏览器都遵守 ECMA-262 第三版,即实现的是JavaScript 1.5版  时间 2000

那么,js依然是当年的js,浏览器和对web的需求早已经不复当年。当年那个为做表单验证而生的js语言,如今承担的是复杂的界面ui和交互处理,以前只需要写十几行或者几十行的js现在需要面对几千上w行的需求。

那么带来的问题就是十年来js语言特有的随意性导致的各路js程序员的js风格各异。

Js的弱类型特性导致项目中经常会出现jser的各种奇技淫巧。

上面的两问题直接导致的是js程序交接维护上的困难。面对js风格清晰易懂的jser的代码还好,如果接手js风格怪异太个性的jser的代码,并且如果还没有注释,那么,看代码真心会看到你吐血

编写规范的随意性 ,编写风格的个性化,是js项目维护成本的很大一部分原因

多人协作项目的困境

其实看过前面的内容,我们大抵的了解到,js是应很简单的需求而生的,甚至简单到是用来做简单的表单验证的。也就是说,js代码,在很长一段时间内,都是由一个开发独立完成的,多人协作上会出现的问题

1,全局变量命名混乱冲突导致系统错误

2,代码集中少量文件导致开发效率降低

3,容易出现功能重复开发

Js开发编写方式的演进

函数:js作为函数式语言与生带来的特性,jser们通过在window下注册一个又一个的function相互调用来完成产品们的需求(全局变量命名极为混乱和不规范)

类:jser为大型js项目开发的尝试, 2006年,Ajax兴起。JavaScript绝地重生,越来越多的后端逻辑放到了前端。网页中的JS代码量急剧增加。这时写函数方式组织大量代码显得力不从心。有时调试一个小功能,从一个函数可能会跳到第N个函数去。这时jser们前仆后继,进行各样尝试,类出现了,Prototype 率先流行开来。用它组织代码,用js的灵活性模拟类的编程,每个类都是Class.create创建的。又有YUIExt等重量级框架。虽然它们的 创建类方式各不同,但它们的设计终极目标却都是要满足大量JavaScript代码的开发而努力

类开发尝试的转折-------这是一个战火纷飞的年带,各路框架豪杰不断涌现,jq的诞生带来了js开发的又一次变革,jq所至,其他框架寸草不生,同时也直接导致 prototype 等“类”的尝试又化为乌有,很大一帮jser转投jq尤其是js新手直接着手jq者,在享受了jq在小型页面dom操作的遍历之后,大型js项目的多人协作和代码组织问题又暴露到了台前,甚至是制约js乃至整个web发展的一个不小的因素

那么,模块化开发——现在,未来?

Commonjs,首先要说下这个。何为commonJS?commonJs可以理解成一个组织,他们中的所有人都致力于提高javascript程序的可移植性以及可交互性。在js模块化开发上做各种的尝试,这种可移植性以及可交互性不仅仅局限于浏览器端,而且也包括了服务器端的javascript, CommonJS 提出了一种用于同步或异步动态加载JavaScript代码的API规范,非常简单却很优雅,称之为AMD(Modules/Asynchron , RequireJS和NodeJS的Nodules已经实现了这个API,而Dojo也将马上完全支持(Dojo1.6)。规范本身非常简单,甚至只包含了一个API:

define([module-name?], [array-of-dependencies?], [module-factory-or-object]);

这个就是差不多的整个amd规范的定义。我们这里主要已requirejs为例做个简单的说明

RequireJS快速入门-模块定义

1.Simple Name/Value Pairs

2.Definition Functions

3.Definition Functions with Dependencies

4.Define a Module as a Function

5.Define a Module with Simplified CommonJS Wrapper

6.Define a Module with a Name

Simple Name/Value Pairs

定义的是一个简单的键值对数据模块ž

 
  1. //Inside file my/shirt.js:  
  2.  define({  
  3.     color: "black",  
  4.     size: "unisize“  
  5.  });  
  6.  

Definition Functions

定义的模块包装在一个function内 

 
  1. define(function () {  
  2. //Do setup work here  
  3.     return {  
  4.        color: "black",  
  5.        size: "unisize“  
  6.  }  
  7.  }); 

Definition Functions with Dependencies

定义一个有模块依赖关系的模块

  1. //module in the same directory as shirt.js  
  2. define(["./cart", "./inventory"], function(cart, inventory) {  
  3.         //return an object to define the "my/shirt" module.  
  4.         return {  
  5.              color: "blue",  
  6.              size: "large",  
  7.              addToCart: function() {  
  8.                  inventory.decrement(this);  
  9.                  cart.add(this);  
  10.              }  
  11.         }  
  12. } );  

那么,执行了这个模块的初始化会依次的加载顺序为

  1. my/cart.js  
  2. my/inventory.js  
  3. my/shirt.js 

Define a Module as a Function

定义的模块为返回一个function

  1. define(["my/cart", "my/inventory"], function(cart, inventory) {  
  2.     //return a function to define "foo/title".  
  3.    //It gets or sets the window title.  
  4.    return function(title) {  
  5.       return title ? (window.title = title) : inventory.storeName + ' ' + cart.name;  
  6.    }  
  7. } ); 

Define a Module with Simplified CommonJS Wrapper

定义一个简单的commonjs包装

  1. define(function(require, exports, module) {  
  2.        var a = require('a'),  
  3.              b = require('b');  
  4. //Return the module value  
  5.        return function () {};  
  6.  } );  
  7.  

这个定义就可以把模块内部的任何变量暴露给exports来作为模块的属性提供。比如:

内有个定义

  1. var name=‘nickli’; 

这个就仅仅是模块的内部私有变量,但是要想作为这个模块的属性提供就可以

  1. Exports.name=“nickli”;  

然后在require这个模块的时候 就可以访问到name这个属性了

最后一点,也是比较重要的一点

Define a Module with a Name  给一个模块设置一个名字,这个在多个模块压缩成一个文件的时候是必要的,因为否则模块系统就找不到你压缩的文件里面哪个模块是哪个。而且这个name的定义 在你的开发环境中也要符合模块文件的路径,比如你的m模块在a文件夹下,那么你的name 的定义也要是 a/m 

  1. //Explicitly defines the "foo/title" module:define("foo/title",  
  2.         ["my/cart", "my/inventory"],  
  3.         function(cart, inventory) {  
  4.             //Define foo/title object in here.  
  5.        }  
  6. ); 

模块化后的加载

  1. <script data-main="scripts/main" src="scripts/require.js"></script> 

Require.js加载完毕后会自动去 拉取scripts/main.js

  1. //Inside scripts/main.js  
  2. require(["some/module", "a.js", "b.js"], function(someModule) { //... });  

会依次加载some/module.js   a.js b.js三个文件

模块化后的新问题

目前nodejs的模块系统是严格遵循的commonjs  规范实施的,但是要注意到,nodejs是运行在server端的,然而浏览器端编程和server的最大不同是server的所有模块文件都是在server和主文件是一块的。而浏览器要面对的是大量的模块文件带来的大量http请求的问题, 嗯, 这个问题在浏览器端是致命的。。。。。。。

不过我们有combo   动态文件压缩技术,这里不详述,前面已经有一随笔 讲述 require来实现combo的支持

关于js的模块化开发和amd相关资料,在http://www.cnblogs.com/snandy/里有不少更加详细的资料。

原文链接:http://www.cnblogs.com/litao229/archive/2012/04/10/2440274.html

【编辑推荐】

1.分享30套免费的高质量网页按钮素材

2.10个绝对让你疯狂的HTML5和JS实验性展示

3.jQuery命名冲突解决的五种方案

4.12个必要的jQuery表单插件

5.一些非常棒的jQuery拖放插件

【责任编辑:张伟 TEL:(010)68476606】

 

责任编辑:张伟 来源: 李涛的博客
相关推荐

2013-04-23 15:31:28

大项目

2011-04-07 15:09:48

项目管理项目

2015-07-13 11:09:06

谷歌改变世界

2014-02-28 13:27:08

程序员代码

2011-04-28 08:59:20

项目框架

2020-05-27 11:03:27

物联网安全物联网IOT

2022-04-27 08:24:04

项目管理群管理管控

2022-10-09 08:48:13

配置化建造者参数

2024-01-12 19:12:46

2018-12-12 14:53:37

维谛技术

2022-02-09 08:54:43

项目JavaScriptvite

2020-10-15 16:27:26

腾讯TencentOS tTKEStack

2020-10-26 13:55:53

数据人工智能区块链

2021-01-14 11:05:41

项目配置属性

2021-07-16 09:17:07

数字化

2013-08-28 09:57:17

工作效率项目

2019-04-08 15:53:37

戴尔

2016-09-02 16:13:05

项目

2021-06-01 06:00:06

typescriptjavascript

2021-07-26 10:33:54

Web开发项目
点赞
收藏

51CTO技术栈公众号