（nginx系列） 第一篇： location规则详解

hcwei 2020年06月10日 351次浏览

声明：本文内容大多来源于网络，这里做了整合排错，如有侵权请告知。
背景介绍

做运维的同学应该都逃不过nginx配置，但是要说精通nginx，笔者认为没有足够的实践积累是不行的，笔者在实际的使用过程中经历了许许多多的坑，或者说是学艺不精导致走了很多弯路，今天这里总结下nginx。希望能帮助大家。

一、 location匹配模式

1.1 匹配模式种类

  • = : 精确匹配。如果请求匹配这个location，那么将停止匹配并立即处理此请求
  • ~ : 最大前缀匹配，例如 location ~ /test 等同于 location /test，不可同时出现在同一server中。
  • ~ : 区分大小写正则匹配
  • ~* : 不区分大小写正则匹配

1.2 匹配优先级

  • 首先匹配 =
  • 其次匹配 ^~
  • 然后按文件中顺序的正则匹配（~,~*）
  • 最后匹配 /
    注意: 在一个 server 中 ^~ 和 / 都是指前缀匹配，作用相同。所以这两种匹配方式不能同时出现，只能同时使用其中的一种。

二、 rewrite规则

2.1 rewrite语法规则

rewrite语法：rewrite [匹配表达式] [重写后表达式] [标识符]

rewrite是使用nginx提供的全局变量或自己设置的变量，结合正则表达式和标志位实现url重写以及重定向。rewrite只能放在server,location,if中，并且只能对域名后边的除去传递的参数外的字符串起作用。

例如：

http://hcwei.cn/a/b/index.php?id=1&user=hcwei

只对/a/b/index.php重写。

如果相对域名或参数字符串起作用，可以使用全局变量匹配，也可以使用proxy_pass反向代理。

表明看rewrite和location功能有点像，都能实现跳转，主要区别在于rewrite是在同一域名内更改获取资源的路径，而location是对一类路径做控制访问或反向代理，可以proxy_pass到其他机器。很多情况下rewrite也会写在location里，它们的执行顺序是：

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

2.2 标识符种类

标识符种类：

  • last : 相当于Apache的[L]标记，表示完成rewrite
  • break : 停止执行当前虚拟主机的后续rewrite指令集
  • redirect : 返回302临时重定向，地址栏会显示跳转后的地址
  • permanent : 返回301永久重定向，地址栏会显示跳转后的地址
    注意：因为301和302不能简单的只返回状态码，还必须有重定向的URL，这就是return指令无法返回301,302的原因了。

last 和 break 区别:

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

三、set指令和变量

3.1 set指令

set语法：set $[变量名] [变量值]

变量使用规范：

  • 除了上文提到的全局变量外，可使用set关键字定义变量
  • 变量的引用使用$前缀
  • nginx中变量只能设置字符串类型变量
  • 变量也有作用域的概念

3.2 全局变量

可用作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://hcwei.cn/doc1/doc2/index.php

  • $host ：hcwei.cn
  • $server_port ：80  # 默认端口80
  • http://hcwei.cn/doc1/doc2/index.php$request_uri ：
  • $document_uri ：/doc1/doc2/index.php
  • $document_root ：/var/www/html
  • $request_filename ：/var/www/html/doc1/doc2/index.php

四、if指令

if语法：if(条件判断公式){判断后执行动作}

if条件(条件判断公式)可以是如下任何内容：

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

判断符种类：

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

例如：

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

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://hcwei.cn; 
} //如果请求的文件名不存在，则反向代理到hcwei.cn，这里的break也是停止rewrite检查。

if ($args ~ user=hcwei){
    rewrite ^ http://hcwei.cn/ permanent;
} //如果请求参数中包含"post=hcwei"，永久重定向到hcwei.cn

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

五、正则匹配

  • . ： 匹配除换行符以外的任意字符
  • ? ： 重复0次或1次
  • + ： 重复1次或更多次
  • * ： 重复0次或更多次
  • \d ：匹配数字
  • ^ ： 匹配字符串的开始
  • $ ： 匹配字符串的结束
  •  ： 重复n次
  • {n,} ： 重复n次或更多次
  • [c] ： 匹配单个字符c
  • [a-z] ： 匹配a-z小写字母的任意一个

小括号()之间匹配的内容，可以在后面通过$1来引用，$2表示的是前面第二个()里的内容。正则里面容易让人困惑的是\转义特殊字符。

六、root和alias

root ：实际访问文件路径会拼接URL中的路径
alias ：实际访问文件路径不会拼接URL中的路径
root示例：

location ^~ /test1/ {  
   root /var/www/html/;  
}
请求地址：http://hcwei.cn/test1/index.html
实际访问：/var/www/html/test/index.html 文件

alias示例：

location ^~ /test/ { 
    alias /var/www/html/; 
}
请求地址：http://hcwei.cn/test/index.html
实际访问：/var/www/html/index.html 文件

注意：alias路径最后必须添加/,否则访问的结果为/var/www/htmlindex.html，会造成访问不到文件。

七、try_files

try_files语法：try_files [原uri] [改造后uri] [最后匹配uri]

try_files一般用于改造uri，使其更容易匹配到后端文件或者文件夹。
例如：

location / {
    try_files $uri $uri/ /index.html;
}

访问地址为：http://hcwei.cn/test
此时$uri即为/test，这样表示先找有没有名为test的文件；如果没有转给/test/，即为查找有没有test的文件夹；如果都没有交给/index.html处理。

八、rewrite实例

实例1：

http {
    # 定义image日志格式
    log_format imagelog '[$time_local] ' $image_file ' ' $image_type ' ' $body_bytes_sent ' ' $status;
    # 开启重写日志
    rewrite_log on;

    server {
      root /var/www/html;

      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 main;
        root /data/images;
        # 应用前面定义的变量。判断首先文件在不在，不在再判断目录在不在，如果还不在就跳转到最后一个url里
        try_files /$arg_file /image404.html;
      }

      location = /image404.html {
        # 图片不存在返回特定的信息
        return 404 "image not found\n";
      }
}

对形如/images/ef/uh7b3/icon.png的请求，重写到/data?file=icon.png，于是匹配到location /data，先看/data/images/test.png文件存不存在，如果存在则正常响应，如果不存在则重写try_files到新的image404 location，直接返回404状态码。

实例2：

rewrite ^/images/(.*)_(\d+)x(\d+)\.(png|jpg|gif)$ /resizer/$1.$4?width=$2&height=$3? last;

对形如/images/icon_500x400.jpg的文件请求，重写到/resizer/icon.jpg?width=500&height=400地址，并会继续尝试匹配location。

上一篇： （nginx系列） 第二篇：跨域配置