【随手记】Nginx配置详解

前言

老大安排的，被迫营业，去给同事讲Nginx。

基本介绍（可跳过）

Nginx 是一个高性能的 HTTP 服务器和反向代理，它以其稳定性、丰富的功能集、简单的配置和低资源消耗而闻名。Nginx主要用来处理HTTP请求，提供负载均衡、静态内容服务、反向代理等功能。

正向代理：居家办公用过公司的内网VPN吧，你所有的请求在发送前，被代理成了内网的IP去获取内网的数据库、调用内网的接口。

反向代理：业务中经常用到，所有前端的请求被发送到同一个端口(80)，通过Nginx监听转发到相应的前端、后端上。比如前端Vue项目启动在8080上，但它不会被直接访问，只会从80端口被转发到8080，用户浏览器显示的站点还是原站点，只是内容变成了8080的页面。

热备（backup）：当一台服务器发生事故时，才启用第二台服务器提供服务。轮询：多个服务器按顺序处理请求。加权轮询（weight）：根据配置的权重大小而分发给不同服务器不同数量的请求，可根据服务器配置调整对应权重，利于降低负载。 ip_hash：让相同ip的客户端请求相同的服务器。有利于保持会话的一致性。

参数配置

Nginx 的主配置文件通常位于以下位置：

linux系统：/etc/nginx/nginx.conf
Windows系统：随Nginx安装路径而变化，在安装目录下的 conf\nginx.conf 中，如果你安装在 D:/program/nginx-1.22，那么配置文件就在 D:/program/nginx-1.22/conf/nginx.conf

其配置结构如下：

 
-——全局块
|
|——event块
|
-——http块
  |
  -————server块
      |
      -————location块

Nginx默认配置及说明如下：

 
#
#user  nobody;
worker_processes  1;
 
#error_log  logs/error.log;
#error_log  logs/error.log  notice;
#error_log  logs/error.log  info;
 
#pid        logs/nginx.pid;
 
 
events {
    worker_connections  1024;
}
 
 
http {
    include       mime.types;
    default_type  application/octet-stream;
 
    #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  logs/access.log  main;
 
    sendfile        on;
    #tcp_nopush     on;
 
    #keepalive_timeout  0;
    keepalive_timeout  65;
 
    #gzip  on;
 
    server {
        listen       80;
        server_name  localhost;
 
        #charset koi8-r;
 
        #access_log  logs/host.access.log  main;
 
        location / {
            root   html;
            index  index.html index.htm;
        }
 
        #error_page  404              /404.html;
 
        # redirect server error pages to the static page /50x.html
        #
        error_page   500 502 503 504  /50x.html;
        location = /50x.html {
            root   html;
        }
 
        # proxy the PHP scripts to Apache listening on 127.0.0.1:80
        #
        #location ~ \.php$ {
        #    proxy_pass   http://127.0.0.1;
        #}
 
        # pass the PHP scripts to FastCGI server listening on 127.0.0.1:9000
        #
        #location ~ \.php$ {
        #    root           html;
        #    fastcgi_pass   127.0.0.1:9000;
        #    fastcgi_index  index.php;
        #    fastcgi_param  SCRIPT_FILENAME  /scripts$fastcgi_script_name;
        #    include        fastcgi_params;
        #}
 
        # deny access to .htaccess files, if Apache's document root
        # concurs with nginx's one
        #
        #location ~ /\.ht {
        #    deny  all;
        #}
    }
 
 
    # another virtual host using mix of IP-, name-, and port-based configuration
    #
    #server {
    #    listen       8000;
    #    listen       somename:8080;
    #    server_name  somename  alias  another.alias;
 
    #    location / {
    #        root   html;
    #        index  index.html index.htm;
    #    }
    #}
 
 
    # HTTPS server
    #
    #server {
    #    listen       443 ssl;
    #    server_name  localhost;
 
    #    ssl_certificate      cert.pem;
    #    ssl_certificate_key  cert.key;
 
    #    ssl_session_cache    shared:SSL:1m;
    #    ssl_session_timeout  5m;
 
    #    ssl_ciphers  HIGH:!aNULL:!MD5;
    #    ssl_prefer_server_ciphers  on;
 
    #    location / {
    #        root   html;
    #        index  index.html index.htm;
    #    }
    #}
}

案例教学

location 匹配优先级（不讲后缀匹配）

1、精准匹配（优先级最高）

 
#将所有对根域名的请求都重定向到统一认证的地址
location = / {
  rewrite ^/(.*)$ https://iam.test.com;
}

