Nginx配置文件

Nginx的核心配置文件默认是放在/usr/local/nginx/conf/nginx.conf

  1. worker_processes  1;
  3. events {
  4.     worker_connections  1024;
  5. }
  7. http {
  8.     include       mime.types;
  9.     default_type  application/octet-stream;
  10.     sendfile        on;
  11.     keepalive_timeout  65;
  13.     server {
  14.         listen       80;
  15.         server_name  localhost;
  16.         location / {
  17.             root   html;
  18.             index  index.html index.htm;
  19.         }
  21.         error_page   500 502 503 504  /50x.html;
  22.         location = /50x.html {
  23.             root   html;
  24.         }
  25.     }
  26. }

nginx.conf配置文件中默认有三大块：全局块、events块、http块
http块中可以配置多个server块，每个server块又可以配置多个location块。

全局配置

主要设置Nginx服务器整体运行的配置指令

  1. user指令

用于配置运行Nginx服务器的worker进程的用户和用户组。使用user指令可以指定启动运行工作进程的用户及用户组，这样对于系统的权限访问控制的更加精细，也更加安全

语法 user user [group]
默认值 nobody
位置 全局块

该属性也可以在编译的时候指定，语法如下./configure --user=user --group=group,如果两个地方都进行了设置，最终生效的是配置文件中的配置。

  • 设置一个用户信息”songhongwei”

    image.png
    此时，worker进程的用户是songhongwei，如果访问当前用户没有权限的资源，nginx会报403错误，例如当前配置，访问nginx的80端口，访问的是html目录下的index.html，但是该文件属于root用户，因此页面会报403

    • index.html对于非root用户没有读权限

image.png

  • 访问结果为403

image.png

  • worker进程是songhongwei用户启动的

image.png

  1. work process指令

master_process:用来指定是否开启工作进程。

语法 master_process on|off;
默认值 master_process on;
位置 全局块

如果设置成off，nginx将不启动master进程，也没有worker进程。
worker_processes:用于配置Nginx生成工作进程的数量，这个是Nginx服务器实现并发处理服务的关键所在。理论上来说workder process的值越大，可以支持的并发处理量也越多，但事实上这个值的设定是需要受到来自服务器自身的限制，建议将该值和服务器CPU的内核数保存一致。

语法 worker_processes num/auto;
默认值 1
位置 全局块

如果将worker_processes设置成2，则会看到如下内容:有两个worker进程
image.png

  1. 其他指令

daemon：设定Nginx是否以守护进程的方式启动。
守护式进程是linux后台执行的一种服务进程，特点是独立于控制终端，不会随着终端关闭而停止。

语法 daemon on|off;
默认值 daemon on;
位置 全局块

pid:用来配置Nginx当前master进程的进程号ID存储的文件路径。

语法 pid file;
默认值 默认为:/usr/local/nginx/logs/nginx.pid
位置 全局块

该属性可以通过./configure --pid-path=PATH来指定
error_log:用来配置Nginx的错误日志存放路径

语法 error_log file [日志级别];
默认值 error_log logs/error.log error;
位置 全局块、http、server、location

该属性可以通过./configure --error-log-path=PATH来指定
其中日志级别的值有：debug|info|notice|warn|error|crit|alert|emerg，翻译过来为试|信息|通知|警告|错误|临界|警报|紧急。
include:用来引入其他配置文件，使Nginx的配置更加灵活

语法 include file;
默认值 无
位置 any

定义一个nginx配置文件test.conf，然后在nginx.conf主配置文件中include定义的test.conf
test.conf监听8080端口的所有请求，返回200 页面显示songhongwei

  1.  server {
  2.     listen       8080;
  3.     server_name  localhost;
  4.     location / {
  5.         default_type text/html;
  6.         return 200 "<h1> songhongwei </h1>";
  7.     }
  8.     error_page   500 502 503 504  /50x.html;
  9.     location = /50x.html {
  10.         root   html;
  11.       }
  12. }

