nginx学习笔记之二：nginx作为web server

一、nginx的配置文件：nginx.conf
1、nginx配置文件的结构：
main(全局配置段)
events {...}
http {
...
server {
location ... {...}
location ... {...}
...
}
server {
...
}
}
2、配置参数需要以分号结尾，语法格式：
参数名 值1 [值2 ...];
3、配置文件中还可使用变量：
模块内置变量
用户自定义变量：set var_name value
4、配置文件检查：nginx -t
5、nginx配置文件vim语法高亮
vim对编译安装的nginx配置文件默认没有设置语法高亮，可执行以下步骤解决：
#mkdir -pv ~/.vim/syntax
#cd ~/.vim/syntax
#wget http://www.vim.org/scripts/download_script.php?src_id=14376 -O nginx.vim
#echo "au BufRead,BufNewFile /usr/local/nginx/* set ft=nginx" >> ~/.vim/filetype.vim

二、nginx的基本核心配置（main段、events{}段）
1、正常运行的必备配置：
①user username [groupname]; #指定运行worker进程的用户和组
②pid /path/to/pidfile_name; #指定nginx的pid文件
③worker_rlimit_nofile #;
worker进程所能够打开的最大文件句柄数。该值不能小于worker_connections×worker_processes，如果nginx工作为反向代理服务器，则该值不能小于worker_connections×worker_processes×2，因为此时一个请求需要维持两个套接字文件。
④worker_rlimit_sigpending #; 设定每个用户能够发往worker进程的信号的数量；
2、优化性能相关的配置：
①worker_processes #; #worker进程的个数；通常其数值应该为CPU的核心数减1；
②worker_cpu_affinity cpumask ...;
例如：
worker_processes 3;
worker_cpu_affinity 0001 0010 1000;

表示将3个worker进程分别绑定在CPU0，CPU1，CPU3上
③ssl_engine device; #在存在ssl硬件加速器的服务器上，指定所使用的ssl硬件加速设备；
④timer_resolution t; #每次内核事件调用返回时，都会使用gettimeofday()来更新nginx缓存时钟；timer_resolution用于定义每隔多久才会由gettimeofday()更新一次缓存时钟；x86-64系统上，gettimeofday()代价已经很小，可以忽略此配置；
⑤worker_priority nice; #-20,19之间的值；
3、事件相关的配置
①accept_mutex [on|off] #是否打开nginx的负载均衡锁；此锁能够让多个worker进程轮流地、序列化地与新的客户端建立连接；而通常当一个worker进程的负载达到其上限的7/8，master就尽可能不再将请求调度此worker；
②lock_file /path/to/lock_file;
③accept_mutex_delay #ms; #accept锁模式中，一个worker进程为取得accept锁的等待时长；如果某worker进程在某次试图取得锁时失败了，至少要等待#ms才能再一次请求锁；
④multi_accept on|off; #是否允许一次性地响应多个用户请求；默认为off;
⑤use [epoll|rtsig|select|poll]; #定义使用的事件模型，建议让nginx自动选择；
⑥worker_connections #; #每个worker进程能够并发响应的最大请求数；
4、用于调试、定位问题: 只调试nginx时使用
①daemon on|off; #是否让ningx运行于后台；默认为on，调试时可以设置为off，使得所有信息直接输出至控制台；
②master_process on|off #是否以master/worker模式运行nginx；默认为on；调试时可设置off以方便追踪；
③error_log /path/to/error_log level; #错误日志文件及其级别；默认为error级别；调试时可以使用debug级别，但要求在编译时必须使用--with-debug启用debug功能；

三、nginx的http web核心功能（http_core_module）
nginx必须使用虚拟主机来配置站点，每个虚拟主机使用一个server {}段配置
非虚拟主机的配置或公共配置，需要定义在server之外，http之内
◆虚拟主机相关的配置：

