Nginx 重写规则指南
HesterPLGF
8年前
<p><img src="https://simg.open-open.com/show/82329704e270c905dcf81939e690beb5.gif"></p> <p>当运维遇到要重写情况时，往往是要程序员把重写规则写好后，发给你，你再到生产环境下配置。对于重写规则说到底就是正则匹配，做运维的岂能对正则表达式不了解的？最起码最基本的正则表达式会写。套用一句阿里的话(某网友说是阿里说的，不清楚到底是不是出自阿里)“不懂程序的运维，不是好运维；不懂运维的开发，不是好开发。”。 正则表达式也是一门语言哈。当你学习一门语言时，必然会遇到该门语言的正则表达式这章节的。 在这里推荐一本非常好的正则表达式书，包含常用的语言的正则写法如sed、perl、bash、awk、php、c#、java、javascript、python、ruby等等，《Regular Expressions Cookbook, 2nd Edition》，也有中文版的，大家可以到网络上找找。</p> <p style="text-align: center;"><img src="https://simg.open-open.com/show/84a7b29171d41b4dac9c2e4b8d8b72d8.jpg"></p> <p>本文介绍nginx的重写模块，创建重写规则向导，便于快捷正确的创建新的重写规则，不求救于人。同时，如果想把apache转换成nginx，重写规则也是要改的咯。</p> <h2><strong>一. rewrite模块介绍</strong></h2> <p>nginx的重写模块是一个简单的正则表达式匹配与一个虚拟堆叠机结合。依赖于PCRE库，因此需要安装pcre。根据相关变量重定向和选择不同的配置，从一个location跳转到另一个location，不过这样的循环最多可以执行10次，超过后nginx将返回500错误。同时，重写模块包含set指令，来创建新的变量并设其值，这在有些情景下非常有用的，如记录条件标识、传递参数到其他location、记录做了什么等等。</p> <h2><strong>二. rewrite模块指令</strong></h2> <p><strong>break</strong></p> <p>语法：break</p> <p>默认值：none</p> <p>使用字段：server, location, if</p> <p>完成当前设置的重写规则，停止执行其他的重写规则。</p> <p><strong>if</strong></p> <p>语法：if (condition) { … }</p> <p>默认值：none</p> <p>使用字段：server, location</p> <p>注意：尽量考虑使用try_files代替。判断的条件可以有以下值：</p> <ol> <li> <p>一个变量的名称：空字符传“”或者一些“0”开始的字符串为false。</p> </li> <li> <p>字符串比较：使用=或!=运算符</p> </li> <li> <p>正则表达式匹配：使用~(区分大小写)和~*(不区分大小写)，取反运算!~和!~*。</p> </li> <li> <p>文件是否存在：使用-f和!-f操作符</p> </li> <li> <p>目录是否存在：使用-d和!-d操作符</p> </li> <li> <p>文件、目录、符号链接是否存在：使用-e和!-e操作符</p> </li> <li> <p>文件是否可执行：使用-x和!-x操作符</p> </li> </ol> <p><strong>return</strong></p> <p>语法：return code</p> <p>默认值：none</p> <p>使用字段：server, location, if</p> <p>停止处理并为客户端返回状态码。非标准的444状态码将关闭连接，不发送任何响应头。可以使用的状态码有：204，400，402-406，408，410, 411, 413, 416与500-504。如果状态码附带文字段落，该文本将被放置在响应主体。相反，如果状态码后面是一个URL，该URL将成为location头补值。没有状态码的URL将被视为一个302状态码。</p> <p><strong>rewrite</strong></p> <p>语法：rewrite regex replacement flag</p> <p>默认值：none</p> <p>使用字段：server, location, if</p> <p>按照相关的正则表达式与字符串修改URI，指令按照在配置文件中出现的顺序执行。可以在重写指令后面添加标记。</p> <p>注意：如果替换的字符串以http://开头，请求将被重定向，并且不再执行多余的rewrite指令。</p> <p>尾部的标记(flag)可以是以下的值：</p> <ul> <li> <p>last – 停止处理重写模块指令，之后搜索location与更改后的URI匹配。</p> </li> <li> <p>break – 完成重写指令。</p> </li> <li> <p>redirect – 返回302临时重定向，如果替换字段用http://开头则被使用。</p> </li> <li> <p>permanent – 返回301永久重定向。</p> </li> </ul> <p><strong>rewrite_log</strong></p> <p>语法：rewrite_log on | off</p> <p>默认值：rewrite_log off</p> <p>使用字段：server, location, if</p> <p>变量：无</p> <p>启用时将在error log中记录notice级别的重写日志。</p> <p><strong>set</strong></p> <p>语法：set variable value</p> <p>默认值：none</p> <p>使用字段：server, location, if</p> <p>为给定的变量设置一个特定值。</p> <p><strong>uninitialized_variable_warn</strong></p> <p>语法：uninitialized_variable_warn on|off</p> <p>默认值：uninitialized_variable_warn on</p> <p>使用字段：http, server, location, if</p> <p>控制是否记录未初始化变量的警告信息。</p> <h2><strong>三. 重写规则组成部分</strong></h2> <h3><strong>3.1 任何重写规则的第一部分都是一个正则表达式</strong></h3> <p>可以使用括号来捕获，后续可以根据位置来将其引用，位置变量值取决于捕获正则表达式中的顺序，$1引用第一个括号中的值，$2引用第二个括号中的值，以此类推。如：</p> <p>^/images/([a-z]{2})/([a-z0-9]{5})/(.*)\.(png|jpg|gif)$</p> <p>$1是两个小写字母组成的字符串，$2是由小写字母和0到9的数字组成的5个字符的字符串，$3将是个文件名，$4是png、jpg、gif中的其中一个。</p> <h3><strong>3.2 重写规则的第二部分是URI</strong></h3> <p>请求被改写。该URI可能包含正则表达式中的捕获的位置参数或这个级别下的nginx任何配置变量。如：</p> <p>/data?file=$3.$4</p> <p>如果这个URI不匹配nginx配置的任何location，那么将给客户端返回301(永久重定向)或302(临时重定向)的状态码来表示重定向类型。该状态码可以通过第三个参数来明确指定。</p> <h3><strong>3.3 重写规则的第三部分</strong></h3> <p>第三部分也就是尾部的标记(flag)。 last标记将导致重写后的URI搜索匹配nginx的其他location，最多可循环10次。如：</p> <p>rewrite '^/images/([a-z]{2})/([a-z0-9]{5})/(.*)\.(png|jpg|gif)$' /data?file=$3.$4 last;</p> <p>break指令可以当做自身指令。如：</p> <p>if ($ bwhog ) {</p> <p>limit _ rate 300k ;</p> <p>break ;</p> <p>}</p> <p>另一个停止重写模块处理指令是return， 来控制主HTTP模块处理请求。 这意味着，nginx直接返回信息给客户端，与error_page结合为客户端呈现格式化的HTML页面或激活不同的模块来完成请求。如果状态码附带文字段落，该文本将被放置在响应主体。相反，如果状态码后面是一个URL，该URL将成为location头补值。没有状态码的URL将被视为一个302状态码。如：</p> <p>location = / image404 . html {</p> <p>return 404 "image not found\n" ;</p> <p>}</p> <h2><strong>四. 实例</strong></h2> <p>http {</p> <p># 定义image日志格式</p> <p>log_format imagelog '[$time_local] ' $ image _ file ' ' $ image _ type ' ' $ body_bytes _ sent ' ' $ status ;</p> <p># 开启重写日志</p> <p>rewrite_log on ;</p> <p>server {</p> <p>root / home / www ;</p> <p>location / {</p> <p># 重写规则信息</p> <p>error_log logs / rewrite . log notice ;</p> <p># 注意这里要用‘’单引号引起来，避免{}</p> <p>rewrite '^/images/([a-z]{2})/([a-z0-9]{5})/(.*)\.(png|jpg|gif)$' / data ? file = $ 3. $ 4 ;</p> <p># 注意不能在上面这条规则后面加上“last”参数，否则下面的set指令不会执行</p> <p>set $ image _ file $ 3 ;</p> <p>set $ image _ type $ 4 ;</p> <p>}</p> <p>location / data {</p> <p># 指定针对图片的日志格式，来分析图片类型和大小</p> <p>access_log logs / images . log main ;</p> <p>root / data / images ;</p> <p># 应用前面定义的变量。判断首先文件在不在，不在再判断目录在不在，如果还不在就跳转到最后一个url里</p> <p>try_files / $ arg_file / image404 . html ;</p> <p>}</p> <p>location = / image404 . html {</p> <p># 图片不存在返回特定的信息</p> <p>return 404 "image not found\n" ;</p> <p>}</p> <p>}</p> <h2><strong>五. 创建新的重新规则</strong></h2> <p>在接到要创建新的重写规则时，要弄清楚需求是什么样的，再决定怎么做。毕竟重写也是耗资源的有效率之分的。 下面的这些问题有些帮助的：</p> <ol> <li> <p>你的URL的模式是什么样的?</p> </li> <li> <p>是否有一个以上的方法来实现？</p> </li> <li> <p>是否需要捕获URL部分作为变量？</p> </li> <li> <p>重定向到另一个web上可以看到我的规则？</p> </li> <li> <p>是否要替换查询的字符串参数？</p> </li> </ol> <p>检查网站或应用程序布局，清楚URL模式。啰嗦一句：我一而再再而三的强调，运维不能与开发脱节，运维要参与到开发当中。如果有不止一种方法实现，创建一个永久重定向。同时，定义一个重写规范，来使网址清洁，还可以帮助网站更容易被找到。</p> <p>实例1. 要将home目录重定向到主页面上，目录结构如下：</p> <p>/</p> <p>/ home</p> <p>/ home /</p> <p>/ home / index</p> <p>/ home / index /</p> <p>/ index</p> <p>/ index . php</p> <p>/ index . php /</p> <p>重写规则如下：</p> <p>rewrite ^/ ( home ( / index )? | index (\. php )?) / ?$ $ scheme :</p> <p>//$host/ permanent;</p> <p>指定$scheme和$host变量，因为要做一个永久重定向并希望nginx使用相同的参数来构造URL。</p> <p>实例2. 如果想分别记录各个部分的URL，可以使用正则表达式来捕获URI，然后，给变量分配指定位置变量，见上面的实例。</p> <p>实例3. 当重写规则导致内部重定向或指示客户端调用该规则本身被定义的location时，必须采取特殊的动作来避免重写循环。如：在server配置段定义了一条规则带上last标志，在引用location时，必须使用break标志。</p> <p>server {</p> <p>rewrite ^ ( / images ) / (. * )\.( png | jpg | gif )$ $ 1 / $ 3 / $ 2. $ 3 last ;</p> <p>location / images / {</p> <p>rewrite ^ ( / images ) / (. * )\.( png | jpg | gif )$ $ 1 / $ 3 / $ 2. $ 3 break ;</p> <p>}</p> <p>}</p> <p>实例4. 作为重写规则的一部分，传递新的查询字符串参数是使用重写规则的目标之一。 如：</p> <p>rewrite ^/images/(.*)_(\d+)x(\d+)\.(png|jpg|gif)$ /resizer/$1.$4?width=$2&height=$3? last;</p> <p>nginx重写规则说起来挺简单的，做起来就难，重点在于正则表达式，同时，还需要考虑到nginx执行顺序。</p> <p> </p> <p> </p> <p> </p> <p>来自：http://mp.weixin.qq.com/s?__biz=MzAwNjA3NDMyOA==&mid=2659762695&idx=2&sn=d0d2cf9c5c7e5a8dfc753d2271d9167a&chksm=806e98b0b71911a67e20025d5f9bbd1c11d58d50cc68594da9aec9f35da74a9fb2b064faec77&scene=0#wechat_redirect</p> <p> </p>