跳至主要內容

Nginx配置文件说明

牧歌2024/4/24...大约 7 分钟develop

Nginx配置文件说明

简单说明

  • server : 用于定义服务，http中可以有多个server块
  • listen : 指定服务器侦听请求的IP地址和端口，如果省略地址，服务器将侦听所有地址，如果省略端口，则使用标准端口
  • server_name : 服务名称，用于配置域名
  • location : 用于配置映射路径uri对应的配置，一个server中可以有多个location, location后面跟一个uri,可以是一个正则表达式, / 表示匹配任意路径, 当客户端访问的路径满足这个uri时就会执行location块里面的代码
  • root : 根路径，当访问http://localhost/test.html，“/test.html”会匹配到”/”uri, 找到root为/usr/local/var/www/html，用户访问的资源物理地址=root + uri = /usr/local/var/www/html + /test.html=/usr/local/var/www/html/test.html
  • index : 设置首页，当只访问server_name时后面不跟任何路径是不走root直接走index指令的；如果访问路径中没有指定具体的文件，则返回index设置的资源，如果访问http://localhost/html/ 则默认返回index.html

常见的location路径映射

常见的location路径映射路径有以下几种：

  • = 进行普通字符精确匹配。也就是完全匹配。
  • ^~ 前缀匹配。如果匹配成功，则不再匹配其他location。
  • ~ 表示执行一个正则匹配，区分大小写
  • ~* 表示执行一个正则匹配，不区分大小写
  • /xxx/ 常规字符串路径匹配
  • / 通用匹配，任何请求都会匹配到

location优先级

注意：location的优先级与location配置的位置无关

当一个路径匹配多个location时究竟哪个location能匹配到时有优先级顺序的，而优先级的顺序于location值的表达式类型有关，和在配置文件中的先后顺序无关。相同类型的表达式，字符串长的会优先匹配。

以下是按优先级排列说明：

  • 等号类型（=）的优先级最高。一旦匹配成功，则不再查找其他匹配项，停止搜索。
  • ^~类型表达式，不属于正则表达式。一旦匹配成功，则不再查找其他匹配项，停止搜索。
  • 正则表达式类型（~ ~*）的优先级次之。如果有多个location的正则能匹配的话，则使用正则表达式最长的那个。
  • 常规字符串匹配类型。按前缀匹配。
  • / 通用匹配，如果没有匹配到，就匹配通用的

优先级搜索问题：不同类型的location映射决定是否继续向下搜索

  • 等号类型、^~类型：一旦匹配上就停止搜索了，不会再匹配其他location了
  • 正则表达式类型(~ ~*）,常规字符串匹配类型/xxx/ : 匹配到之后，还会继续搜索其他其它location，直到找到优先级最高的，或者找到第一种情况而停止搜索

location优先级从高到底： (location =) > (location 完整路径) > (location ^~ 路径) > (location ~,~* 正则顺序) > (location 部分起始路径) > (/)

location = / {  
    # 精确匹配/，主机名后面不能带任何字符串 /  
    [ configuration A ]  
}  
location / {  
    # 匹配所有以 / 开头的请求。  
    # 但是如果有更长的同类型的表达式，则选择更长的表达式。  
    # 如果有正则表达式可以匹配，则优先匹配正则表达式。  
    [ configuration B ]  
}  
location /documents/ {  
    # 匹配所有以 /documents/ 开头的请求，匹配符合以后，还要继续往下搜索。  
    # 但是如果有更长的同类型的表达式，则选择更长的表达式。  
    # 如果有正则表达式可以匹配，则优先匹配正则表达式。  
    [ configuration C ]  
}  
location ^~ /images/ {  
    # 匹配所有以 /images/ 开头的表达式，如果匹配成功，则停止匹配查找，停止搜索。  
    # 所以，即便有符合的正则表达式location，也不会被使用  
    [ configuration D ]  
}  
  
location ~* \.(gif|jpg|jpeg)$ {  
    # 匹配所有以 gif jpg jpeg结尾的请求。  
    # 但是 以 /images/开头的请求，将使用 Configuration D，D具有更高的优先级  
    [ configuration E ]  
}  
  
location /images/ {  
    # 字符匹配到 /images/，还会继续往下搜索  
    [ configuration F ]  
}  
  
  
location = /test.htm {  
    root   /usr/local/var/www/htm;  
    index  index.htm;  
}

location uri正则表达式

  • . ：匹配除换行符以外的任意字符
  • ? ：重复0次或1次
  • + ：重复1次或更多次
  • * ：重复0次或更多次
  • \d ：匹配数字
  • ^ ：匹配字符串的开始
  • $ ：匹配字符串的结束
  • {n} ：重复n次
  • {n,} ：重复n次或更多次
  • [c] ：匹配单个字符c
  • [a-z] ：匹配a-z小写字母的任意一个
  • (a|b|c) : 属线表示匹配任意一种情况，每种情况使用竖线分隔，一般使用小括号括括住，匹配符合a字符 或是b字符 或是c字符的字符串
  • \ 反斜杠：用于转义特殊字符

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

其他常用指令

1. return指令

返回http状态码 和 可选的第二个参数可以是重定向的URL

location /permanently/moved/url {
    return 301 http://www.example.com/moved/here;
}

2. rewrite指令

重写URI请求 rewrite，通过使用rewrite指令在请求处理期间多次修改请求URI，该指令具有一个可选参数和两个必需参数。

第一个(必需)参数是请求URI必须匹配的正则表达式。

第二个参数是用于替换匹配URI的URI。

可选的第三个参数是可以停止进一步重写指令的处理或发送重定向(代码301或302)的标志

location /users/ {
    rewrite ^/users/(.*)$ /show?user=$1 break;
}

3. error_page指令

使用error_page指令，您可以配置NGINX返回自定义页面以及错误代码，替换响应中的其他错误代码，或将浏览器重定向到其他URI。在以下示例中，error_page指令指定要返回404页面错误代码的页面(/404.html)。

error_page 404 /404.html;

4. 日志

访问日志：需要开启压缩 gzip on; 否则不生成日志文件，打开log_format、access_log注释

log_format  main  '$remote_addr - $remote_user [$time_local] "$request" '
                      '$status $body_bytes_sent "$http_referer" '
                      '"$http_user_agent" "$http_x_forwarded_for"';

access_log  /usr/local/etc/nginx/logs/host.access.log  main;

gzip  on;

5. deny 指令

# 禁止访问某个目录
location ~* \.(txt|doc)${
    root $doc_root;
    deny all;
}

6. 内置变量

nginx的配置文件中可以使用的内置变量以美元符$开始，也有人叫全局变量。其中，部分预定义的变量的值是可以改变的。

  • $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相同

proxy_pass

配置 proxy_pass 代理转发时，如果在 proxy_pass 后面的 url 加 /，表示绝对根路径；如果没有 /，表示相对路径，把匹配的路径部分也给代理走。

贡献者

wenleiwang
最近更新：