文档说明
万能资源加速(扩展版)
此加速服务为万能资源加速服务扩展版,不仅包含万能资源加速服务普通版的所有功能,还支持对任意第三方网站的任意前端资源进行加速,极大地扩大了使用范围。
此加速服务作为原普通版的扩展,原则上不考虑和普通版在同一个CDN供应商上,以降低运营风险,且CDN的服务质量会稍逊于普通版。
此加速服务不适用于我们的资源的扩展引用方式,只能使用普通引用方式,流量也有限,且仅支持https协议。
此加速服务对于自定义扩展资源默认并不开通,需要用户订阅我们的网站,并申请网站地址和提交网站资源规则列表(当前只支持6个规则)。当前需要手动申请,后续版本完善后,可在我们网站上自行提交自动开通。
对于用户申请的自定义资源加速,目前仅限用户自己的网站调用(不允许跨域调用,未来有可能会逐步放开到10个),不能提供给他方使用。
服务地址为:https://res-ext.webcache.cn
资源引用方式如下:
1)自动模式(有我方可替代服务,则替代),把原地址去掉协议头后追加到我方服务地址的后面。
<script src="https://res-ext.webcache.cn/unpkg.com/jquery@2.2.4/dist/jquery.min.js"></script>
2)跳转模式(直接跳转到第三方资源上),在上述自动模式的根地址前面追加“/-”。
<script src="https://res-ext.webcache.cn/-/unpkg.com/jquery@2.2.4/dist/jquery.min.js"></script>
当我方CDN出现故障,您可以在URL地址上去掉我们的服务地址前缀即可。当您对我方CDN加速暂时不满意时,可使用上述跳转模式,强制使用原有第三方资源。以此希望能保证您的加速服务不间断,网站也能持续运行。
申请加速资源的URL规则如下表。
序号 | 基本规则/应用规则 | 说明 |
1 | <base_path>/[v]{version}/<file_path> | 以版本号为文件夹分类存放,通常用于多个JS公共库集中存放。 |
/static/lib/jquery/{version}/jquery.min.js /static/lib/jquery/v{version}/jquery.min.js |
||
2 | <dir_path>/<name>(-|_)[v]{version}<ext> | 版本号附带在文件名尾部,通常用于只需要单个版本库的情况。文件扩展名只能为“.js”、“.min.js”、“.css”、“.min.css”。 |
/static/lib/jquery-{version}.min.js /static/lib/jquery_v{version}.min.js |
||
3 | <path>?(v|_v)={version} | 通过在URL查询参数中附带版本号,通常为日期顺序号,最多缓存文件的5个版本,历史缓存版本将被不定期删除。另外,每日也最多使用5个,超过则不缓存,而是跳转。 |
/static/img/002.jpg?_v={version} |
||
4 | <dir_path>/<name>(-|_|.){hash}<ext> | 此为附带HASH的文件名,扩展名只能为“.js”和“.css”。 |
/static/js/index_{hash}.js |
以上规则里,除了第3条规则明确指明以外,其他规则的实例URL里的查询参数不能包括“v”和“_v”参数,否则,将跳转到原地址。
上述包含的符号说明:尖括号“<>”为用户需要实例化的规则内容,小括号“()”为必须但可选内容,大括号“{}”为规则变量,不可在应用规则中实例化,中括号“[]”为可选内容,字符“|”为可选分隔符。
上述包含的代称或规则变量的说明:
变量/代称 | 说明 |
<base_path> | 基本目录,最多3层。 |
<dir_path> | 目录路径,最多5层。 |
<file_path> | 版本下的文件路径,最多5层。 |
<path> | 完整文件路径,最多10层。 |
<ext> | 文件扩展名,非指定说明的情况下,默认包括:.js, .min.js, .css, .min.css, .json, .jpg, .jpeg, .gif, .png, .svg, .ttf, .otf, .ttc, .eot, .woff, .woff2, .tiff。 |
{version} | 版本号,可以是“1.2.3”、“1.2.0-beta”,也可以是“20250414”。最多缓存5个主版本(子版本不受限制),历史版本将被不定期删除。 |
{hash} | HASH字符串,通常是对文件内容进行MD5或SHA1计算后的值,可以为8到32位,小写。最多缓存文件的10个HASH版本,历史HASH版本将被不定期删除。 |
其中,对资源文件的默认限制为最大100KB(仅判断传输内容大小,不判断是否压缩过),图形图像格式限制如下:
文件类型 | 大小限制 | 尺寸限制 |
svg | 10KB | - |
gif | 20KB | 面积小于64x64 |
jpg | 30KB | 面积小于64x64 |
png | 40KB | 面积小于64x64 或正方形尺寸小于128x128 |
如果实际请求URL没有被规则命中,则跳转到原地址。如果是图形图像资源URL被命中,但不满足上述图形图像的特别条件,则返回403禁止访问。
最后,需要站长用户把上述URL规则写到一个JSON文件里,并放到网站根目录下可访问到的地方,并命名为webcache.json。当前非自动模式下,可不放在网站上,直接在申请时发给我们。
整体文件样例如下:
{
"name": "webcache",
"version": "1.0",
"files": [
"/static/css/common.css?_v={version}",
"/static/lib/jquery/{version}/jquery.min.js",
"/static/js/lock-{version}.min.js",
"/static/js/index_{hash}.js",
"/static/js/test.js?_v={version}",
"/static/img/002.jpg?_v={version}"
],
"updated": "2025.04.14"
}
配置文件“webcache.json”字段说明:
字段 | 说明 |
name | 固定为“webcache”。 |
version | 版本号,表示此配置格式的版本号,目前固定为1.0。 |
files | 文件URL规则列表,目前只允许配置6个。 |
updated | 更新时间,格式为“YYYY.MM.DD”,用于自动化更新部署。 |
后续扩展也将在此配置。
更新时间:2025.04.16