Nginx

目录

• rewrite
  • 地址重写 & 地址转发
  • Set 指令
    • Rewrite常用全局变量
  • if 指令
  • break 指令
  • return 指令
  • rewrite 指令
  • rewrite_log 指令
• rewrite 范例
  • 域名跳转
  • 域名镜像
  • 独立域名
  • 目录自动添加 "/"
  • 合并目录
  • 防盗链

---

Rewrite 主要的作用是用来实现URL的重写。

Rewrite 是Nginx服务器提供的一个重要基本功能，是Web服务器产品中几乎必备的功能。

Nginx 服务器的Rewrite功能的实现依赖于PCRE的支持，因此在编译安装Nginx服务器之前，需要安装PCRE库。Nginx使用的是ngx_http_rewrite_module模块来解析和处理Rewrite功能的相关配置。

rewrite

地址重写 & 地址转发

# 重写和转发的区别:
- 地址重写浏览器地址会发生变化而地址转发则不变。

- 一次地址重写会产生两次请求而一次地址转发只会产生一次请求。

- 地址重写到的页面必须是一个完整的路径而地址转发则不需要。

- 地址重写因为是两次请求所以request范围内属性不能传递给新页面而地址转发因为是一次请求所以可以传递值。
- 地址转发速度快于地址重写。

Set 指令

set指令: 该指令用来设置一个新的变量。

语法	set $variable value;
默认值	—
位置	server、location、if

variable: 变量的名称，该变量名称要用"$"作为变量的第一个字符，且不能与Nginx服务器预设的全局变量同名。

value: 变量的值，可以是字符串、其他变量或者变量的组合等。

Rewrite常用全局变量

变量	说明
$args	变量中存放了请求URL中的请求指令。比如http://192.168.200.133:8080?arg1=value1&args2=value2中的"arg1=value1&arg2=value2"，功能和$query_string一样
$http_user_agent	变量存储的是用户访问服务的代理信息(如果通过浏览器访问，记录的是浏览器的相关版本信息)
$host	变量存储的是访问服务器的server_name值
$document_uri	变量存储的是当前访问地址的URI。比如http://192.168.200.133/server?id=10&name=zhangsan中的"/server"，功能和$uri一样
$document_root	变量存储的是当前请求对应location的root值，如果未设置，默认指向Nginx自带html目录所在位置
$content_length	变量存储的是请求头中的Content-Length的值
$content_type	变量存储的是请求头中的Content-Type的值
$http_cookie	变量存储的是客户端的cookie信息，可以通过add_header Set-Cookie 'cookieName=cookieValue'来添加cookie数据
$limit_rate	变量中存储的是Nginx服务器对网络连接速率的限制，也就是Nginx配置中对limit_rate指令设置的值，默认是0，不限制。
$remote_addr	变量中存储的是客户端的IP地址
$remote_port	变量中存储了客户端与服务端建立连接的端口号
$remote_user	变量中存储了客户端的用户名，需要有认证模块才能获取
$scheme	变量中存储了访问协议
$server_addr	变量中存储了服务端的地址
$server_name	变量中存储了客户端请求到达的服务器的名称
$server_port	变量中存储了客户端请求到达服务器的端口号
$server_protocol	变量中存储了客户端请求协议的版本，比如"HTTP/1.1"
$request_body_file	变量中存储了发给后端服务器的本地文件资源的名称
$request_method	变量中存储了客户端的请求方式，比如"GET","POST"等
$request_filename	变量中存储了当前请求的资源文件的路径名
$request_uri	变量中存储了当前请求的URI，并且携带请求参数，比如http://192.168.200.133/server?id=10&name=zhangsan中的"/server?id=10&name=zhangsan"

if 指令

if: 该指令用来支持条件判断，并根据条件判断结果选择不同的Nginx配置。

语法	if (condition){...}
默认值	—
位置	server、location

condition为判定条件，可以支持以下写法。

• 变量名

- 如果变量名对应的值为空或者是0，if都判断为false,其他条件为true。
if ($param){
	
}

• = 和 !=

- 使用"="和"!="比较变量和字符串是否相等，满足条件为true，不满足为false
if ($request_method = POST){ # 若请求方式为 POST 则返回405
	return 405;
}

• 正则表达式

- 使用正则表达式对变量进行匹配，匹配成功返回true，否则返回false。变量与正则表达式之间使用"~","~*","!~","!~*"来连接。

"~"代表匹配正则表达式过程中区分大小写，

"~*"代表匹配正则表达式过程中不区分大小写

"!~"和"!~*"刚好和上面取相反值，如果匹配上返回false,匹配不上返回true

if ($http_user_agent ~ MSIE){
	#$http_user_agent的值中是否包含MSIE字符串，如果包含返回true
}

• 判断请求的文件是否存在使用"-f"和"!-f"

- 当使用"-f"时，如果请求的文件存在返回true，不存在返回false。

- 当使用"!f"时，如果请求文件不存在，但该文件所在目录存在返回true,文件和目录都不存在返回false,如果文件存在返回false。

