Summary of nginx configuration location and how to write rewrite rules

The article is reprinted from: "nginx configuration location summary and rewrite rule writing"

1. Location regular writing

An example:

location  = / {
  # 精确匹配 / ，主机名后面不能带任何字符串
  [ configuration A ] 
}

location  / {
  # 因为所有的地址都以 / 开头，所以这条规则将匹配到所有请求
  # 但是正则和最长字符串会优先匹配
  [ configuration B ] 
}

location /documents/ {
  # 匹配任何以 /documents/ 开头的地址，匹配符合以后，还要继续往下搜索
  # 只有后面的正则表达式没有匹配到时，这一条才会采用这一条
  [ configuration C ] 
}

location ~ /documents/Abc {
  # 匹配任何以 /documents/ 开头的地址，匹配符合以后，还要继续往下搜索
  # 只有后面的正则表达式没有匹配到时，这一条才会采用这一条
  [ configuration CC ] 
}

location ^~ /images/ {
  # 匹配任何以 /images/ 开头的地址，匹配符合以后，停止往下搜索正则，采用这一条。
  [ configuration D ] 
}

location ~* \.(gif|jpg|jpeg)$ {
  # 匹配所有以 gif,jpg或jpeg 结尾的请求
  # 然而，所有请求 /images/ 下的图片会被 config D 处理，因为 ^~ 到达不了这一条正则
  [ configuration E ] 
}

location /images/ {
  # 字符匹配到 /images/，继续往下，会发现 ^~ 存在
  [ configuration F ] 
}

location /images/abc {
  # 最长字符匹配到 /images/abc，继续往下，会发现 ^~ 存在
  # F与G的放置顺序是没有关系的
  [ configuration G ] 
}

location ~ /images/abc/ {
  # 只有去掉 config D 才有效：先最长匹配 config G 开头的地址，继续往下搜索，匹配到这一条正则，采用
    [ configuration H ] 
}

location ~* /js/.*/\.js

starts with = to indicate an exact match
For example, in A, only the request at the end of the root directory is matched, and the following cannot Take any string. The beginning of
^~ indicates that the uri starts with a regular string, which is not a regular match. The beginning of
~ indicates the case-sensitive regular matching; the beginning of
~* indicates the case-insensitive regular matching.
/ Universal matching, if there is no other match, Any request will match the
order no priority:
(location =) > (location full path) > (location ^~ path) > (location ~,~* regular order) > (location partial starting path ) > (/)
The above matching result
According to the above location writing method, the following matching example is established:
/ -> config A
Exact and complete match, even /index.html cannot match
/downloads/download. html -> config B
After matching B, there is no match below, use B
/images/1.gif -> configuration D
match to F, match below to D, stop going down
/images/abc /def -> config D
The longest match is G, go down to match D, stop going down
You can see that anything starting with /images/ will match D and stop. It makes no sense to write FG here. , H will never get its turn, this is just to illustrate the matching order
/documents/document.html -> config C
matches C, there is no match below, use C
/documents/1.jpg -> configuration E
matches C, and goes down to E
/documents/Abc.jpg -> config CC
matches C at the longest, goes down to CC in regular order, and does not go down to E
Suggestions for actual use
So in actual use, I personally feel that there are at least three matching rule definitions, as follows:

#直接匹配网站根，通过域名访问网站首页比较频繁，使用这个会加速处理，官网如是说。
#这里是直接转发给后端应用服务器了，也可以是一个静态首页
# 第一个必选规则
location = / {
    proxy_pass http://tomcat:8080/index
}
# 第二个必选规则是处理静态文件请求，这是nginx作为http服务器的强项
# 有两种配置模式，目录匹配或后缀匹配,任选其一或搭配使用
location ^~ /static/ {
    root /webroot/static/;
}
location ~* \.(gif|jpg|jpeg|png|css|js|ico)$ {
    root /webroot/res/;
}
#第三个规则就是通用规则，用来转发动态请求到后端应用服务器
#非静态文件请求就默认是动态请求，自己根据实际把握
#毕竟目前的一些框架的流行，带.php,.jsp后缀的情况很少了
location / {
    proxy_pass http://tomcat:8080/
}

