Nginx 是一个免费开源且稳定高效的 Web 服务器程序,拥有反向代理以及负载平衡的功能,经常作为最前端的服务器。PHP 是一种适合用于网站开发的脚本式编程语言,弹性度高,可以直接被嵌入 HTML 文档中。Nginx 可以透过 FastCGI 去运行 PHP 程序,且内置 FastCGI 缓存功能。

如果您不知道如何在 Ubuntu Server 架设 Nginx 服务器,可以先参考这篇文章:

CGI 是什么?

CGI (Common Gateway Interface)是一个用于网页服务器的界面标准,支持 CGI 的网页服务器会将其所接收到的 HTTP 请求的内容(路径、标头、主体等)作为运行某支程序时用的环境变量以及从标准输入(stdin)输入的数据,而该程序输出到标准输出(stdout)的数据会被网页服务器拿来回应给客户端。网页服务器每次使用 CGI 运行程序时,都会创建出新的进程(process),其实就像是我们在终端机直接用文件路径去运行某支程序那样,可想而知,这样的方式在应付多个 HTTP 请求时是很没有效率的。

FastCGI 是什么?

FastCGI 就是在网页服务器和用 CGI 所运行的程序(以下简称 CGI 程序)之间再加一个管理员。网页服务器要把 HTTP 请求交给管理员处理,而不是直接用 CGI 去运行程序。管理员会负责分配 CGI 程序的运行资源,使系统不会每次遇到请求就开一个进程去跑指定的 CGI 程序,以此来改善网络服务的运作效率。

PHP FastCGI

PHP FastCGI(php-fastcgi) 是早期 PHP 的 FastCGI 实作。

FPM (FastCGI Process Manager)

FPM(php-fpm) 是 PHP 目前的 FastCGI 实作。

安装 PHP

由于 PHP 是脚本式编程语言,因此需要有 PHP 的运行环境才可以被运行。运行以下指令可以安装 PHP 的运行环境:

sudo apt install php-cli

以 apt 安装 php-cli

安装完 php-cli 套件后,就可以使用 php 指令来运行 PHP 代码。如下图:

以 php 指令运行 PHP 代码

输入以下指令可以查看 PHP 的版本:

php -v

以 php -v 查看 PHP 版本

使用 php 指令运行 PHP 程序,其设置档的路径是 /etc/php/<PHP版本号码>/cli/php.ini。例如 PHP 7.4,设置档的路径就是 /etc/php/7.4/cli/php.ini。有关于 php.ini 文件,会在这篇文章之后再提到。

安装 FPM

运行以下指令可以安装 FPM:

sudo apt install php-fpm

以 apt 安装 php-fpm

FPM 预设只会监听 Unix Domain Socket(简称 UDS,或称 IPC Socket),UDS 文件路径为 /run/php/php<PHP版本号码>-fpm.sock。例如 PHP 7.4,UDS 文件路径就是 /run/php/php7.4-fpm.sock。

如果我们要确认 FPM 有没有安装并激活成功,可以利用 socat 这个指令工具来进行。使用以下指令可以安装 socat:

sudo apt install socat

运行以下指令来判断 FPM 有没有正常工作:

echo /dev/null | sudo socat unix:/var/run/php/php-fpm.sock - && echo "Working!" || echo "Not working!"

以上的 /var/run/php/php-fpm.sock 是 /run/php/php<PHP版本号码>-fpm.sock 的符号链接。

以 socat 确认 FPM 的 UDS 正常运作

设置 FPM

FPM 的设置档放置于 /etc/php/<PHP版本号码>/fpm/ 目录中。例如 PHP 7.4,就是在 /etc/php/7.4/fpm/ 目录中。

FPM 的设置档目录中还有一个 pool.d 目录,用来放置每个「池」(Pool)的设置档,一个池就是一个 FastCGI 的管理区域(或者说管理员)。预设有一个 www 池,设置档文件名为 www.conf,它预设的模样长成这样:

www.conf 的预设内容

