Package.js  现代化的JavaScript项目make工具


Posted in Javascript onMay 23, 2012

Package.js项目地址:http://code.google.com/p/package-js/ 

Package.js是一个很方便的JavaScript包依赖管理及Make工具。它的设计目标是使浏览器端的JavaScript Component/App 开发更加模块化。如果您只是在开发一个小型的网站,只会混杂在HTML中写几行JS代码用于改善一下用户体验,那么Package.js也许并不适合您。如果您正在开发一个中到大型的WebApp,有几十甚至几百几千个JS文件和CSS文件、HTML模板文件,如果您正在为管理这些JS模块之间的依赖和加载而烦恼,为发布到生产环境时将JS文件合并打包而写Makefile写得头晕,那么,Package.js,这就是你想要的!赶快来了解并使用Package.js吧! 

Package.js主要包含两个部分

运行在浏览器中的,用于define及import模块的JS库API
运行在node.js环境,将所有JS包及其依赖的CSS及HTML文件合并的make工具

Package.js浏览器端的API参照了CommonJS/AMD规范,兼容此规范的最简单形式,并在此基础扩展了一些语法,以便于开发包含CSS及HTML模板的JavaScript UI组件。

直接来看一下使用Package.js开发的项目的目录结构吧,简单明了:

Test 
├── dom 
│ └── Style.js #命名空间为Test.dom.Style的模块文件 
├── init.js #根命名空间初始化文件 
├── _nsconf_.js #Package.js会读取的配置文件 
├── ui 
│ ├── Button 
│ │ ├── img 
│ │ │ └── bg.png 
│ │ ├── init.js #Test.ui.Button命名空间的模块文件 
│ │ ├── style.css #UI组件的CSS文件 
│ │ └── tpl.html #UI组件的HTML模板文件 
│ └── Form 
│ ├── init.js 
│ ├── style.css 
│ └── tpl.html 
├── util 
│ └── Cookie.js #命名空间为Test.util.Cookie的JS包 
└── _xproxy_.html -> ../Package/_xproxy_.html #此文件为Soft Link指向Package.js源码中的Package/_xproxy_.html,用于跨域加载HTML模板文件

使用Package.js,模块的定义语法——
Root/ui/Button/init.js代码:
Package.define("Root.ui.Button",["Root.ui.Pane","Root.util.Tpl","Root.util.Event"], 
function (Pane,Tpl,Event) { 
//Pane为Root.ui.Pane 
//Tpl对应Root.util.Tpl 
//依此类推 
//..... 
});

与CommonJS的AMD规范不同,在Package.js的语法中,一个JS模块,不但可以依赖其它JS包,还可以依赖CSS及HTML模板文件、及其它的JSON数据文件,并在运行时,获取到依赖的其它文件的内容。定义语法如下:
Package.define("NS.ui.Button",["MT.ui.Component"], 
{ 
tpl:"tpl.html", 
_style:"style.css" 
},function (Component) { 
//通过this.assets.tpl访问tpl.html内容 
var bgImgUrl=this.path+"img/bg.png",tpl=this.assets.tpl; 
function Button(opt) { 
//也可以通过当前Package对象的_pkgMeta_属性访问assets 
this.tpl=String2Dom(opt.tpl || Button._pkgMeta_.assets.tpl); 
} 
return Button; 
})

在浏览器中,可以使用下面的方法导入一个JS模块,
在导入的过程中,Package.js自动帮您做了后勤工作:1、加载这个模块的依赖模块。2、加载依赖的HTML及CSS文件。
Package.imports(["Root.ui.Button"],function (Button) { 
var btn=new Button(); 
btn.renderTo(document.body); 
});

在开发时,为了模块化,您需要将JS分成一个一个小的模块文件,但发布到生产环境时,为了加载速度上的考虑,您需要将这些JS文件合并成单个的JS文件并压缩,同样,CSS文件也要合并到一起。
//您的打包配置文件 
//build-config.json文件内容 
{ 
"staticUrls": {"defaults":"http://statics.iwt.macrotarget.com/jslibs/"}, 
"nsconfs":["http://www.cnblogs.com/statics/jslibs/XLib/_nsconf_.js"], 
"includes":["XLib.apps.MainApp","XLib.ui.*"], 
"compress":true //使用UglifyJS和UglifyCSS进行压缩 
}

借助Package.js,完成这个功能,您只需要写三四行JSON配置代码,执行一个命令,就一切OK了。
#执行命令 
build.js build-config.json js all.min.js 
build.js build-config.json css all.min.css 
#腰不酸了,腿不疼了!

引用

PS:build.js还帮您做掉一个小事:将CSS文件中的background:url()之类的相对路径转换成绝对URL。您在开发时,CSS中url()始终只需要写相对路径,在部署到生产环境时,build.js合并后的CSS会自动将其转换成绝对URL。甚至,如果你有使用IE6 Png AlphaImageLoader滤镜,使用wui4ie6的loader,您在开发时仍然可以在src=里写相对路径,在开发模式下,Package.js也会自动生成使用绝对URL的CSS Rule,在打包时也会对 AlphaImageLoader的src作转换,CSS中永远不需要写绝对URL

Package.js相比于其它模块加载器及AMD实现(RequireJS,SeaJS...)有什么优势或缺点?

