Nginx 实现会话保持的方式配置小结

在 NGINX 中实现会话保持（Session Persistence），可以通过多种方法完成。以下是一些常见的方式：

1. 使用 IP 哈希（IP Hash）

IP 哈希是一种简单的负载均衡策略，它基于客户端的 IP 地址将请求分配到同一个后端服务器。该方法适合基本的会话保持场景。

配置示例：

upstream backend {    ip_hash;  # 使用 IP 哈希来实现会话保持    server backend1.example.com;    server backend2.example.com;}server {    listen 80;    server_name example.com;    location / {        proxy_pass http://backend;    }}

这种方式比较简单，但如果客户端的 IP 发生变化，会话保持就会失效（例如，移动客户端切换网络）。

2. 基于 Cookie 的会话保持

NGINX 可以通过设置一个特定的 Cookie 来实现会话保持，客户端的请求将基于 Cookie 被路由到同一台后端服务器。

配置示例：

upstream backend {    server backend1.example.com;    server backend2.example.com;    sticky cookie srv_id expires=1h;  # 基于 Cookie 实现会话保持}server {    listen 80;    server_name example.com;    location / {        proxy_pass http://backend;    }}

在这个示例中，`sticky cookie srv_id expires=1h;` 会为客户端设置一个名为 `srv_id` 的 Cookie，并且该 Cookie 的有效期为 1 小时。当客户端发起请求时，它会带上这个 Cookie，NGINX 将根据 Cookie 将请求路由到正确的服务器。

3. 基于 URL 参数的会话保持

如果应用程序能够在 URL 中传递某种标识符，NGINX 也可以基于 URL 参数实现会话保持。配置示例：

upstream backend {    server backend1.example.com;    server backend2.example.com;    sticky route $arg_session_id;  # 基于 URL 参数实现会话保持}server {    listen 80;    server_name example.com;    location / {        proxy_pass http://backend;    }}

在这个示例中，NGINX 使用 `$arg_session_id` 来决定请求应该路由到哪一台后端服务器。需要确保应用程序在 URL 中正确地传递 `session_id` 参数。

4. 基于 Session Sticky 模块

如果需要更加灵活的会话保持配置，你可以使用第三方的 `nginx-sticky-module` 模块（需要手动编译 NGINX 支持此模块）。

配置示例：

upstream backend {    sticky;  # 使用 sticky 模块    server backend1.example.com;    server backend2.example.com;}server {    listen 80;    server_name example.com;    location / {        proxy_pass http://backend;    }}

这需要额外安装模块，可以提供更丰富的会话保持功能，如基于 Cookie 或其他自定义规则。

具体实现

基于 `nginx-sticky-module` 模块实现会话保持需要先编译并安装该模块，然后配置 NGINX 使用它。以下是详细的实现步骤，包括模块的安装和配置过程。

 1. 安装 NGINX Sticky 模块

Step 1: 下载并编译 NGINX 源码和 Sticky 模块

要安装 `nginx-sticky-module`，需要重新编译 NGINX 并加入该模块。以下是基于 Linux 的示例：

- 首先，安装必要的依赖：

sudo apt-get updatesudo apt-get install build-essential libpcre3 libpcre3-dev zlib1g zlib1g-dev libssl-dev

- 下载 NGINX 源码（可根据需要下载你所用的版本）：

cd /usr/local/srcwget http://nginx.org/download/nginx-1.24.0.tar.gz   版本号可以根据需要调整tar -zxvf nginx-1.24.0.tar.gzcd nginx-1.24.0

- 下载 `nginx-sticky-module` 模块：

git clone https://bitbucket.org/nginx-goodies/nginx-sticky-module-ng.git

Step 2: 编译并安装 NGINX

在编译 NGINX 时，指定模块路径，将 `sticky-module` 添加到 NGINX 中：

- 检查当前 NGINX 的编译参数（如果 NGINX 已经安装）：

nginx -V

- 进入 NGINX 源码目录，编译并安装 NGINX：

./configure --with-http_ssl_module --add-module=/usr/local/src/nginx-sticky-module-ng   根据路径调整makesudo make install

- 验证 NGINX 是否正确编译和安装：

/usr/local/nginx/sbin/nginx -v

 2. 配置 NGINX 使用 Sticky 模块

`nginx-sticky-module` 安装好后，你就可以使用它来实现会话保持。

 配置示例：

upstream backend {    sticky;    server backend1.example.com;    server backend2.example.com;    server backend3.example.com;}server {    listen 80;    server_name example.com;    location / {        proxy_pass http://backend;    }}

- `sticky`：此指令开启会话保持，模块会自动为每个客户端生成一个基于 Cookie 的哈希值，并将请求路由到同一台服务器。

该配置基于 `nginx-sticky-module`，它会为客户端设置一个名为 `route` 的 Cookie，后续请求将通过该 Cookie 进行会话保持。

 3. Sticky 指令的更多配置选项

`nginx-sticky-module` 支持多种配置参数，可以根据需求进行调整。常用选项如下：

- `sticky name=cookiename expires=1h domain=.example.com path=/`:
  - `name`: 指定 Cookie 名字，默认为 `route`。
  - `expires`: Cookie 的过期时间，例如 `1h` 表示 1 小时。
  - `domain`: 指定 Cookie 作用的域名。
  - `path`: 指定 Cookie 的路径。 配置示例：

upstream backend {    sticky name=sessionid expires=2h domain=.example.com path=/;    server backend1.example.com;    server backend2.example.com;    server backend3.example.com;}server {    listen 80;    server_name example.com;    location / {        proxy_pass http://backend;    }}

此配置将创建一个名为 `sessionid` 的 Cookie，Cookie 的有效期为 2 小时，且适用于 `.example.com` 域名下的所有路径。

 4. 验证 Sticky 会话保持

- 启动 NGINX 服务：

sudo /usr/local/nginx/sbin/nginx

- 测试配置是否生效：可以通过浏览器或 curl 工具测试，观察是否客户端的后续请求会被路由到同一台服务器。

curl -I http://example.com

5. 常见问题排查

- 模块安装失败：确保 NGINX 是通过源码编译的，并且在编译时指定了 `--add-module` 参数。如果 NGINX 是通过包管理器安装的，可能需要先卸载再重新编译。
- NGINX 无法启动：确保所有 NGINX 配置文件语法正确，可以使用以下命令检查配置：

sudo /usr/local/nginx/sbin/nginx -t

总结

- IP Hash：适合简单场景，但对网络变化敏感。
- Cookie：最常用、灵活，适合大部分会话保持需求。
- URL 参数：适合特定业务场景，例如 URL 中带有用户标识符。
- 第三方模块：适用于需要更多控制或特殊功能的场景。