美文网首页
nginx location,rewrite 详解

nginx location,rewrite 详解

作者: 呆叔么么 | 来源:发表于2020-01-14 14:12 被阅读0次

    location

    一、语法规则

    location [=|~|~*|^~] /uri/ { … }

    符号  含义
    =   开头表示精确匹配(不支持正则表达式)
    ^~  开头表示 uri 以某个常规字符串开头,理解为匹配 url 路径即可(不支持正则表达式)
    ~   开头表示区分大小写的正则匹配
    ~*  开头表示不区分大小写的正则匹配
    /   通用匹配,任何请求都会匹配到
    

    多个 location 配置的情况下匹配顺序为

    首先匹配 =
    其次匹配 ^~
    其次是按文件中顺序的正则匹配
    最后是交给 / 通用匹配
    当有匹配成功时候,停止匹配,按当前匹配规则处理请求
    

    实例

    location = / {
       #规则A
    }
    location = /login {
       #规则B
    }
    location ^~ /static/ {
       #规则C
    }
    location ~ \.(gif|jpg|png|js|css)$ {
       #规则D
    }
    location ~* \.png$ {
       #规则E
    }
    location / {
       #规则F
    }
    
    那么产生的效果如下:
    访问根目录 /, 比如 http://localhost/ 将匹配规则 A
    访问 http://localhost/login 将匹配规则 B,http://localhost/register 则匹配规则 F
    访问 http://localhost/static/a.html 将匹配规则 C
    访问 http://localhost/a.gif, http://localhost/b.jpg 将匹配规则 D和规则 E,但是规则 D 顺序优先,规则 E不起作用,而 http://localhost/static/c.png则优先匹配到规则 C
    访问 http://localhost/a.PNG 则匹配规则 E,而不会匹配规则 D,因为规则 E 不区分大小写
    访问 http://localhost/category/id/1111 则最终匹配到规则 F,因为以上规则都不匹配,这个时候应该是 nginx 转发请求给后端应用服务器,比如 FastCGI(PHP),tomcat(jsp),nginx 作为反向代理服务器存在
    

    二、运用场景

    # 直接匹配网站根,通过域名访问网站首页比较频繁,使用这个会加速处理,官网如是说。
    # 这里是直接转发给后端应用服务器了,也可以是一个静态首页
    # 第一个必选规则
    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/
    }
    

    使用location时注意事项

    rootalias主要区别在于nginx如何解释location后面的uri,这会使两者分别以不同的方式将请求映射到服务器文件上。
    root的处理结果是:root路径+location路径
    alias的处理结果是:使用alias路径替换location路径
    alias是一个目录别名的定义,root则是最上层目录的定义。

    关于alias后添不添加"/"

    • (1) . alias虚拟目录配置中,location匹配的path目录如果后面不带"/",那么访问的url地址中这个path目录后面加不加"/"不影响访问,访问时它会自动加上"/"
      但是如果location匹配的path目录后面加上"/",那么访问的url地址中这个path目录必须要加上"/",访问时它不会自动加上"/"。如果不加上"/",访问就会失败!
    • (2) . root目录配置中,location匹配的path目录后面带不带"/",都不会影响访问。
      root实例
    location ^~ /t/ {
         root /www/root/html/;
    }
    

    如果一个请求的URI/t/a.html
    web服务器将会返回服务器上的/www/root/html/t/a.html的文件。
    alias实例

    location ^~ /t/ {
     alias /www/root/html/new_t/;
    }
    

    如果一个请求的URI是/t/a.html时,web服务器将会返回服务器上的/www/root/html/new_t/a.html的文件。注意这里是new_t,因为alias会把location后面配置的路径丢弃掉,把当前匹配到的目录指向到指定的目录。

    注意
    使用alias时,目录名后面一定要加"/"
    alias在使用正则匹配时,必须捕捉要匹配的内容并在指定的内容处使用。
    alias只能位于location块中。(root可以不放在location中)

    rewrite

    一.语法

    server {
        rewrite 规则 定向路径 重写类型;
    }
    
    规则:可以是字符串或者正则来表示想匹配的目标url
    定向路径:表示匹配到规则后要定向的路径,如果规则里有正则,则可以使用$index来表示正则里的捕获分组
    重写类型:
    last :相当于Apache里德(L)标记,表示完成rewrite,浏览器地址栏URL地址不变
    break;本条规则匹配完成后,终止匹配,不再匹配后面的规则,浏览器地址栏URL地址不变
    redirect:返回302临时重定向,浏览器地址会显示跳转后的URL地址
    permanent:返回301永久重定向,浏览器地址栏会显示跳转后的URL地址
    

    二.简单例子

    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;
    }
    

    二.last和break的区别

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

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

    在location里一旦返回break则直接生效并停止后续的匹配location

    server {
        location / {
            rewrite /last/ /q.html last;
            rewrite /break/ /q.html break;
        }
    
        location = /q.html {
            return 400;
        }
    }
    
    • 访问/last/时重写到/q.html,然后使用新的uri再匹配,正好匹配到locatoin = /q.html然后返回了400
    • 访问/break时重写到/q.html,由于返回了break,则直接停止了

    if判断

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

    if (表达式) {
    }
    
    • 当表达式只是一个变量时,如果值为空或任何以0开头的字符串都会当做false

    • 直接比较变量和内容时,使用=或!=

    • ~正则表达式匹配,~*不区分大小写的匹配,!~区分大小写的不匹配
      一些内置的条件判断:

    • -f和!-f用来判断是否存在文件

    • -d和!-d用来判断是否存在目录

    • -e和!-e用来判断是否存在文件或目录

    • -x和!-x用来判断文件是否可执行
      内置的全局变量

    $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
    网站路径是:/var/www/html

    $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
    

    例子

    # 如果文件不存在则返回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规则来使用,如:

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

    上面表示:

    • /test.html => /xiaowu.html
    • /test.html?name=ok => /ok.html?name=ok

    本文参考 https://www.cnblogs.com/jiangyang/p/8485046.html

    相关文章

      网友评论

          本文标题:nginx location,rewrite 详解

          本文链接:https://www.haomeiwen.com/subject/jxnoactx.html