⑴server {...}
定义一个虚拟主机；nginx支持使用基于主机名或IP的虚拟主机；
⑵listen address[:port] [default_server] [ssl]...;
listen port [default_server] [ssl]...;
default_server：定义此server为http中默认的server；如果所有的server中没有任何一个listen使用此参数，那么第一个server即为默认server
rcvbuf=SIZE：接收缓冲大小
sndbuf=SIZE：发送缓冲大小
ssl：https server
⑶server_name [...];
server_name可以跟多个主机名，名称中可以使用通配符和正则表达式(通常以~开头)；当nginx收到一个请求时，会取出其首部的server的值，而后跟众server_name进行比较；比较方式：
①先做精确匹配，如 www.magedu.com
②左侧通配符匹配，如 *.magedu.com
③右侧通配符匹配，如 www.*
④正则表达式匹配，如 ~^.*\.magedu\.com$
⑷server_name_hash_bucket_size 32|64|128;
为了实现快速主机查找，nginx使用hash表来保存主机名
⑸location [ = | ~ | ~* | ^~ ] uri { ... } #location只能放在server和location中，location可出现多次
location @name { ... }
功能：允许根据用户请求的URI来匹配指定的各location以进行访问配置；匹配到时，将被location块中的配置所处理；比如：http://www.magedu.com/images/logo.gif
匹配规则：
=：精确匹配；
~：正则表达式模式匹配，区分字符大小写
~*：正则表达式模式匹配，忽略字符大小写
^~：URI前缀匹配，不检查正则表达式
@：用来定义“Named Location”这种“Named Location”不是用来处理外部的http请求，而是专门用来处理内部重定向的；此用法不常用
匹配优先级：
精确匹配、以^~开头的最长前缀匹配、正则表达式检索（由第一个匹配到所处理）、最长前缀匹配
示例：
① location / {
root /web/a;
}
② location ^~ /documents/ {
root /web/b;
}
③ location /documents/media/ {
root /web/c;
}
④ location ~* \.(gif|jpg|jpeg)$ {
root /web/d;
}
⑤ location = /documents/media/test.jpg {
root /web/e;
}
若请求的uri为/documents/media/test.jpg，则匹配的优先次序为⑤②④③①

◆文件路径定义：
⑴root path; #指定web资源根目录，可用于http，server和location中
⑵alias path; #定义指定路径的替换路径，只能用于location中
区别root path和alias path：
例，用户请求www.magedu.com/images/b.html
①location /i/ {
root /data/images;
}

“/i/top.gif”将由/data/images/i/top.gif文件来响应
②location /i/ {
alias /data/images/;
}

“/i/top.gif”将由/data/images/top.gif文件来响应
说明：
root和alias指定的path都可以包含除$document_root和$realpath_root以外的变量
root文件路径的构造仅仅是将URI拼在root指令的值后面。如果需要修改URI，应该使用alias指令。
如果在定义了正则表达式的路径中使用了alias，那么正则表达式中应该含有匹配组， 并且alias应该引用这些匹配组来组成一个完整的文件路径，比如：
location ~ ^/users/(.+\.(?:gif|jpe?g|png))$ {
alias /data/w3/images/$1;
}
⑶index file ...; #定义默认页面，可跟多个值
⑷error_page code ... [=[response]] uri;
当对于某个请求返回错误时，如果匹配上了error_page指令中设定的code，则重定向到新的uri，uri可以包含变量；还可以使用“=response”语法改变响应状态码。例如：
error_page 404 =200 /empty.gif;

error_page 403 http:/example.com/forbidden.html; #还可对错误进行重定向

如果内部跳转时无需改变URI，可以将错误处理转到一个命名路径：
location / {
error_page 404 = @fallback;
}

