#smartcomb

===============

smartcomb是一个用php实现的web模块拼合器，相对于其他的代码拼合工具，它有如下特性：

• 可以拼合任意类型的文件，不限于js文件。
• 集中并声明依赖，自动分析依赖拼合，按需加载。
• 支持多种配置切换
• 自动修改css,less中的图片路径，无需担心拼合后css图片路径出错
• 支持php命令行调用，支持命令直接生成拼合静态文件，且过程可逆
• 缓存支持
• 支持直接生成静态文件并更新调用

##github地址

git clone https://github.com/hafeyang/smartcomb.git

##Smartcomb结构简图

点击可以查看大图

##模块声明配置

smartcomb是由smartcomb.php 和modules.js构成，modules.js是一个json文件，必须是严格的json格式，key需要加上双引号，用于模块声明。格式为：

{
    [profile]:{
		"basePath": "所有文件共有的基础路径",
		"modules":{
			"[modulename]":{
				[type1]:["file1","file2"],
				"dependencies":["depend module name","",""]
			}
		}
	}
 }

下面是一个demo:

{
    "default":{
        "basePath":"modules/",
        "modules":{
            "base":{
                "js":["base/base.js","base/common.js"],
                "css":["base/reset.css"],
                "less":["base/reset.less"]
             },
             "pageA":{
                 "js":["pageA/pageA-util.js","pageA/pageA.js"],
                 "css":["pageA/pageA.css"],
                 "dependencies":["base"]
             }
        }
    }
}

##web中使用

上面的demo声明了profile 为default的模块配置。声明两个模块base和pageA,pageA依赖于base模块。其中base模块包括两个js文件: modules/base/base.js，该路径是相对于smartcomb.php的路径，文件类型可以任意定义，使用时指定类型即可。

如上配置文件，我们可以在页面中如下引用：

<script type="text/javascript" src="path/to/smartcomb.php?type=js&modules=pageA"></script>
<link href="path/to/smartcomb.php?type=css&modules=pageA" type="text/css" charset="utf-8"/>

pageA依赖于base模块。smartcomb自动拼合依赖的的文件。

smartcomb.php调用参数：

• profile:配置类型，默认为default。用该参数可以切换profile
• type:文件类型，模块声明中的类型，可以是自定义的任何文件类型，默认是js
• modules:需要拼合的模块，多个模块可以用,分割

##命令行中使用

可以直接使用 php命令，如：

php smartcomb.php -profile default -type js -modules pageA

命令直接在标准输出中输出拼合结果，可以直接生成文件。

php smartcomb.php -profile default -type js -modules pageA > pageA-dep.js

参数与web调用方式一致

##css中引用图片路径修改规则

只修改相对路径的图片，文件后缀限于png,gif,png

background-image: url("images/q4.jpg"); /*相对路径，修正*/
background-image: url('../images/q3.jpg'); /*相对路径，修正*/
background-image: url(./images/q3.jpg); /*相对路径，修正*/
background-image: url(/abc/images/q2.jpg); /*绝对路径，无视*/
background-image: url(http://abc.com/a.png); /*绝对路径，无视*/

##缓存策略

可以参见php实现缓存 http://www.jonasjohn.de/snippets/php/caching.htm

###Etag缓存

将拼合的文件内容md5值后作为ETag的值写入到 http header，这样文件修改ETag也随之更新，浏览器端缓存失效

###通过Last-Modified

将http header中的 Last-Modified 设置成拼合文件中最近修改的文件时间，通过，Last-Modified If-Modified-Since缓存。

###默认的缓存时间

如果ETag,和Last-Modified 都不改变，缓存30天失效，通过http header 中的 Cache-Control ,Expires实现

##生成静态文件并更新引用

可以将代码中的smartcomb.php引用：

<script type="text/javascript" src="path/to/smartcomb.php?type=js&modules=pageA"></script>
<link href="path/to/smartcomb.php?type=css&modules=pageA" type="text/css" charset="utf-8"/>

直接替换为

<script type="text/javascript" src="path/to/[md5].js"></script>
<link href="path/to/[md5].css" type="text/css" charset="utf-8"/>

替换命令为：

php path/to/combbuild.php  -target=target/dir -prefix=html,php -exclude aboutus.html,contact.html

该命令会在smartcomb.php所在目录生成以拼合文件内容MD5值命名的文件，同时更新smartcomb.php的引用。

参数定义：

• target 需要替换的目标目录，注意该目录中有且只有唯一smartcomb.php 文件，因为生成的文件与smartcomb.php同目录，默认为当前目录
• ext 需要替换的文件名后缀，多个后缀以,分隔，默认为html
• exclude 需要排除的文件，多个文件名以,分隔,只要文件完整路径中包含该文件名将会排出，默认会排出smartcomb自身的文件

##静态文件还原成smartcomb.php引用

可以将代码中的[md5].js [md5].css还原为smartcomb.php引用：

<script type="text/javascript" src="path/to/[md5].js"></script>
<link href="path/to/[md5].css" type="text/css" charset="utf-8"/>

还原为

<script type="text/javascript" src="path/to/smartcomb.php?type=js&modules=pageA"></script>
<link href="path/to/smartcomb.php?type=css&modules=pageA" type="text/css" charset="utf-8"/>

替换命令为：

php path/to/combdev.php  -target=target/dir -prefix=html,php -exclude aboutus.html,contact.html

参数定义：

• target 需要替换的目标目录，注意该目录中有且只有唯一smartcomb.php 文件，因为生成的文件与smartcomb.php同目录，默认为当前目录
• ext 需要替换的文件名后缀，多个后缀以,分隔，默认为html
• exclude 需要排除的文件，多个文件名以,分隔,只要文件完整路径中包含该文件名将会排出，默认会排出smartcomb自身的文件

=============

Thanks,任何问题,请与我联系：)