001-nginx基础配置-location、Rewrite、return 直接返回码、全局变量

一、基础语法

1.1、location block 的基本语法形式是：

    location [=|~|~*|^~|@] pattern { ... } 即：location [=|~|~*|^~|...] /url/  {... ...}

[=|~|~*|^~|@] 被称作 location modifier ，这会定义 Nginx 如何去匹配其后的 pattern ，以及该 pattern 的最基本的属性（简单字符串或正则表达式）

选项参数

　　= 　　表示精准匹配

　　^~ 　　表示uri以某个常规字符串开头，理解为匹配 url路径即可。nginx不对url做编码，因此请求为/static/20%/aa，可以被规则^~ /static/ /aa匹配到（注意是空格）。

　　~ 　　表示区分大小写正则匹配

　　~* 　　表示不区分大小写正则匹配

　　!~ 　　分别为区分大小写不匹配

　　!~*　　不区分大小写不匹配

其他参数：

　　-f 判断文件是否存在

　　-d 判断目录是否存在

　　-x 判断文件是否可执行

　　-e 判断文件、目录、链接是否存在

1.2、正则基础

　　^　　匹配字符串的开始位置；

　　$　　匹配字符串的结束位置；

　　.*　　 .匹配任意字符，*匹配数量0到正无穷；

　　.　　斜杠用来转义，.匹配 .    特殊使用方法

　　（值1|值2|值3|值4）　　或匹配模式，例：（jpg|gif|png|bmp）匹配jpg或gif或png或bmp

　　!　　非 

二、基本示例

2.1、静态资源匹配

　　　　# 静态资源
        charset utf-8;
        index index.html index.htm;

        #配置Nginx动静分离，定义的静态页面直接从Nginx发布目录读取。
        location ~ .*.(html|htm|gif|jpg|jpeg|bmp|png|ico|txt|js|css)$ {
            root /export/html/webapps;
            #expires定义用户浏览器缓存的时间为7天，如果静态页面不常更新，可以设置更长，这样可以节省带宽和缓解服务器的压力
            expires      7d;
        }

　　　　说明： ~ 区分大小写正则匹配；.*    匹配可以任意字符，以及不论个数；. 匹配一个 .；(html|htm|gif|jpg|jpeg|bmp|png|ico|txt|js|css)$ 匹配任意括号中模式并且结束；

三、要点

3.1、location匹配顺序

1. "="前缀指令匹配，如果匹配成功，则停止其他匹配
2. 普通字符串指令匹配，顺序是从长到短，匹配成功的location如果使用^~，则停止其他匹配（正则匹配）
3. 正则表达式指令匹配，按照配置文件里的顺序，成功就停止其他匹配
4. 如果第三步中有匹配成功，则使用该结果，否则使用第二步结果

　　多个location配置的情况下匹配顺序为：首先匹配 =，其次匹配^~, 其次是按文件中顺序的正则匹配，最后是交给 / 通用匹配。当有匹配成功时候，停止匹配，按当前匹配规则处理请求。

3.2、注意点

1. 匹配的顺序是先匹配普通字符串，然后再匹配正则表达式。另外普通字符串匹配顺序是根据配置中字符长度从长到短，也就是说使用普通字符串配置的location顺序是无关紧要的，反正最后nginx会根据配置的长短来进行匹配，但是需要注意的是正则表达式按照配置文件里的顺序测试。找到第一个比配的正则表达式将停止搜索。

2. 一般情况下，匹配成功了普通字符串location后还会进行正则表达式location匹配。有两种方法改变这种行为，其一就是使用“=”前缀，这时执行的是严格匹配，并且匹配成功后立即停止其他匹配，同时处理这个请求；另外一种就是使用“^~”前缀，如果把这个前缀用于一个常规字符串那么告诉nginx 如果路径匹配那么不测试正则表达式。

3.3、匹配模式及顺序location modifier 【依次匹配】

　　location = /uri 　　　=开头表示精确匹配，只有完全匹配上才能生效。

　　location ^~ /uri 　　^~ 开头对URL路径进行前缀匹配，并且在正则之前。

　　location ~ pattern 　~开头表示区分大小写的正则匹配。

　　location ~* pattern 　~*开头表示不区分大小写的正则匹配。

　　location /uri 　　　　不带任何修饰符，也表示前缀匹配，但是在正则匹配之后。

　　location / 　　　　　通用匹配，任何未匹配到其它location的请求都会匹配到，相当于switch中的default。 

3.3.1、【=】精确匹配

server {
    server_name website.com;
    location = /abcd {
    […]
    }
}

