Nginx学习：HTTP核心模块（四）错误页面与跳转

最最核心的部分学习完了，但其实还有更多的内容要等待着我们探索。今天我们先来看到的就是关于错误页面的设置以及 301、302 跳转相关的内容。这两块内容都有一个特点，那就是页面或明显地，或不明显地产生了跳转变化，显示的都不是本来我们应该要得到的那个链接的页面。

error_page

这个指令应该是比较常见了吧，为指定错误定义显示的URI。

error_page code ... [=[response]] uri;

当前配置级别没有 error_page 指令时，将从上层配置继承， URI 可以包含变量。一般对于错误页面，我们想要友好提示，都会准备一些静态或动态页面，比如说网上有包含很多设计元素的 404 页面模板。code 可以设置多个，=response 可以修改返回的响应码，最后的 uri 就是我们要最终显示哪个 uri 页面。先来看看默认的 Nginx 错误页面的配置是啥样的吧。

#error_page  404              /404.html;

error_page   500 502 503 504  /50x.html;
location = /50x.html {
  root   html;
}

刚安装完的自带的 Server 中，默认的 error_page 就是这两个配置，404 是被注释起来的。而 500 提供了一个 50x.html 在默认的 html 目录下。我们直接来访问试下，先访问一个不存在的静态页面。

然后再访问一个会报 500 错误的 php 页面。这个 PHP 代码就不粘出来了，就是 thorw new Exception(); 抛出了一个异常。

需要注意的是一点是，在访问 php 页面时，需要配置 php 中的参数，保证 fastcgi_intercept_errors是 on 的，否则 Nginx 不会处理 php 的错误信息。

location ~ \.php$ {
  root html;

  fastcgi_pass unix:/var/sock/php-fpm/www.sock;
  fastcgi_index  index.php;
  fastcgi_param  SCRIPT_FILENAME  $document_root$fastcgi_script_name;

  include        fastcgi_params;
  fastcgi_intercept_errors on;  # 需要这个保持 on 状态
}

看出来了吧，默认情况下 404 确实是没有页面的，而 500 页面也走的是 html 目录下的那个 50x.html 。现在我们来配置几个页面。

// 404.html
this is 404 page.

// 404.php
<?php
echo "php 404";

// 50x.php
<?php
echo "php 50x";

普通配置

默认全局的 404 我们就直接打开原始配置中的 404 注释的部分就好了。现在访问之前的那个不存在的 URL 就会看到已经走到我们新建的那个 404.html 页面了。

error_page 是有层级的，前面已经说过了，现在我们在一个 location 中配置一个 404 的 error_page ，那么访问这个 location 就会走这里的 error_page 设置。

location /errtest1/ {
  error_page 404 /404.php;
}

上面的配置可以让 /errortest1 这个路径的访问返回的是 404.php 的错误展示页面。

跳转配置

跳转配置指的是可以跳转到指定的页面，在这里我们会用到 =response 参数。

location /errtest2/ {
  error_page 404 @notfound;
}

location /errtest3/ {
  error_page 404 =301 http://www.baidu.com;
}

location @notfound {
  return 301 /index.html;
}

访问 /errtest2/ 会打开首页，这里还使用到了 location 的命名路径功能。另外一个 /errtest3/ 则会直接 301 跳转到百度的首页。这两个就不截图了，大家可以自己试下哦。

PHP配置

对于 PHP 来说，其实也就是在 location 中配置 error_page 的效果，在这里我们将 500 系列的指向了 50x.php 文件，404 指向了 404.php 文件。特别注意的就是 fastcgi_intercept_errors 需要开启，这个前面已经说过了。

location ~ \.php$ {
  root html;

  error_page 500 501 502 503 /50x.php;
  error_page 404 =200 /404.php;
  fastcgi_pass unix:/var/sock/php-fpm/www.sock;
  fastcgi_index  index.php;
  fastcgi_param  SCRIPT_FILENAME  $document_root$fastcgi_script_name;
  include        fastcgi_params;
  fastcgi_intercept_errors on;
}

另外，只要 location 中有一个 error_page 了，那么外层的 error_page 就不管用了。什么意思呢？把上面 404 的注释掉，然后再次访问一个不存在的 php 页面，得到的结果是这样的。

这是由 fastcgi 接管的 404 报错页面，会显示 File not found. （如果没有开启 fastcgi_intercept_errors 的话，也会一直显示这个）

连续报错测试

连续报错是指假设我们指定的报错 URI 也不存在，会产生什么效果呢？这时，Nginx 会以最后获得的状态码为准。还是拿 404 来测试。

error_page  404              /404444.html;

