内置变量

内置变量

变量形式

在使用变量的地方，使用${varName}来表示变量，比如：

/${1}/hello${requestPath}?name=${arg.name}

匹配变量

匹配变量值的是有正则表达式的地方，使用匹配结果，通常为一个从0开始的数字，比如在重写规则中：

/(\w+)/(\w+)

那么

${0} - 表示整体匹配的内容
${1} - 表示第一个括号匹配的内容
${2} - 表示第二个括号匹配的内容

可以使用(?i)来设置不区分大小写：

(?i)/index.php

更多可用的正则表达式可以参考 RE2 Syntax。

命名变量

也可以给变量设置一个名称：

/(?P<myName>\w+)

然后就可以在待替换字符串中使用 ${myName} ：

/hello/${myName}

请求相关变量

${edgeVersion} - 边缘节点的版本
${remoteAddr} - 客户端地址（IP），会依次根据X-Forwarded-For、X-Real-IP、RemoteAddr获取，适合前端有别的反向代理服务时使用，存在伪造的风险
${rawRemoteAddr} - 客户端地址（IP），返回直接连接服务的客户端原始IP地址
${remotePort} - 客户端端口
${remoteUser} - 客户端用户名
${requestURI} - 请求URI，比如/hello?name=lily
${requestPath} - 请求路径（不包括参数），比如/hello
${requestURL} - 完整的请求URL，比如https://example.com/hello?name=lily，v0.2.5版本加入
${requestPathExtension} - 请求路径中的文件扩展名，包括点符号，比如.html、.png
${requestLength} - 请求内容长度
${requestMethod} - 请求方法，比如GET、POST
${requestFilename} - 请求文件路径
${scheme} - 请求协议，http或https
${proto} - 包含版本的HTTP请求协议，类似于HTTP/1.0
${timeISO8601} - ISO 8601格式的时间，比如2018-07-16T23:52:24.839+08:00
${timeLocal} - 本地时间，比如17/Jul/2018:09:52:24 +0800
${msec} - 带有毫秒的时间，比如1531756823.054
${timestamp} - unix时间戳，单位为秒
${host} - 主机名，通常是请求的域名
${host.first} - 主机名第一段，比如www.example.com的值为www
${host.last} - 主机名最后一段，比如www.example.com的值为com
${host.N} - 主机名的第几段，从0开始，N最大为4，即${host.0}、${host.1}…${host.4}
${host.-N} - 主机名的倒数第几段，从-1开始，比如对于www.example.com的${host.-1}值为com，N最大为5
${serverName} - 接收请求的服务器名
${serverPort} - 接收请求的服务器端口
${referer} - 请求来源URL
${referer.host} - 请求来源URL域名，在v0.2.6中加入
${userAgent} - 客户端信息
${contentType} - 请求头部的Content-Type
${request} - 构造类似于”GET / HTTP/1.1”之类的请求字符串
${cookies} - 所有cookie组合字符串
${cookie.NAME} - 单个cookie值，比如${cookie.sid}
${args} - 所有URL参数组合字符串
${arg.NAME} - 单个URL参数值，比如${arg.name}
${headers} - 所有Header信息组合字符串
${header.NAME} - 单个Header值，比如${header.User-Agent}
${documentRoot} - 当前请求的文档根目录

响应相关变量

${requestTime} - 请求花费时间
${bytesSent} - 发送的内容长度，包括Header（字节）
${bodyBytesSent} - 发送的内容长度，不包括Header（字节）
${status} - 状态码，比如200
${statusMessage} - 状态消息，比如200 OK
${response.contentType} - 响应的Content-Type值
${response.header.NAME} - 响应中的Header值

源站相关变量

${origin.id} - 后端服务器ID
${origin.code} - 后端服务器代号
${origin.address} - 后端服务器地址，包含主机地址和端口
${origin.host} - 后端服务器地址，只包含主机地址
${origin.scheme} - 后端服务器协议

缓存相关变量

${cache.status} - 缓存状态，值可能为：
- BYPASS - 没有开启缓存策略或者其他原因未通过缓存策略处理的时候，状态为BYPASS
- HIT - 已命中缓存
- MISS - 未命中缓存
- PURGE - 正在清除缓存
${cache.policy.id} - 缓存策略ID
${cache.policy.name} - 缓存策略名称
${cache.policy.type} - 缓存策略类型（memory、file之类）