nginx中location使用方法总结

在nignx中我们比较长使用的就是location，我们使用location来定位资源或者转发请求，使用不当经常就会遇到404错误，无法找到资源或者请求异常。下面我们来详细了解一下location的用法。

语法

location的具体语法如下：

1
2
location [ = | ~ | ~* | ^~ ] uri { ... }
location @name { ... }

语法规则很简单，一个location关键字，后面跟着可选的修饰符，后面是要匹配的字符，花括号中是要执行的操作。

修饰符

在语法中可以看到location有四中修饰符，其实还有一种就是修饰符就是什么也没有，location后边直接跟uri，下边来详细了解一下各种修饰符的作用：

= 表示精确匹配。只有请求的url路径与后面的字符串完全相等时，才会命中。 ~ 表示该规则是使用正则定义的，区分大小写。 ~* 表示该规则是使用正则定义的，不区分大小写。 ^~ 表示如果该符号后面的字符是最佳匹配，采用该规则，不再进行后续的查找。 无修饰符 表示前缀匹配

=、~和^~是非正则匹配，~和~*是正则匹配。

location匹配还有一个特点：**非正则匹配优先！**非正则>正则

匹配过程

总共5种修饰符，如果一个url请求过来可以匹配到多种，那nginx会如何选择呢？下边来看一下完整的匹配过程：

用所有的前缀字符串去匹配URI(这里说的前缀字符串，是除和*修饰的字符串外的所有字符串，包括=、^~及无修饰符三种都算是前缀字符串)；
如果找到=号修饰的字符串与URI匹配(无论它在哪个位置)，则终止匹配过程，并进入该location内部执行具体操作；
如果不找到=号修饰的字符串，则继续匹配普通前缀字符串(即用^~修饰的或无修饰符的字符串)；
在^~修饰的或无修饰符的字符串中如果有多个规则能匹配上URI，则会查看最长的那一个是否用^~修饰；
如果最长的那个有用^~修饰，则终止匹配，这个用^~修饰的“最长”的匹配就是最终被选用的location，但是如果这个“最长”的匹配没有用^~修饰(说明它是无修饰符的)，则会暂时把它存储下来，但不会终止匹配，而是继续进行后面的正则匹配；
开始正则匹配，匹配所有用或*修饰的字符串
匹配到第一个正则表达式后终止匹配，使用对应的location；
如果没有匹配到正则表达式，则使用之前存储的前缀字符串对应的location，至此，整个匹配过程结束。

路径匹配

使用location的时候，代码块里一般会使用root或者alias或者proxy_pass下边详细说一下proxy_pass的用法。

proxy_pass

Nginx的官网将proxy_pass分为两种类型：

种是只包含IP和端口号的（连端口之后的/也没有，这里要特别注意），比如proxy_pass http://localhost:8080，这种方式称为不带URI方式；
另一种是在端口号之后有其他路径的，包含了只有单个/的，如proxy_pass http://localhost:8080/，以及其他路径，比如proxy_pass http://localhost:8080/abc。

不带URI方式(相对路径)

对于不带URI方式，Nginx将会保留location中路径部分，比如：<

1
2
3
location /api1/ {
  proxy_pass http://localhost:8080;
}

在访问http://localhost/api1/xxx时，会代理到`http://localhost:8080/api1/xxx

带URI方式(绝对路径)

对于带URI方式，nginx将使用诸如alias的替换方式对URL进行替换，并且这种替换只是字面上的替换，比如：

1
2
3
location /api2/ {
  proxy_pass http://localhost:8080/;
}

当访问http://localhost/api2/xxx时，http://localhost/api2/（注意最后的/）被替换成了http://localhost:8080/，然后再加上剩下的xxx，于是变成了http://localhost:8080/xxx。下面再给一些例子来帮助大家理解相对路径和绝对路径：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
server {
  listen       80;
  server_name  localhost;

  # proxy_pass中的域名是相对路径，所以会带上location中的路径
  location /api1/ {
    proxy_pass http://localhost:8080;
  }
  # http://localhost/api1/xxx -> http://localhost:8080/api1/xxx

  # proxy_pass中的域名是绝对路径，所以不会带上location中的路径
  location /api2/ {
    proxy_pass http://localhost:8080/;
  }
  # http://localhost/api2/xxx -> http://localhost:8080/xxx

  # proxy_pass中的域名是相对路径，所以会带上location中的路径
  location /api3 {
    proxy_pass http://localhost:8080;
  }
  # http://localhost/api3/xxx -> http://localhost:8080/api3/xxx

  # proxy_pass中的域名是绝对路径，所以不会带上location中的路径
  location /api4 {
    proxy_pass http://localhost:8080/;
  }
  # http://localhost/api4/xxx -> http://localhost:8080//xxx，匹配到/api4/xxx,location中是/api4需去掉剩下/xxx，加上proxy_pass则是//xxx

  # proxy_pass中的域名是绝对路径，所以不会带上location中的路径
  location /api5/ {
    proxy_pass http://localhost:8080/haha;
  }
  # http://localhost/api5/xxx -> http://localhost:8080/hahaxxx，匹配到/api5/xxx, 去掉location中的/api5/剩下xxx，加上proxy_pass则是hahaxxx

  # proxy_pass中的域名是绝对路径，所以不会带上location中的路径
  location /api6/ {
    proxy_pass http://localhost:8080/haha/;
  }
  # http://localhost/api6/xxx -> http://localhost:8080/haha/xxx

  # proxy_pass中的域名是绝对路径，所以不会带上location中的路径
  location /api7 {
    proxy_pass http://localhost:8080/haha;
  }
  # http://localhost/api7/xxx -> http://localhost:8080/haha/xxx

  # proxy_pass中的域名是绝对路径，所以不会带上location中的路径
  location /api8 {
    proxy_pass http://localhost:8080/haha/;
  }
  # http://localhost/api8/xxx -> http://localhost:8080/haha//xxx，匹配到/api8/xxx,去掉location中的/api8剩下/xxx,加上proxy_pass则是/haha//xxx
}

以上就是nginx中location的使用方法，匹配规则，以及代码块中proxy_pass的使用方法，希望可以帮到大家。