http://tengine.taobao.org/book/chapter_02.html
http://nginx.org/en/docs/http/ngx_http_rewrite_module .html
2. Rewrite rules
The rewrite function is to use the global variables provided by nginx or the variables set by yourself, combined with regular expressions and flags to implement url rewriting and redirection. rewrite can only be placed in server{}, location{}, if{}, and can only work on the string after the domain name except for the passed parameters, such as http://seanlook.com/a/we/index .php?id=1&u=str is only rewritten for /a/we/index.php. Syntax rewrite regex replacement [flag];
If relative domain names or parameter strings work, you can use global variable matching or use proxy_pass reverse proxy.
It shows that the functions of rewrite and location are somewhat similar, both can achieve jumps. The main difference is that rewrite changes the path to obtain resources within the same domain name, while location controls access or reverse proxy to a type of path, and can proxy_pass to other paths. machine. In many cases, rewrite will also be written in the location. Their execution order is:
Execute the rewrite instruction of the server block
Execute location matching
Execute the rewrite instruction in the selected location
If one of the URI steps is rewritten, rewrite Loop through 1-3 until a real file is found; if the loop exceeds 10 times, a 500 Internal Server Error will be returned.
2.1 flag
last: Equivalent to Apache's [L] mark, indicating completion of rewrite
break: Stop executing the subsequent rewrite instruction set of the current virtual host
redirect: Return to 302 temporary redirection, the address bar will display the redirected Address
permanent: Return 301 permanent redirection, the address bar will display the address after the jump
Because 301 and 302 cannot simply return status codes, they must also have redirected URLs, which is why the return command cannot return 301, 302 . The difference between last and break here is a bit difficult to understand:
last is generally written in server and if, while break is generally used in location
last does not terminate the rewritten url matching, that is, the new url will go through the matching process from the server again. And break terminates the rewritten matching
break and last can organize the continued execution of the subsequent rewrite instructions
2.2 if instruction and global variables
if judgment instruction
The syntax is if(condition){...}, for a given condition condition to judge. If true, the rewrite instruction within the curly braces will be executed. The if condition (condition) can be anything as follows:
When the expression is just a variable, if the value is empty or any string starting with 0, it will be treated as false
When comparing variables and content directly, use = or !=
~regular expression matching, ~*case-insensitive matching, !~case-insensitive non-matching
-f and !-f are used to determine whether the file exists
-d and !-d are used to determine whether a directory exists
-e and !-e are used to determine whether a file or directory exists
-x and !-x are used to determine whether a file is executable

例如：

if ($http_user_agent ~ MSIE) {
    rewrite ^(.*)$ /msie/$1 break;
} //如果UA包含"MSIE"，rewrite请求到/msid/目录下

if ($http_cookie ~* "id=([^;]+)(?:;|$)") {
    set $id $1;
 } //如果cookie匹配正则，设置变量$id等于正则引用部分

if ($request_method = POST) {
    return 405;
} //如果提交方法为POST，则返回状态405（Method not allowed）。return不能返回301,302

if ($slow) {
    limit_rate 10k;
} //限速，$slow可以通过 set 指令设置

if (!-f $request_filename){
    break;
    proxy_pass  http://127.0.0.1; 
} //如果请求的文件名不存在，则反向代理到localhost 。这里的break也是停止rewrite检查

if ($args ~ post=140){
    rewrite ^ http://example.com/ permanent;
} //如果query string中包含"post=140"，永久重定向到example.com

location ~* \.(gif|jpg|png|swf|flv)$ {
    valid_referers none blocked www.jefflei.com www.leizhenfang.com;
    if ($invalid_referer) {
        return 404;
    } //防盗链
}