比较重要的设置项目如下:

  • user、group:设置这个池在运行 CGI 程序的时候,进程是属于哪个拥有者和群组的。预设为 www-data,与 Nginx 预设的相同。
  • listen:设置这个池从哪个地方接收请求。预设是 /run/php/php<PHP版本号码>-fpm.sock。如果 FastCGI 服务是跑在与 Nginx 服务器不同的操作系统上,那这个设置就要改成网络界面的 IP 地址和连接端口,例如 0.0.0.0:9000。
  • listen.owner、listen.group:设置当监听 UDS 文件时,要用哪个拥有者和群组来创建 UDS 文件。不设置的话就会是照 user 和 group 的设置。
  • listen.mode:设置当监听 UDS 文件时,创建出来的 UDS 文件的文件权限。不设置的话是 0660。
  • php_admin_value[error_log]:设置错误日志的保存路径。预设的保存路径是 /var/log/php<PHP版本号码>-fpm.log。如果一个 FastCGI 服务提供了多个 PHP 网站,可以透过区分 FPM 池来顺便区分出错误日志档(让每个 PHP 网站都拥有一个独立的错误日志档),这样日后会比较好维护。不过设置了另外的错误日志路径后,记得也要去设置 logrotate,让新的 PHP 错误日志文件也可以正常被「轮替(rotate)」。
  • catch_workers_output:设置是否要取得子进程输出的消息至错误日志中。不设置的话是 no。建议先设置为 yes,激活这个功能,让 PHP 程序运行的时候出现的消息都可以被放在错误日志中。
  • pm:设置子进程的数量要固定还是浮动。static 是固定为最大数量(pm.max_children);dynamic 是动态调整;ondemand 是进程开完就关。预设是 dynamic。
  • pm.max_children:设置子进程的最大数量。预设是 5。这个数量可以设为处理器(逻辑处理器)的数量再根据每个子进程的内存用量乘上某个倍数(例如内存剩得少就乘 2,内存剩得多就乘 4)。
  • pm.start_servers:设置当子进程数量是动态调整时,预先创建的子进程数量。
  • pm.min_spare_servers:设置当子进程数量是动态调整时,最少保留的闲置子进程的数量。
  • pm.max_spare_servers:设置当子进程数量是动态调整时,最大保留的闲置子进程的数量。
  • pm.process_idle_timeout:设置当子进程是开完就关时,子进程是要闲置多久(秒)后才会被关闭。
  • pm.max_requests:设置当子进程处理完几次请求后,就重新创建。当有用到有内存泄漏(Memory Leak)的 PHP 模块时,可以设置这个项目。
  • pm.status_path:设置用来查看这个池的状态的请求路径。建议设置这个项目,挺方便的,例如设成 pm.status_path = /status,这样只要发送路径为 /status 的请求就可以知道这个池的状态(文章之后会再说明)。

套用 FPM 的新设置

改写 FPM 设置档并存盘后,新设置并不会立即套用给正在运行中的 FPM 服务。

要让 FPM 服务重新读取设置档,最好先用以下指令检查 FPM 设置档是否无误,避免 FPM 服务因为设置档错误而中断服务。

sudo php-fpm<PHP版本号码> -t

例如 PHP 7.4,指令如下:

sudo php-fpm7.4 -t

以 php-fpm7.4 -t 检查设置档

接着再运行如下的指令来重新加载 FPM 的设置档:

sudo systemctl reload php<PHP版本号码>-fpm

例如 PHP 7.4,指令如下:

sudo systemctl reload php7.4-fpm

以 systemctl reload 重新加载 FPM

如果有将 FPM 监听的目标改为 IP 地址和连接端口的话,可以用以下指令来检查是否有正常在监听:

sudo ss -tlnp | grep php-fpm