nginx.conf主配置文件include定义的test.conf

  1. user songhongwei;
  2. master_process on;
  3. worker_processes  2;
  5. events {
  6.     worker_connections  1024;
  7. }
  8. http {
  9.     include       mime.types;
  10.     default_type  application/octet-stream;
  11.     sendfile        on;
  12.     keepalive_timeout  65;
  13.     # 引入自定义的配置
  14.     include test.conf;
  15.     server {
  16.         listen       80;
  17.         server_name  localhost;
  18.         location / {
  19.             root   html;
  20.             index  index.html index.htm;
  21.         }
  22.         error_page   500 502 503 504  /50x.html;
  23.         location = /50x.html {
  24.             root   html;
  25.         }
  26.     }
  27. }

events配置

主要设置Nginx服务器与用户的网络连接,这一部分对Nginx服务器的性能影响较大

  1. accept_mutex:用来设置Nginx网络连接序列化 | 语法 | accept_mutex on|off; | | —- | —- | | 默认值 | accept_mutex on; | | 位置 | events |

这个配置主要可以用来解决”惊群”问题。意思是在某一个时刻，客户端发来一个请求连接，Nginx后台是以多进程的工作模式，也就是说有多个worker进程会被同时唤醒，但是最终只会有一个进程可以获取到连接，如果每次唤醒的进程数目太多，就会影响Nginx的整体性能。如果将上述值设置为on(开启状态)，将会对多个Nginx进程接收连接进行序列号，一个个来唤醒接收，就防止了多个进程对连接的争抢。

  1. multi_accept:用来设置是否允许同时接收多个网络连接 | 语法 | multi_accept on|off; | | —- | —- | | 默认值 | multi_accept off; | | 位置 | events |

如果multi_accept被禁止了，nginx一个工作进程只能同时接受一个新的连接。否则，一个工作进程可以同时接受所有的新连接

  1. worker_connections：用来配置单个worker进程最大的连接数 | 语法 | worker_connections number; | | —- | —- | | 默认值 | worker_commections 512; | | 位置 | events |

这里的连接数不仅仅包括和前端用户建立的连接数，而是包括所有可能的连接数。另外，number值不能大于操作系统支持打开的最大文件句柄数量。

  1. use:用来设置Nginx服务器选择哪种事件驱动来处理网络消息。 | 语法 | use method; | | —- | —- | | 默认值 | 根据操作系统定 | | 位置 | events |

注意：此处所选择事件处理模型是Nginx优化部分的一个重要内容，method的可选值有select/poll/epoll/kqueue等
另外这些值的选择，我们也可以在编译的时候使用
--with-select_module、--without-select_module、
--with-poll_module、--without-poll_module来设置是否需要将对应的事件驱动模块编译到Nginx的内核。

http配置

是Nginx服务器配置中的重要部分，代理、缓存、日志记录、第三方模块配置等

  1. default_type:用来配置Nginx响应前端请求默认的MIME类型。在Nginx的配置文件中，默认有两行配置，在default_type之前还有一句include mime.types某些接口的时候需要返回指定的文本字符串或者json字符。

include mime.types;
default_type application/octet-stream``;

语法 default_type mime-type;
默认值 default_type text/plain；
位置 http、server、location

案例：配置/json 返回json类型，/html返回html类型

  1. server {
  2.     listen       8081;
  3.     server_name  localhost;
  4.     location /json {
  5.     #返回json格式
  6.         default_type application/json;
  7.         return 200 "{id:1,name:songhongwei}";
  8.     }
  9.     location /html {
  10.     # 返回html格式
  11.         default_type text/html;
  12.         root html;
  13.         index index.html;
  14.     }
  15. }
  • 自定义服务日志

Nginx中日志的类型分access.log、error.log。
access.log:用来记录用户所有的访问请求。
error.log:记录nginx本身运行时的错误信息，不会记录用户的访问请求。
Nginx服务器支持对服务日志的格式、大小、输出等进行设置，需要使用到两个指令，分别是access_log和log_format指令。
access_log:用来设置用户访问日志的相关属性。