全局变量
下面是可以用作if判断的全局变量
$args ： #这个变量等于请求行中的参数，同$query_string
$content_length ： 请求头中的Content-length字段。
$content_type ： 请求头中的Content-Type字段。
$document_root ： 当前请求在root指令中指定的值。
$host ： 请求主机头字段，否则为服务器名称。
$http_user_agent ： 客户端agent信息
$http_cookie ： 客户端cookie信息
$limit_rate ： 这个变量可以限制连接速率。
$request_method ： 客户端请求的动作，通常为GET或POST。
$remote_addr ： 客户端的IP地址。
$remote_port ： 客户端的端口。
$remote_user ： 已经经过Auth Basic Module验证的用户名。
$request_filename ： 当前请求的文件路径，由root或alias指令与URI请求生成。
$scheme ： HTTP方法（如http，https）。
$server_protocol ： 请求使用的协议，通常是HTTP/1.0或HTTP/1.1。
$server_addr ： 服务器地址，在完成一次系统调用后可以确定这个值。
$server_name ： 服务器名称。
$server_port ： 请求到达服务器的端口号。
$request_uri ： 包含请求参数的原始URI，不包含主机名，如：”/foo/bar.php?arg=baz”。
$uri ： 不带请求参数的当前URI，$uri不包含主机名，如”/foo/bar.html”。
$document_uri ： 与$uri相同。
例：http://localhost:88/test1/test2/test.php
$host：localhost
$server_port：88
$request_uri：http://localhost:88/test1/test2/test.php
$document_uri：/test1/test2/test.php
$document_root：/var/www/html
$request_filename：/var/www/html/test1/test2/test.php
2.3 常用正则
. ： 匹配除换行符以外的任意字符
? ： 重复0次或1次
+ ： 重复1次或更多次
* ： 重复0次或更多次
\d ：匹配数字
^ ： 匹配字符串的开始
$ ： 匹配字符串的介绍
{n} ： 重复n次
{n,} ： 重复n次或更多次
[c] ： 匹配单个字符c
[a-z] ： 匹配a-z小写字母的任意一个
小括号()之间匹配的内容，可以在后面通过$1来引用，$2表示的是前面第二个()里的内容。正则里面容易让人困惑的是\转义特殊字符。
2.4 rewrite实例
例1：

http {
    # 定义image日志格式
    log_format imagelog '[$time_local] ' $image_file ' ' $image_type ' ' $body_bytes_sent ' ' $status;
    # 开启重写日志
    rewrite_log on;
 
    server {
        root /home/www;
 
        location / {
                # 重写规则信息
                error_log logs/rewrite.log notice; 
                # 注意这里要用‘’单引号引起来，避免{}
                rewrite '^/images/([a-z]{2})/([a-z0-9]{5})/(.*)\.(png|jpg|gif)$' /data?file=$3.$4;
                # 注意不能在上面这条规则后面加上“last”参数，否则下面的set指令不会执行
                set $image_file $3;
                set $image_type $4;
        }
 
        location /data {
                # 指定针对图片的日志格式，来分析图片类型和大小
                access_log logs/images.log mian;
                root /data/images;
                # 应用前面定义的变量。判断首先文件在不在，不在再判断目录在不在，如果还不在就跳转到最后一个url里
                try_files /$arg_file /image404.html;
        }
        location = /image404.html {
                # 图片不存在返回特定的信息
                return 404 "image not found\n";
        }
}

对形如/images/ef/uh7b3/test.png的请求，重写到/data?file=test.png，于是匹配到location /data，先看/data/images/test.png文件存不存在，如果存在则正常响应，如果不存在则重写tryfiles到新的image404 location，直接返回404状态码。
例2：
rewrite ^/images/(.*)_(\d+)x(\d+)\.(png|jpg|gif)$ /resizer/$1.$4?width=$2&height=$3? last;
对形如/images/bla_500x400.jpg的文件请求，重写到/resizer/bla.jpg?width=500&height=400地址，并会继续尝试匹配location。

以上就介绍了 nginx配置location总结及rewrite规则写法，包括了方面的内容，希望对PHP教程有兴趣的朋友有所帮助。