Nginx：05---Nginx配置文件语法

董哥的黑板报

已于 2022-04-20 21:33:23 修改

阅读量1.2k

点赞数 1

分类专栏： Nginx 文章标签： Nginx配置文件语法

于 2020-05-23 13:22:34 首次发布

本文链接：https://blog.csdn.net/qq_41453285/article/details/106299053

版权

Nginx 专栏收录该内容

15 篇文章 16 订阅

订阅专栏

配置文件由“配置块”和“配置项”组成。格式如下：

<section> {
    <directive> <parameters>;
    <section> {
        <directive> <parameters>;
        ...
    }
    ...
}

一、配置块

配置块也称为“节”或“部分”
配置块由一个块配置项名和一对大括号组成。例如：

events {

}

配置块是可以嵌套的，内层块直接继承外层块。当内外层块中的配置发生冲突时，究竟是以内层块还是外层块的配置为准，取决于解析这个配置项的模块。例如下面的案例中，server块里的任意配置都是基于http块里的已有配置的

http {
    upstream backend {
        server 127.0.0.1:8080;
    }
    gzip on;
    server {
        location /webstatic {
            gzip off;
        }
    }
}

二、配置项

配置项是最基本的配置单位
格式如下：
- 首先，在行首的是配置项名，这些配置项名必须是Nginx的某一个模块想要处理的，否则Nginx会认为配置文件出现了非法的配置项名。配置项名输入结束后，将以空格作为分隔符
- 其次是配置项值，它可以是数字或字符串（当然也包括正则表达式）。针对一个配置项，既可以只有一个值，也可以包含多个值，配置项值之间仍然由空格符来分隔。当然，一个配置项对应的值究竟有多少个，取决于解析这个配置项的模块
- 最后，每行配置的结尾需要加上分号

配置项名 配置项值1 配置项值2 ... ;

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

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

配置项的注释

如果有一个配置项暂时需要注释掉，那么可以加“#”注释掉这一行配置
例如：
#pid logs/nginx.pid;

配置项的单位

大部分模块遵循一些通用的规定，如指定空间大小时不用每次都定义到字节、指定时间时不用精确到毫秒
当指定空间大小时，可以使用的单位包括：
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框架提供的相应解析配置项方法，那么配置项值才可以携带单位

三、在配置中使用变量

有些模块允许在配置项中使用变量，如在日志记录部分
例如：remote_addr是一个变量，使用它的时候前面要加上$符号。需要注意的是，这种变量只有少数模块支持，并不是通用的

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

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

四、内嵌其他配置文件（include关键字）

include可以在一个配置文件中用来包含另一个配置文件
语法格式：

include 配置文件名;

使用注意事项：
- include文件也要遵循Nginx配置文件的语法
- 如果路径中出现通配符，表示可以配置多个文件
- 如果在本配置文件中与include的配置文件中出现相同的配置，那么以最后一次定义的为标准，后面的会覆盖前面的
例如下面是几个演示案例：

include /opt/local/etc/nginx/mime.types;

include /opt/local/etc/nginx/vhost/*.conf;

如果你想在运行nginx前测试一下配置文件语法是否有错误，可以使用nginx的-t参数。例如：

/usr/local/nginx/sbin/nginx -t demo.conf

五、提示

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

六、配置演示案例

例如，下面是一个简单的配置文件

user nobody;

worker_processes 8;
error_log varlog/nginx/error.log error;

#pid logs/nginx.pid;

events {
    use epoll;
    worker_connections 50000;
}

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

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

    access_log logs/access.log main buffer=32k;
｝