我们将全局的 404 报错页面修改为一个不存在的文件，那么最后返回的错误页面又会变成最前面我们看到的那个 Nginx 默认的 404 页面。

如果不修改全局的，只是修改 /errtest1/ 的配置，那么最终也会显示这个 Nginx 默认的 404 错误页面，这个大家可以自己尝试一下哦。

跳转重定向

这里所说的跳转，主要指的就是 301 或者 302 的跳转。HTTP 的基础就不多说了，这个 301、302 也不算特别偏门的知识，这里的配置主要影响的就是在 301 或者 302 时返回的响应头中，Location 的变化情况。跳转相关的配置项都可以用于 http、server、location 各个模块中。

absolute_redirect

第一个配置指令。

absolute_redirect on | off;

它可以作用于 http，server，location 模块， 默认值是 on ，如果禁用的话，Nginx 发出的重定向将是相对的。这是啥意思呢？其实就是相对路径和绝对路径的问题。我们先随便设置一个 301 跳转的路径。

// nginx.conf http..server...
location /t {
    return 301 /index.html;
}

上面的配置是在默认的那个 server 下面添加的一个 location ，然后直接 return 返回一个 301 跳转页面，其实就是直接又跳回首页了。现在我们可以使用浏览器或者 Postman 进行测试，主要就是看访问这个 /t 路径时，返回的响应头中的 Location 属性。默认情况，它是这样的。

// 访问 http://192.168.56.88/t
Location: http://192.168.56.88/index.html

没啥问题吧，接下来将 absolute_redirect 修改成 off 。

// nginx.conf http
absolute_redirect off;

我们直接在 http 下面配置指这个令，然后 reload 重载配置，之后再次去访问 /t 路径。

// 访问 http://192.168.56.88/t
Location: /index.html

看出来不同了吧，现在 Location 返回的结果没有了前面的 Host 信息，就是我们在 return 中定义的那个相对路径了。

这个指令出现在 1.11.8 版本，和它一起打配合的还有后面两个指令，另外还需要注意的一点是，如果我们重定向本身就是带有 Host 信息的，比如：

return 301 http://192.168.56.88/index.html

那么这几个配置指令就没啥效果了，因为我们已经写死了固定的跳转绝对路径。

server_name_in_redirect

这个配置指令是用于确定要不要用 server_name 来做为跳转时的 Host 部分。

server_name_in_redirect on | off;

啥意思呢？首先，默认值是 off ，在默认的情况下，Nginx 会以请求头中的 Host 字段为基础，其实就是我们访问 URL 的 HOST 部分啦。这样在跳转链接的时候，如果 absolute_redirect 是 on，并且  return中也不是绝对路径的话，就会自动将 HOST 添加上，组成完整的 URL 。

如果将它配置成 on ，那么就会忽略请求头中的 Host ，而是直接使用当前 server 下面的 server_name 这个配置属性。

// nginx.conf http...server...
server_name  localhost;

在测试环境中，默认的那个 server 配置的 server_name 的值是 localhost 。然后，我们将 server_name_in_redirect 设置为 on ，接下来 reload 配置再次进行测试。

// 访问 http://192.168.56.88/t
Location: http://localhost/index.html

看出来效果了吧，不管你请求是 IP ，还是指定一个域名或者怎么样，它始终会返回 server_name 定义的内容，那么如果有多个 server_name 呢？

// nginx.conf http...server...
server_name  core.nginx.test localhost

// 访问 http://192.168.56.88/t
Location: http://core.nginx.test/index.html

它返回的是第一个 server_name 的值。

port_in_redirect

从名字就能看出，这个配置应该是和端口有关系，它是控制重定向跳转时带不带上原来的端口。

port_in_redirect on | off;

默认值是 on ，表示请求过来的是哪个端口，跳转时也带上哪个端口。在测试时，我们先给 server 添加一个监听的端口，比如加一个 8080 ，然后正常访问 8080 端口的链接。（默认 80 端口的看不出效果，因为 80 端口会直接省略掉）

// 访问 http://192.168.56.88:8080/t
Location: http://192.168.56.88:8080/index.html

然后，我们将这个配置项设置成 off 。再次请求。

// 访问 http://192.168.56.88:8080/t
Location: http://192.168.56.88/index.html

看出来效果了吧，这回转发就没有带上端口了，直接走默认的 80 端口了。

总结

今天的内容不难，也不复杂，和前面两篇比起来简直太轻松了吧。而且，error_page 和 return 跳转这种操作也是非常基本的操作。不少的同学也早就已经用过了，而且可能比我知道的还要更多。因此，也就不多献丑了，先了解，再深入，更多好玩的用法和配置还等着我们继续学习呢！

参考文档：

http://nginx.org/en/docs/http/ngx_http_core_module.html