语法 access_log path[format[buffer=size]]
默认值 access_log logs/access.log combined;
位置 http
, server
, location

log_format:用来指定日志的输出格式。
日志输出的nginx内置变量可参考http://nginx.org/en/docs/varindex.html官网，例如

变量名 变量含义
request_uri 完整的原始请求 URI (带参数)
request_method 请求方法，通常是GET
或者POST
remote_addr 客户端ip
remote_port 客户端端口
语法 log_format name [escape=default|json|none] string….;
默认值 log_format combined “…”;
位置 http

案例:

  1. http {
  2.     include       mime.types;
  3.     default_type  application/octet-stream;
  4.     sendfile        on;
  5.       # 定义日志格式
  6.     log_format  main  'songhongwei 好帅====>$remote_addr - $remote_user [$time_local] "$request" '
  7.                       '$status "$http_referer" '
  8.                       ' "$http_x_forwarded_for"';
  9.    # 引用日志格式 
  10.     access_log  logs/access.log  main;
  12. }

日志输出:
image.png

  • 其他配置指令

  1. sendfile:用来设置Nginx服务器是否使用sendfile()传输文件，该属性可以大大提高Nginx处理静态资源的性能 | 语法 | sendfile on|off； | | —- | —- | | 默认值 | sendfile off; | | 位置 | http、server、location |

  2. keepalive_timeout:用来设置长连接的超时时间。

》为什么要使用keepalive？
HTTP是一种无状态协议，客户端向服务端发送一个TCP请求，服务端响应完毕后断开连接。
客户端向服务端发送多个请求，每个请求都需要重新创建一次连接，使用keepalive模式，可以告诉服务器端在处理完一个请求后保持这个TCP连接的打开状态，若接收到来自这个客户端的其他请求，服务端就会利用这个未被关闭的连接，而不需要重新创建一个新连接，提升效率，但是这个连接也不能一直保持，连接如果过多，服务端的性能下降，这个时候就需要我们进行设置其的超时时间。

语法 keepalive_timeout time;
默认值 keepalive_timeout 75s;
位置 http、server、location
  1. keepalive_requests:用来设置一个keep-alive连接使用的次数。 | 语法 | keepalive_requests number; | | —- | —- | | 默认值 | keepalive_requests 100; | | 位置 | http、server、location |

server配置

是Nginx配置和虚拟主机相关的内容

  1. listen指令

listen:用来配置监听端口。

语法 listen address[:port] [default_server]…;
listen port [default_server]…;
默认值 listen :80 | :8000
位置 server 
  1. #listen localhost:8000 监听指定的IP和端口
  2. listen 127.0.0.1:8000; 
  3. #监听指定IP的所有端口
  4. listen 127.0.0.1;    
  5. #监听指定端口上的连接
  6. listen 8000;    
  7. #监听指定端口上的连接
  8. listen *:8000;

default_server属性是标识符，用来将此虚拟主机设置成默认主机。所谓的默认主机指的是匹配到了listen但是没有匹配到server_name(用来处理没有成功匹配server_name的请求
)，则会默认执行的。如果不指定默认使用的是第一个server。

  1. server{
  2.     listen 8080;
  3.     server_name 127.0.0.1;
  4.     location /{
  5.         root html;
  6.         index index.html;
  7.     }
  8. }
  9. server{
  10.     listen 8080 default_server;
  11.     server_name localhost;
  12.     default_type text/plain;
  13.     return 444 'This is a error request';
  14. }
  1. server_name指令

server_name：用来设置虚拟主机服务名称。

语法 server_name name …;
name可以提供多个中间用空格分隔
默认值 server_name “”;
位置 server

server_name的配置方式有三种，精确匹配、通配符匹配、正则表达式匹配

  • 精确匹配

因为是域名访问，测试是的虚拟域名，需要在/etc/hosts文件里修改host解析

  1. server {
  2.     listen       8090;
  3.     server_name www.song.com www.hongwei.com;
  4.     location /json {
  5.         default_type application/json;
  6.         return 200 "{'id':1,'name':'songhongwei'}";
  7.     }
  9.    location /html {
  10.         default_type text/html;
  11.         root html;
  12.         index index.html;
  13.     }
  14. }

