因为要实现一种迷之重写寻径，认真地搜寻了这方面的资料。
这两天折腾很久，才实现了这样一个功能：
请求 /a/b
若文件不存在，查找 /a/index.php，/b 作为 PATH_INFO；
若文件不存在，查找 /index.php，/a/b 作为 PATH_INFO；
若文件不存在，返回 404.
这只是一种对 PHP 做的多（统一入口模式）站点的调试用适配方案，简单替换成其他后端平台基本都不可用。
因为 nginx 对 rewrite 有次数限制（10次，更多则报错500），而且这种行为明显违背 nginx 的高性能理念，肯定不适合部署在生产机，不过在本机调试的时候还是能够带来方便的。 :)
具体实现见本文最后。
更多 nginx 的配置内容可以参见我的另一篇文章 nginx configuration manual。本文重点介绍的是 url rewrite 部分。
我们用到了以下5种指令：
- set
- if
- return
- break
- rewrite
set
赋值语句。
语法
set var_name value;
使用变量的时候需要添加 $ 前缀，即$ver_name。
if
分支语句
语法
if (expr) { .. }
表达式为变量时，判断值是否为空，或是以0开头的字符串，是则作为 false 处理。
你可以直接比较使用运算符 = 和 !=
if ($request_method = POST) {
return 405; # Method not allowed
}
或者使用正则匹配，语法如下
- ~ 大小写敏感匹配
- ~* 大小写不敏感匹配
- !~ 大小写敏感不匹配
- !~* 大小写不敏感不匹配
if ($request_filename ~ .+\.php($|/)) {
# convey to PHP server
}
你也使用以下记号检测文件或目录
- -f 检测文件存在
- -d 检测目录存在
- -e 检测文件、目录或符号链接存在
- -x 检测文件可执行
if (-d $request_filename) {
rewrite ^/(.+)([^/])$ http://$host/$1$2 permanent;
# 使访问目录时网址格式正确
}
return
返回 HTTP 状态码。
语法
return HTTP_STATUS_CODE [uri | content];
有人这么使用它
return 302 https://www.baidu.com/;
return https://www.baidu.com/; # 302 跳转的简写
return 200 "U got me."; # 后者将作为 body 返回
break;
不再执行后面的判断。
rewrite
url 重写。
语法
rewrite regex dst [flag];
其中，flag 可以是：
- [空] 继续匹配
- last 结束当前 location 内的 rewrite 检测，重新选择 location
- break 结束当前 location 内的 rewrite 检测，开始请求文件
- redirect 302跳转 临时重定向
- permanent 301跳转 永久重定向
rewrite 只在 server, location, if 区块有效。
rewrite 只对 $request_filename 匹配，所以不要包含 $host 或 $args，它们分别是 hostname 和 query_string。
默认情况下，query_string 将被会追加到 rewrite 的结果中，如果不需要，请让 dst 部分以 ? 结束。
rewrite ^/user/(.+)$ /user.php?id=$1? last;
# 忽略 query_string
rewrite 后生成的 url 将继续进行 rewrite 检查，最多尝试 10 次，仍未结束则返回 HTTP 500 错误。
rewrite 的流程
- server 区块中的 rewrite 规则将优先执行且最多执行一次，然后判断能命中哪一个 location。
- 被命中的 location 区块中的 rewrite 规则执行后将再次判断命中哪一个 location。
错误的 rewrite 将导致第 2 步死循环，在 rewrite 次数超限后500。
location 区块
首先讲一讲 location 的语法和用途。
location = / {
# / only
# 请求路径是 / 的时候命中它
}
location / {
# like: /, /file.ext, /dir/file.ext
# 请求路径以 / 开头或就是 /
# 不处理正则式
}
location ^~ /dir/ {
# like: /dir/file.ext
# 请求路径以 /dir/ 开头
# 不处理正则式
}
location ~ \.(jpg|gif)$ {
# any *.jpg, *.gif
# 请求路径以 .jpg 或 .gif 结尾
# 处理正则式，可以用 ~* 启用大小写不敏感匹配
}
location @tag {
# 为内部重定向而使用
}
location 的匹配优先级
- =
- 空匹配符，精确匹配时
- ^~ 路径
- 正则匹配。
- 空匹配符，以指定模式开始时
- 同一优先级的项按先后顺序，前者优先
(location =) > (location 完整路径) > (location ^~ 路径) > (location ~* 正则) > (location 路径)
注意空匹配符和 ^~ 是不能一样的。
location /a/ {
return 400;
}
location ^~ /a/ {
return 404;
}
# [emerg]: duplicate location "/a/"
try_files
尝试文件。受 root 和 index 语句影响。
语法
try_files file1 [file2] [...] (uri, @tag, =code)
按顺序检查文件是否存在，并返回第一个存在的文件。如果所有文件都不存在，则内部重定向到最后一个参数对应的 回退uri, @tag 或者 HTTP_STATUS_CODE。
index index.php index.html;
try_files /cache/ $uri @fallback;
将依次尝试
- $document_root/cache/
发现是目录，根据 index 规则依次尝试，并在命中后触发重定向 - $document_root/cache/index.php 可重定向
- $document_root/cache/index.html 可重定向
- $document_root$uri
发现是文件，如果文件存在则直接返回文件内容，不存在则根据 index 规则依次尝试，并在命中后触发重定向 - $document_root$url index.php 可重定向
- $document_root$url index.html 可重定向
- 仍未命中，内部重定向到 @fallback 区块。
如果没有最后一个参数则返回 HTTP 500。如果最后一个参数为文件，则该文件必须存在。
注意，中途命中的项目如果不可重定向将返回文件内容，甚至是源代码！
如果 回退uri 不是去命中 location 则不会在 url 后追加 $args，如果需要请明确写出
try_files $uri $uri/ /index.php?q=$uri&$args;
example
优先使用 /static/ 下的资源，没有再访问 / 下的同名资源
if (-e $document_root/static$request_uri) {
rewrite ^/(.*)$ /static/$1 break;
break;
}
注意以下几点
- nginx 的路径变量约定，开头有反斜线而结尾没有。
- nginx 字符串和变量可以直接连接，如果有歧义可以花括号括起变量名称，此时整个字符串必须加双引号。如："${document_root}/static${request_uri}"
本文开头所述的配置文件在 server 段应有如下代码，其他部分使用自己的配置
index index.php index.html index.htm;
set $path $request_uri;
set $path_info "";
location / {
try_files $uri $uri/ @404;
}
location @404 {
if ($path ~ ^(.*)(/.+)$) {
set $path $1/index.php;
set $path_info $2;
rewrite .* $path last;
}
return 404;
}
location ~ .+\.php($|/) {
fastcgi_split_path_info ^(.+\.php)(/.*)$;
if ($path_info !~ .+) {
set $path_info $fastcgi_path_info;
}
try_files $fastcgi_script_name @404php;
fastcgi_param PATH_INFO $path_info;
fastcgi_index index.php;
include fastcgi.conf;
fastcgi_pass unix:/usr/local/var/run/php-fpm.sock;
fastcgi_connect_timeout 60;
fastcgi_send_timeout 300;
fastcgi_read_timeout 300;
}
location @404php {
if ($path = /index.php) {
return 404;
}
if ($path ~ ^(.*)(/.+)/index\.php$) {
set $path_info $2$path_info;
set $path $1/index.php;
rewrite .* $path last;
}
return 404;
}
常用全局变量一览表
$arg_PARAMETER 其中 PARAMETER 为参数名。
如 ?foo=123 则 $arg_foo = "123"
$args query_string 即 GET 请求中的参数。只读。如 "foo=123&bar=boom"
$binary_remote_addr 二进制码形式的客户端地址。
$body_bytes_sent 传送页面的字节数
$content_length 请求头中的Content-length字段。
$content_type 请求头中的Content-Type字段。
$cookie_COOKIE cookie COOKIE的值。
$document_root 当前请求在root指令中指定的值。
$document_uri 与$uri相同。
$host 请求中的主机头(Host)字段，如果请求中的主机头不可用或者空，则为处理请求的server名称(处理请求的server的server_name指令的值)。值为小写，不包含端口。
$hostname 机器名使用 gethostname系统调用的值
$http_HEADER HTTP请求头中的内容，HEADER为HTTP请求中的内容转为小写，-变为_(破折号变为下划线)，例如：$http_user_agent(Uaer-Agent的值), $http_referer...;
$is_args 如果 $args 设置，值为 "?" 否则为 ""
$sent_http_HEADER HTTP响应头中的内容，HEADER为HTTP响应中的内容转为小写，-变为_(破折号变为下划线)，例如： $sent_http_cache_control, $sent_http_content_type...;
$limit_rate 这个变量可以限制连接速率。
$nginx_version 当前运行的nginx版本号。
$query_string 与$args相同。
$remote_addr 客户端的IP地址。
$remote_port 客户端的端口。
$remote_user 已经经过Auth Basic Module验证的用户名。
$request_filename 当前连接请求的文件路径，由root或alias指令与URI请求生成。
$request_body 这个变量（0.7.58+）包含请求的主要信息。在使用proxy_pass或fastcgi_pass指令的location中比较有意义。
$request_body_file 客户端请求主体信息的临时文件名。
$request_completion 如果请求成功，设为"OK"；如果请求未完成或者不是一系列请求中最后一部分则设为空。
$request_method 这个变量是客户端请求的动作，通常为GET或POST。
包括0.8.20及之前的版本中，这个变量总为main request中的动作，如果当前请求是一个子请求，并不使用这个当前请求的动作。
$request_uri 这个变量等于包含一些客户端请求参数的原始URI，它无法修改，请查看$uri更改或重写URI。
$scheme 所用的协议，比如http或者是https，比如rewrite ^(.+)$ $scheme://example.com$1 redirect;
$server_addr 服务器地址，在完成一次系统调用后可以确定这个值，如果要绕开系统调用，则必须在listen中指定地址并且使用bind参数。
$server_name 服务器名称。
$server_port 请求到达服务器的端口号。
$server_protocol 请求使用的协议，通常是HTTP/1.0或HTTP/1.1。
$uri 请求中的当前URI(不带请求参数，参数位于$args)，不同于浏览器传递的$request_uri的值，它可以通过内部重定向，或者使用index指令进行修改。不包括协议和主机名，例如/foo/bar.html
网友评论