Package.js是面向Web App Framework开发,定义语法及文件目录结构较严格(或者说稍显复杂),只使用AMD规范中最简单的一种define语法
Package.js将JS模块对CSS及HTML文件的依赖与对其它JS模块的依赖在define写法上区分开来,并且在build.js中也包含了对CSS、HTML、JSON打包的处理
(TOT)包含对IE6 CSS的特殊照顾(没办法,我们自己的项目需要)
增加PackageMeta,一个JS模块在运行时可以知道自己的URL
...如果算缺点的话:不与CommonJS AMD规范完全兼容
build时支持三种导出模式:includes,deps,all
开发模式下更方便:使用_xproxy_.html跨域加载,无需代理。使用_nsconf_.js,无需配置paths。

听完这些简单的介绍或许您对Package.js已经跃跃欲试了,在使用之前,您可以参考下 
Package.js的详细文档:http://package-js.googlecode.com/hg/docs/Package.html。 

好!不要再用落后的方式开发JavaScript App,不要再做Out Man,赶快使用Package.js吧 ^O^ 

Javascript 相关文章推荐
JavaScript 比较时间大小的代码
Apr 24 Javascript
javascript 防止刷新,后退,关闭
Aug 07 Javascript
jQuery设置指定网页元素宽度和高度的方法
Mar 25 Javascript
jQuery基于ajax实现带动画效果无刷新柱状图投票代码
Aug 10 Javascript
理解JavaScript中Promise的使用
Jan 18 Javascript
深入理解JavaScript中为什么string可以拥有方法
May 24 Javascript
移动端H5开发 Turn.js实现很棒的翻书效果
Jun 20 Javascript
javascript 小数乘法结果错误的处理方法
Jul 28 Javascript
Easyui 关闭jquery-easui tab标签页前触发事件的解决方法
Apr 28 jQuery
浅谈layui 绑定form submit提交表单的注意事项
Oct 25 Javascript
JS猜数字游戏实例讲解
Jun 30 Javascript
一起来看看Vue的核心原理剖析
Mar 24 Vue.js
检测input每次的输入是否合法遇到汉字输入就有问题
May 23 #Javascript
JavaScript可否多线程? 深入理解JavaScript定时机制
May 23 #Javascript
setTimeout的延时为0时多个浏览器的区别
May 23 #Javascript
jQuery 瀑布流 绝对定位布局(二)(延迟AJAX加载图片)
May 23 #Javascript
jQuery 瀑布流 浮动布局(一)(延迟AJAX加载图片)
May 23 #Javascript
Javascript 面向对象(三)接口代码
May 23 #Javascript
Javascript 面向对象(二)封装代码
May 23 #Javascript
You might like
php绝对路径与相对路径之间关系的的分析
2010/03/03 PHP
服务器上配置PHP运行环境教程
2015/02/12 PHP
调试Node.JS的辅助工具(NodeWatcher)
2012/01/04 Javascript
JavaScript Scoping and Hoisting 翻译
2012/07/03 Javascript
用客户端js实现带省略号的分页
2013/04/27 Javascript
三分钟带你玩转jQuery.noConflict()
2016/02/15 Javascript
【经典源码收藏】基于jQuery的项目常见函数封装集合
2016/06/07 Javascript
canvas 弹幕效果(实例分享)
2017/01/11 Javascript
微信扫码支付零云插件版实例详解
2017/04/26 Javascript
Webpack打包css后z-index被重新计算的解决方法
2017/06/18 Javascript
react系列从零开始_简单谈谈react
2017/07/06 Javascript
jquery动态赋值id与动态取id方法示例
2017/08/21 jQuery
用Vue.js方法创建模板并使用多个模板合成
2019/06/28 Javascript
详解json串反转义(消除反斜杠)
2019/08/12 Javascript
微信小程序关键字变色实现代码实例
2019/12/13 Javascript
绘制微信小程序验证码功能的实例代码
2021/01/05 Javascript
pytyon 带有重复的全排列
2013/08/13 Python
Python使用CMD模块更优雅的运行脚本
2015/05/11 Python
Python中if __name__ == '__main__'作用解析
2015/06/29 Python
Django 使用logging打印日志的实例
2018/04/28 Python
Python对象属性自动更新操作示例
2018/06/15 Python
在Python中过滤Windows文件名中的非法字符方法
2019/06/10 Python
Python Numpy计算各类距离的方法
2019/07/05 Python
解决Python3 控制台输出InsecureRequestWarning问题
2019/07/15 Python
python GUI库图形界面开发之PyQt5信号与槽机制、自定义信号基础介绍
2020/02/25 Python
Python爬取12306车次信息代码详解
2020/08/12 Python
Python机器学习工具scikit-learn的使用笔记
2021/01/28 Python
SmartBuyGlasses德国:购买太阳镜和眼镜
2019/08/20 全球购物
法国春天百货官网:Printemps.com
2020/06/29 全球购物
英国运动风奢侈品购物网站:Maison De Fashion
2020/08/28 全球购物
如何写毕业求职自荐信
2013/11/06 职场文书
巴西世界杯32强口号
2014/06/05 职场文书
2014年数学教师工作总结
2014/12/03 职场文书
用几道面试题来看JavaScript执行机制
2021/04/30 Javascript
再次探讨go实现无限 buffer 的 channel方法
2021/06/13 Golang
Mysql Innodb存储引擎之索引与算法
2022/02/15 MySQL