Nginx 重定向时获取域名

TL;DR

如果你在处理 Nginx 重定向时要获取原请求的域名（比如 HTTP 到 HTTPS），请用 $host 而不是 $server_name 。

问题和解决方案

今天碰到一个问题，服务器上一个子域名的请求重定向到另一个子域名上面去了。查了一段时间发现这个问题只有在 HTTP 到 HTTPS 跳转的时候才会发生。大概是这样：

从 HTTP 的 sub2 子域名跳转到 HTTPS 的 sub1 子域名
http://sub2.example.com/more_things -> https://sub1.example.com/more_things

我用的 Nginx ，当初为了让 HTTP 请求跳转到同名的 HTTPS 请求，配置如下：

http {
  server {
    listen       80;
    server_name  sub1.example.com sub2.example.com;
    return       301 https://$server_name$request_uri;
  }

  server {
    listen       443 ssl spdy;
    server_name  sub1.example.com sub2.example.com;
    # ...
  }
}

因为 301 是永久重定向，某些浏览器的缓存会记住重定向，下次访问原地址就会直接向新地址发请求，所以这个问题在浏览器里面不一定重现得了（包括 Chrome 的 Incognito Window），能每次完整重现的方式只有 curl 。

$ curl -I http://sub2.example.com/

HTTP/1.1 301 Moved Permanently
Server: nginx/1.9.3 (Ubuntu)
Date: Tue, 23 Feb 2016 06:06:30 GMT
Content-Type: text/html
Content-Length: 193
Connection: keep-alive
Location: https://sub1.example.com/

查了一下，发现问题出在 $server_name 变量上。这个变量会始终返回 server_name 中第一个名字。这里其实应该用 $host 变量。修改后的配置如下：

http {
  server {
    listen       80;
    server_name  sub1.example.com sub2.example.com;
    return       301 https://$host$request_uri;
  }
}

$host 变量会按照以下优先级获取域名：

1. Request-Line 中的域名信息。Request-Line 包含 method, uri 和 HTTP 版本。

2. 请求头信息中的 "Host" 。

3. Nginx 中匹配的 server_name 配置。

这几乎可以保证在任何环境下正确地得到域名。如果是同域名下的重定向最好都用 $host 。

参考资料

Nginx Wiki - $host
Nginx 官方文档。其中对 $host 讲的比较详细，但 $server_name 只是一笔带过。

StackOverflow - What is the difference between Nginx variables $host, $http_host, and $server_name?
StackOverflow 上关于三个变量区别的讨论。里面提到了为什么 $host 是适用于所有场景的唯一选择。

HTTP/1.1 : Request-Line
HTTP/1.1 规范中对 Request-Line 的描述。