Welcome to YARP - 5.压缩、缓存
目錄
Welcome to YARP - 1.認識YARP并搭建反向代理服務
Welcome to YARP - 2.配置功能
- 2.1 - 配置文件（Configuration Files）
- 2.2 - 配置提供者（Configuration Providers）
- 2.3 - 配置過濾器（Configuration Filters）
Welcome to YARP - 3.負載均衡
Welcome to YARP - 4.限流
Welcome to YARP - 5.身份驗證和授權
Welcome to YARP - 6.壓縮、緩存
Welcome to YARP - 7.健康檢查
Welcome to YARP - 8.分布式跟蹤
介紹
網關的 緩存和 壓縮是常見的性能優化手段 ，用于提高系統的響應速度和降低網絡傳輸的開銷。
YARP 的 緩存 和 壓縮 其實也是 .NET 本身的功能。只需要配置 .NET 本身的緩存和壓縮功能即可。
緩存
緩存的主要目的是優化性能、提高效率，減少對后端服務的負擔。 我們可以對
頻繁請求的靜態數據或不經常更改的數據 進行 API 緩存，從而降低對后端服務的請求次數，提高響應速度，減輕后端服務的負載。
也可以對 靜態資源 緩存 如：css、js、圖像等，從而 加速頁面加載速度，減輕服務器壓力，提高用戶體驗。 等等。
基于 HTTP 的響應緩存
用于緩存的主 HTTP 標頭是 Cache-Control，它用于指定緩存指令。 當請求從客戶端到達服務器以及響應從服務器返回客戶端時，這些指令控制緩存行為。 請求和響應在代理服務器之間移動，并且代理服務器還必須符合 HTTP 1.1 緩存規范。
Cache-Control通用消息頭字段，被用于在 http 請求和響應中，通過指定指令來實現緩存機制。緩存指令是單向的，這意味著在請求中設置的指令，不一定被包含在響應中。要使用緩存，請求頭中必須攜帶
Cache-Control標頭。同時響應頭中也要做相應的設置。
下表中顯示了常用 Cache-Control 指令
| 指令 | 操作 |
|---|---|
| public | 緩存可以存儲響應。 |
| private | 響應不得由共享緩存存儲。 專用緩存可以存儲和重用響應。 |
| max-age | 客戶端不接受期限大于指定秒數的響應。 示例：max-age=60（60 秒），max-age=2592000（1 個月） |
| no-cache | 請求時：緩存不能使用存儲的響應來滿足請求。 源服務器重新生成客戶端的響應，中間件更新其緩存中存儲的響應。 響應時：響應不得用于未經源服務器驗證的后續請求。 |
| no-store | 請求時：緩存不得存儲請求。 響應時：緩存不得存儲任何部分的響應。 |
相應的我們也要添加響應緩存中間件：
若要測試響應緩存，請使用 Fiddler、Postman 或其他可以顯式設置請求標頭的工具。顯式設置上述的請求標頭。
配置中間件
在 中 Program.cs ，將響應緩存中間件服務 AddResponseCaching 添加到服務集合中，并將應用配置為將中間件與 UseResponseCaching 擴展方法一起使用。 UseResponseCaching 將中間件添加到請求處理管道中：
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddReverseProxy()//添加ReverseProxy相關服務到DI
.LoadFromConfig(builder.Configuration.GetSection("ReverseProxy"));//從配置文件中加載ReverseProxy的設置
builder.Services.AddResponseCaching(options =>
{
options.UseCaseSensitivePaths = false; //確定是否將響應緩存在區分大小寫的路徑上。
options.SizeLimit = options.SizeLimit * 10; // 響應緩存中間件的大小限制（以字節為單位） 1G
});
var app = builder.Build();
if (app.Environment.IsDevelopment())
{
app.UseSwagger();
app.UseSwaggerUI();
}
// 使用 CORS 中間件時，必須在 UseResponseCaching 之前調用 UseCors。
// app.UseCors();
app.UseRouting();
// 攔截請求并判斷 請求頭中是否包含 CacheControl 標頭，如果沒有則加上緩存標頭
app.Use(async (context, next) =>
{
var header = context.Request.Headers;
var cacheControl = header.CacheControl;
if (!string.IsNullOrEmpty(header.CacheControl))
{
header.CacheControl = new Microsoft.Extensions.Primitives.StringValues("max-age");
}
await next(context);
});
app.UseResponseCaching();
app.Use(async (context, next) =>
{
context.Response.GetTypedHeaders().CacheControl =
new Microsoft.Net.Http.Headers.CacheControlHeaderValue()
{
Public = true,
MaxAge = TimeSpan.FromSeconds(10)
};
context.Response.Headers[Microsoft.Net.Http.Headers.HeaderNames.Vary] = new string[] { "Accept-Encoding" };
await next(context);
});
app.MapReverseProxy();
app.MapGet("/", () => DateTime.Now.ToLongTimeString());
app.Run();
以上示例中：
- Cache-Control：緩存可緩存響應長達10秒。
- Vary：將中間件配置為僅當后續請求的 Accept-Encoding 標頭與原始請求頭匹配時才提供緩存的響應。
app.Use(async (context, next) =>
{
var header = context.Request.Headers;
var cacheControl = header.CacheControl;
if (!string.IsNullOrEmpty(header.CacheControl))
{
header.CacheControl = new Microsoft.Extensions.Primitives.StringValues("max-age");
}await next(context);});
可以看到我們先設置了 請求頭的 緩存標頭，如果 沒有此 設置，幾乎所有瀏覽器（標頭值）都會發送 CacheControl：no-cache 或其他值，強制執行非緩存頁面請求，這會導致 ResponseCachingMiddleware 實現忽略此請求（忽略緩存）并將其傳遞到服務器以檢索數據。 如果你用 postman 或者 fiddle則可以主動這只CacheControl標頭值為上述說的那幾種。
上述示例中我們先 添加了 YARP 服務，然后添加了 AddResponseCaching 響應的緩存服務，然后攔截了請求并設置緩存標頭，再開啟了 UseResponseCaching() 響應緩存中間件。接下來設置了 [響應頭的標頭值]( ASP.NET Core 中的響應緩存中間件 | Microsoft Learn )，最后開啟了 代理 中間件。源碼已上傳GitHub.
壓縮
網絡帶寬是一種有限資源。 減小響應大小通常可顯著提高應用的響應速度。 減小有效負載大小的一種方式是壓縮應用的響應。 但是 YARP 默認是禁用解壓縮的，因為它會增加 CPU 開銷。
什么時候使用 響應壓縮 中間件？
在 IIS、Apache 或 Nginx 中使用基于服務器的響應壓縮技術。
- IIS 動態壓縮模塊
- Apache mod_deflate 模塊
- Nginx 壓縮和解壓縮
而 HTTP.sys 服務器和 Kestrel 服務器當前不提供內置壓縮支持，這時候就需要使用響應壓縮中間件了。
我們使用 YARP 的直接轉發來 演示一下 壓縮功能，當然壓縮是 .NET 本身自帶的功能，你也可以通過添加壓縮中間件來開啟響應壓縮。
代碼示例：
using System.Diagnostics;
using System.Net;
using Yarp.ReverseProxy.Forwarder;
using Yarp.ReverseProxy.Transforms;
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddHttpForwarder();
// Add services to the container.
var app = builder.Build();
// Configure our own HttpMessageInvoker for outbound calls for proxy operations
var httpClient = new HttpMessageInvoker(new SocketsHttpHandler()
{
UseProxy = false,
AllowAutoRedirect = false,
AutomaticDecompression = DecompressionMethods.GZip, // 設置響應壓縮方式
UseCookies = false,
ActivityHeadersPropagator = new ReverseProxyPropagator(DistributedContextPropagator.Current),
ConnectTimeout = TimeSpan.FromSeconds(15),
});
// Setup our own request transform class
var transformer = new CustomTransformer(); // or HttpTransformer.Default;
var requestConfig = new ForwarderRequestConfig { ActivityTimeout = TimeSpan.FromSeconds(100) };
app.UseRouting();
// Configure the HTTP request pipeline.
app.MapForwarder("/{**catch-all}", "http://localhost:5047", requestConfig, transformer, httpClient);
app.Run();
/// <summary>
/// 自定義請求轉換
/// </summary>
class CustomTransformer : HttpTransformer
{
///<summary>
/// A callback that is invoked prior to sending the proxied request. All HttpRequestMessage
/// fields are initialized except RequestUri, which will be initialized after the
/// callback if no value is provided. The string parameter represents the destination
/// URI prefix that should be used when constructing the RequestUri. The headers
/// are copied by the base implementation, excluding some protocol headers like HTTP/2
/// pseudo headers (":authority").
///</summary>
///<param name="httpContext">傳入請求</param>
///<param name="proxyRequest">傳出的代理請求</param>
///<param name="destinationPrefix">所選目標服務器的uri前綴，可用于創建RequestUri</param>
public override async ValueTask TransformRequestAsync(HttpContext httpContext, HttpRequestMessage proxyRequest, string destinationPrefix, CancellationToken cancellationToken)
{
// 轉發所有頭部信息
await base.TransformRequestAsync(httpContext, proxyRequest, destinationPrefix, cancellationToken);
// 自定義查詢query 值
var queryContext = new QueryTransformContext(httpContext.Request);
queryContext.Collection.Remove("param1");
queryContext.Collection["s"] = "xx2";
// 分配自定義 URI。在此處連接時請注意額外的斜杠。RequestUtilities.MakeDestinationAddress 是一個安全的默認值。
proxyRequest.RequestUri = RequestUtilities.MakeDestinationAddress("http://localhost:5047", httpContext.Request.Path, queryContext.QueryString);
// 禁止原始請求標頭，使用目標 Uri 中的標頭
proxyRequest.Headers.Host = null;
}
}
上述示例中，我們使用了 YARP 的直接轉發模式，不需要添加 YARP 服務和中間件，但是要添加 這個東西 AddHttpForwarder，然后配置 自定義請求轉換 類。并開啟 壓縮模式為 GZip。
如果想看效果記得使用fiddle 抓取請求的返回值查看原始請求，因為postman和瀏覽器客戶端 都會默認對常用的壓縮格式的數據進行解壓縮。
如果服務器本身支持壓縮，請使用 基于服務器的壓縮技術。而 HTTP.sys 服務器和 Kestrel 服務器 是不支持壓縮技術的，所以這時候才考慮使用 壓縮中間件。
總結
本章我們介紹了 YARP 的緩存和壓縮功能，其實也都是 .NET 自身的功能，如果了解使用過 .NET的 緩存 和 壓縮 中間件很容易就能理解。本章示例代碼已上傳GitHub，建議把代碼down下來自己實驗一下，再去配合理解。
有什么問題歡迎留言交流。
下篇文章我們繼續介紹 YARP 的健康檢查功能。
總結
以上是生活随笔為你收集整理的Welcome to YARP - 5.压缩、缓存的全部內容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： 开发现代化的.NetCore控制台程序：
- 下一篇： GitHub 官方开源的字体集「GitH