匹配情况：

    http://website.com/abcd        # 正好完全匹配

    http://website.com/ABCD        # 如果运行 Nginx server 的系统本身对大小写不敏感，比如 Windows ，那么也匹配

    http://website.com/abcd?param1m2    # 忽略查询串参数（query string arguments），这里就是 /abcd 后面的 ?param1m2

    http://website.com/abcd/    # 不匹配，因为末尾存在反斜杠（trailing slash），Nginx 不认为这种情况是完全匹配

    http://website.com/abcde    # 不匹配，因为不是完全匹配

3.3.2、【none】不写location modifier

可以不写 location modifier ，Nginx 仍然能去匹配 pattern 。这种情况下，匹配那些以指定的 patern 开头的 URI，注意这里的 URI 只能是普通字符串，不能使用正则表达式。

server {
    server_name website.com;
    location /abcd {
    […]
    }
}

匹配情况：

    http://website.com/abcd        # 正好完全匹配

    http://website.com/ABCD        # 如果运行 Nginx server 的系统本身对大小写不敏感，比如 Windows ，那么也匹配

    http://website.com/abcd?param1m2    # 忽略查询串参数（query string arguments），这里就是 /abcd 后面的 ?param1m2

    http://website.com/abcd/    # 末尾存在反斜杠（trailing slash）也属于匹配范围内

    http://website.com/abcde    # 仍然匹配，因为 URI 是以 pattern 开头的

3.3.3、【~】对大小写敏感，且 pattern 须是正则表达式

server {
    server_name website.com;
    location ~ ^/abcd$ {
    […]
    }
}

匹配情况：

    http://website.com/abcd        # 完全匹配

    http://website.com/ABCD        # 不匹配，~ 对大小写是敏感的

    http://website.com/abcd?param1m2    # 忽略查询串参数（query string arguments），这里就是 /abcd 后面的 ?param1m2

    http://website.com/abcd/    # 不匹配，因为末尾存在反斜杠（trailing slash），并不匹配正则表达式 ^/abcd$

    http://website.com/abcde    # 不匹配正则表达式 ^/abcd$

注意：对于一些对大小写不敏感的系统，比如 Windows ，~ 和 ~* 都是不起作用的，这主要是操作系统的原因。

3.3.4、【~*】与 ~ 类似，但这个 location modifier 不区分大小写，pattern 须是正则表达式

server {
    server_name website.com;
    location ~* ^/abcd$ {
    […]
    }
}

匹配情况：

    http://website.com/abcd        # 完全匹配

    http://website.com/ABCD        # 匹配，这就是它不区分大小写的特性

    http://website.com/abcd?param1m2    # 忽略查询串参数（query string arguments），这里就是 /abcd 后面的 ?param1m2

    http://website.com/abcd/    # 不匹配，因为末尾存在反斜杠（trailing slash），并不匹配正则表达式 ^/abcd$

    http://website.com/abcde    # 不匹配正则表达式 ^/abcd$

3.3.5、【^~】

匹配情况类似 2. (None) 的情况，以指定匹配模式开头的 URI 被匹配，不同的是，一旦匹配成功，那么 Nginx 就停止去寻找其他的 Location 块进行匹配了（与 Location 匹配顺序有关）

3.3.6、【@】

用于定义一个 Location 块，且该块不能被外部 Client 所访问，只能被 Nginx 内部配置指令所访问，比如 try_files or error_page

3.4、搜索顺序以及生效优先级

写在配置文件中每个 Server 块中的 Location 块的次序是不重要的，Nginx 会按 location modifier 的优先级来依次用 URI 去匹配 pattern ，顺序如下：

    1. =

    2. (None)    如果 pattern 完全匹配 URI（不是只匹配 URI 的头部）

    3. ^~

    4. ~ 或 ~*

    5. (None)    pattern 匹配 URI 的头部

3.5、匹配案例

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

四、nginx  Rewrite相关

4.1、rewrite指令的最后一项参数为flag标记

flag标记有：

　　1.last    相当于apache里面的[L]标记，表示rewrite。

　　2.break本条规则匹配完成后，终止匹配，不再匹配后面的规则。

　　3.redirect  返回302临时重定向，浏览器地址会显示跳转后的URL地址。

　　4.permanent  返回301永久重定向，浏览器地址会显示跳转后的URL地址。

　　使用last和break实现URI重写，浏览器地址栏不变。而且两者有细微差别，使用alias指令必须用last标记;使用proxy_pass指令时，需要使用break标记。Last标记在本条rewrite规则执行完毕后，会对其所在server{......}标签重新发起请求，而break标记则在本条规则匹配完成后，终止匹配。

　　例如：如果我们将类似URL/photo/123456 重定向到/path/to/photo/12/1234/123456.png

　　rewrite "/photo/([0-9]{2})([0-9]{2})([0-9]{2})"/path/to/photo/$1/$1$2/$1$2$3.png ;

4.2、Rewrite 规则相关指令

1.break指令

　　使用环境：server,location,if;
　　该指令的作用是完成当前的规则集，不再处理rewrite指令。