ss 指令可以显示出 Socket 相关的信息。-l 参数可以只显示正在监听中的连接。若使用 ss 指令时都没给任何参数的话,会忽略掉监听中的连接。-t 参数可以只显示 TCP 连接。-n 参数可以让连接端口数字直接被输出,而不是用一个名称代替。-p 参数可以显示占用连接的进程。下图是笔者在 PHP 8.1 的环境中,让 FPM 监听 0.0.0.0:3000 时的运行结果。

以 ss 确认 FPM 监听的连接端口

设置 PHP

透过 FPM 运行 PHP 程序的 PHP 设置档放在 FPM 的设置档目录中,文件名为 php.ini。例如 PHP 7.4,PHP 设置档路径就是 /etc/php/7.4/fpm/php.ini。它预设的模样长成这样:

FPM 的 php.ini 预设内容

比较重要的设置项目如下:

  • display_errors:设置是否将 PHP 的警告和错误消息直接输出到标准输出(stdout)或是标准错误(stderr)。预设是 Off(不输出)。设置为 On 可以输出到标准输出(stdout);设置为 stderr 可以输出到标准错误。这个功能在 PHP 程序的开发阶段还蛮方便的。
  • default_mimetype:设置 PHP 程序输出的内容之预设的 MIME 类型。预设是 text/html。
  • max_execution_time:设置每个 PHP 程序的最长运行时间(秒)。预设是 30。
  • max_input_time:设置每个 PHP 程序的最长读取请求的时间(秒)。预设是 60。
  • memory_limit:设置每个 PHP 程序的最大内存使用量(字节,可用 K、M 等单位)。预设是 128M。
  • upload_max_filesize:设置每个上传的文件的最大大小(字节,可用 K、M 等单位)。预设是 2M。
  • post_max_size:设置每个 POST 请求主体的最大大小(字节,可用 K、M 等单位)。预设是 8M。可以把这个看作是一次上传的所有文件的最大总大小。
  • opcache.enable:设置是否打开 Zend OPCache。预设是 1(打开)。设成 0 可以关闭,PHP 程序还在开发阶段时将 Zend OPCache 关闭会比较方便。
  • opcache.memory_consumption:设置 Zend OPCache 使用的共享内存大小(MB)。预设是 128。

套用 PHP 的新设置

改写 PHP 设置档并存盘后,新设置并不会立即套用给正在运行中的 FPM 服务。

要让 FPM 服务重新读取 PHP 设置档,最好先用如下的指令检查 PHP 设置档是否无误,避免 FPM 服务因为设置档错误而中断服务或 PHP 程序运行异常。

php -e -c /etc/php/<PHP版本号码>/fpm/php.ini -r 'echo "OK\n";'

例如 PHP 7.4,指令如下:

php -e -c /etc/php/7.4/fpm/php.ini -r 'echo "OK\n";'

以 php -e -c 检查 php.ini

接着再运行如下的指令来重新启动 FPM:

sudo systemctl restart php<PHP版本号码>-fpm

例如 PHP 7.4,指令如下:

sudo systemctl restart php7.4-fpm

以 systemctl restart 重新启动 FPM

设置 Nginx

PHP 的相关设置都搞定后,再来总算要来处理 Nginx 的部份啦!

在 Nginx 设置档的 location 区块中,可以使用 fastcgi_pass 命令,将 PHP 请求交给 FastCGI 服务来处理。fastcgi_pass 命令的用法类似 proxy_pass 命令,如下:

server {
    index index.html index.php;

    location ~ \.php$ {
        fastcgi_pass unix:/run/php/php7.4-fpm.sock;
        include fastcgi.conf;
    }
}

以上设置,可以让路径为 .php 结尾的请求,透过 FastCGI 服务来处理。

这边有个十分令人疑惑的地方,那就是 /etc/nginx 目录下其实有两个预设的 FastCGI 设置档,第一个是上面用的 fastcgi.conf,第二个是 fastcgi_params,这两个文件只差在前者比后者多了:

fastcgi_param  SCRIPT_FILENAME    $document_root$fastcgi_script_name;