image.png

  • 使用通配符配置

server_name中支持通配符”“，但需要注意的是*通配符不能出现在域名的中间，只能出现在首段或尾段，如：
image.png

  2. server {
  3.     listen       8091;
  4.       # www.song.cn abc.song.cn www.hongwei.cn www.hongwei.com
  6.     server_name *.song.cn www.hongwei.*;
  7.     location /json {
  8.         default_type application/json;
  9.         return 200 "{id:1,name:songhongwei}";
  10.     }
  12.    location /html {
  13.         default_type text/html;
  14.         root html;
  15.         index index.html;
  16.     }
  17. }
  • 使用正则表达式配置

server_name中可以使用正则表达式，并且使用~作为正则表达式字符串的开始标记
常见的正则表达式:

代码 说明
^ 匹配搜索字符串开始位置
$ 匹配搜索字符串结束位置
. 匹配除换行符\n之外的任何单个字符
\ 转义字符，将下一个字符标记为特殊字符
[xyz] 字符集，与任意一个指定字符匹配
[a-z] 字符范围，匹配指定范围内的任何字符
\w 与以下任意字符匹配 A-Z a-z 0-9 和下划线,等效于[A-Za-z0-9_]
\d 数字字符匹配，等效于[0-9]
{n} 正好匹配n次
{n,} 至少匹配n次
{n,m} 匹配至少n次至多m次
* 零次或多次，等效于{0,}
+ 一次或多次，等效于{1,}
? 零次或一次，等效于{0,1}

配置案例:

  1. server{
  2.         listen 8092;
  3.         server_name ~^www\.(\w+)\.com$;
  4.         default_type text/plain;
  5.         return 200 $1  $2 ;
  6. }
  7. # 注意 ~后面不能加空格，括号可以取值 $1 表示第一个匹配的值,$2表示第二个匹配的值,本案例中没有匹配的第二个值
  • 匹配执行顺序

由于server_name指令支持通配符和正则表达式，因此在包含多个虚拟主机的配置文件中，可能会出现一个名称被多个虚拟主机的server_name匹配成功，Nginx的匹配顺序为：

  1. 1. 准确匹配server_name
  2. 2. 配符在开始时匹配server_name成功
  3. 3. 通配符在结束时匹配server_name成功
  4. 4. 正则表达式匹配server_name成功
  5. 5. 被默认的default_server处理，如果没有指定默认找第一个server

案例:

  1. server{
  2.         listen 8093;
  3.         server_name ~^www\.\w+\.com$;
  4.         default_type text/plain;
  5.         return 200 'regex_success';
  6. }
  8. server{
  9.         listen 8093;
  10.         server_name www.song.*;
  11.         default_type text/plain;
  12.         return 200 'wildcard_after_success';
  13. }
  15. server{
  16.         listen 8093;
  17.         server_name *.song.com;
  18.         default_type text/plain;
  19.         return 200 'wildcard_before_success';
  20. }
  22. server{
  23.         listen 8093;
  24.         server_name www.song.com;
  25.         default_type text/plain;
  26.         return 200 'exact_success';
  27. }
  29. server{
  30.         listen 8093 default_server;
  31.         server_name _;
  32.         default_type text/plain;
  33.         return 444 'default_server not found server';
  34. }
  35. # /etc/hosts配置
  36. 127.0.0.1 www.song.com
  37. 127.0.0.1 abc.song.com
  38. 127.0.0.1 www.song.cn
  39. 127.0.0.1 www.hongwei.com
  41. 127.0.0.1 www.hongwei.cn
  43. # 访问 www.song.com 返回 exact_success
  45. # 访问 abc.song.com 返回 wildcard_before_success
  47. # 访问 www.song.cn 返回 wildcard_after_success
  49. # 访问 www.hongwei.com 返回 regex_success
  51. # 访问 www.hongwei.cn 返回 default_server not found server

