Nginx之Location总结

前言

本文主要目的是记录一下日常使用 location 指令的一些要点，以便必要时进行翻查。😄

初探Location

location
syntax: location [=|~|~*|^~|@] /uri/ { ... }

其中“~ ”前缀表示匹配区分大小写的正则location ，“~* ”前缀表示匹配不区分大小写的正则location；其他前缀（包括：“=”，“^~ ”和“@ ”）和无任何前缀的都属于普通 location ，=精确匹配，^~不使用正则，@内部重定向。

匹配顺序

对于一个特定的HTTP请求，nginx应该匹配哪个location块的指令呢? 匹配规则是：先匹配普通location ，再匹配正则表达式。

对于匹配普通location，有如下两点：

匹配URI的前缀部分
最大匹配原则（因为location不是“严格匹配”，而是“前缀匹配”，就会产生一个HTTP请求，可以“前缀匹配”到多个普通location ，例如：location /prefix/mid/ {} 和location /prefix/ {} ，对于请求/prefix/mid/t.html ，前缀匹配的话两个location都满足，选哪个？根据最大匹配原则，于是选的是location /prefix/mid/ {} ）

对于正则表达式的匹配：

通常的规则是匹配完了“普通location”指令，还需要继续匹配“正则location”，但是也可以告诉nginx匹配到了“普通location”后，不再需要继续匹配“正则location”了，要做到这一点只要在“普通location”前面加上“^~ ”符号（^ 表示“非”，~ 表示“正则”，意思是：不要继续匹配正则）。

除了“^~ ”可以阻止继续搜索正则location外，还可以加“=”。那么“^~ ”和“=”都能阻止继续搜索正则location的话，那它们之间有什么区别呢？区别很简单，共同点是它们都能阻止继续搜索正则location，不同点是“^~ ”依然遵守“最大前缀”匹配规则，然而“=”不是“最大前缀”，而是严格匹配(exact match)。

例如，“location / {}”和“location = / {}”的区别，“location / {}”遵守普通location的最大前缀匹配，由于任何URI 都必然以“/ ”根开头，所以对于一个URI ，如果有更精确的匹配，那自然是选这个更精确的；如果没有，“/ ”一定能为这个URI 垫背（至少能匹配到“/ ”），也就是说“location / {}”有点默认配置的味道，其他更精确的配置能覆盖这个默认配置（这也是为什么我们总能看到“location / {}”这个配置的一个很重要的原因）。而“location = / {}”遵守的是“严格精确匹配exact match”，也就是只能匹配对根目录的请求，同时会禁止继续搜索正则 location 。如果我们只想对“GET / ”请求配置作用指令，那么我们可以选“location = / {}”。这样能减少正则location的搜索，因此效率比“location / {}” 高。

普通location匹配完后，还会继续匹配正则location；但是nginx允许阻止这种行为，方法很简单，只需要在普通location前加“^~ ”或“=”。但其实还有一种“隐含”的方式来阻止正则location的搜索，这种隐含的方式就是：当“最大前缀”匹配恰好就是一个“严格精确(exact match)”匹配，照样会停止后面的搜索。原文字面意思是：只要遇到“精确匹配exact match”，即使普通location没有带“=”或“^~ ”前缀，也一样会终止后面的匹配。假设当前配置是：location /exact/match/test.html { 配置指令块1}，location /prefix/ { 配置指令块2} 和 location ~ .html$ { 配置指令块3} ，如果我们请求 GET /prefix/index.html ，则会被匹配到指令块3 ，因为普通location /prefix/依据最大匹配原则能匹配当前请求，但是会被后面的正则location覆盖；当请求GET /exact/match/test.html ，会匹配到指令块1 ，因为这个是普通location的exact match ，会禁止继续搜索正则location。

最后来看一个总结的栗子：

Example:
location   = / {
  # matches the query / only.
  [ configuration A ]
}
location   / {
  # matches any query, since all queries begin with /, but regular
  # expressions and any longer conventional blocks will be
  # matched first.
  [ configuration B ]
}
location ^~ /photos/ {
    # matches any query beginning with /images/ and halts searching,
  # so regular expressions will not be checked.
  [ configuration C ]
}
location ~* \.(gif|jpg|jpeg)$ {
  # matches any request ending in gif, jpg, or jpeg. However, all
  # requests to the /images/ directory will be handled by
  # Configuration C.  
  [ configuration D ]
}
 
Example requests:
  ● / -> configuration A
  ● /production/document.html -> configuration B
  ● /photos/1.gif -> configuration C
  ● /production/1.jpg -> configuration D