Nginx路径重写

Nginx路径重写

ReWrite介绍

rewrite功能就是使用nginx提供的全局变量或自己设置的变量，结合正则表达式和标志位实现url重写以及重定向。

​ rewrite和location的功能有点相像，都能实现跳转，主要区别在于rewrite常用于同一域名内更改获取资源的路径，而location是对一类路径做控制访问和反向代理，可以proxy_pass到其他服务器。

​ Nginx提供的全局变量或自己设置的变量，结合正则表达式和标志位实现url重写以及重定向。
​ rewrite只能放在server{},location{},if{}中，并且只能对域名后边的除去传递的参数外的字符串起作用。
​ Rewrite主要的功能就是实现URL的重写，Nginx的Rewrite规则采用Pcre，perl兼容正则表达式的语法规则匹配，如果需要Nginx的Rewrite功能，在编译Nginx之前，需要编译安装PCRE库。
​ 通过Rewrite规则，可以实现规范的URL、根据变量来做URL转向及选择配置。

ReWrite模块

​ nginx通过ngx_http_rewrite_module模块支持url重写、支持if条件判断，但不支持else。另外该模块需要PCRE支持，应在编译nginx时指定PCRE支持。根据相关变量重定向和选择不同的配置，从一个location跳转到另一个location，不过这样的循环最多可以执行10次，超过后nginx将返回500错误。同时，重写模块包含set指令，来创建新的变量并设其值，这在有些情景下非常有用的，如记录条件标识、传递参数到其他location、记录做了什么等等。

rewrite 应用场景

Nginx的rewrite功能在企业里应用非常广泛：

• 可以调整用户浏览的URL，看起来更规范，合乎开发及产品人员的需求。
• 为了让搜索引擎搜录网站内容及用户体验更好，企业会将动态URL地址伪装成静态地址提供服务。
• 网址换新域名后，让旧的访问跳转到新的域名上。例如，访问京东的360buy.com会跳转到jd.com
• 根据特殊变量、目录、客户端的信息进行URL调整等

ReWrite相关指令

ReWrite的语法

1

rewrite regex replacement [flag];

• rewrite：固定格式

• regex： 正则表达式

• replacement：重写后的URL

• flag： 重写状态标记

例子

1

rewrite ^/(.*) http://www.etiantian.org/$1 permanent;

​ 在上述指令中，rewrite为固定关键字，表示开启一条rewrite匹配规则，regex部分是^/(.*)，这是一个正则表达式，表示匹配所有，匹配成功后跳转到http://www.etiantian.org/$1。这里的$1是取前面regex部分括号里的内容结尾的permanent；是永久301重定向标记，即跳转到后面的http://www.etiantian.org/$1地址上。

执行顺序

很多情况下rewrite也会写在location里，它们的执行顺序是：

1. 执行server块的rewrite指令

2. 执行location匹配

3. 执行选定的location中的rewrite指令

如果其中某步URI被重写，则重新循环执行1-3，直到找到真实存在的文件；循环超过10次，则返回500 Internal Server Error错误。

flag标志位

​ 因为301和302不能简单的只返回状态码，还必须有重定向的URL，这就是return指令无法返回301,302的原因了。这里 last 和 break 区别有点难以理解：

• last一般写在server和if中，而break一般使用在location中
• last不终止重写后的url匹配，即新的url会再从server走一遍匹配流程，而break终止重写后的匹配
• break和last都能组织继续执行后面的rewrite指令

常用正则

if判断

简单重写很多时候满足不了需求，比如需要判断当文件不存在时、当路径包含xx时等条件，则需要用到if

语法

1
2
3

if (表达式) {
   ... ...
}

注意

• 当表达式只是一个变量时，如果值为空或任何以0开头的字符串都会当做false
• 直接比较变量和内容时，使用=或!=
• 正则表达式匹配，*不区分大小写的匹配，!~区分大小写的不匹配

内置条件判断

• -f 和 !-f用来判断是否存在文件
• -d 和 !-d用来判断是否存在目录
• -e 和 !-e用来判断是否存在文件或目录
• -x 和 !-x用来判断文件是否可执行

全局变量

下面是可以用作if判断的全局变量

​ nginx的配置文件中可以使用的内置变量以美元符$开始，也有人叫全局变量。其中，部分预定义的变量的值是可以改变的。

示例

简单示例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

server {
    # 访问 /last.html 的时候，页面内容重写到 /index.html 中
    rewrite /last.html /index.html last;

    # 访问 /break.html 的时候，页面内容重写到 /index.html 中，并停止后续的匹配
    rewrite /break.html /index.html break;

    # 访问 /redirect.html 的时候，页面直接302定向到 /index.html中
    rewrite /redirect.html /index.html redirect;

    # 访问 /permanent.html 的时候，页面直接301定向到 /index.html中
    rewrite /permanent.html /index.html permanent;

    # 把 /html/*.html => /post/*.html ，301定向
    rewrite ^/html/(.+?).html$ /post/$1.html permanent;

    # 把 /search/key => /search.html?keyword=key
    rewrite ^/search\/([^\/]+?)(\/|$) /search.html?keyword=$1 permanent;
}

结合IF示例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

server {
    # 如果文件不存在则返回400
    if (!-f $request_filename) {
        return 400;
    }
    
    # 如果host不是xuexb.com，则301到xuexb.com中
    if ( $host != "xuexb.com" ){
        rewrite ^/(.*)$ https://xuexb.com/$1 permanent;
    }
    
    # 如果请求类型不是POST则返回405
    if ($request_method = POST) {
        return 405;
    }
    
    # 如果参数中有 a=1 则301到指定域名
    if ($args ~ a=1) {
        rewrite ^ http://example.com/ permanent;
    }
}

结合location使用

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

server {
    
    listen 80;
    server_name lotus.com;
    
    location = /test.html {
        # 默认值为lotus
        set $name lotus;
    
        # 如果参数中有 name=xx 则使name用该值
        if ($args ~* name=(\w+?)(&|$)) {
            set $name $1;
        }
    
        # 301
        rewrite ^ /$name.html permanent;
    }
}

完整示例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

server {
    listen 80;
    server_name lotus.com www.lotus.com;

    if ( $host != 'www.abc.com'  ) {
        rewrite ^/(.*) http://www.abc.com/$1 permanent;
    }

    location / {
        root /data/www/www;
        index index.html index.htm;
    }

    error_log    logs/error_www.abc.com.log error;
    access_log    logs/access_www.abc.com.log    main;
}