2.if指令

　　使用环境：server,location
　　该指令用于检查一个条件是否符合，如果条件符合，则执行大括号内的语句。If指令不支持嵌套，不支持多个条件&&和||处理。

3.return指令

　　语法：return code ;
　　使用环境：server,location,if;
　　该指令用于结束规则的执行并返回状态码给客户端。
　　示例：如果访问的URL以".sh"或".bash"结尾，则返回403状态码

location ~ .*.(sh|bash)?$ {
　　return 403;
}

4.rewrite 指令

　　语法：rewrite regex replacement flag
　　使用环境：server,location,if
　　该指令根据表达式来重定向URI，或者修改字符串。指令根据配置文件中的顺序来执行。注意重写表达式只对相对路径有效。如果你想配对主机名，你应该使用if语句，示例如下：

if( $host ~* www.(.*) ){
    set $host_without_www $1;
    rewrite ^(.*)$  http://$host_without_www$1permanent;
}

5.Set指令

　　语法：setvariable value ; 默认值:none; 使用环境：server,location,if;
　　该指令用于定义一个变量，并给变量赋值。变量的值可以为文本、变量以及文本变量的联合。
　　示例：set$varname "hello world";

6.Uninitialized_variable_warn指令

　　语法：uninitialized_variable_warnon|off
　　使用环境：http,server,location,if
　　该指令用于开启和关闭未初始化变量的警告信息，默认值为开启。

4.3、示例

1.当访问的文件和目录不存在时，重定向到某个php文件

if( !-e $request_filename ){
    rewrite ^/(.*)$ index.php last;
}

2.目录对换 /123456/xxxx  ====>  /xxxx?id=123456

rewrite ^/(d+)/(.+)/  /$2?id=$1 last;

3.如果客户端使用的是IE浏览器，则重定向到/ie目录下

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

4.禁止访问多个目录

location ~ ^/(cron|templates)/ {
    deny all;
    break;
}

5.禁止访问以/data开头的文件

location ~ ^/data {
    deny all;
}

6.禁止访问以.sh,.flv,.mp3为文件后缀名的文件

location ~ .*.(sh|flv|mp3)$ {
    return 403;
}

7.设置某些类型文件的浏览器缓存时间

location ~ .*.(gif|jpg|jpeg|png|bmp|swf)$ {
    expires 30d;
}
location ~ .*.(js|css)$ {
    expires 1h;
}

8.给favicon.ico和robots.txt设置过期时间;
这里为favicon.ico为99天,robots.txt为7天并不记录404错误日志

location ~(favicon.ico) {
    log_not_found off;
    expires 99d;
    break;
}
location ~(robots.txt) {
    log_not_found off;
    expires 7d;
    break;
}

9.设定某个文件的过期时间;这里为600秒，并不记录访问日志

location ^~ /html/scripts/loadhead_1.js {
    access_log  off;
    root /opt/lampp/htdocs/web;
    expires 600;
    break;
}

10.文件反盗链并设置过期时间
这里的return412 为自定义的http状态码，默认为403，方便找出正确的盗链的请求

“rewrite ^/ http://img.linuxidc.net/leech.gif;”显示一张防盗链图片
“access_log off;”不记录访问日志，减轻压力
“expires 3d”所有文件3天的浏览器缓存

location ~*^.+.(jpg|jpeg|gif|png|swf|rar|zip|css|js)$ {
    valid_referers none blocked *.linuxidc.com*.linuxidc.net localhost 208.97.167.194;
    if ($invalid_referer) {
        rewrite ^/ http://img.linuxidc.net/leech.gif;
        return 412;
        break;
    }
    access_log  off;
    root /opt/lampp/htdocs/web;
    expires 3d;
    break;
}

11.只允许固定ip访问网站，并加上密码

root /opt/htdocs/www;
allow  208.97.167.194; 
allow  222.33.1.2; 
allow  231.152.49.4;
deny  all;
auth_basic “C1G_ADMIN”;
auth_basic_user_file htpasswd;

12将多级目录下的文件转成一个文件，增强seo效果

/job-123-456-789.html 指向/job/123/456/789.html

rewrite^/job-([0-9]+)-([0-9]+)-([0-9]+).html$ /job/$1/$2/jobshow_$3.html last;

13.文件和目录不存在的时候重定向：

if (!-e $request_filename) {
　　proxy_pass http://127.0.0.1;
}

14.将根目录下某个文件夹指向2级目录
如/shanghaijob/ 指向 /area/shanghai/
如果你将last改成permanent，那么浏览器地址栏显是/location/shanghai/

rewrite ^/([0-9a-z]+)job/(.*)$ /area/$1/$2last;

上面例子有个问题是访问/shanghai时将不会匹配

