【学习笔记收藏】nginx 配置 location 总结及 rewrite 规则写法

说起 Nginx 几乎是永远无法绕开其 .conf 后缀的配置文件编辑的,所以对 Nginx 配置文件的相关语法、语句、变量的学习也是用好 Nginx 的必要条件C & 9之一。相对于编程、脚本等, Nginx 配置文件J s ) ]还算是比较简单的,所以明月很有兴F ; Q 4 o趣深入研究学习一下的,今天就先从配置 location 总结及 rewrite 规则写法开始。

【学习笔记收藏】nginx 配置 location 总结及 rewrite 规则写法

一、 Y V n u b P ?locat} = xion正则写法

一个示例:

location  = / {
# 精确匹配 / ,主机名后面不能带任何字符串
[ configuration A ]
}
location  / {
# 因为所有的地址都以 / 开头,所以这条规则将匹配到所有请求
# 但是正则和最长字符串会优先匹配
[ configuration B ]
}
location /docu( = ? o P 3ments/ {
# 匹配任何以 /documents/ 开头的{ | . N W ;地址,匹配符合以后,还要继续往下搜索
# 只有后} w ; z j W F * o面的正则表达式没有匹配到时,这一条才会采用这一条B s v )
[ configurati6 ] Von C ]
}
location ~ /do^ 5 ) y ; ? ecuments/Abc {
# 匹配任何以 /documents/ 开头的地址,匹配符合以后,还要继续往下搜索
# 只有后面的正则表达式没有匹G E a ? y4 ^ ! Q 7 U e w到时,q y x这一条才会采用这一条
[ configuration CI V + $ & ;C ]
}
location ^~ /images/ {
# 匹配任何以 /images/ 开Y  G y : J v头的地址,匹配符合. q i ( e x ^ b Y以后,停止往下搜索正则,采用这一条。
[ configuration D ]
}
locatioh ] Mn ~* \.(gif|jpg|jpeg)$ {
# 匹配所有以 gif,jpg或jpeg 结X ` ( ? { g W尾的请求
# 然而,所有请求 /images/ 下的图片会被 config D 处理,因为 ^~ 到达不了这一条正则
[ configuration E ]
}
location /images/ {
# 字符匹配到 /images/,继续往下,会发现 ^t 9 U 3 H F~ 存在
[ configuration Fg M y U m o m ; 2 ]
}
location /images/abc {
# 最长字符匹配d = t e到 /images/abc,继续往下,会发现 ^~ 存在
# F与G的放置顺序是没有关系的
[ configb [ / ` ? Z Iuration G ]
}
locatis a Aon ~ /images/abc/ {
# 只有去掉 confi. v Kg D 才有效:先最长匹配 config G 开头的地址,继续往$ K 4 I  k g下搜索,匹配到这一条正则,采用
[ co_ 9 @ snfiguration H ]
}
location ~* /js/.*/\.js
  • = 开头表示精确匹配,如 A 中只匹配根目录结尾的请求,后面不能带任何字符串。
  • ^~ 开头表示uri以某个常规字符串开头,不是正则匹配
  • ~ 开头表示区分大小写的正则匹配;
  • ~* 开头表示不区分大小写的正则匹配
  • / 通用匹配, 如果没有其它匹配,任何请求都会匹. C ; l ~ h配到

顺序不等于优先级:

(loF Q p y 8 ? ` xcation =) > (location 完整= @ . W 0路径) > (location ^~ 路径) > (location ~,~* 正则顺序) > (location 部分起始路径) > (/)

上面的匹配结果。按照上面的location写法,以下的匹配示例成立:

  • / -> c N G S Oonfig A 精确完全匹配,即使/index.html也匹配不了
  • /downloads/downlo} ? w nad.html -> config B 匹配B以后,往下没有任何匹配,采用B
  • /images/1.gif -> configuration D 匹配到F,往下匹配到D4 X C x r . X,停止往下
  • /imagesz M }/abc/def -> config D 最长匹配到G,往下匹配D,停止往X - ( c

你可以看到 任何以/images/开头的都会匹配到D并停止,FG写在这里是没有任何意义的,H是永远轮不到的,这里T + n z & 3只是为了说明匹配顺序

  • /documents/document.e [ 3html3 ( f C f P G ) l -> config C 匹配到C,往下没有任何匹配,采用C
  • /documents/1.jpg -> configt : . 8 w ^ 2 U %urat; O P Fion E 匹配到C,往下正R & : p Y l ) O Q则匹配到E
  • /doT n S l / l | ( .cuments/Abc.jpg ->{ 6 q . J z c B; config CC 最长匹配到C,往下正则顺序匹配到CC,不会往下到E

实际使用建议

所以实际使用中,个人觉得至少有三个匹配规则定义,如下:

#6 C p直接匹配网站根,通过域名f F | V ! G e访问网站首页比较频繁,使用这个会加速处理,官网如是说。
#这里是直接转发给后N } d 7 J应用服务器了,也可i $ B y a _ ) t以是一个静态首页
# 第一个必选规则
locatic $ J t n q 7 e Pon = / {
pr1 [ E U ! Toxy_pass http://tomcat:8r v | #080/index
}
# 第二个必选规则是处理静态文件请求,这是nginx作为D T P ] A thttp服务器的强项
# 有R 6 P q 8 a A #两种配置模式,目录匹配或后缀匹配,任选其一或搭配使用
location ^~ /static/ {
root /webroot/static/;
}
location ~* \.4 [ J 3(gif|jpg|jpeg|png|css|js& u % } U F c  =|ico)$ {
roo3 K 3t /webroot/res/;
}
#I $ y 第三个规则就是通用规则,用来转发动态请求到后端应用服务器
# 非静态文件请求就默认是动态请求,自己根据G + o & 7 a O]  ] Y际把握
# 毕竟目前的一些框架的流行,带.php,.jF Z ] .sp后缀的情况很少了
location / {
proxy_pass http://tomcat:8V 2 : s 2 w080/
}

参考:

  1. http://tengine.taobao.org/bookn Q J D * a //chapter_02.html
  2. http://nginx.org/en/docs/http/ngx_http_rewrite_module.html

二、Rewrite规则

rewrite功能就是,使用nginx提供的全局变量或自己设置的变量,结合正则表达式和标志位实现url重写以及重定向。r x 1 * B & ! Iewrite只能放在server{},location{},if{}中,并且只能对域名后边的除去传递的参数外的字符串起作用,例如http://seanloa } ] i w gok.com/a/we/index.php?id=1&u=str 只对/a/we/index.php重写。语法rewrite regex replacement [flag];C 0 V p R H

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

表明看rewrv 3 { I $ Q L ( Tite和location功能有点像,都能实现跳转,主要区别在于i : @rewrite是在同一域名内- $ b 0 # 4 * s更改获取资源的路径,L M S而location是对一类路径做控制访问或反向代理,可以proxy_pass到其他机器。很多情况下rewrite也会写在location里,它们的执行顺序是:

  1. 执行server块的rewrite指令
  2. 执行locatih r e Mon匹配
  3. 执行选定的location中的rewrite指令

如果其中某步URI9 1 J * ] 8被重写,则重新循环执行1-3,直到找到真实存在的文件;循A a # - a [环超过10次,则返回500 Internal Server Error错误。

1、flag标志位

  • last : 相当于Apache的[L]标记,表示完成rewrite
  • break% c | I F ! : 停止执行当前虚拟主机的后续rewrite指令集
  • redirect : 返回302临时重定向,地址栏会显示跳转后的地址
  • permanent : 返回301永久重定向,地址栏会显示跳转后的地址

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

  1. last一般写在server和if中,而break一般9 } / } 4 A ; c使用在location中
  2. last不终止重写后的url匹配,即新的url会再从server走一遍匹配流程,而break终止重写后的匹配
  3. break和last都能组织继续执行后面的rewrite指令

2、i1 - ; & x a 0 1f指令与全局变量

if判断指令

语法为if(condition){...},对给定的条件condition进行判断。如果为真,大括号内的rewrite指令将被执行,if条件(conditon)可以是J n c _如下任何内容:

  • 当表达式只是一个变量} p $ R d C 6时,如果值为空或任何以0开头的字符串都会当做false
  • 直接比较变量和内容时,使用=!=
  • ~正则表达式匹配,^ 2 c U e ~~*不区分大小写的匹配,!~区分大小写的不匹配

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

例如:

if ($http_user_agent ~ MSIE) {
rewrS k g S o f m = ite ^(.*)$ /msie/$1 break;
} //如果UA包含"MSIE",rewrite请求到/msid/目录下
if ($http_cookie ~* "idC % u E 0 p +=([^;]+)(?:;|$m d ] % i  ,)") {
set $id $1;
} //如果cookie匹配正则,设置变量$id等于正则引用部分
if ($r~ l : Nequest_metho4 = Z _ I G C Hd = POST) {
return 405;
} //如果提交方法为POST,则返回状态405(Method not allowed)。return不能返回301,302
if ($slow) {
limit_rate 10k;
} //限速,$slow可以通过 set 指令设置
if (!-f $requet 4 %st_filename){
break;
proxy_pass  http:/P  Y L % : ) b 0/127.0.0.1;
} //如果请求的文件名不存在H R / e M N q,则反向代理到localhost 。这里的break也是停止rewrite检查
if ($args ~ post=140){
rewrite ^ http://example.com/ permanent;
} //如果query string中包含"post=140",永久重定向到example.com
locati, O W Z 0 5 Bon/ M [ e F , % q e ~* \.(b c C V ]  Wgif|jpg|png|swf|flv)$ {
valid_referers none blocked www.jefflei.com www.leizhenfany { i b (g.com;
if ($invalid_referer) {
return 404;
} //防盗链
}

全局变量

下面是可以用作if判断的全局变量

$args : #这个变量等于请求行中的参数,同$query_string
$conten4 6 i & 9 0 c S Ot_length : 请求头中H a O W 2 x C | &的Content-length字段。
$content_type : 请求头中的ContO r P : ~ - oent-Type字段。
$document_root : 当前请求在roY t %ot指令中指定的值。
$host : 请求主机头字段,否则为服务器名称。
$http_user_agent : 客户端agent信息
$http_coJ n & / l Y Tokie : 客户端cookie信息
$limit_rate : 这个变量可以限制连接速率。
$request_method : 客户Y S m 6 X $ h e ,U 0 s请求的动作,通常为GET或POST。2 2 | $ `
$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.` + F x g 2 41。
$server_addr : 服务器地址,在完成一次系统调用后可以确定这个值。
$server_nameX x c 0 h n _ 服务器名称。
$server_; 3 x N 9 4 & D Lport : 请求到达服务器的H 2 ? 3 ~ & 0 L ,端口号。
$request_uri: I - | . ( 包含请求参数的原始URI,不包含主机名,如:”/fo5 T e N oo/bar.php?arg=baz”。
$uri : 不带请求参数的当前URIP @ , @ !,$uri不包含主机名,如”/foo/bar.html”。
$document_uri : 与$uri相同。

例:http://lof b W | 3 s /calhost:88/test1/test2/test.php

$host:localhost
$server_port:88
$request_uri:http://localhost:88/test1/test2/test.php
$document_uri:/test1/Z B } , F K 7 etest2/x k } Ptest.) 3 pphp
$document_root:/var/www/html
$request_filename:/var/www/$ K / C Qhtml/test1/test2/test.php

3、常用正则

  • . : 匹配除换行符以外的任意字符
  • ? : 重复0次或1次
  • + : 重复1次或更多次
  • * : 重复0次或更多次
  • \d :匹配数字
  • ^ : 匹配字符串的开始
  • $ : 匹配字符串的介绍
  • {n} : 重复n次
  • {n,} : 重复n次或更多h J v : H
  • [c] : 匹配单个字符c
  • [a-z] : 匹配E c f ( _ l Oa-z小写字母的, L O f 4任意一个

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

4、rewrite实例X Q } . L

例1:

http {
# 定义image日志格式
log_format imagelog '[$time_local] b e l f C v r %' $image_fm G ~ ? Y . G eile ' ' $image_. x .type ' ' $body_a h N _ * + | vbytes_sent ' ' $status;
# 开启重写日志
rewrite_log on;
server {
rom = :ot /home/www;
location / {
# 重写规D 6 v E u则信息
error_log logs/rewrite.log notice;
# 注意这里要用‘’单引号引起来,避免{}
rewriteU u 0 j R [ I 8 '^/images/([a-z]{2})/([a-z0-9]{5})/(.*)\.(pngQ C k j k . 8 i|jpg|gif)$0 S C 4 $ ; i K $' /data?file=$3.$4;
# 注意不能在上面这条规则后面加上“last”参数,否则下面的set指令不会执行
set $i0 o W n L z 6mage_file $3;
set $image_type $4;
}
location /N d 0 i )data {
# 指定针对图片的日志格式,来分析J 5 t图片类型和大小
a. ] d % Mccess_log logs/images.log mian;9 [ ^ n E 5 + ?
root /dO @ 1ata/images;
# 应用j K 1 G ! k F前面定义的变量。判断首先文件在不在,不在m 5 P ` ? 5再判断目录在不在,如果还不在就跳转到最后一个u/ j Frl里
try_files /$arg_file /image404.html;k h | 4 * l K
}
location = /image404.html {
# 图片不存在返回特定的信息
return 404 "image not found\n";
}
}

对形如/images/ef/uh7b3/test.png的请求,重写到/data?file=test.png,于是匹配到location /data,先看/R G c R c &data/images/test.png文件存不存在,如果H y R ^ L y d存在则正常响应,如果不存在则重写tr 7 # - V $ } byfiles到新的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地址,并会5 R h z V S u R继续尝试匹配location

上述内容转载自【Sean's Notes】博客文章http://seanlook.com/2015/05/17/nginx-location-rewrite/