Nginx 极简教程
本项目是一个 Nginx 极简教程,目的在于帮助新手快速入门 Nginx。

博客作者:联系请点击,搬运不易,希望请作者喝咖啡,可以点击联系博客作者

一、Nginx 简介

什么是 Nginx?

Nginx (engine x) 是一款轻量级的 Web 服务器 、反向代理服务器及电子邮件(IMAP/POP3)代理服务器。
img

什么是反向代理?

反向代理(Reverse Proxy)方式是指以代理服务器来接受 internet 上的连接请求,然后将请求转发给内部网络上的服务器,并将从服务器上得到的结果返回给 internet 上请求连接的客户端,此时代理服务器对外就表现为一个反向代理服务器。
img

二、Nginx 入门

详细安装方法请参考:Nginx 安装
nginx 的使用比较简单,就是几条命令。
常用到的命令如下:
1
nginx -s stop #快速关闭Nginx,可能不保存相关信息,并迅速终止web服务。
2
nginx -s quit #平稳关闭Nginx,保存相关信息,有安排的结束web服务。
3
nginx -s reload #因改变了Nginx相关配置,需要重新加载配置而重载。
4
nginx -s reopen #重新打开日志文件。
5
nginx -c filename #为 Nginx 指定一个配置文件,来代替缺省的。
6
nginx -t #不运行,仅仅测试配置文件。nginx 将检查配置文件的语法的正确性,并尝试打开配置文件中所引用到的文件。
7
nginx -v #显示 nginx 的版本。
8
nginx -V #显示 nginx 的版本,编译器版本和配置参数。
Copied!
如果不想每次都敲命令,可以在 nginx 安装目录下新添一个启动批处理文件startup.bat,双击即可运行。内容如下:
1
@echo off
2
rem 如果启动前已经启动nginx并记录下pid文件,会kill指定进程
3
nginx.exe -s stop
4
5
rem 测试配置文件语法正确性
6
nginx.exe -t -c conf/nginx.conf
7
8
rem 显示版本信息
9
nginx.exe -v
10
11
rem 按照指定配置去启动nginx
12
nginx.exe -c conf/nginx.conf
Copied!
如果是运行在 Linux 下,写一个 shell 脚本,大同小异。

三、Nginx 实战

我始终认为,各种开发工具的配置还是结合实战来讲述,会让人更易理解。

Http 反向代理

我们先实现一个小目标:不考虑复杂的配置,仅仅是完成一个 http 反向代理。
nginx.conf 配置文件如下:
注:conf/nginx.conf 是 nginx 的默认配置文件,也可以使用 nginx -c 指定你的配置文件
1
#运行用户
2
#user somebody;
3
4
#启动进程,通常设置成和cpu的数量相等
5
worker_processes 1;
6
7
#全局错误日志
8
error_log D:/Tools/nginx-1.10.1/logs/error.log;
9
error_log D:/Tools/nginx-1.10.1/logs/notice.log notice;
10
error_log D:/Tools/nginx-1.10.1/logs/info.log info;
11
12
#PID文件,记录当前启动的nginx的进程ID
13
pid D:/Tools/nginx-1.10.1/logs/nginx.pid;
14
15
#工作模式及连接数上限
16
events {
17
worker_connections 1024; #单个后台worker process进程的最大并发链接数
18
}
19
20
#设定http服务器,利用它的反向代理功能提供负载均衡支持
21
http {
22
#设定mime类型(邮件支持类型),类型由mime.types文件定义
23
include D:/Tools/nginx-1.10.1/conf/mime.types;
24
default_type application/octet-stream;
25
26
#设定日志
27
log_format main '[$remote_addr] - [$remote_user] [$time_local] "$request" '
28
'$status $body_bytes_sent "$http_referer" '
29
'"$http_user_agent" "$http_x_forwarded_for"';
30
31
access_log D:/Tools/nginx-1.10.1/logs/access.log main;
32
rewrite_log on;
33
34
#sendfile 指令指定 nginx 是否调用 sendfile 函数(zero copy 方式)来输出文件,对于普通应用,
35
#必须设为 on,如果用来进行下载等应用磁盘IO重负载应用,可设置为 off,以平衡磁盘与网络I/O处理速度,降低系统的uptime.
36
sendfile on;
37
#tcp_nopush on;
38
39
#连接超时时间
40
keepalive_timeout 120;
41
tcp_nodelay on;
42
43
#gzip压缩开关
44
#gzip on;
45
46
#设定实际的服务器列表
47
upstream zp_server1{
48
server 127.0.0.1:8089;
49
}
50
51
#HTTP服务器
52
server {
53
#监听80端口,80端口是知名端口号,用于HTTP协议
54
listen 80;
55
56
#定义使用www.xx.com访问
57
server_name www.helloworld.com;
58
59
#首页
60
index index.html
61
62
#指向webapp的目录
63
root D:\01_Workspace\Project\github\zp\SpringNotes\spring-security\spring-shiro\src\main\webapp;
64
65
#编码格式
66
charset utf-8;
67
68
#代理配置参数
69
proxy_connect_timeout 180;
70
proxy_send_timeout 180;
71
proxy_read_timeout 180;
72
proxy_set_header Host $host;
73
proxy_set_header X-Forwarder-For $remote_addr;
74
75
#反向代理的路径(和upstream绑定),location 后面设置映射的路径
76
location / {
77
proxy_pass http://zp_server1;
78
}
79
80
#静态文件,nginx自己处理
81
location ~ ^/(images|javascript|js|css|flash|media|static)/ {
82
root D:\01_Workspace\Project\github\zp\SpringNotes\spring-security\spring-shiro\src\main\webapp\views;
83
#过期30天,静态文件不怎么更新,过期可以设大一点,如果频繁更新,则可以设置得小一点。
84
expires 30d;
85
}
86
87
#设定查看Nginx状态的地址
88
location /NginxStatus {
89
stub_status on;
90
access_log on;
91
auth_basic "NginxStatus";
92
auth_basic_user_file conf/htpasswd;
93
}
94
95
#禁止访问 .htxxx 文件
96
location ~ /\.ht {
97
deny all;
98
}
99
100
#错误处理页面(可选择性配置)
101
#error_page 404 /404.html;
102
#error_page 500 502 503 504 /50x.html;
103
#location = /50x.html {
104
# root html;
105
#}
106
}
107
}
Copied!

