URL重寫是基於一個或多個預置規則修改請求URL的行爲。URL重寫在資源位置和訪問地址之間創建了一種抽象,這樣二者之間就減少了緊密的聯繫。URL重寫有多種適用的場景:
•臨時或永久移動或替換服務器資源,同時爲這些資源保持穩定的訪問
•爲不同應用程序或同一個應用程序的不同區域的拆分請求處理
•根據請求移除、添加、重新組織URL段(segment)
•SEO優化
•允許使用友好的公共URL來幫助人們通過鏈接預測找到內容
•將不安全的請求重定向到安全端點
•圖片防盜鏈
可以通過多種方式定義改變URL的規則,包括正則表達式、Apache mod_rewrite模塊規則、IIS重寫模塊規則和自定義規則邏輯。本文介紹URL重寫及說明如何在ASP.NET Core應用中使用URL重寫中間件。
注意:URL重寫可能會降低應用的性能,您應該儘可能的限制規則的數量和規則的複雜性。
URL重定向和URL重寫
從字面意思上看URL重定向和URL重寫的差異並不明顯,但二者在提供資源給客戶端方面都有重要意義。ASP.NET Core的URL重寫中間件能夠同時滿足二者的需求。URL重定向是客戶端操作,指示客戶端在另一個地址訪問資源,需要額外往返服務器。當客戶端對資源發出請求時,返回到客戶端的重定向URL將顯示在瀏覽器的地址欄中。例如/resource被重定向到/different-resource時:客戶端請求/resource,服務端響應客戶端應在/different-resource獲取資源,其響應的狀態碼會指示重定向是臨時的還是永久的,然後客戶端會向/different-resource發送一個新請求獲取資源。
將請求重定向到其他URL時,可以指定重定向是永久還是臨時。301(Moved Permanently)狀態代碼用於表明資源具有新的永久URL,並且希望客戶端將來對該資源的所有請求都應使用新URL。當收到301狀態碼時客戶端可以緩存響應。302(Found)狀態碼用於臨時重定向,所以客戶端不應該存儲和重用該URL。狀態碼的含義請參考這裏。URL重寫是服務器端操作,用於從不同的資源地址提供資源。URL重寫不需要額外的往返服務器,並且重寫後的URL不會返回給客戶端,也不會出現在客戶端的地址欄中。當/resource被重寫爲/different-resource時:客戶端請求/resource,服務端在內部從/different-resource獲取資源並響應給客戶端。儘管客戶端也許可以從重寫後的URL處獲取資源,但客戶端並不會收到資源存在於重寫後URL的通知。
何時使用URL重寫中間件
當無法在Windows Server上使用IIS重寫模塊、Apache服務器上的Apache mod_rewrite模塊、Nginx上的URL重寫或應用程序託管在HTTP.sys服務器(以前稱爲WebListener)上時,請使用URL重寫中間件。推薦在IIS,Apache或Nginx中使用基於服務器的URL重寫技術的主要原因是中間件不支持這些模塊的全部功能,並且中間件的性能可能無法達到這些模塊的性能。但是,這些服務器重寫模塊的某些功能不適用於ASP.NET Core項目,例如IIS Rewrite模塊的IsFile和IsDirectory。在這些情況下,請改用中間件。
包引用
要在項目中使用URL重寫中間件,請添加Microsoft.AspNetCore.Rewrite包的引用。該功能適用於ASP.NET Core 1.1或更高版本的應用程序。
配置重寫及重定向規則
通過RewriteOptions類實例的擴展方法來建立URL重寫和重定向規則,按照你希望處理的順序將這些規則鏈接起來,然後通過使用app.UseRewriter(options)將URL重寫選項傳遞到請求管道,以下是幾種重寫、重定向的配置代碼,後面會針對每種配置單獨解釋:
public void Configure(IApplicationBuilder app)
{
using (StreamReader apacheModRewriteStreamReader =
File.OpenText("ApacheModRewrite.txt"))
using (StreamReader iisUrlRewriteStreamReader =
File.OpenText("IISUrlRewrite.xml"))
{
var options = new RewriteOptions()
.AddRedirect("redirect-rule/(.*)", "redirected/$1")
.AddRewrite(@"^rewrite-rule/(\d+)/(\d+)", "rewritten?var1=$1&var2=$2",
skipRemainingRules: true)
.AddApacheModRewrite(apacheModRewriteStreamReader)
.AddIISUrlRewrite(iisUrlRewriteStreamReader)
.Add(MethodRules.RedirectXMLRequests)
.Add(new RedirectImageRequests(".png", "/png-images"))
.Add(new RedirectImageRequests(".jpg", "/jpg-images"));
app.UseRewriter(options);
}
app.Run(context => context.Response.WriteAsync(
$"Rewritten or Redirected Url: " +
$"{context.Request.Path + context.Request.QueryString}"));
}
URL重定向
使用AddRedirect方法重定向請求,第一個參數爲匹配請求URL的正則表達式,第二個參數爲替換的文本,第三個參數(如果存在)指定狀態碼,如果未指定狀態碼,默認爲302(Found)。
public void Configure(IApplicationBuilder app)
{
var options = new RewriteOptions()
.AddRedirect("redirect-rule/(.*)", "redirected/$1");
app.UseRewriter(options);
}
打開瀏覽器的開發者工具,向/redirect-rule/1234/5678發送一個請求。重定向規則中的正則表達式將匹配請求路徑,將路徑替換爲/redirected/1234/5678,服務端將重定向URL和302(Found)狀態代碼發送回客戶端。客戶端基於該URL發送新請求並將該URL顯示到地址欄中,然後客戶端收到一個200(OK)的響應。
警告:新建重定向規則時一定要謹慎,重定向規則將會對應用每一個請求都進行匹配,包括重定向後的URL。所以很容易不小心創建一個無限重定向循環。
發送一個請求:/redirect-rule/1234/5678,響應如下圖:
重定向規則中正則表達式括號內的部分稱爲捕獲組,表達式中點(.)的含義是匹配任何字符,星號()表示匹配之前的字符零次或者多次。因此,URL中最後兩段/123/5678被(.)捕獲組所捕獲,URL中位於redirect-rule/之後的任何值都將會被該組捕獲。
在替換字符串中,捕獲組將捕獲的內容注入到($n)符號所在位置,其中$後的數字n代表捕獲的序列號。第一個捕獲組是$1,第二個是$2,以此類推。在上面的例子中,重定向規則中的正則表達式只有一個捕獲組,所以替換字符串中只有一個$1,最終/redirect-rule/1234/5678被替換爲/redirect-rule/1234/5678。
URL重定向到安全站點
可使用AddRedirectToHttps方法將不安全的請求重定向到具有安全HTTPS協議的同一主機和路徑,如果未提供狀態碼參數,中間件將使用默認值302(Found)。如果未提供端口號參數,中間件使用默認值null,這意味着客戶端將使用https協議同時從443端口訪問資源,下面的代碼片段演示如何將重定向狀態碼設爲301(Moved Permanently),同時將端口設爲5001:
public void Configure(IApplicationBuilder app)
{
var options = new RewriteOptions().AddRedirectToHttps(301, 5001);
app.UseRewriter(options);
}
也可以使用AddRedirectToHttpsPermanent方法將不安全的請求重定向到具有安全HTTPS協議的同一主機和路徑(端口443上的https://)。中間件將響應狀態碼設置爲301(Moved Permanently)。
public void Configure(IApplicationBuilder app)
{
var options = new RewriteOptions().AddRedirectToHttpsPermanent();
app.UseRewriter(options);
}
注意:在不需要其他重定向規則的情況下重定向到HTTPS時,建議使用HTTPS重定向中間件。請參考這裏
URL重寫
可使用AddRewrite方法創建重寫規則,第一個參數爲匹配請求URL的正則表達式,第二個參數是替換字符串,第三個參數skipRemainingRules: {true|false},表示如果當前規則生效是否要跳過其它的重寫規則。
public void Configure(IApplicationBuilder app)
{
var options = new RewriteOptions()
.AddRewrite(@"^rewrite-rule/(\d+)/(\d+)", "rewritten?var1=$1&var2=$2", skipRemainingRules: true);
app.UseRewriter(options);
}
}
發送一個請求:/rewrite-rule/1234/5678,重定向請求及響應如下圖:
我們注意到正則表達式開頭是字符^,它的含義是匹配需要從URL路徑的開頭開始。在之前重定向例子中,正則表達式的開頭並沒有字符^,因此,路徑中redirect-rule/之前的任何字符都可以成功匹配。
路徑
是否匹配
/redirect-rule/1234/5678
是
/my-cool-redirect-rule/1234/5678
是
/anotherredirect-rule/1234/5678
是
在重寫規則中,正則表達式^rewrite-rule/(\d+)/(\d+)僅匹配以rewrite-rule/開頭的路徑,請注意二者之間的區別:
路徑
是否匹配
/rewrite-rule/1234/5678
是
/my-cool-rewrite-rule/1234/5678
否
/anotherrewrite-rule/1234/5678
否
在正則表達式^rewrite-rule/(\d+)/(\d+)中有兩個捕獲組:(\d+)/(\d+),\d表示匹配一個數字,加號(+)表示匹配之前的字符1次或者多次。因此,匹配的URL必須包含一個數字,後跟一個正斜槓,後跟另一個數字。捕獲的內容將會被分別注入到重寫字符串中的$1和$2位置。所以請求URL/rewrite-rule/1234/5678將會被重寫爲/rewritten?var1=1234&var2=5678。如果原始請求中存在查詢字符串,則在重寫URL時會保留該查詢字符串。URL重寫不會有額外的服務器往返。如果資源存在,服務端獲取資源內容並返回給客戶端200(OK)狀態碼。因爲客戶端沒有被重定向,所以瀏覽器地址欄中的地址不會改變。就客戶端而言,是感知不到URL重寫的。
注意:儘可能使用skipRemainingRules:true參數,因爲匹配規則是一個昂貴的過程並增加了應用程序響應時間。爲了更快的響應,請考慮以下建議:
•將重寫規則排序:從最常匹配的規則到最不常匹配的規則
•規則匹配成功之後跳過剩餘的規則
使用Apache mod_rewrite規則
使用AddApacheModRewrite方法應用Apache mod_rewrite規則,請確保規則文件已隨應用程序部署至服務器。瞭解更多關於Apache mod_rewrite規則,請參考這裏
public void Configure(IApplicationBuilder app)
{ //StreamReader用於從ApacheModRewrite.txt規則文件中讀取規則。
using (StreamReader apacheModRewriteStreamReader =
File.OpenText("ApacheModRewrite.txt"))
{
var options = new RewriteOptions()
.AddApacheModRewrite(apacheModRewriteStreamReader);
app.UseRewriter(options);
}
}
以下爲ApacheModRewrite.txt的內容:
Rewrite path with additional sub directory
RewriteRule ^/apache-mod-rules-redirect/(.) /redirected?id=$1 [L,R=302]
示例應用程序將來自/apache-mod-rules-redirect/(.\)的請求重定向到/redirected?id=$1,響應碼爲302(Found)。
中間件支持以下Apache mod_rewrite服務器變量:
•CONN_REMOTE_ADDR
•HTTP_ACCEPT
•HTTP_CONNECTION
•HTTP_COOKIE
•HTTP_FORWARDED
•HTTP_HOST
•HTTP_REFERER
•HTTP_USER_AGENT
•HTTPS
•IPV6
•QUERY_STRING
•REMOTE_ADDR
•REMOTE_PORT
•REQUEST_FILENAME
•REQUEST_METHOD
•REQUEST_SCHEME
•REQUEST_URI
•SCRIPT_FILENAME
•SERVER_ADDR
•SERVER_PORT
•SERVER_PROTOCOL
•TIME
•TIME_DAY
•TIME_HOUR
•TIME_MIN
•TIME_MON
•TIME_SEC
•TIME_WDAY
•TIME_YEAR
使用IIS URL重寫模塊規則
使用AddIISUrlRewrite方法應用IIS URL重寫規則,請確保規則文件已隨應用程序部署至服務器。在Windows Server IIS上運行時,不要讓中間件直接使用web.config文件,規格文件應該存儲於web.config之外,以避免和IIS重寫模塊衝突。瞭解更多關於IIS重寫模塊的規則,請參考這裏和這裏。
public void Configure(IApplicationBuilder app)
{ //StreamReader用於從IISUrlRewrite.xml規則文件中讀取規則
using (StreamReader iisUrlRewriteStreamReader =
File.OpenText("IISUrlRewrite.xml"))
{
var options = new RewriteOptions()
.AddIISUrlRewrite(iisUrlRewriteStreamReader);
app.UseRewriter(options);
}
}
以下爲IISUrlRewrite.xml的內容:
<rewrite>
<rules>
<rule name="Rewrite segment to id querystring" stopProcessing="true">
<match url="^iis-rules-rewrite/(.*)$" />
<action type="Rewrite" url="rewritten?id={R:1}" appendQueryString="false"/>
</rule>
</rules>
</rewrite>
示例應用程序將來自/iis-rules-rewrite/(.*)的請求重寫爲/rewritten?id=$1,響應碼爲200(OK)。
ASP.NET Core 2.x發佈的中間件不支持以下IIS URL重寫模塊功能:
•Outbound Rules
•Custom Server Variables
•Wildcards
•LogRewrittenUrl
中間件支持以下IIS URL重寫模塊服務器變量:
•CONTENT_LENGTH
•CONTENT_TYPE
•HTTP_ACCEPT
•HTTP_CONNECTION
•HTTP_COOKIE
•HTTP_HOST
•HTTP_REFERER
•HTTP_URL
•HTTP_USER_AGENT
•HTTPS
•LOCAL_ADDR
•QUERY_STRING
•REMOTE_ADDR
•REMOTE_PORT
•REQUEST_FILENAME
•REQUEST_URI
注意:可以通過PhysicalFileProvider類獲取IFileProvider。這種方法可以爲重寫規則文件的位置提供更大的靈活性。
PhysicalFileProvider fileProvider = new PhysicalFileProvider(Directory.GetCurrentDirectory());
基於方法的規則
使用Add(Action<RewriteContext> applyRule)在方法中實現自己的規則邏輯,RewriteContext公開HttpContext以方便在方法中使用,而context.Result決定了如何進行後續的管道處理。如下表:
context.Result
行爲
RuleResult.ContinueRules(默認行爲)
繼續應用後續規則
RuleResult.EndResponse
停止應用規則併發送響應
RuleResult.SkipRemainingRules
停止應用規則併發送上下文(HttpContext)至下箇中間件
public void Configure(IApplicationBuilder app)
{
var options = new RewriteOptions()
.Add(MethodRules.RedirectXMLRequests);
app.UseRewriter(options);
}
//自定義的規則方法
public static void RedirectXMLRequests(RewriteContext context)
{
var request = context.HttpContext.Request;
// Because we're redirecting back to the same app, stop
// processing if the request has already been redirected
if (request.Path.StartsWithSegments(new PathString("/xmlfiles")))
{
return;
}
if (request.Path.Value.EndsWith(".xml", StringComparison.OrdinalIgnoreCase))
{
var response = context.HttpContext.Response;
response.StatusCode = StatusCodes.Status301MovedPermanently;
context.Result = RuleResult.EndResponse;
response.Headers[HeaderNames.Location] =
"/xmlfiles" + request.Path + request.QueryString;
}
}
示例應用程序演示了將.xml結尾的請求路徑重定向的自定義邏輯方法。如果對/file.xml發出請求,則會將其重定向到/xmlfiles/file.xml。響應碼被設置爲301 (Moved Permanently)。對於重定向來說,你必須顯式指定響應的狀態碼,否則響應碼將被默認爲200(OK)且客戶端也不會發生重定向。
發送一個請求:/file.xml,響應如下圖:
基於IRule接口的規則
使用Add(IRule)在從IRule派生的類中實現您自己的規則邏輯。使用IRule的方式比使用基於方法的規則方法具有更好的靈活性,派生類可以包含構造函數,您可以在其中傳遞ApplyRule方法的參數。
public void Configure(IApplicationBuilder app)
{
var options = new RewriteOptions()
.Add(new RedirectImageRequests(".jpg", "/jpg-images"));
app.UseRewriter(options);
}
public class RedirectImageRequests : IRule
{
private readonly string _extension;
private readonly PathString _newPath;
public RedirectImageRequests(string extension, string newPath)
{
//此處省略了參數校驗
_extension = extension;
_newPath = new PathString(newPath);
}
public void ApplyRule(RewriteContext context)
{
var request = context.HttpContext.Request;
if (request.Path.StartsWithSegments(new PathString(_newPath)))
{
return;
}
if (request.Path.Value.EndsWith(_extension, StringComparison.OrdinalIgnoreCase))
{
var response = context.HttpContext.Response;
response.StatusCode = StatusCodes.Status301MovedPermanently;
context.Result = RuleResult.EndResponse;
response.Headers[HeaderNames.Location] =
_newPath + request.Path + request.QueryString;
}
}
}
發送一個請求:/image.png,響應內容如下: