Ingress企業(yè)實戰(zhàn)：URL重寫與高級玩法
作者：船長
在Nginx、Apache等常見的Web服務(wù)器中，URL重寫可以通過正則表達式、規(guī)則匹配等方式來實現(xiàn)。具體的語法和方法會因服務(wù)器軟件的不同而有所不同。
什么是URL重寫
URL重寫（URL rewriting）是一種在Web服務(wù)器上修改或轉(zhuǎn)換請求URL的過程。它通常涉及使用服務(wù)器配置或規(guī)則來更改傳入的URL，以便在不改變實際請求資源的情況下，實現(xiàn)不同的行為，如重定向、路徑映射、參數(shù)處理等。URL重寫在服務(wù)器層面進行，因此客戶端（如瀏覽器）對于URL的請求不會感知到這些更改，但服務(wù)器會根據(jù)配置進行適當(dāng)?shù)奶幚?。URL重寫可以用于多種目的，例如：
- 重定向: 將一個URL重寫為另一個URL，實現(xiàn)301永久重定向或302臨時重定向。這可以用于更改站點結(jié)構(gòu)、修復(fù)錯誤的URL、實現(xiàn)SEO優(yōu)化等。
- 路徑映射: 將一個URL的路徑映射到另一個位置，這對于隱藏實際文件路徑或路徑重組很有用。
- 查詢參數(shù)處理: 在URL中添加、刪除或修改查詢參數(shù)，以適應(yīng)不同的應(yīng)用需求。
- 動態(tài)URL到靜態(tài)URL: 將動態(tài)生成的URL（帶有參數(shù)）轉(zhuǎn)化為靜態(tài)URL，更友好且易于索引。
- 隱藏技術(shù)細節(jié): 可以通過URL重寫隱藏后端服務(wù)器或應(yīng)用程序的實際技術(shù)細節(jié)，提高安全性。
在Nginx、Apache等常見的Web服務(wù)器中，URL重寫可以通過正則表達式、規(guī)則匹配等方式來實現(xiàn)。具體的語法和方法會因服務(wù)器軟件的不同而有所不同。通常，服務(wù)器配置文件中會有專門的部分用于配置URL重寫規(guī)則，例如在Nginx中是使用rewrite指令。URL重寫是一種強大的技術(shù)，但在使用時需要小心，確保配置正確以避免潛在的問題，例如無限循環(huán)重定向或錯誤的重寫規(guī)則可能導(dǎo)致網(wǎng)站不可用。
Ingress 內(nèi)置變量
內(nèi)置預(yù)定義變量即無需聲明就可以使用的變量，通常包括一個http請求或響應(yīng)中一部分內(nèi)容的值，以下為一些常用的內(nèi)置預(yù)定義變量：
變量名 定義
$arg_PARAMETER GET請求中變量名PARAMETER參數(shù)的值。
$args 這個變量等于GET請求中的參數(shù)。例如，foo=123&bar=blahblah;這個變量只可以被修改
$binary_remote_addr 二進制碼形式的客戶端地址。
$body_bytes_sent 傳送頁面的字節(jié)數(shù)
$content_length 請求頭中的Content-length字段。
$content_type 請求頭中的Content-Type字段。
$cookie_COOKIE cookie COOKIE的值。
$document_root 當(dāng)前請求在root指令中指定的值。
$document_uri 與$uri相同。
$host 請求中的主機頭(Host)字段，如果請求中的主機頭不可用或者空，則為處理請求的server名稱(處理請求的server的server_name指令的值)。值為小寫，不包含端口。
$hostname 機器名使用 gethostname系統(tǒng)調(diào)用的值
$http_HEADER HTTP請求頭中的內(nèi)容，HEADER為HTTP請求中的內(nèi)容轉(zhuǎn)為小寫，-變?yōu)開(破折號變?yōu)橄聞澗€)，例如：$http_user_agent(Uaer-Agent的值);
$http_user_agent ： 客戶端agent信息;
$http_cookie ： 客戶端cookie信息;
$sent_http_HEADER HTTP響應(yīng)頭中的內(nèi)容，HEADER為HTTP響應(yīng)中的內(nèi)容轉(zhuǎn)為小寫，-變?yōu)開(破折號變?yōu)橄聞澗€)，例如： $sent_http_cache_control, $sent_http_content_type…;
$is_args 如果$args設(shè)置，值為"?"，否則為""。
$limit_rate 這個變量可以限制連接速率。
$nginx_version 當(dāng)前運行的nginx版本號。
$query_string 與$args相同。
$remote_addr 客戶端的IP地址。
$remote_port 客戶端的端口。
$remote_user 已經(jīng)經(jīng)過Auth Basic Module驗證的用戶名。
$request_filename 當(dāng)前連接請求的文件路徑，由root或alias指令與URI請求生成。
$request_body 這個變量（0.7.58+）包含請求的主要信息。在使用proxy_pass或fastcgi_pass指令的location中比較有意義。
$request_body_file 客戶端請求主體信息的臨時文件名。
$request_completion 如果請求成功，設(shè)為"OK"；如果請求未完成或者不是一系列請求中最后一部分則設(shè)為空。
$request_method 這個變量是客戶端請求的動作，通常為GET或POST。包括0.8.20及之前的版本中，這個變量總為main request中的動作，如果當(dāng)前請求是一個子請求，并不使用這個當(dāng)前請求的動作。
$request_uri 這個變量等于包含一些客戶端請求參數(shù)的原始URI，它無法修改，請查看$uri更改或重寫URI,
包含請求參數(shù)的原始URI，不包含主機名，如：”/foo/bar.php?arg=baz”。
$scheme 所用的協(xié)議，比如http或者是https，比如rewrite ^(.+)$ $scheme://example.com$1 redirect;
$server_addr 服務(wù)器地址，在完成一次系統(tǒng)調(diào)用后可以確定這個值，如果要繞開系統(tǒng)調(diào)用，則必須在listen中指定地址并且使用bind參數(shù)。
$server_name 服務(wù)器名稱。
$server_port 請求到達服務(wù)器的端口號。
$server_protocol 請求使用的協(xié)議，通常是HTTP/1.0或HTTP/1.1。
$uri 請求中的當(dāng)前URI(不帶請求參數(shù)，參數(shù)位于args)，不同于瀏覽器傳遞的args)，不同于瀏覽器傳遞的args)，不同于瀏覽器傳遞的request_uri的值，它可以通過內(nèi)部重定向，或者使用index指令進行修改。uri不包含主機名，如”/foo/bar.html”。Ingress 正則表達式
正則表達式匹配，其中：
~ 為區(qū)分大小寫匹配
~* 為不區(qū)分大小寫匹配
!~和!~* 分別為區(qū)分大小寫不匹配及不區(qū)分大小寫不匹配
. 匹配除換行符以外的任意字符
\w 匹配字母或數(shù)字或下劃線或漢字
\s 匹配任意的空白符
\d 匹配數(shù)字
\b 匹配單詞的開始或結(jié)束
^ 匹配字符串的開始
$ 匹配字符串的結(jié)束
* 重復(fù)零次或更多次
+ 重復(fù)一次或更多次
? 重復(fù)零次或一次
{n} 重復(fù)n次
{n,} 重復(fù)n次或更多次
{n,m} 重復(fù)n到m次
*? 復(fù)任意次，但盡可能少重復(fù)
+? 重復(fù)1次或更多次，但盡可能少重復(fù)
?? 重復(fù)0次或1次，但盡可能少重復(fù)
{n,m}? 重復(fù)n到m次，但盡可能少重復(fù)
{n,}? 重復(fù)n次以上，但盡可能少重復(fù)
\W 匹配任意不是字母，數(shù)字，下劃線，漢字的字符
\S 匹配任意不是空白符的字符
\D 匹配任意非數(shù)字的字符
\B 匹配不是單詞開頭或結(jié)束的位置
[^x] 匹配除了x以外的任意字符
[^aeiou] 匹配除了aeiou這幾個字母以外的任意字符
(exp) 匹配exp,并捕獲文本到自動命名的組里
(?<name>exp) 匹配exp,并捕獲文本到名稱為name的組里，也可以寫成(?'name'exp)
(?:exp) 匹配exp,不捕獲匹配的文本，也不給此分組分配組號
(?=exp) 匹配exp前面的位置
(?<=exp) 匹配exp后面的位置
(?!exp) 匹配后面跟的不是exp的位置
(?<!exp) 匹配前面不是exp的位置
(?#comment) 注釋分組不對正則表達式的處理產(chǎn)生任何影響配置URL重寫規(guī)則
在某些應(yīng)用場景中，后端服務(wù)提供的URL與Ingress規(guī)則中執(zhí)行的路徑不同，而Ingress訪將訪問路徑直接轉(zhuǎn)發(fā)到后端相同路徑，如果不配置URL重寫規(guī)則，所有訪問都將返回404。比如如下案例，Ingress規(guī)則中配置的是/user/info，而后端服務(wù)提供的訪問路徑是/info,在不配置重寫的情況下，會直接轉(zhuǎn)發(fā)給后端/user/info與實際提供的訪問路徑/info不匹配，會直接返回404。接下來咱們用案例的方式進行驗證。
不配置URL重寫直接轉(zhuǎn)發(fā)：
$ cat ingress.yml
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
name: demo
spec:
rules:
- host: demo.kubesre.com
http:
paths:
- path: /
pathType: ImplementationSpecific
backend:
service:
name: demo-svc
port:
number: 8080
ingressClassName: nginx
$ kubectl apply -f ingress.yml
ingress.networking.k8s.io/demo configured訪問驗證(/user/info)：
# 訪問/user/info，可以看出直接返回404
$ curl http://demo.kubesre.com/user/info
404 page not found配置URL重寫：
$ cat ingress.yml
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
name: demo
annotations:
nginx.ingress.kubernetes.io/rewrite-target: /$2
spec:
rules:
- host: demo.kubesre.com
http:
paths:
- path: /user(/|$)(.*)
pathType: ImplementationSpecific
backend:
service:
name: demo-svc
port:
number: 8080
ingressClassName: nginx
$ kubectl apply -f ingress.yml
ingress.networking.k8s.io/demo configured訪問驗證(/user/info)：
# 訪問/user/info，可以看出直接正常返回了
$ curl http://demo.kubesre.com/user/info
{"message":"云原生運維圈！"}注解說明：
以上案例Ingress重寫是通過nginx.ingress.kubernetes.io/rewrite-target注解實現(xiàn)不同路徑的重寫規(guī)則。占位符$2表示將第二個括號即(.*)中匹配到的所有字符填寫到nginx.ingress.kubernetes.io/rewrite-target注解中。想必大家都知道Ingress是基于Nginx開發(fā)的，此時是通過Ingress CRD進行創(chuàng)建的重寫配置，其本質(zhì)也是修改Nginx配置文件的，此時從Ingress里的Nginx拷貝出來的配置如下：
server {
server_name demo.kubesre.com ;
listen 80 ;
listen [::]:80 ;
listen 443 ssl http2 ;
listen [::]:443 ssl http2 ;
set $proxy_upstream_name "-";
ssl_certificate_by_lua_block {
certificate.call()
}
location ~* "^/user(/|$)(.*)" {
set $namespace "default";
rewrite "(?i)/user(/|$)(.*)" /$2 break;
proxy_pass http://upstream_balancer;
proxy_redirect off;
}高級URL重寫規(guī)則
對于一些復(fù)雜的重寫規(guī)則需求，可以通過如下注解來實現(xiàn)，其本質(zhì)也是修改Nginx配置文件。
- nginx.ingress.kubernetes.io/server-snippet：在nginx.conf的“server”字段中添加自定義配置。
- nginx.ingress.kubernetes.io/configuration-snippet：在nginx.conf的“l(fā)ocation”字段中添加自定義配置。
URL重寫Flag參數(shù)：
- last：表示本條規(guī)則匹配完成后繼續(xù)向下匹配。
- break：表示本條規(guī)則匹配完成后停止匹配。
- redirect：表示臨時重定向，返回狀態(tài)碼302。
- permanent：表示永久重定向，返回狀態(tài)碼301。
重定向就是將網(wǎng)頁自動轉(zhuǎn)向重定向：
- 301永久性重定向：新網(wǎng)址完全繼承舊網(wǎng)址，舊網(wǎng)址的SEO網(wǎng)絡(luò)搜索引擎的排名等完全清零
- 301重定向是網(wǎng)頁更改地址后對搜索引擎友好的最好方法，只要不是暫時搬移的情況，都建議使用301來做轉(zhuǎn)址。
- 302臨時性重定向：對舊網(wǎng)址沒有影響，但新網(wǎng)址不會有排名
- 搜索引擎爬蟲會抓取新的內(nèi)容而保留舊的網(wǎng)址
配置Location：
通過Ingress注解nginx.ingress.kubernetes.io/server-snippet配置location，訪問/sre，返回401錯誤代碼，案例如下：
$ cat sre.yml
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
annotations:
nginx.ingress.kubernetes.io/server-snippet: |
location /sre {
return 401;
}
name: demo-redirect
spec:
rules:
- host: demo.kubesre.com
http:
paths:
- path: /
pathType: ImplementationSpecific
backend:
service:
name: demo-svc
port:
number: 8080
ingressClassName: nginx
$ kubectl apply -f 1.yml
ingress.networking.k8s.io/demo-redirect configured訪問驗證：
# 表示驗證成功
$ curl http://demo.kubesre.com/sre/
<html>
<head><title>401 Authorization Required</title></head>
<body>
<center><h1>401 Authorization Required</h1></center>
<hr><center>nginx</center>
</body>
</html>URL重定向（permanent）：
cat demo-permanent.yml
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
annotations:
nginx.ingress.kubernetes.io/configuration-snippet: |
rewrite ^/$ https://www.baidu.com redirect;
name: demo-redirect
spec:
rules:
- host: demo.kubesre.com
http:
paths:
- path: /
pathType: ImplementationSpecific
backend:
service:
name: demo-svc
port:
number: 8080
ingressClassName: nginx
$ kubectl apply -f demo-permanent.yml
ingress.networking.k8s.io/demo-permanent created訪問驗證：
# 301永久重定向，瀏覽器?地址欄會顯示跳轉(zhuǎn)后的URL地址,真實效果可以通過瀏覽器訪問測試驗證
$ curl http://demo.kubesre.com
<html>
<head><title>301 Moved Permanently</title></head>
<body>
<center><h1>301 Moved Permanently</h1></center>
<hr><center>nginx</center>
</body>
</html>URL重定向（redirect）：
通過URL重定向，訪問/test/info,直接重定向302跳轉(zhuǎn)到/user/info。
$ cat demo-redirect.yml
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
annotations:
nginx.ingress.kubernetes.io/configuration-snippet: |
rewrite ^/test/(.*)$ /user/$1 redirect;
name: demo-redirect
spec:
rules:
- host: demo.kubesre.com
http:
paths:
- path: /test
pathType: ImplementationSpecific
backend:
service:
name: demo-svc
port:
number: 8080
ingressClassName: nginx
$ kubectl apply -f demo-redirect.yml
ingress.networking.k8s.io/demo-redirect created訪問驗證：
# 302 說明已經(jīng)重定向了，實際效果可以通過瀏覽器訪問查看
$ curl http://demo.kubesre.com/test/info
<html>
<head><title>302 Found</title></head>
<body>
<center><h1>302 Found</h1></center>
<hr><center>nginx</center>
</body>
</html>URL重寫（last）：
通過URL重寫實現(xiàn)，訪問/sre,返回的是/kube的結(jié)果，可以利用重寫Flag last參數(shù)，當(dāng)URL重寫后，會發(fā)送一個新的請求，再次進入server塊，重試location匹配，匹配成功直接把結(jié)果直接返回。
$ cat sre.yml
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
annotations:
nginx.ingress.kubernetes.io/configuration-snippet: |
rewrite ^/sre /kube last;
nginx.ingress.kubernetes.io/server-snippet: |
location /sre {
return 401;
}
location /kube {
return 403;
}
name: demo-redirect
spec:
rules:
- host: demo.kubesre.com
http:
paths:
- path: /sre
pathType: ImplementationSpecific
backend:
service:
name: demo-svc
port:
number: 8080
ingressClassName: nginx
$ kubectl apply -f sre.yml
ingress.networking.k8s.io/demo-redirect configured訪問驗證：
# 訪問/sre，則返回/kube結(jié)果403
$ curl http://demo.kubesre.com/sre/
<html>
<head><title>403 Forbidden</title></head>
<body>
<center><h1>403 Forbidden</h1></center>
<hr><center>nginx</center>
</body>總結(jié)
本文介紹了URL重寫的概念，并通過實際案例的方式講解了URL重寫的方方面面，下一章將講解Ingress更多企業(yè)級實戰(zhàn)，請敬請期待！
責(zé)任編輯：武曉燕
來源：
云原生運維圈