2、正则前缀匹配（匹配到后，停止搜索）

 
#所有匹配到 /images/ 请求都会转发到静态资源服务器的images路径下
location ^~ /images/ {
  proxy_set_header X-Real-IP $remote_addr;
  proxy_set_header Host $proxy_host;
  proxy_pass http://static_server/images;
}

3、不区分大小写、区分大小写的前缀匹配（~* 优先级高于 ~，但仍会向下搜索）

 
location ~* /upload {
  // 不区分大小写
}
 
location ~ /Upload {
  // 区分大小写 且优先级低于 ~*
}
 
location ~* /upload/images {
  // 优先级相同，取规则最准确的（最长的）
}

4、前缀匹配（最常用）

 
location /api/weekly {
  proxy_set_header X-Real-IP $remote_addr;
  proxy_set_header Host $proxy_host;
  proxy_pass http://backend_server/weekly;
}

5、通用匹配（任何未匹配到的请求都会走这条配置，由于与1的精准匹配重叠，所以不会生效）

 
location / {
  # proxy_http_version 1.1;
  proxy_set_header X-Real-IP $remote_addr;
  client_max_body_size 20M;
  client_body_buffer_size 20M;
  proxy_set_header Host test.com;
  proxy_pass http://dev_ui;
}

优先级及匹配字符长度相同的情况下，按location块先后顺序决定优先级

root路径映射

统一查找文件时的根目录，路径映射的规则可以直接参照linux命令行，很简单的。

映射规则：可以相对路径、可以是绝对路径.
位置：可以在http、server、location中定义，可单独使用
作用：定义全局的根目录，可被子模块中的root配置覆盖。
在同一个 location 块中，不能同时使用 root 和 alias。
alias语法和root相似，不能直接使用正则，只能作用于某一location块，且不会影响其他块。

建议在server块中定义全局的根目录，在location块中根据需要配置alias。如果需要正则匹配实现alias的效果，就用到了rewrite。

 
# 通用匹配只能有一条，多条nginx -t 检查会报错
# 换句话说，配置中只能有一个 location / {} 块
# 下列配置仅针对 精准匹配未影响通用匹配的情况下，且只能有一份
location / {
  # 访问test.com显示/usr/local/html/absolute下的index.htm(l)页面
  root /usr/local/html/absolute;
  index index.html index.htm;
}
 
location / {
  # 访问test.com显示D:/usr/local/html/test下的index.htm(l)页面
  root   D:/usr/local/html/test;
  index  index.html index.htm;
}
 
location / {
  # 访问test.com显示 nginx 安装目录下的 html/relative/index.htm(l) 页面
  root   html/relative;
  index  index.html index.htm;
}

root 与 alias 的区别

① 路径 root的处理结果：root路径＋location路径 alias的处理结果：使用alias路径替换location路径 alias是一个目录别名的定义，root则是最上层目录的定义 ② 作用域 alias只能作用在location中，而root可以存在server、http和location中 ③ 语法格式 alias后面必须要用 “/” 结束，不然会被认为是个文件，而找不到对应的目录；而root则对 “/” 可有可无。alias不支持直接使用正则，但可以获取location匹配的参数，且必须使用。

rewrite重写

 
 rewrite    <regex>    <replacement>    [flag];