location @fallback {
proxy_pass http://backend; }

⑸try_files path1 [path2 ...] uri;
自左至右尝试读取由path所指定路径，在第一次找到即停止并返回；如果所有path均不存在，则按最后一个uri进行内部跳转。最后一个参数也可以是code，还可以是命名路径，如@fallback；
例如：
location ~* ^/documents/(.*)$ {
root /www/htdocs;
try_files $uri /docu/$1 /temp.html @fallback; #或前面的几个文件都找不到，则会以原始URI转到最后指定的命名location
}
location /text/ {
alias /web/a/;
try_files $uri /text/back.html =404; #若去掉“=404”而以“/text/back.html”结尾，则“/text/back.html”不再表示一个文件的相对路径，而表示uri，它会重新寻找匹配的location
}
若请求/text/temp.html，则寻找的文件路径依次是/web/a/temp.html，/web/a/text/back.html，若这两个文件都找不到，则返回404

◆网络连接相关的设置：
⑴keepalive_timeout time; #保持连接的超时时长；默认为75秒
⑵keepalive_requests n; #在一次长连接上允许承载的最大请求数
⑶keepalive_disable [msie6 | safari | none ]; #对指定的浏览器禁止使用长连接
⑷tcp_nodelay on|off; #对keepalive连接是否使用TCP_NODELAY选项
⑸client_header_timeout time; #读取http请求首部的超时时长
⑹client_body_timeout time; #读取http请求包体的超时时长
⑺send_timeout time; #发送响应的超时时长

◆对客户端请求的限制：
⑴limit_except method ... { ... }
指定对范围之外的其它方法的访问控制，只能用在location中
例：
limit_except GET { #除get以外的其它方法只允许172.16.0.0访问
allow 172.16.0.0/16;
deny all;
}
⑵client_max_body_size size;
http请求包体的最大值；常用于限定客户所能够请求的最大包体；根据请求首部中的Content-Length来检测，以避免无用的传输；
⑶limit_rate speed; #限制客户端每秒钟传输的字节数；默认为0，表示没有限制；
⑷limit_rate_after time;
nginx向客户端发送响应报文时，如果时长超出了此处指定的时长，则后续的发送过程开始限速；

◆文件操作的优化：
⑴sendfileon|off; #是否启用sendfile功能；
⑵aio on|off; #是否启用aio功能；
⑶open_file_cache max=N [inactive=time]|off; #是否打开文件缓存功能；
max: 缓存条目的最大值；当满了以后将根据LRU算法进行置换；
inactive: 某缓存条目在指定时长时没有被访问过时，将自动被删除；默认为60s
缓存的信息包括：
文件句柄、文件大小和上次修改时间；
已经打开的目录结构；
没有找到或没有访问权限的信息；
⑷open_file_cache_errors on|off; #是否缓存文件找不到或没有权限访问等相关信息；
⑸open_file_cache_valid time; #多长时间检查一次缓存中的条目是否超出非活动时长，默认为60s
⑹open_file_cache_min_use #; #在inactive指定的时长内被访问超此处指定的次数地，才不会被删除；

◆对客户端请求的特殊处理：
⑴ignore_invalid_headers on|off;
是否忽略不合法的http首部；默认为on，off意味着请求首部中出现不合规的首部将拒绝响应；只能用于server和http
⑵log_not_found on|off; #是否将文件找不到的信息也记录进错误日志中；
⑶resolver address; #指定nginx使用的dns服务器地址；
⑷resover_timeout time; #指定DNS解析超时时长，默认为30s；
⑸server_tokens on|off; #是否在错误页面中显示nginx的版本号；

◆内存及磁盘资源分配：
⑴client_body_in_file_only on|clean|off;
HTTP的包体是否存储在磁盘文件中；非off表示存储，即使包体大小为0也会创建一个磁盘文件；on表示请求结束后包体文件不会被删除，clean表示会被删除；
⑵client_body_in_single_buffer on|off;
HTTP的包体是否存储在内存buffer当中；默认为off；
⑶cleint_body_buffer_size size;
nginx接收HTTP包体的内存缓冲区大小；若包体超出该值，则会写入磁盘文件中
⑷client_body_temp_path dir-path [level1 [level2 [level3]]];
HTTP包体存放的临时目录；
例如：client_body_temp_path /var/tmp/client/ 1 2;
后面的数字表示十六制的位数；此语句表示在/var/tmp/client目录下创建16个一级子目录，然后在每个一级子目录下创建16*16个二级子目录
⑸client_header_buffer_size size;
正常情况下接收用户请求的http报文header部分时分配的buffer大小；默认为1k
⑹large_client_header_buffers number size;
存储超大Http请求首部的内存buffer大小及个数；
⑺connection_pool_size size;
nginx对于每个建立成功的tcp连接都会预先分配一个内存池，此处即用于设定此内存池的初始大小；默认为256
⑻request_pool_size size;
nginx在处理每个http请求时会预先分配一个内存池，此处即用于设定此内存池的初始大小；默认为4k

◆http核心模块的内置变量：
$uri: 当前请求的uri，不带参数；
$request_uri: 请求的uri，带完整参数；
$host: http请求报文中host首部；如果请求中没有host首部，则以处理此请求的虚拟主机的主机名代替；
$hostname: nginx服务运行在的主机的主机名；
$remote_addr: 客户端IP
$remote_port: 客户端Port
$remote_user: 使用用户认证时客户端用户输入的用户名；
$request_filename: 用户请求中的URI经过本地root或alias转换后映射的本地的文件路径；
$request_method: 请求方法
$server_addr: 服务器地址
$server_name: 服务器名称
$server_port: 服务器端口
$server_protocol: 服务器向客户端发送响应时的协议，如http/1.1, http/1.0
$scheme: 在请求中使用scheme, 如https://www.magedu.com/中的https；
$http_HEADER: 匹配请求报文中指定的HEADER，$http_host匹配请求报文中的host首部
$sent_http_HEADER: 匹配响应报文中指定的HEADER，例如$http_content_type匹配响应报文中的content-type首部；
$document_root：当前请求映射到的root配置；

四、nginx作为web server的其它功能
1、访问控制（http_access_module）
allow address | CIDR | unix: | all;
deny address | CIDR | unix: | all;
缺省是allow all
示例：
location / {
deny 192.168.1.1;
allow 192.168.1.0/24;
allow 10.1.1.0/16;
deny all;6
}

2、用户认证（http_auth_basic_module)
auth_basic string | off;
auth_basic_user_file file;
示例：
location /admin/ {
root /www/b.org;
auth_basic "admin area";
auth_basic_user_file /etc/nginx/.htpasswd;
}
3、当无默认主页时显示文件列表，常用于建立下载站点（http_autoindex_module）
autoindex on | off;
4、防盗链（http_referer_module）
⑴定义合规的引用
valid_referers none | blocked | server_names | string ...;
说明：
none：缺少“Referer”请求头；
blocked：“Referer” 请求头存在，但是它的值被防火墙或者代理服务器删除； 这些值都不以“http://” 或者 “https://”字符串作为开头；
server_names：“Referer” 请求头包含某个虚拟主机名；
string可以是：
任意字符串：定义一个服务器名和可选的URI前缀。服务器名允许在开头或结尾使用“*”符号。 当nginx检查时，“Referer”请求头里的服务器端口将被忽略。
正则表达式：必须以“~”符号作为开头。 需要注意的是表达式会从“http://”或者“https://”之后的文本开始匹配
示例：
valid_referers none blocked server_names
*.example.com example.* www.example.org/galleries/
~\.google\.;
⑵拒绝不合规的引用
if ($invalid_referer) {
rewrite ^/.*$ http://www.b.org/403.html; }

5、URL重写（http_rewrite_module）
⑴rewrite regex replacement [flag];
如果URI能匹配指定的正则表达式，此URI将被replacement参数定义的字符串改写。如果replacement的字符串以“http://”或“https://”开头，nginx将结束执行过程，并返回给客户端一个重定向。
flag参数可以是：
①last：一旦被当前规则匹配并重写后立即停止检查后续的其它rewrite的规则，而后通过重写后的规则重新发起请求
②break：一旦被当前规则匹配并重写后立即停止检查后续的其它rewrite的规则，而后继续由nginx进行后续操作；
③redirect：返回302临时重定向，浏览器会显示跳转后的URL地址
④permanent：返回301永久重定向，浏览器会显示跳转后的URL地址。
注意：
last和break只是实现URL重写，浏览器地址栏中的URL地址不变，这与重定向不同。
一般将rewrite写在location中时都使用break标志，或者将rewrite写在if上下文中

如果replacement字符串包括新的请求参数，以往的请求参数会添加到新参数后面。如果不希望这样，在replacement字符串末尾加一个问号“？”，就可以避免，例如：
rewrite ^/users/(.*)$ /show?user=$1? last;

如果正则表达式中包含字符“}”或者“;”，整个表达式应该被包含在单引号或双引号的引用中，因这两个符号在nginx配置文件中有特殊意义。
示例：
location / {
root /www/b.org;
rewrite ^/images/(.*)$ /imgs/$1 last;
rewirte ^/imgs/(.*)$ /images/$1 last;
}
上述用法会造成nginx重复10轮循环，然后返回错误500，应将last换成break

⑵rewrite_log on|off;
是否把重写过程记录在错误日志中，默认为off；若开启，默认为notice级别；
⑶return code [text];
return code URL;
return URL;
用于结束rewrite规则，并且为客户返回状态码；可以使用的状态码有204, 400, 402-406, 500-504等；
⑷if (condition) { ... }
示例：
if ($http_user_agent ~ MSIE) {
rewrite ^(.*)$ /msie/$1 break;
}
if ($invalid_referer) {
return 403;
}

6、查看nginx基本状态信息（http_stub_status_module，非标准模块，需在编译安装nginx时指定）
location /basic_status {
stub_status on;
}