Nginx读书笔记(2) —— Nginx配置的通用语法

Nginx配置的通用语法

Nginx的配置文件其实是一个普通的文本文件。下面来看一个简单的例子。

1 块配置项

块配置项由一个块配置项名和一对大括号组成。具体示例如下:

上面代码段中的events、http、server、location、upstream等都是块配置项,块配置项之后是否如“location/webstatic{...}”那样在后面加上参数,取决于解析这个块配置项的模块,不能一概而论,但块配置项一定会用大括号把一系列所属的配置项全包含进来,表示大括号内的配置项同时生效。所有的事件类配置都要在events块中,http、server等配置也遵循这个规定。

块配置项可以嵌套。内层块直接继承外层块,例如,上例中,server块里的任意配置都是基于http块里的已有配置的。当内外层块中的配置发生冲突时,究竟是以内层块还是外层块的配置为准,取决于解析这个配置项的模块,第4章将会介绍http块内配置项冲突的处理方法。例如,上例在http模块中已经打开了“gzip on;”,但其下的location/webstatic又把gzip关闭了:gzip off;,最终,在/webstatic的处理模块中,gzip模块是按照gzip off来处理请求的。

2 配置项的语法格式

从上文的示例可以看出,最基本的配置项语法格式如下:

下面解释一下配置项的构成部分。

首先,在行首的是配置项名,这些配置项名必须是Nginx的某一个模块想要处理的,否则Nginx会认为配置文件出现了非法的配置项名。配置项名输入结束后,将以空格作为分隔符。

其次是配置项值,它可以是数字或字符串(当然也包括正则表达式)。针对一个配置项,既可以只有一个值,也可以包含多个值,配置项值之间仍然由空格符来分隔。当然,一个配置项对应的值究竟有多少个,取决于解析这个配置项的模块。我们必须根据某个Nginx模块对一个配置项的约定来更改配置项,第4章将会介绍模块是如何约定一个配置项的格式。

最后,每行配置的结尾需要加上分号。

注意  如果配置项值中包括语法符号,比如空格符,那么需要使用单引号或双引号括住配置项值,否则Nginx会报语法错误。例如:

log_format  main  '$remote_addr - $remote_user [$time_local] "$request" ';

3 配置项的注释

如果有一个配置项暂时需要注释掉,那么可以加“#”注释掉这一行配置。例如:

#pid  logs/nginx.pid;

4 配置项的单位

大部分模块遵循一些通用的规定,如指定空间大小时不用每次都定义到字节、指定时间

时不用精确到毫秒。

当指定空间大小时,可以使用的单位包括:

·K或者k千字节(KiloByte,KB)。

·M或者m兆字节(MegaByte,MB)。

例如:

gzip_buffers  4 8k;
client_max_body_size 64M;

当指定时间时,可以使用的单位包括:

·ms(毫秒), s(秒), m(分钟), h(小时), d(天), w(周,包含7天), M(月,包含30天), y(年,包含365天)。

例如:

expires                 10y;
proxy_read_timeout      600;
client_body_timeout     2m;

注意  配置项后的值究竟是否可以使用这些单位,取决于解析该配置项的模块。如果这个模块使用了Nginx框架提供的相应解析配置项方法,那么配置项值才可以携带单位。

5 在配置中使用变量

有些模块允许在配置项中使用变量,如在日志记录部分,具体示例如下。

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

其中,remote_addr是一个变量,使用它的时候前面要加上$符号。需要注意的是,这种变量只有少数模块支持,并不是通用的。

许多模块在解析请求时都会提供多个变量(如本章后面提到的http core module、http proxy module、http upstream module等),以使其他模块的配置可以即时使用。我们在学习某个模块提供的配置说明时可以关注它是否提供变量。

提示  在执行configure命令时,我们已经把许多模块编译进Nginx中,但是否启用这些模块,一般取决于配置文件中相应的配置项。换句话说,每个Nginx模块都有自己感兴趣的配置项,大部分模块都必须在nginx.conf中读取某个配置项后才会在运行时启用。例如,只

有当配置http{...}这个配置项时,ngx_http_module模块才会在Nginx中启用,其他依赖ngx_http_module的模块也才能正常使用。