所以引用 fastcgi.conf,表示要把 PHP 文件放在 Nginx 虚拟主机的根目录底下。而引用 fastcgi_params,表示要自行另外决定 PHP 文件的位置,例如:

server {
    root /var/www/html;

    index index.html index.php;

    location ~ \.php$ {
        fastcgi_pass unix:/run/php/php7.4-fpm.sock;
        fastcgi_param SCRIPT_FILENAME /var/www/php$fastcgi_script_name;
        include fastcgi_params;
    }
}

如果 FPM 有激活 pm.status_path 设置项目,而设置值是 /status 的话,可以再加上如下的 location 区块。

server {
    index index.html index.php;

    location ~ \.php$ {
        fastcgi_pass unix:/run/php/php7.4-fpm.sock;
        include fastcgi.conf;
    }

    location = /status {
        allow 127.0.0.1;
        deny all;
        fastcgi_pass unix:/run/php/php7.4-fpm.sock;
        include fastcgi.conf; 
    }
}

如此一来就可以在同一台主机透过 HTTP 协定发送路径为 /status 的请求来取得 FPM 服务的状态。如下图:

浏览器显示的 FPM 服务状态

如果要在别台主机查看 FPM 服务的状态,可以加上更多的 allow 命令,或者干脆改用 HTTP 基本认证(帐密认证)。

关于 UDS 文件的 URI,可以在 server 区块内使用 set 命令,将 URI 存进一个变量内,这样在使用多次 fastcgi_pass 命令时也不用一直去重复填写 URI。如下:

server {
    index index.html index.php;

    set $php_uds unix:/run/php/php7.4-fpm.sock;

    location ~ \.php$ {
        fastcgi_pass $php_uds;
        include fastcgi.conf;
    }

    location = /status {
        allow 127.0.0.1;
        deny all;
        fastcgi_pass $php_uds;
        include fastcgi.conf; 
    }
}

另外有些特定的 PHP 程序可能会需要大量的运行时间,在 PHP 脚本中,可以调用 set_time_limit 函数来单独改变该 PHP 脚本的运行时间。当然,如果要让该 PHP 脚本也能够正常把结果回传给 Nginx,就要在 Nginx 设置档中使用 fastcgi_read_timeout 和 fastcgi_send_timeout 命令来提高 PHP 程序读取和回应数据的间隔之逾时的时间。fastcgi_read_timeout 和 fastcgi_send_timeout 命令可以被用在 http、server 和 location 区块中,不设置的话是 60s(60 秒)。

设置 FastCGI 缓存

Nginx 在接收 FastCGI 服务回应的数据时,可以将其缓存成文件,这样下次如果又有一样的请求,Nginx 就可以直接从文件系统中捞出来回应,不必再转送给 FastCGI 服务处理。

在 http 区块中使用 fastcgi_cache_path 命令,可以创建文件缓存存放的目录,以及用以保存键值(Key)的「Zone」。例如:

http {
    fastcgi_cache_path /path/to/cache levels=1:2 keys_zone=my_cache:10m max_size=10g inactive=60m use_temp_path=off;

    ...
}

以上设置,可以创建出一个名为 my_cache 的「Zone」,拥有 10MiB 的大小的共享内存空间,用以保存被缓存的资源的哈希值以及请求次数。而被缓存的资源则会保存在文件系统中的 /path/to/cache 目录底下,另外拥有两层子目录。/path/to/cache 目录不需要事先被创建出来,因为它会在 Nginx 加载设置档时被创建,但 /path/to 目录要事先被创建。

levels 最多可以拥有三层,值的格式为 x[:y[:z]],x 表示第一层子目录的文件名长度,y 表示第二层子目录的文件名长度,z 表示第三层子目录的文件名长度。文件名是从缓存的键值经过 MD5 哈希值的十六进制(HEX)字符串中,于尾端开始取固定长度的子字符串来使用。举例来说,若 levels 设为 1:2,缓存的键值经 MD5 哈希后的十六进制字符串为 b7f54b2df7773722d382f4809d65029c,则这个缓存文件的存放路径为 c/29/b7f54b2df7773722d382f4809d65029c。