关键字      正则        替代内容          flag标记(可为空）

 
location /testrewrite {
  # 使用rewrite指令重写请求URI
  rewrite ^/(.*)$ https://baidu.com permanent;
  
  # 重写后的请求将被转发到baidu.com
}
 
location /testrewrite2/ {
    # 使用rewrite指令重写请求URI
    # 捕获 /testrewrite2/ 后面的所有内容作为 $1
    rewrite ^/testrewrite2/(.*)$ https://cn.bing.com/search?q=$1 permanent;
    # 转发到重写后的 URI
    #proxy_pass https://cn.bing.com;
}

参考链接

Nginx系列：root与alias指令用法的区别

https://cloud.tencent.com/developer/article/1696822

正向代理、反向代理及负载均衡

https://blog.csdn.net/justinqin/article/details/119519019

Nginx官方文档

https://nginx.org/en/docs/http/ngx_http_core_module.html#alias

Nginx做负载均衡并显示转发日志

https://www.cnblogs.com/woaimengmeng/p/15331167.html

Nginx 反向代理与负载均衡详解

https://www.runoob.com/w3cnote/nginx-proxy-balancing.html

Nginx location匹配规则及优先级

https://blog.csdn.net/why_still_confused/article/details/109953803

	-——全局块
	\|
	\|——event块
	\|
	-——http块
	\|
	-————server块
	\|
	-————location块

	#
	#user nobody;
	worker_processes 1;

	#error_log logs/error.log;
	#error_log logs/error.log notice;
	#error_log logs/error.log info;

	#pid logs/nginx.pid;


	events {
	worker_connections 1024;
	}


	http {
	include mime.types;
	default_type application/octet-stream;

	#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 logs/access.log main;

	sendfile on;
	#tcp_nopush on;

	#keepalive_timeout 0;
	keepalive_timeout 65;

	#gzip on;

	server {
	listen 80;
	server_name localhost;

	#charset koi8-r;

	#access_log logs/host.access.log main;

	location / {
	root html;
	index index.html index.htm;
	}

	#error_page 404 /404.html;

	# redirect server error pages to the static page /50x.html
	#
	error_page 500 502 503 504 /50x.html;
	location = /50x.html {
	root html;
	}

	# proxy the PHP scripts to Apache listening on 127.0.0.1:80
	#
	#location ~ \.php$ {
	# proxy_pass http://127.0.0.1;
	#}

	# pass the PHP scripts to FastCGI server listening on 127.0.0.1:9000
	#
	#location ~ \.php$ {
	# root html;
	# fastcgi_pass 127.0.0.1:9000;
	# fastcgi_index index.php;
	# fastcgi_param SCRIPT_FILENAME /scripts$fastcgi_script_name;
	# include fastcgi_params;
	#}

	# deny access to .htaccess files, if Apache's document root
	# concurs with nginx's one
	#
	#location ~ /\.ht {
	# deny all;
	#}
	}


	# another virtual host using mix of IP-, name-, and port-based configuration
	#
	#server {
	# listen 8000;
	# listen somename:8080;
	# server_name somename alias another.alias;

	# location / {
	# root html;
	# index index.html index.htm;
	# }
	#}


	# HTTPS server
	#
	#server {
	# listen 443 ssl;
	# server_name localhost;

	# ssl_certificate cert.pem;
	# ssl_certificate_key cert.key;

	# ssl_session_cache shared:SSL:1m;
	# ssl_session_timeout 5m;

	# ssl_ciphers HIGH:!aNULL:!MD5;
	# ssl_prefer_server_ciphers on;

	# location / {
	# root html;
	# index index.html index.htm;
	# }
	#}
	}

	#将所有对根域名的请求都重定向到统一认证的地址
	location = / {
	rewrite ^/(.*)$ https://iam.test.com;
	}

	#所有匹配到 /images/ 请求都会转发到静态资源服务器的images路径下
	location ^~ /images/ {
	proxy_set_header X-Real-IP $remote_addr;
	proxy_set_header Host $proxy_host;
	proxy_pass http://static_server/images;
	}

	location ~* /upload {
	// 不区分大小写
	}

	location ~ /Upload {
	// 区分大小写且优先级低于 ~*
	}

	location ~* /upload/images {
	// 优先级相同，取规则最准确的（最长的）
	}

	location /api/weekly {
	proxy_set_header X-Real-IP $remote_addr;
	proxy_set_header Host $proxy_host;
	proxy_pass http://backend_server/weekly;
	}

	location / {
	# proxy_http_version 1.1;
	proxy_set_header X-Real-IP $remote_addr;
	client_max_body_size 20M;
	client_body_buffer_size 20M;
	proxy_set_header Host test.com;
	proxy_pass http://dev_ui;
	}

	# 通用匹配只能有一条，多条nginx -t 检查会报错
	# 换句话说，配置中只能有一个 location / {} 块
	# 下列配置仅针对精准匹配未影响通用匹配的情况下，且只能有一份
	location / {
	# 访问test.com显示/usr/local/html/absolute下的index.htm(l)页面
	root /usr/local/html/absolute;
	index index.html index.htm;
	}

	location / {
	# 访问test.com显示D:/usr/local/html/test下的index.htm(l)页面
	root D:/usr/local/html/test;
	index index.html index.htm;
	}

	location / {
	# 访问test.com显示 nginx 安装目录下的 html/relative/index.htm(l) 页面
	root html/relative;
	index index.html index.htm;
	}

	rewrite <regex> <replacement> [flag];
	关键字正则替代内容 flag标记(可为空）

	location /testrewrite {
	# 使用rewrite指令重写请求URI
	rewrite ^/(.*)$ https://baidu.com permanent;

	# 重写后的请求将被转发到baidu.com
	}

	location /testrewrite2/ {
	# 使用rewrite指令重写请求URI
	# 捕获 /testrewrite2/ 后面的所有内容作为 $1
	rewrite ^/testrewrite2/(.*)$ https://cn.bing.com/search?q=$1 permanent;
	# 转发到重写后的 URI
	#proxy_pass https://cn.bing.com;
	}