if (-f $request_filename){
	#判断请求的文件是否存在
}
if (!-f $request_filename){
	#判断请求的文件是否不存在
}

• 判断请求的目录是否存在使用"-d"和"!-d"

• 判断请求的目录或者文件是否存在使用"-e"和"!-e"

• 判断请求的文件是否可执行使用"-x"和"!-x"

• 注意事项:

(1). if (param) if 和 (param)之间有一个空格。

(2). 和Java不太一样的地方是字符串不需要添加引号。

(3). 正则表达式字符串一般不需要加引号，但是如果字符串中包含"}"或者是";"等字符时，就需要把引号加上。

break 指令

break: 该指令用于中断当前相同作用域中的其他Nginx配置。与该指令处于同一作用域的Nginx配置中，位于它前面的指令配置生效，位于后面的指令配置无效

语法	break;
默认值	—
位置	server、location、if

nginx.conf

location /{
	if ($param){
		set $id $1;
		break;
		limit_rate 10k;
	}
}

return 指令

return: 该指令用于完成对请求的处理，直接向客户端返回响应状态代码。在return后的所有Nginx配置都是无效的。

语法	return code [text]; return code URL; return URL;
默认值	—
位置	server、location、if

code: 为返回给客户端的HTTP状态代理。可以返回的状态代码为0~999的任意HTTP状态代理。

text: 为返回给客户端的响应体内容，支持变量的使用。

URL: 为返回给客户端的URL地址。

rewrite 指令

rewrite: 该指令通过正则表达式的使用来改变URI。可以同时存在一个或者多个指令，按照顺序依次对URL进行匹配和处理。

URL 和 URI

URI: 统一资源标识符
URL: 统一资源定位符

语法	rewrite regex replacement [flag];
默认值	—
位置	server、location、if

regex: 用来匹配URI的正则表达式

replacement: 匹配成功后，用于替换URI中被截取内容的字符串。如果该字符串是以"http://"或者"https://"开头的，则不会继续向下对URI进行其他处理，而是直接返回重写后的URI给客户端。

flag: 用来设置rewrite对URI的处理行为，可选值有如下：

- last

- break

- redirect

- permanent

rewrite_log 指令

rewrite_log: 该指令配置是否开启URL重写日志的输出功能。

语法	rewrite_log on|off;
默认值	rewrite_log off;
位置	http、server、location、if

开启后，URL重写的相关日志将以notice级别输出到error_log指令配置的日志文件汇总。

rewrite 范例

域名跳转

• 需求分析

如果我们想访问京东网站，大家都知道我们可以输入www.jd.com,但是同样的我们也可以输入www.360buy.com同样也都能访问到京东网站。这个其实是因为京东刚开始的时候域名就是www.360buy.com，后面由于各种原因把自己的域名换成了www.jd.com, 虽然说域名变量，但是对于以前只记住了www.360buy.com的用户来说，我们如何把这部分用户也迁移到我们新域名的访问上来，针对于这个问题，我们就可以使用Nginx中Rewrite的域名跳转来解决。

• 域名跳转

两个域名 www.hosystem.com | www.hos.com | www.hosys.com

# 1. 修改 Hosts 文件
$ vi /etc/hosts
127.0.0.1 www.hosystem.com
127.0.0.1 www.hosys.com
127.0.0.1 www.hos.com

nginx.conf

    server{
        listen 80;
        server_name www.hosystem.com;
        location /{
            default_type text/html;
            return 200 '<h1>welcome to hosystem!</h1>';
        }
    }

    server{
        listen 80;
        # 访问 hos.com 或 hosys.com 都自动跳转到 hosystem.com 上
        server_name www.hos.com www.hosys.com;
        rewrite ^/ http://www.hosystem.com;
    }

• 域名跳转 - 携带请求URI

server {
	listen 80;
	server_name www.hos.com www.hosys.com;
	rewrite ^(.*) http://www.hosystem.com$1 permanent;
}

域名镜像

• 需求分析

镜像网站指定是将一个完全相同的网站分别放置到几台服务器上，并分别使用独立的URL进行访问。其中一台服务器上的网站叫主站，其他的为镜像网站。镜像网站和主站没有太大的区别，可以把镜像网站理解为主站的一个备份节点。可以通过镜像网站提供网站在不同地区的响应速度。镜像网站可以平衡网站的流量负载、可以解决网络宽带限制、封锁等。

域名跳转中，将www.hos.com和www.hosys.com 都能跳转到 www.hosystem.com，那么www.hosystem.com我们就可以把它起名叫主域名，其他两个就是我们所说的镜像域名，当然如果我们不想把整个网站做镜像，只想为其中某一个子目录下的资源做镜像，我们可以在location块中配置rewrite功能，比如:

nginx.conf

server {
	listen 80;
	server_name www.hos.com www.hosys.com;
    location /user {
    	rewrite ^/user(.*)$ http://www.hosystem.com$1;
    }
    location /emp{
        default_type text/html;
        return 200 '<h1>emp_success</h1>';
    }
}

独立域名

• 需求分析

一个完整的项目包含多个模块，比如购物网站有商品搜索模块、商品详情模块和购物车模块等，何为每一个模块设置独立的域名。

