Node.js环境下如何编码含单引号URL以适配CloudFront缓存失效规则

问题根因 #

首先明确三种原生编码方法不符合要求的原因：

• encodeURI：仅编码空格等非URL保留字符，不会编码单引号、?、&、=等保留字符，单引号原样提交会触发CloudFront路径校验错误
• encodeURIComponent：会编码路径分隔符/，导致CloudFront无法识别正常的路径层级结构，校验失败
• 已废弃的escape：刚好保留/且编码了其余特殊字符，符合CloudFront规则但属于废弃API，存在兼容性和标准风险

正确编码逻辑 #

CloudFront对缓存失效路径的编码要求为：仅保留路径分隔符/，其余所有特殊字符（包括?、&、=、单引号、空格等）均按照RFC 3986标准做百分号编码。

实现代码（JavaScript） #

我们可以基于标准的encodeURIComponent封装自定义编码函数，完全替代废弃的escape方法：

function encodeCloudFrontPath(path) {
  return path.split('').map(char => {
    // 仅保留路径分隔符/不编码，其余字符全部做标准URL编码
    if (char === '/') return char;
    return encodeURIComponent(char);
  }).join('');
}

效果验证 #

对问题中的目标URL使用上述函数编码，得到的结果和escape方法输出完全一致，可正常通过CloudFront校验：
/autocomplete/posts/2%3Fterm%3D13%20Scary%20Podcasts%20That%27ll%20Keep%20You%20Up%20All%20Night%26pagesize%3D25%26pagenumber%3D1%26excludeexpiredposts%3Dtrue

注意事项 #

• 提交缓存失效路径时不需要携带协议、域名部分，仅需传入路径+查询参数的完整片段即可
• 该方案同时兼容含中文、其他特殊符号的路径编码，均符合CloudFront的校验规则

内容的提问来源于stack exchange，提问作者jvm