测试:

  1. 1.
    启动 webapp,注意启动绑定的端口要和 nginx 中的 upstream 设置的端口保持一致。
  2. 2.
    更改 host:在 C:\Windows\System32\drivers\etc 目录下的 host 文件中添加一条 DNS 记录
1
127.0.0.1 www.helloworld.com
Copied!
  1. 1.
    启动前文中 startup.bat 的命令

Https 反向代理

一些对安全性要求比较高的站点,可能会使用 HTTPS(一种使用 ssl 通信标准的安全 HTTP 协议)。
这里不科普 HTTP 协议和 SSL 标准。但是,使用 nginx 配置 https 需要知道几点:
  • HTTPS 的固定端口号是 443,不同于 HTTP 的 80 端口
  • SSL 标准需要引入安全证书,所以在 nginx.conf 中你需要指定证书和它对应的 key
其他和 http 反向代理基本一样,只是在 Server 部分配置有些不同。
1
#HTTP服务器
2
server {
3
#监听443端口。443为知名端口号,主要用于HTTPS协议
4
listen 443 ssl;
5
6
#定义使用www.xx.com访问
7
server_name www.helloworld.com;
8
9
#ssl证书文件位置(常见证书文件格式为:crt/pem)
10
ssl_certificate cert.pem;
11
#ssl证书key位置
12
ssl_certificate_key cert.key;
13
14
#ssl配置参数(选择性配置)
15
ssl_session_cache shared:SSL:1m;
16
ssl_session_timeout 5m;
17
#数字签名,此处使用MD5
18
ssl_ciphers HIGH:!aNULL:!MD5;
19
ssl_prefer_server_ciphers on;
20
21
location / {
22
root /root;
23
index index.html index.htm;
24
}
25
}
Copied!

负载均衡

前面的例子中,代理仅仅指向一个服务器。
但是,网站在实际运营过程中,大部分都是以集群的方式运行,这时需要使用负载均衡来分流。
nginx 也可以实现简单的负载均衡功能。
假设这样一个应用场景:将应用部署在 192.168.1.11:80、192.168.1.12:80、192.168.1.13:80 三台 linux 环境的服务器上。网站域名叫 www.helloworld.com,公网 IP 为 192.168.1.11。在公网 IP 所在的服务器上部署 nginx,对所有请求做负载均衡处理(下面例子中使用的是加权轮询策略)。
nginx.conf 配置如下:
1
http {
2
#设定mime类型,类型由mime.type文件定义
3
include /etc/nginx/mime.types;
4
default_type application/octet-stream;
5
#设定日志格式
6
access_log /var/log/nginx/access.log;
7
8
#设定负载均衡的服务器列表
9
upstream load_balance_server {
10
#weigth参数表示权值,权值越高被分配到的几率越大
11
server 192.168.1.11:80 weight=5;
12
server 192.168.1.12:80 weight=1;
13
server 192.168.1.13:80 weight=6;
14
}
15
16
#HTTP服务器
17
server {
18
#侦听80端口
19
listen 80;
20
21
#定义使用www.xx.com访问
22
server_name www.helloworld.com;
23
24
#对所有请求进行负载均衡请求
25
location / {
26
root /root; #定义服务器的默认网站根目录位置
27
index index.html index.htm; #定义首页索引文件的名称
28
proxy_pass http://load_balance_server ;#请求转向load_balance_server 定义的服务器列表
29
30
#以下是一些反向代理的配置(可选择性配置)
31
#proxy_redirect off;
32
proxy_set_header Host $host;
33
proxy_set_header X-Real-IP $remote_addr;
34
#后端的Web服务器可以通过X-Forwarded-For获取用户真实IP
35
proxy_set_header X-Forwarded-For $remote_addr;
36
proxy_connect_timeout 90; #nginx跟后端服务器连接超时时间(代理连接超时)
37
proxy_send_timeout 90; #后端服务器数据回传时间(代理发送超时)
38
proxy_read_timeout 90; #连接成功后,后端服务器响应时间(代理接收超时)
39
proxy_buffer_size 4k; #设置代理服务器(nginx)保存用户头信息的缓冲区大小
40
proxy_buffers 4 32k; #proxy_buffers缓冲区,网页平均在32k以下的话,这样设置
41
proxy_busy_buffers_size 64k; #高负荷下缓冲大小(proxy_buffers*2)
42
proxy_temp_file_write_size 64k; #设定缓存文件夹大小,大于这个值,将从upstream服务器传
43
44
client_max_body_size 10m; #允许客户端请求的最大单文件字节数
45
client_body_buffer_size 128k; #缓冲区代理缓冲用户端请求的最大字节数
46
}
47
}
48
}
Copied!