http://search.hosystem.com:81  访问商品搜索模块
http://item.hosystem.com:82	  访问商品详情模块
http://cart.hosystem.com:83	  访问商品购物车模块

nginx.conf

server{
	listen 81;
	server_name search.hosystem.com;
	rewrite ^(.*) http://www.hosystem.com/search$1;
}
server{
	listen 82;
	server_name item.hosystem.com;
	rewrite ^(.*) http://www.hosystem.com/item$1;
}
server{
	listen 83;
	server_name cart.hosystem.com;
	rewrite ^(.*) http://www.hosystem.com/cart$1;
}

目录自动添加 "/"

• 需求分析

访问路径最后有无斜杠是否有区别？

nginx.conf

server {
	listen	8082;
	server_name localhost;
	location /hos {
		root html;
		index index.html;
	}
}

# 先访问localhost:8082/hos 再创建 index.html 然后进行访问 查看两者区别
mkdir -p /usr/local/nginx/html/hos
echo '<h1>welcome to hos!</h1>' > index.html

通过http://192.168.200.133:8082/hos 和 通过http://192.168.200.133:8082/hos/访问的区别？

如果不加斜杠，Nginx服务器内部会自动做一个301的重定向，重定向的地址会有一个指令叫server_name_in_redirect on|off;来决定重定向的地址：

如果该指令为on
	重定向的地址为:  http://server_name:8082/目录名/;
	http://localhost:8082/hos/
如果该指令为off
	重定向的地址为:  http://原URL中的域名:8082/目录名/;
	http://192.168.200.133:8082/hos/

http://192.168.200.133:8082/hos如果不加斜杠，那么按照上述规则，如果指令server_name_in_redirect为on，则301重定向地址变为 http://localhost:8082/hos/;如果为off，则301重定向地址变为http://192.168.200.133:8082/hos/。后面这个是正常的，前面地址就有问题。

Nginx 补充知识

server_name_in_redirect指令在Nginx的0.8.48版本之前默认都是on，之后改成了off,所以现在我们这个版本不需要考虑这个问题，但是如果是0.8.48以前的版本并且server_name_in_redirect设置为on，通过rewrite来解决这个问题。

# 使用rewrite功能为末尾没有斜杠的URL自动添加一个斜杠
server {
	listen	80;
	server_name localhost;
	server_name_in_redirect on;
	location /hos {
		# 若访问的资源时一个目录 则后面需要加'/' 若访问的资源时一个文件 则后面不需要加'/'
		if (-d $request_filename){
			rewrite ^/(.*)([^/])$ http://$host/$1$2/ permanent;
		}
	}
}

# 老版本
server {
	listen	80;
	server_name localhost;
	server_name_in_redirect on;
	location /hos {
		# 若访问的资源时一个目录 则后面需要加'/' 若访问的资源时一个文件 则后面不需要加'/'
		if (-d $request_filename){
			rewrite ^/(.*)([^/])$ http://$host:$server_port$1$2/ permanent;
		}
	}
}

合并目录

• 需求分析

搜索引擎优化(SEO)是一种利用搜索引擎的搜索规则来提高目的网站在有关搜索引擎内排名的方式。我们在创建自己的站点时，可以通过很多中方式来有效的提供搜索引擎优化的程度。其中有一项就包含URL的目录层级一般不要超过三层，否则的话不利于搜索引擎的搜索也给客户端的输入带来了负担，但是将所有的文件放在一个目录下又会导致文件资源管理混乱并且访问文件的速度也会随着文件增多而慢下来，这两个问题是相互矛盾的，使用rewrite如何解决上述问题。

问题

网站中有一个资源文件的访问路径时 /server/11/22/33/44/20.html,也就是说20.html存在于第5级目录下，如果想要访问该资源文件，客户端的URL地址就要写成 http://192.168.200.133/server/11/22/33/44/20.html。

server {
	listen 8083;
	server_name localhost;
	location /server{
		root html;
	}
}

# 创建20.html
$ cd /usr/local/nginx/html
$ mkdir -p ./server/11/22/33/44
$ echo '<h1>welcome to 20.html</h1>' > ./server/11/22/33/44/20.html

解决

使用rewrite进行配置。

server {
	listen 8083;
	server_name localhost;
	location /server{
		rewrite ^/server-([0-9]+)-([0-9]+)-([0-9]+)-([0-9]+).html$ /server/$1/$2/$3/$4/$5.html last;
	}
}

客户端只需要输入http://www.web.name/server-11-22-33-44-20.html就可以访问到20.html页面了。这里也充分利用了rewrite指令支持正则表达式的特性。

防盗链

• 需求分析

在rewrite中的防盗链和之前将的原理其实都是一样的，只不过通过rewrite可以将防盗链的功能进行完善下，当出现防盗链的情况，使用rewrite将请求转发到自定义的一张图片和页面，给用户比较好的提示信息。

nginx.conf

location /images {
    root html;
    valid_referers none blocked www.baidu.com;
    if ($invalid_referer){
        #return 403;
        rewrite ^/    /images/forbidden.png break;
    }
}