rewrite ^/([0-9a-z]+)job$ /area/$1/ last;
rewrite ^/([0-9a-z]+)job/(.*)$ /area/$1/$2last;

这样/shanghai 也可以访问了，但页面中的相对链接无法使用，
如./list_1.html真实地址是/area/shanghia/list_1.html会变成/list_1.html,导至无法访问。
那我加上自动跳转也是不行
(-d $request_filename)它有个条件是必需为真实目录，而我的rewrite不是的，所以没有效果

if (-d $request_filename){
    rewrite ^/(.*)([^/])$ http://$host/$1$2/permanent;
}

rewrite ^/([0-9a-z]+)job$ /$1job/permanent;
rewrite ^/([0-9a-z]+)job/(.*)$ /area/$1/$2last;

15.域名跳转

server{
    listen      80;
    server_name  jump.linuxidc.com;
    index index.html index.htm index.php;
    root  /opt/lampp/htdocs/www;
    rewrite ^/ http://www.linuxidc.com/;
    access_log  off;
}

16.多域名转向

server_name  www.linuxidc.com www.linuxidc.net;
index index.html index.htm index.php;
root  /opt/lampp/htdocs;
if ($host ~ "linuxidc.net") {
    rewrite ^(.*) http://www.linuxidc.com$1permanent;
}

五、return

1： 返回错误码

eg:  单独配置返回返回码场景

nginx 配置如下：

    location = /test {
         return 403 ;
    }

通过返回的页面为： 403 Forbidden 正常的403错误返回码报错

可以看出 对于单独返回返回码的场景， 可以进行过滤拦截场景使用）

2： 通过return  返回 文本信息和 json

 location ^~ /pic {
          default_type text/html ;
          return 200  'test test test ';
 }

进行 http://192.168.1.19:8080/pic/test 进行测试，页面返回编辑的内容： test test test 

        location ^~ /pic {
          default_type application/json ;
          return 200  '{"name":"nanjing_wuxu","result":"success"}';
        }

http://192.168.1.19:8080/pic/test 进行测试，页面返回编辑的内容：{"name":"nanjing_wuxu","result":"success"}

可以理解，可以通过return 为请求方之间返回编辑的文本等信息

3： 直接跳转功能

        location ^~ /pic {
          return http://192.168.1.19:8080/aa.jpg;
        }

进行http://192.168.1.19:8080/pic/test 进行测试，返回的是aa.jsp图片， 从日志中也可以进行查看，进行了跳转

 [26/Jan/2018:17:05:33 +0800] "GET /pic/test HTTP/1.1" 302 153 "-" "Mozilla/5.0 (Windows NT 6.1; WOW64; rv:36.0) Gecko/20100101 Firefox/36.0"
 [26/Jan/2018:17:05:33 +0800] "GET /aa.jpg HTTP/1.1" 200 879394 "-" "Mozilla/5.0 (Windows NT 6.1; WOW64; rv:36.0) Gecko/20100101 Firefox/36.0"

五、nginx全局变量

arg_PARAMETER    #这个变量包含GET请求中，如果有变量PARAMETER时的值。
args                    #这个变量等于请求行中(GET请求)的参数，如：foo=123&bar=blahblah;
binary_remote_addr #二进制的客户地址。
body_bytes_sent    #响应时送出的body字节数数量。即使连接中断，这个数据也是精确的。
content_length    #请求头中的Content-length字段。
content_type      #请求头中的Content-Type字段。
cookie_COOKIE    #cookie COOKIE变量的值
document_root    #当前请求在root指令中指定的值。
document_uri      #与uri相同。
host                #请求主机头字段，否则为服务器名称。
hostname          #Set to themachine’s hostname as returned by gethostname
http_HEADER
is_args              #如果有args参数，这个变量等于”?”，否则等于”"，空值。
http_user_agent    #客户端agent信息
http_cookie          #客户端cookie信息
limit_rate            #这个变量可以限制连接速率。
query_string          #与args相同。
request_body_file  #客户端请求主体信息的临时文件名。
request_method    #客户端请求的动作，通常为GET或POST。
remote_addr          #客户端的IP地址。
remote_port          #客户端的端口。
remote_user          #已经经过Auth Basic Module验证的用户名。
request_completion #如果请求结束，设置为OK. 当请求未结束或如果该请求不是请求链串的最后一个时，为空(Empty)。
request_method    #GET或POST
request_filename  #当前请求的文件路径，由root或alias指令与URI请求生成。
request_uri          #包含请求参数的原始URI，不包含主机名，如：”/foo/bar.php?arg=baz”。不能修改。
scheme                #HTTP方法（如http，https）。
server_protocol      #请求使用的协议，通常是HTTP/1.0或HTTP/1.1。
server_addr          #服务器地址，在完成一次系统调用后可以确定这个值。
server_name        #服务器名称。
server_port          #请求到达服务器的端口号。