Nginx配置多文件

在日常工作中Nginx可谓是Web开发人员的利器了; Nginx可以做负载均衡,url重写,ip拦截,静态资源服务器等等,功能不得不说是眼花缭乱;如果一味的在nginx.conf中进行追加,无疑会非常臃肿,而且看起来像蜘蛛网一般,而且修改一个配置怕影响线上其它服务;所以基于这个背景,非常有必要对Nginx的配置进行隔离,Nginx配置多文件是一个比较好的做法;

一、基于什么规则来划分？

其实这个没有统一的标准,只要看起来清晰,方便后期维护就是好的做法; 笔者是按照配置类型进行的拆分,主要分为这么几类: upstream,server,location; 如果要求粒度更细,可以拆分http,https等等,看自己的喜好,前提就是方便线上运维人员配置就行了。

二、示例

2.1 Nginx.conf

# user  nobody;
worker_processes 1;
...
# pid        logs/nginx.pid;
events {
    worker_connections 1024;
}
...
http {
    include mime.types;
    default_type application/octet-stream;
    # log_format  main  '$remote_addr - $remote_user [$time_local] "$request" '
    # '$status $body_bytes_sent "$http_referer" '
    # '"$http_user_agent" "$http_x_forwarded_for"';
    # access_log  logs/access.log  main;
    sendfile on;
    # tcp_nopush     on;
    # keepalive_timeout  0;
    keepalive_timeout 65;
    # gzip  on;
    include /data/tools/nginx/conf/conf.d/*/*.conf;
}

通过include关键字即可导入外部配置; 这里就是导入conf.d目录下任意文件下的*.conf配置;在conf.d下可以设置大目录,笔者这里按server,upstream进行的拆分,如下所示:

[root@xxx/data/tools/nginx/conf/conf.d]# ll
total 12
drwxr-xr-x 3 root root 4096 Jul 18 00:19 mon_server
drwxr-xr-x 2 root root 4096 Jul 18 00:10 test_server
drwxr-xr-x 2 root root 4096 Jul 18 00:00 upstream

在upstream目录下放置统一的负载均衡配置,在*_server下配置指定的location和server配置,其层次结构如下:

drwxr-xr-x 2 root root 4096 Jul 18 00:14 location
-rw-r--r-- 1 root root  338 Jul 17 23:58 server.conf

server.conf内容如下:

server {
        listen 80;
        server_name xxx;
        error_log logs/xx.log;
        charset utf-8;
        # access_log logs/xxx_access.log access;
        location / {
                root /data/xxx/dist;
                index index.html index.htm;
        }
        
        #import all location config
        include /data/tools/nginx/conf/conf.d/xx/location/*.conf;
}

然后再location目录中按业务进行拆分配置,相对比较清晰;

-- location
  -- point.conf
  -- pay.conf
  -- order.conf

point.conf配置片段如下:

location /point {
    add_header  X-UA-Compatible 'IE=Edge,chrome=1';
    proxy_connect_timeout 120s;
    proxy_read_timeout 120s;
    proxy_send_timeout 120s;
    proxy_pass http://xxx/;
    proxy_redirect    off;
    proxy_set_header  Host             $host;
    proxy_set_header  X-Real-IP        $http_x_real_ip;
    proxy_set_header  X-Forwarded-For  $proxy_add_x_forwarded_for; 
}

三、总结

Nginx的配置导入功能非常灵活,在http,server下都可以导入外部配置。通过这个功能把复杂的配置可以很好的拆分开来,对后期配置修改非常轻便,而且当线上出现问题的时候,也不会轻易改错,影响面相对会比较小。

最后总结一下location的用法:
~ #波浪线表示执行一个正则匹配，区分大小写
~* #表示执行一个正则匹配，不区分大小写
^~ #^~表示普通字符匹配，如果该选项匹配，只匹配该选项，不匹配别的选项，一般用来匹配目录
= #进行普通字符精确匹配
@ #"@" 定义一个命名的 location，使用在内部定向时

示例:

location  = / {
  # 只匹配"/".
}
location  / {
  # 匹配任何请求，因为所有请求都是以"/"开始
  # 但是更长字符匹配或者正则表达式匹配会优先匹配
}
location ^~ /images/ {
  # 匹配任何以 /images/ 开始的请求，并停止匹配 其它location
}
location ~* .(gif|jpg|jpeg)$ {
  # 匹配以 gif, jpg, or jpeg结尾的请求. 
}