max_size=10g 用来限制 /path/to/cache 目录底下的缓存总大小最多只能有 10GiB,超过的话就会从最久没被使用的缓存开始删除。

inactive=60m 用来设置缓存在 60 分钟内如果都没被使用,就将其删除。use_temp_path=off 用来设置要缓存的文件不要事先存到 fastcgi_temp_path 再搬进缓存(在无打开 FastCGI 缓存时,FastCGI 服务所回应的数据会先被暂存至预设的或是指定的 fastcgi_temp_path,在有激活缓存的情况下,实在没必要再做这个动作)。

接着还要用 fastcgi_cache_key 命令来设置缓存用的键值,基本的设置方式如下:

http {
    fastcgi_cache_path /path/to/cache levels=1:2 keys_zone=my_cache:10m max_size=10g inactive=60m use_temp_path=off;
    fastcgi_cache_key $scheme$request_uri;

    ...
}

在想要激活 FastCGI 缓存的 location 区块,使用 fastcgi_cache 命令,就可以让 Nginx 进行 FastCGI 缓存了。fastcgi_cache 命令的参数要传入一个「Zone」的名称,例如:

http {
    fastcgi_cache_path /path/to/cache levels=1:2 keys_zone=my_cache:10m max_size=10g inactive=60m use_temp_path=off;
    fastcgi_cache_key $scheme$request_uri;

    server {
        index index.html index.php;

        location ~ \.php$ {
            fastcgi_cache_revalidate on;
            fastcgi_cache my_cache;
            fastcgi_pass unix:/run/php/php7.4-fpm.sock;
            include fastcgi.conf;
        }
    }
}

以上设置另外还激活了 fastcgi_cache_revalidate,可以让 Nginx 在处理过期缓存的时候去尝试向 FastCGI 服务确认缓存的有效性,而不是直接让 FastCGI 服务重新处理请求。

还有一个地方要注意的是,这边用的 fastcgi_cache_key,由于没有区分是哪个 Host,所以在不同的 server 区块下,最好使用不同的「Zone」来缓存。另外也不建议用 $host 变量来组成 fastcgi_cache_key,因为 $host 变量在 server 区块不是因 server_name 成功匹配而被选择到时,$host 变量的值是由请求标头的 Host 字段来决定的,因此会有被注入(injection)攻击的可能性。

利用 fastcgi_cache_use_stale 命令,当 FastCGI 服务无法正常处理请求(有错误或是逾时),或是回应了如 500 (Internal Server Error)的错误状态码时,Nginx 还可以把上一次缓存到但是过期的结果回应给客户端。例如:

http {
    fastcgi_cache_path /path/to/cache levels=1:2 keys_zone=my_cache:10m max_size=10g inactive=60m use_temp_path=off;
    fastcgi_cache_key $scheme$request_uri;

    server {
        index index.html index.php;

        location ~ \.php$ {
            fastcgi_cache_use_stale error timeout invalid_header http_500 http_503;
            fastcgi_cache_revalidate on;
            fastcgi_cache my_cache;
            fastcgi_pass unix:/run/php/php7.4-fpm.sock;
            include fastcgi.conf;
        }
    }
}

fastcgi_cache_use_stale 命令也可以在参数加上 updating,让缓存正在被更新时,也依然去使用过期的缓存。而若加了 updating,则应该要再激活 fastcgi_cache_background_update,让 Nginx 可以在背景更新过期的缓存。例如:

http {
    fastcgi_cache_path /path/to/cache levels=1:2 keys_zone=my_cache:10m max_size=10g inactive=60m use_temp_path=off;
    fastcgi_cache_key $scheme$request_uri;

    server {
        index index.html index.php;

        location ~ \.php$ {
            fastcgi_cache_use_stale error timeout invalid_header updating http_500 http_503;
            fastcgi_cache_background_update on;
            fastcgi_cache_revalidate on;
            fastcgi_cache my_cache;
            fastcgi_pass unix:/run/php/php7.4-fpm.sock;
            include fastcgi.conf;
        }
    }
}

