nginx rewrite 规则的配置

1. 概述

顾名思义，rewrite 就是重定向，就是将收到的请求依据配置重定向成为另一个请求并返回。 nginx、Apache 都提供了强大的 rewrite 功能，在实际使用中，也十分的方便，比如消息的转发或网站默认页面或出错页面的处理等。 ngx_http_rewrite_module 模块实现了对 url 的判断、正则匹配、重定向。

2. nginx 预定义变量

nginx 配置文件中可以使用很多变量，rewrite 的规则就是在配置文件中定义的，因此，首先了解 nginx 有哪些预定义变量更加有利于我们去了解和配置 rewrite 规则。 nginx 配置中可以出现的变量，同时也可以通过 set 指令创建变量。 可以通过第三方模块 echo-nginx-module 查看配置中 相应变量的值。

nginx 预定义变量

3. nginx rewrite 指令

3.1. nginx write 指令执行顺序

1. 执行 server 块的 rewrite 指令
2. 进行 location 匹配
3. 执行 location 块的 rewrite 指令

上述过程可能会嵌套、重复执行，如果 rewrite 次数达到 10 次，就会返回 500 Internal Server Error。

3.2. break 指令

停止执行当前虚拟主机的后续 rewrite 指令集。 如：

if ($slow) {
    limit_rate 10k;
    break;
}

3.3. if 指令

对给定条件 condition 进行判断，如果为真，则执行大括号内的 rewrite 指令。

if (condition)
{
    ...
}

如：

if ($http_user_agent ~ MSIE) {
    rewrite ^(.*)$ /msie/$1 break;
}

if ($http_cookie ~* "id=([^;]+)(?:;|$)") {
    set $id $1;
}

if ($request_method = POST) {
    return 405;
}

if ($slow) {
    limit_rate 10k;
}

if ($invalid_referer) {
    return 403;
}

3.4. if 指令的 condition

if 指令的 condition 可以是下列中的任何内容：

if 指令的 condition

3.5. return 指令

用来停止处理并返回状态或 URL。

return code;
return URL;

3.6. rewrite 指令

rewrite regex replacement [flag];

如果一个URI匹配指定的正则表达式regex，URI就按照replacement重写。 flag 取值如下：

• last — 停止处理后续rewrite指令集，然后对当前重写的新URI重新进入 server 进行匹配
• break — 停止处理后续rewrite指令集，并不在重新查找,但是当前location内剩余非rewrite语句和location外的的非rewrite语句可以执行
• redirect — 如果replacement不是以http:// 或https://开始，返回302临时重定向
• permant — 返回301永久重定向

如：

server {
    ...
    rewrite ^(/download/.*)/media/(.*)..*$ $1/mp3/$2.mp3 last;
    rewrite ^(/download/.*)/audio/(.*)..*$ $1/mp3/$2.ra last;
    return 403;
    ...
}

如果在 rewrite 的 URL 最后加一个 ?，则说明在 rewrite 后去掉原请求的所有参数。

rewrite ^/users/(.*)$ /show?user=$1? last;

3.7. set 指令

创建自定义变量。

set variable value;

3.8. rewrite_log 指令

开启或关闭以notice级别打印rewrite处理日志到error log文件，可以出现在 main、server、location 配置的任何位置。

rewrite_log on|off;

3.9. uninitialized_variable_warn 指令

控制是否输出为初始化的变量到日志。

uninitialized_variable_warn on|off;

4. 利用 nginx rewrite 实现的几个功能

4.1. 防止 sql 注入

通过判断 URI 中是否有 ’、;、>、< 等字符可以快速过滤掉可能发生 SQL 注入的请求，然后直接返回 404 Not Found。

if ( $query_string ~* ".*[;'<>].*" ) {
    return 404;
}

4.2. PHP 框架隐藏入口 php

下面这个配置来源于 php 框架 Symfony 手册，用来隐藏作为入口的 app.php。 所有请求全部被重定向到 app.php 下。

server {
  listen 80;

  server_name example.com; # 域名
  root /var/www/symfony2/web; # 站点根目录

  error_log /var/log/nginx/symfony2.error.log;
  access_log /var/log/nginx/symfony2.access.log;

  # 如果URL中包含app.php，则转发为伪静态格式
  rewrite ^/app\.php/?(.*)$ /$1 permanent;

  location / {
    index app.php;
    try_files $uri @rewriteapp;
  }

  location @rewriteapp {
    rewrite ^(.*)$ /app.php/$1 last;
  }

  # 此段为将PHP请求转交给FastCGI服务，PHP-FPM是非常流行的选项。
  location ~ ^/(app|app_dev)\.php(/|$) {
    fastcgi_pass   127.0.0.1:9000;
    fastcgi_split_path_info ^(.+\.php)(/.*)$;
    include fastcgi_params;
    fastcgi_param  SCRIPT_FILENAME    $document_root$fastcgi_script_name;
    fastcgi_param  HTTPS              off;
  }
}

4.3. 将不存在的请求定义到 app.php 处理

location / {
    if (!-e $request_filename){
        rewrite ^(.*)$ /app.php break;
    }
}

5. 参考文献

1. nginx内置预定义变量 http://www.nginx.cn/273.html
2. Symfony2在Nginx下的配置 http://symfony.cn/articles/symfony2-nginx-configuration.html
3. Module ngx_http_rewrite_module http://nginx.org/en/docs/http/ngx_http_rewrite_module.html
4. nginx rewrite 指令 http://www.nginx.cn/216.html
5. htaccess to nginx converter http://winginx.com/en/htaccess
6. Nginx系列教程之四：Nginx常用变量汇总及测试 http://mingyang.blog.51cto.com/2807508/1547546