文档

自定义Cachekey

更新时间:

配置自定义Cachekey,开发者可以根据HTTP请求的不同部分(例如URI、请求参数、HTTP请求头或自定义变量等)制定规则来生成Cachekey,将访问同一个文件的一类请求转化为统一的Cachekey,避免将同一类请求缓存为不同文件的问题,从而提高缓存的命中率,降低回源率,减少请求的响应时间和带宽消耗。

使用场景

重要

自定义Cachekey功能不会修改回源的URL,仅会修改请求的缓存标识,回源的请求和客户端发起的请求内容保持一致。

Cachekey是一个文件在CDN节点上缓存时唯一的身份ID,每个在CDN节点上缓存的文件都对应一个Cachekey。文件的Cachekey默认为客户端请求的URL(带参数)。

场景一

客户不同请求的URL中含有复杂的参数,因此即使多个请求访问的是同一个文件,但由于URL参数不同,CDN节点会视为请求不同文件而将不同请求缓存成多个文件,造成回源的请求增加。图一

可通过自定义Cachekey规则将同一类请求的Cachekey统一,降低回源率。图二

场景二

客户端请求的URL一样时,CDN将视为请求同一个文件。但实际上请求的Http Header中携带了client字段区分了客户端系统,希望请求不同文件。场景一

此时可通过自定义Cachekey将client字段的值拼接至Cachekey,两个请求即可识别为2个不同的Cachekey。场景二

操作步骤

  1. 登录CDN控制台

  2. 在左侧导航栏,单击域名管理

  3. 域名管理页面,找到目标域名,单击操作列的管理

  4. 在指定域名的左侧导航栏,单击缓存配置

  5. 自定义Cachekey页签下,单击配置,配置Cachekey。

    说明

    支持对URI、请求参数、HTTP Header进行修改,同时支持自定义变量,从请求中提取需要的字段。最终的Cachekey将由URI、请求参数、HTTP Header、自定义变量四部分组合而成。

    参数类型

    操作说明

    URI

    • 源URI:以正斜线(/)开头的URI,不含http://头及域名。支持PCRE正则表达式。

    • 目标URI:以正斜线(/)开头的URI,不含http://头及域名。操作结果是使用改写后的目标URI来拼接Cachekey。

    请求参数

    操作的对象是用户发起的原始请求URL中携带的参数,可以对参数进行新增、删除、修改、保留操作,操作后的结果将会拼接到Cachekey中。

    HTTP Header

    操作的对象是用户发起的原始请求中携带的HTTP Header,可以将多个HTTP Header的值拼接到Cachekey中。

    自定义变量

    可使用正则表达式从用户发起的原始请求中的请求参数、HTTP Header、Cookie、URI中截取出任意字段拼接到Cachekey中。

    自定义Cachekey

  6. 单击确定

配置示例

URI

客户端的请求http://aliyundoc.com/a/b/image.jpghttp://aliyundoc.com/a/b/c/image.jpg 将视为请求同一个文件,该文件的Cachekey为http://aliyundoc.com/c/image.jpgURI

请求参数

客户端的请求http://aliyundoc.com/a/b/image.jpg?delete_par=1&modify_par=1 将按规则添加add_par=1,删除delete_par,将modify_par的值修改为2,最终转化为http://aliyundoc.com/a/b/image.jpg?modify_par=2&add_par=1

重要

请求参数中,如对同一个变量同时进行了多个操作,则各种操作的生效优先级:新增>删除>保留>修改。

参数操作

HTTP Header

客户端请求的HTTP Header的User-AgentAccept-Language的值将被拼接到Cachekey中。例如请求http://aliyundoc.com/a/b/image.jpg中的User-Agent=Mozilla/5.0 (Linux; X11)Accept-Language=en,则该请求的Cachekey为:http://aliyundoc.com/a/b/image.jpgMozilla/5.0(Linux;X11)enHTTP Header

自定义变量

示例一

变量名为language,来源为Request Header,来源字段名为Accept-Language,匹配规则为 ([%w]+),([%w]+),变量表达式为$1aa自定义变量

客户端的请求http://aliyundoc.com/a/b/image.jpg且携带HTTP请求头Accept-Language=en,ch ,则匹配规则将匹配到en赋值给变量表达式中的$1。变量表达式还将在末尾拼接上aa,得到enaa的变量并取别名为language,拼接在URL后方形成最终的Cachekey:http://aliyundoc.com/a/b/image.jpgenaa

说明

变量表达式中的$n的含义是匹配规则中第n个括号所匹配到的内容。例如示例一中Accept-Language=en,ch,匹配规则为([%w]+),([%w]+),则$1=en$2=ch

示例二

变量名为expired,来源为Request Cookie,来源字段名为a,匹配规则为[%w]+:(.*),变量表达式为 $1自定义变量

客户端的请求http://aliyundoc.com/a/b/image.jpg且携带Cookie a=expired_time:12635187,则匹配规则将匹配到12635187赋值给变量表达式中的$1并取别名为expired,拼接在URL后方形成最终的Cachekey:http://aliyundoc.com/a/b/image.jpg12635187

示例三

同时设置URI规则和自定义变量。

URI:

将所有URI符合/abc/.*/abc的请求都合并成 /abc示例三

自定义变量:

变量名为testname,来源为Path,匹配规则为/abc/xyz/(.*),变量表达式为$1示例三

客户端的请求URLhttp://aliyundoc.com/abc/xyz/abc/image.jpg,按URI的配置Cachekey将被合并成http://aliyundoc.com/abc/image.jpg, 然后根据自定义变量的配置该URL将会命中/abc/xyz/(.*),此时$1将被赋值为abc并拼接到Cachekey中,形成最终的Cachekey:http://aliyundoc.com/abc/image.jpgabc,从而达到两个规则组合使用,实现更复杂的缓存逻辑。

如果没有匹配到CacheKey的自定义变量,则变量表达式$1就不会被拼接到CacheKey中。