location 配置

基于Nginx服务器接收请求字符串与location后面的值进行匹配，对特定请求进行处理

  • location指令

location:用来设置请求的URI

语法 location [ = | ~ | ~* | ^~ |@ ] uri{…}
默认值 —
位置 server,location

uri变量是待匹配的请求字符串，可以不包含正则表达式，也可以包含正则表达式，nginx服务器在搜索匹配location的时候，先使用不包含正则表达式进行匹配，找到一个匹配度最高的一个，然后在通过包含正则表达式的进行匹配，如果能匹配到直接访问，匹配不到，就使用刚才匹配度最高的那个location来处理请求。
属性介绍:
不带符号，要求必须以指定模式开始，但是正则表达式规则和长的块规则将被优先和查询匹配

  1. server {
  2.     listen 80;
  3.     server_name 127.0.0.1;
  4.     location /abc {
  5.         default_type text/plain;
  6.         return 200 "access success";
  7.     }
  8. }
  9. # 以下访问都是正确的
  10. http://172.41.100.15/abc
  11. http://172.41.100.15/abc?p1=TOM
  12. http://172.41.100.15/abc/
  13. http://172.41.100.15/abcdef

  1. = : 用于不包含正则表达式的uri前，必须与指定的模式精确匹配

    1. server {
    2.  listen 80;
    3.  server_name 127.0.0.1;
    4.  location =/abc{
    5.      default_type text/plain;
    6.      return 200 "access success";
    7.  }
    8. }
    9. # 可以匹配到
    10. http://172.41.100.15/abc
    11. http://172.41.100.15/abc?p1=TOM
    12. # 匹配不到
    13. http://172.41.100.15/abc/
    14. http://172.41.100.15/abcdef

  2. ~ ： 用于表示当前uri中包含了正则表达式，并且区分大小写

~ ： 用于表示当前uri中包含了正则表达式，*并且不区分大小写

  1. server {
  2.     listen 80;
  3.     server_name 127.0.0.1;
  4.     location ~^/abc\w*$ {
  5.         default_type text/plain;
  6.         return 200 "no ignore";
  7.     }
  8. }
  9. server {
  10.     listen 80;
  11.     server_name 127.0.0.1;
  12.     location ~*^/abc\w*$ {
  13.         default_type text/plain;
  14.         return 200 "ignore";
  15.     }
  16. }
  17. # 访问 http://172.41.100.15/abc 返回 no ignore
  19. # 访问 http://172.41.100.15/Abc 返回  ignore
  1. ^~: 用于不包含正则表达式的uri前，功能和不加符号的一致，主要区别在下面：

Nginx匹配是先使用不包含正则表达式进行匹配，找到一个匹配度最高的一个，然后在通过包含正则表达式的进行匹配，如果能匹配到直接访问，匹配不到，就使用刚才匹配度最高的那个location来处理请求。但是如果使用^~ ，则匹配到直接使用，不在进行正则匹配，例如

  1. server {
  2.     listen 80;
  3.     server_name 127.0.0.1;
  4.    location /images {
  5.         default_type text/plain;
  6.         return 200 "images access success";
  7.     }
  8.    location ~^/images {
  9.         default_type text/plain;
  10.         return 200 "express access success";
  11.     }
  12. }
  14. # 访问 http://172.41.100.15/images 返回的是 express access success，因为使用了正则匹配
  15. server {
  16.   listen 81;
  17.   server_name localhost;
  18.   location ~^/images{
  19.     default_type text/plain;
  20.     return 200 "express access success";
  21.   }
  22.   location ^~/images {
  23.     default_type text/plain;
  24.     return 200 "access success";
  25.   }
  26. }
  27. # 访问 http://172.41.100.15:81/images 返回的是 access success，因为中断了正则匹配
  1. @ ： 定义一个命名的 location，使用在内部定向
    1. server{
    2.  error_page 404 @jump_to_error;
    3.  location @jump_to_error {
    4.      default_type text/plain;
    5.      return 404 'Not Found Page...';
    6.  }
    7. }