负载均衡策略

Nginx 提供了多种负载均衡策略,负载均衡策略在各种分布式系统中基本上原理一致

轮询

1
upstream bck_testing_01 {
2
# 默认所有服务器权重为 1
3
server 192.168.250.220:8080
4
server 192.168.250.221:8080
5
server 192.168.250.222:8080
6
}
Copied!

加权轮询

1
upstream bck_testing_01 {
2
server 192.168.250.220:8080 weight=3
3
server 192.168.250.221:8080 # default weight=1
4
server 192.168.250.222:8080 # default weight=1
5
}
Copied!

最少连接

1
upstream bck_testing_01 {
2
least_conn;
3
4
# with default weight for all (weight=1)
5
server 192.168.250.220:8080
6
server 192.168.250.221:8080
7
server 192.168.250.222:8080
8
}
Copied!

加权最少连接

1
upstream bck_testing_01 {
2
least_conn;
3
4
server 192.168.250.220:8080 weight=3
5
server 192.168.250.221:8080 # default weight=1
6
server 192.168.250.222:8080 # default weight=1
7
}
Copied!

IP Hash

1
upstream bck_testing_01 {
2
3
ip_hash;
4
5
# with default weight for all (weight=1)
6
server 192.168.250.220:8080
7
server 192.168.250.221:8080
8
server 192.168.250.222:8080
9
10
}
Copied!

普通 Hash

1
upstream bck_testing_01 {
2
3
hash $request_uri;
4
5
# with default weight for all (weight=1)
6
server 192.168.250.220:8080
7
server 192.168.250.221:8080
8
server 192.168.250.222:8080
9
10
}
Copied!

网站有多个 webapp 的配置

当一个网站功能越来越丰富时,往往需要将一些功能相对独立的模块剥离出来,独立维护。这样的话,通常,会有多个 webapp。
举个例子:假如 www.helloworld.com 站点有好几个 webapp,finance(金融)、product(产品)、admin(用户中心)。访问这些应用的方式通过上下文(context)来进行区分:
http 的默认端口号是 80,如果在一台服务器上同时启动这 3 个 webapp 应用,都用 80 端口,肯定是不成的,所以,这三个应用需要分别绑定不同的端口号。
那么,问题来了,用户在实际访问 www.helloworld.com 站点时,访问不同 webapp,总不会还带着对应的端口号去访问吧。所以,你再次需要用到反向代理来做处理。

案列:

1
http {
2
#此处省略一些基本配置
3
4
upstream product_server{
5
server www.helloworld.com:8081;
6
}
7
8
upstream admin_server{
9
server www.helloworld.com:8082;
10
}
11
12
upstream finance_server{
13
server www.helloworld.com:8083;
14
}
15
16
server {
17
#此处省略一些基本配置
18
#默认指向product的server
19
location / {
20
proxy_pass http://product_server;
21
}
22
23
location /product/{
24
proxy_pass http://product_server;
25
}
26
27
location /admin/ {
28
proxy_pass http://admin_server;
29
}
30
31
location /finance/ {
32
proxy_pass http://finance_server;
33
}
34
}
35
}
Copied!

静态站点

有时候,我们需要配置静态站点(即 html 文件和一堆静态资源)。
举例来说:如果所有的静态资源都放在了 /app/dist 目录下,我们只需要在 nginx.conf 中指定首页以及这个站点的 host 即可。

配置如下:

1
worker_processes 1;
2
3
events {
4
worker_connections 1024;
5
}
6
7
http {
8
include mime.types;
9
default_type application/octet-stream;
10
sendfile on;
11
keepalive_timeout 65;
12
13
gzip on;
14
gzip_types text/plain application/x-javascript text/css application/xml text/javascript application/javascript image/jpeg image/gif image/png;
15
gzip_vary on;
16
17
server {
18
listen 80;
19
server_name www.hezhiqiang.com;
20
21
location / {
22
root /app/dist;
23
index index.html;
24
#转发任何请求到 index.html
25
}
26
}
27
}
Copied!
然后,添加 HOST:
1
127.0.0.1 www.hezhiqiang.com
Copied!
此时,在本地浏览器访问 www.hezhiqiang.com ,就可以访问静态站点了。

搭建文件服务器

有时候,团队需要归档一些数据或资料,那么文件服务器必不可少。使用 Nginx 可以非常快速便捷的搭建一个简易的文件服务。
Nginx 中的配置要点:
  • 将 autoindex 开启可以显示目录,默认不开启。
  • 将 autoindex_exact_size 开启可以显示文件的大小。
  • 将 autoindex_localtime 开启可以显示文件的修改时间。
  • root 用来设置开放为文件服务的根路径。
  • charset 设置为 charset utf-8,gbk;,可以避免中文乱码问题(windows 服务器下设置后,依然乱码,本人暂时没有找到解决方法)。
一个最简化的配置如下:
1
autoindex on; # 显示目录
2
autoindex_exact_size on; # 显示文件大小
3
autoindex_localtime on; # 显示文件时间
4
5
server {
6
charset utf-8,gbk; # windows 服务器下设置后,依然乱码,暂时无解
7
listen 9050 default_server;
8
listen [::]:9050 default_server;
9
server_name _;
10
root /share/fs;
11
}
Copied!

解决跨域

web 领域开发中,经常采用前后端分离模式。这种模式下,前端和后端分别是独立的 web 应用程序,例如:后端是 Java 程序,前端是 React 或 Vue 应用。
各自独立的 web app 在互相访问时,势必存在跨域问题。解决跨域问题一般有两种思路:
  1. 1.
    CORS
在后端服务器设置 HTTP 响应头,把你需要允许访问的域名加入 Access-Control-Allow-Origin 中。
  1. 1.
    jsonp
把后端根据请求,构造 json 数据,并返回,前端用 jsonp 跨域。
这两种思路,本文不展开讨论。
需要说明的是,nginx 根据第一种思路,也提供了一种解决跨域的解决方案。
举例:www.helloworld.com 网站是由一个前端 app ,一个后端 app 组成的。前端端口号为 9000, 后端端口号为 8080。
前端和后端如果使用 http 进行交互时,请求会被拒绝,因为存在跨域问题。来看看,nginx 是怎么解决的吧:
首先,在 enable-cors.conf 文件中设置 cors :
1
# allow origin list
2
set $ACAO '*';
3
4
# set single origin
5
if ($http_origin ~* (www.helloworld.com)$) {
6
set $ACAO $http_origin;
7
}
8
9
if ($cors = "trueget") {
10
add_header 'Access-Control-Allow-Origin' "$http_origin";
11
add_header 'Access-Control-Allow-Credentials' 'true';
12
add_header 'Access-Control-Allow-Methods' 'GET, POST, OPTIONS';
13
add_header 'Access-Control-Allow-Headers' 'DNT,X-Mx-ReqToken,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type';
14
}
15
16
if ($request_method = 'OPTIONS') {
17
set $cors "${cors}options";
18
}
19
20
if ($request_method = 'GET') {
21
set $cors "${cors}get";
22
}
23
24
if ($request_method = 'POST') {
25
set $cors "${cors}post";
26
}
Copied!
接下来,在你的服务器中 include enable-cors.conf 来引入跨域配置:
1
# ----------------------------------------------------
2
# 此文件为项目 nginx 配置片段
3
# 可以直接在 nginx config 中 include(推荐)
4
# 或者 copy 到现有 nginx 中,自行配置
5
# www.helloworld.com 域名需配合 dns hosts 进行配置
6
# 其中,api 开启了 cors,需配合本目录下另一份配置文件
7
# ----------------------------------------------------
8
upstream front_server{
9
server www.helloworld.com:9000;
10
}
11
upstream api_server{
12
server www.helloworld.com:8080;
13
}
14
15
server {
16
listen 80;
17
server_name www.helloworld.com;
18
19
location ~ ^/api/ {
20
include enable-cors.conf;
21
proxy_pass http://api_server;
22
rewrite "^/api/(.*)quot; /$1 break;
23
}
24
25
location ~ ^/ {
26
proxy_pass http://front_server;
27
}
28
}
Copied!
到此,就完成了。

资源