另外还有 fastcgi_cache_min_uses 命令可以设置资源至少要被请求几次才会真的缓存到文件系统中。不设置的话是 1。增加这个值表示要让更频繁被访问的资源更能留在缓存中。例如:

http {
    fastcgi_cache_path /path/to/cache levels=1:2 keys_zone=my_cache:10m max_size=10g inactive=60m use_temp_path=off;
    fastcgi_cache_key $scheme$request_uri;

    server {
        index index.html index.php;

        location ~ \.php$ {
            fastcgi_cache_min_uses 3;
            fastcgi_cache_use_stale error timeout invalid_header updating http_500 http_503;
            fastcgi_cache_background_update on;
            fastcgi_cache_revalidate on;
            fastcgi_cache my_cache;
            fastcgi_pass unix:/run/php/php7.4-fpm.sock;
            include fastcgi.conf;
        }
    }
}

对于没有在 HTTP 标头内设置缓存的回应,我们也可以利用 fastcgi_cache_valid 命令来缓存它,不过不是很建议这样做。fastcgi_cache_valid 命令的前几个参数是 HTTP 状态码,最后一个参数是要缓存的时间(秒),即表示要对 HTTP 状态码为前几个参数的回应做缓存。如果只有传入一个时间给 fastcgi_cache_valid 命令,则会套用给 200、301 和 302 状态码;如果状态码是传入 any,即代表所有状态码。例如:

http {
    fastcgi_cache_path /path/to/cache levels=1:2 keys_zone=my_cache:10m max_size=10g inactive=60m use_temp_path=off;
    fastcgi_cache_key $scheme$request_uri;

    server {
        index index.html index.php;

        location ~ \.php$ {
            fastcgi_cache_valid 200 60m;
            fastcgi_cache_min_uses 3;
            fastcgi_cache_use_stale error timeout invalid_header updating http_500 http_503;
            fastcgi_cache_background_update on;
            fastcgi_cache_revalidate on;
            fastcgi_cache my_cache;
            fastcgi_pass unix:/run/php/php7.4-fpm.sock;
            include fastcgi.conf;
        }
    }
}

若想控制激活缓存的时机以及刷新(refresh)缓存的时机,可以利用 fastcgi_cache_bypass 和 fastcgi_no_cache 命令。这两个命令都可以传入多个字符串,以空格隔开。若传入 fastcgi_cache_bypass 命令的字符串有至少一个不是空字符串 "" 或是 "0",则 Nginx 就不会使用缓存中的数据来回应,但还是会把新拿到的回应存入缓存中;若传入 fastcgi_no_cache 命令的字符串有至少一个不是空字符串 "" 或是 "0",Nginx 还是可以使用缓存中的数据来回应,但如果需要去向 FastCGI 服务拿新的回应,该回应就不会被存入缓存中。

如果要删除缓存,可以直接删除文件系统中,存放缓存数据的目录下的文件以及目录。举例来说,如果想删除所有缓存,可以运行以下指令(请小心使用,有误删到其它文件的危险性):

sudo sh -c 'rm -rf /path/to/cache/*'

如果是用 HTTP 标头字段的消息来辨识不同的客户端,就可能要改用如下的缓存键值设置(以 Authorization 标头来举例):

fastcgi_cache_key $scheme$request_uri$http_authorization;

套用 Nginx 的新设置

改写 Nginx 设置档并存盘后,新设置并不会立即套用给正在运行中的 Nginx 服务器。

要让 Nginx 服务器重新读取设置档,最好先用以下指令检查设置档是否无误,避免 Nginx 服务器因为设置档错误而中断服务。

sudo nginx -t

以 nginx -t 检查设置档

接着再运行以下指令来重新加载 Nginx 的设置档:

sudo nginx -s reload

以 nginx -s reload 重新加载设置