前言
ASP.NET Core中有很多RateLimit元件，.NET 7甚至推出了官方版本。不過這些元件的主要目標是限制客戶端訪問服務的頻率，在HTTP伺服器崩潰前主動拒絕部分請求。如果請求沒有被拒絕服務會盡可能呼叫資源儘快處理。
現在有一個問題，有什麼辦法限制響應的傳送速率嗎？這在一些需要長時間傳輸流式資料的情況時很有用，避免少量請求耗盡網路頻寬，儘可能同時服務更多請求。
Tip
本文節選自我的新書《C#與.NET6 開發從入門到實踐》12.11 流量控制。實現方式偏向知識講解和教學，不保證元件穩定性，不建議直接在產品中使用。有關新書的更多介紹歡迎檢視《C#與.NET6 開發從入門到實踐》預售，作者親自來打廣告了！
正文
用過百度網盤的人應該都深有體會，如果沒有會員，下載速度會非常慢。實現這種效果的方法有兩種：控制TCP協議的滑動視窗大小；控制響應流的寫入大小和頻率。偏向系統底層的流量控制軟體因為無法干涉軟體中的流，所以一般會直接控制核心TCP協議的滑動視窗大小；而下載軟體等客戶端應用通常直接控制流的寫入和讀取，此時TCP協議的擁塞控制演算法會自動調整滑動視窗大小。這種流量控制對提供大型多媒體資源的應用（例如線上影片網站）非常重要，能防止一個請求的響應占用太多頻寬影響其他請求的響應傳送。
ASP.NET Core並沒有原生提供相關功能，Nuget上也沒有找到相關的程式包（截止截稿）。但其實利用ASP.NET Core提供的介面，是可以實現這個功能的。筆者以ASP.NET Core的響應壓縮中介軟體為藍本，實現了一個簡單的響應限流中介軟體。
編寫節流元件
支援限速的基礎流
using System;
namespace AccessControlElementary;
/// <summary>
/// 支援流量控制的流
/// </summary>
public class ThrottlingStream : Stream
{
/// <summary>
/// 用於指定每秒可傳輸的無限位元組數的常數。
/// </summary>
public const long Infinite = 0;
#region Private members
/// <summary>
/// 基礎流
/// </summary>
private readonly Stream _baseStream;
/// <summary>
/// 每秒可透過基礎流傳輸的最大位元組數。
/// </summary>
private long _maximumBytesPerSecond;
/// <summary>
/// 自上次限制以來已傳輸的位元組數。
/// </summary>
private long _byteCount;
/// <summary>
/// 最後一次限制的開始時間（毫秒）。
/// </summary>
private long _start;
#endregion
#region Properties
/// <summary>
/// 獲取當前毫秒數。
/// </summary>
/// <value>當前毫秒數。</value>
protected long CurrentMilliseconds => Environment.TickCount;
/// <summary>
/// 獲取或設定每秒可透過基礎流傳輸的最大位元組數。
/// </summary>
/// <value>每秒最大位元組數。</value>
public long MaximumBytesPerSecond
{
get => _maximumBytesPerSecond;
set
{
if (MaximumBytesPerSecond != value)
{
_maximumBytesPerSecond = value;
Reset();
}
}
}
/// <summary>
/// 獲取一個值，該值指示當前流是否支援讀取。
/// </summary>
/// <returns>如果流支援讀取，則為true；否則為false。</returns>
public override bool CanRead => _baseStream.CanRead;
/// <summary>
/// 獲取估算的流當前的位元率（單位：bps）。
/// </summary>
public long CurrentBitsPerSecond { get; protected set; }
/// <summary>
/// 獲取一個值，該值指示當前流是否支援定位。
/// </summary>
/// <value></value>
/// <returns>如果流支援定位，則為true；否則為false。</returns>
public override bool CanSeek => _baseStream.CanSeek;
/// <summary>
/// 獲取一個值，該值指示當前流是否支援寫入。
/// </summary>
/// <value></value>
/// <returns>如果流支援寫入，則為true；否則為false。</returns>
public override bool CanWrite => _baseStream.CanWrite;
/// <summary>
/// 獲取流的長度（以位元組為單位）。
/// </summary>
/// <value></value>
/// <returns>一個long值，表示流的長度（位元組）。</returns>
/// <exception cref="T:System.NotSupportedException">基礎流不支援定位。</exception>
/// <exception cref="T:System.ObjectDisposedException">方法在流關閉後被呼叫。</exception>
public override long Length => _baseStream.Length;
/// <summary>
/// 獲取或設定當前流中的位置。
/// </summary>
/// <value></value>
/// <returns>流中的當前位置。</returns>
/// <exception cref="T:System.IO.IOException">發生I/O錯誤。</exception>
/// <exception cref="T:System.NotSupportedException">基礎流不支援定位。</exception>
/// <exception cref="T:System.ObjectDisposedException">方法在流關閉後被呼叫。</exception>
public override long Position
{
get => _baseStream.Position;
set => _baseStream.Position = value;
}
#endregion
#region Ctor
/// <summary>
/// 使用每秒可傳輸無限位元組數的常數初始化 <see cref="T:ThrottlingStream"/> 類的新例項。
/// </summary>
/// <param name="baseStream">基礎流。</param>
public ThrottlingStream(Stream baseStream)
: this(baseStream, Infinite) { }
/// <summary>
/// 初始化 <see cref="T:ThrottlingStream"/> 類的新例項。
/// </summary>
/// <param name="baseStream">基礎流。</param>
/// <param name="maximumBytesPerSecond">每秒可透過基礎流傳輸的最大位元組數。</param>
/// <exception cref="ArgumentNullException">當 <see cref="baseStream"/> 是null引用時丟擲。</exception>
/// <exception cref="ArgumentOutOfRangeException">當 <see cref="maximumBytesPerSecond"/> 是負數時丟擲.</exception>
public ThrottlingStream(Stream baseStream, long maximumBytesPerSecond)
{
if (maximumBytesPerSecond < 0)
{
throw new ArgumentOutOfRangeException(nameof(maximumBytesPerSecond),
maximumBytesPerSecond, "The maximum number of bytes per second can't be negatie.");
}
_baseStream = baseStream ?? throw new ArgumentNullException(nameof(baseStream));
_maximumBytesPerSecond = maximumBytesPerSecond;
_start = CurrentMilliseconds;
_byteCount = 0;
}
#endregion
#region Public methods
/// <summary>
/// 清除此流的所有緩衝區，並將所有緩衝資料寫入基礎裝置。
/// </summary>
/// <exception cref="T:System.IO.IOException">發生I/O錯誤。</exception>
public override void Flush() => _baseStream.Flush();
/// <summary>
/// 清除此流的所有緩衝區，並將所有緩衝資料寫入基礎裝置。
/// </summary>
/// <exception cref="T:System.IO.IOException">發生I/O錯誤。</exception>
public override Task FlushAsync(CancellationToken cancellationToken) => _baseStream.FlushAsync(cancellationToken);
/// <summary>
/// 從當前流中讀取位元組序列，並將流中的位置前進讀取的位元組數。
/// </summary>
/// <param name="buffer">位元組陣列。當此方法返回時，緩衝區包含指定的位元組陣列，其值介於offset和（offset+count-1）之間，由從當前源讀取的位元組替換。</param>
/// <param name="offset">緩衝區中從零開始的位元組偏移量，開始儲存從當前流中讀取的資料。</param>
/// <param name="count">從當前流中讀取的最大位元組數。</param>
/// <returns>
/// 讀入緩衝區的位元組總數。如果許多位元組當前不可用，則該值可以小於請求的位元組數；如果已到達流的結尾，則該值可以小於零（0）。
/// </returns>
/// <exception cref="T:System.ArgumentException">偏移量和計數之和大於緩衝區長度。</exception>
/// <exception cref="T:System.ObjectDisposedException">方法在流關閉後被呼叫。</exception>
/// <exception cref="T:System.NotSupportedException">基礎流不支援讀取。 </exception>
/// <exception cref="T:System.ArgumentNullException">緩衝區為null。</exception>
/// <exception cref="T:System.IO.IOException">發生I/O錯誤。</exception>
/// <exception cref="T:System.ArgumentOutOfRangeException">偏移量或讀取的最大位元組數為負。</exception>
public override int Read(byte[] buffer, int offset, int count)
{
Throttle(count);
return _baseStream.Read(buffer, offset, count);
}
/// <summary>
/// 從當前流中讀取位元組序列，並將流中的位置前進讀取的位元組數。
/// </summary>
/// <param name="buffer">位元組陣列。當此方法返回時，緩衝區包含指定的位元組陣列，其值介於offset和（offset+count-1）之間，由從當前源讀取的位元組替換。</param>
/// <param name="offset">緩衝區中從零開始的位元組偏移量，開始儲存從當前流中讀取的資料。</param>
/// <param name="count">從當前流中讀取的最大位元組數。</param>
/// <param name="cancellationToken">取消令牌。</param>
/// <returns>
/// 讀入緩衝區的位元組總數。如果許多位元組當前不可用，則該值可以小於請求的位元組數；如果已到達流的結尾，則該值可以小於零（0）。
/// </returns>
/// <exception cref="T:System.ArgumentException">偏移量和計數之和大於緩衝區長度。</exception>
/// <exception cref="T:System.ObjectDisposedException">方法在流關閉後被呼叫。</exception>
/// <exception cref="T:System.NotSupportedException">基礎流不支援讀取。 </exception>
/// <exception cref="T:System.ArgumentNullException">緩衝區為null。</exception>
/// <exception cref="T:System.IO.IOException">發生I/O錯誤。</exception>
/// <exception cref="T:System.ArgumentOutOfRangeException">偏移量或讀取的最大位元組數為負。</exception>
public override async Task<int> ReadAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken)
{
return await ReadAsync(buffer.AsMemory(offset, count), cancellationToken);
}
/// <summary>
/// 從當前流中讀取位元組序列，並將流中的位置前進讀取的位元組數。
/// </summary>
/// <param name="buffer">記憶體緩衝區。當此方法返回時，緩衝區包含讀取的資料。</param>
/// <param name="cancellationToken">取消令牌。</param>
/// <returns>
/// 讀入緩衝區的位元組總數。如果許多位元組當前不可用，則該值可以小於請求的位元組數；如果已到達流的結尾，則該值可以小於零（0）。
/// </returns>
/// <exception cref="T:System.ArgumentException">偏移量和計數之和大於緩衝區長度。</exception>
/// <exception cref="T:System.ObjectDisposedException">方法在流關閉後被呼叫。</exception>
/// <exception cref="T:System.NotSupportedException">基礎流不支援讀取。 </exception>
/// <exception cref="T:System.ArgumentNullException">緩衝區為null。</exception>
/// <exception cref="T:System.IO.IOException">發生I/O錯誤。</exception>
/// <exception cref="T:System.ArgumentOutOfRangeException">偏移量或讀取的最大位元組數為負。</exception>
public override async ValueTask<int> ReadAsync(Memory<byte> buffer, CancellationToken cancellationToken = default)
{
await ThrottleAsync(buffer.Length, cancellationToken);
return await _baseStream.ReadAsync(buffer, cancellationToken);
}
/// <summary>
/// 設定當前流中的位置。
/// </summary>
/// <param name="offset">相對於參考點的位元組偏移量。</param>
/// <param name="origin">型別為<see cref="T:System.IO.SeekOrigin"/>的值，指示用於獲取新位置的參考點。</param>
/// <returns>
/// 當前流中的新位置。
/// </returns>
/// <exception cref="T:System.IO.IOException">發生I/O錯誤。</exception>
/// <exception cref="T:System.NotSupportedException">基礎流不支援定位，例如流是從管道或控制檯輸出構造的。</exception>
/// <exception cref="T:System.ObjectDisposedException">方法在流關閉後被呼叫。</exception>
public override long Seek(long offset, SeekOrigin origin)
{
return _baseStream.Seek(offset, origin);
}
/// <summary>
/// 設定當前流的長度。
/// </summary>
/// <param name="value">當前流的所需長度（位元組）。</param>
/// <exception cref="T:System.NotSupportedException">基礎流不支援寫入和定位，例如流是從管道或控制檯輸出構造的。</exception>
/// <exception cref="T:System.IO.IOException">發生I/O錯誤。</exception>
/// <exception cref="T:System.ObjectDisposedException">方法在流關閉後被呼叫。</exception>
public override void SetLength(long value)
{
_baseStream.SetLength(value);
}
/// <summary>
/// 將位元組序列寫入當前流，並按寫入的位元組數前進此流中的當前位置。
/// </summary>
/// <param name="buffer">位元組陣列。此方法將要寫入當前流的位元組從緩衝區複製到當前流。</param>
/// <param name="offset">緩衝區中從零開始向當前流複製位元組的位元組偏移量。</param>
/// <param name="count">要寫入當前流的位元組數。</param>
/// <exception cref="T:System.IO.IOException">發生I/O錯誤。</exception>
/// <exception cref="T:System.NotSupportedException">基礎流不支援寫入。</exception>
/// <exception cref="T:System.ObjectDisposedException">方法在流關閉後被呼叫。</exception>
/// <exception cref="T:System.ArgumentNullException">緩衝區為null。</exception>
/// <exception cref="T:System.ArgumentException">偏移量和寫入位元組數之和大於緩衝區長度。</exception>
/// <exception cref="T:System.ArgumentOutOfRangeException">偏移量或寫入位元組數為負。</exception>
public override void Write(byte[] buffer, int offset, int count)
{
Throttle(count);
_baseStream.Write(buffer, offset, count);
}
/// <summary>
/// 將位元組序列寫入當前流，並按寫入的位元組數前進此流中的當前位置。
/// </summary>
/// <param name="buffer">位元組陣列。此方法將要寫入當前流的位元組從緩衝區複製到當前流。</param>
/// <param name="offset">緩衝區中從零開始向當前流複製位元組的位元組偏移量。</param>
/// <param name="count">要寫入當前流的位元組數。</param>
/// <param name="cancellationToken">取消令牌。</param>
/// <exception cref="T:System.IO.IOException">發生I/O錯誤。</exception>
/// <exception cref="T:System.NotSupportedException">基礎流不支援寫入。</exception>
/// <exception cref="T:System.ObjectDisposedException">方法在流關閉後被呼叫。</exception>
/// <exception cref="T:System.ArgumentNullException">緩衝區為null。</exception>
/// <exception cref="T:System.ArgumentException">偏移量和寫入位元組數之和大於緩衝區長度。</exception>
/// <exception cref="T:System.ArgumentOutOfRangeException">偏移量或寫入位元組數為負。</exception>
public override async Task WriteAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken)
{
await WriteAsync(buffer.AsMemory(offset, count), cancellationToken);
}
/// <summary>
/// 將記憶體緩衝區寫入當前流，並按寫入的位元組數前進此流中的當前位置。
/// </summary>
/// <param name="buffer">記憶體緩衝區。此方法將要寫入當前流的位元組從緩衝區複製到當前流。</param>
/// <param name="cancellationToken">取消令牌。</param>
/// <exception cref="T:System.IO.IOException">發生I/O錯誤。</exception>
/// <exception cref="T:System.NotSupportedException">基礎流不支援寫入。</exception>
/// <exception cref="T:System.ObjectDisposedException">方法在流關閉後被呼叫。</exception>
/// <exception cref="T:System.ArgumentNullException">緩衝區為null。</exception>
/// <exception cref="T:System.ArgumentException">偏移量和寫入位元組數之和大於緩衝區長度。</exception>
/// <exception cref="T:System.ArgumentOutOfRangeException">偏移量或寫入位元組數為負。</exception>
public override async ValueTask WriteAsync(ReadOnlyMemory<byte> buffer, CancellationToken cancellationToken = default)
{
await ThrottleAsync(buffer.Length, cancellationToken);
await _baseStream.WriteAsync(buffer, cancellationToken);
}
/// <summary>
/// 返回一個表示當前<see cref="T:System.Object" />的<see cref="T:System.String" />。
/// </summary>
/// <returns>
/// 表示當前<see cref="T:System.Object" />的<see cref="T:System.String" />。
/// </returns>
public override string ToString()
{
return _baseStream.ToString()!;
}
#endregion
#region Protected methods
/// <summary>
/// 如果位元率大於最大位元率，嘗試限流
/// </summary>
/// <param name="bufferSizeInBytes">緩衝區大小（位元組）。</param>
protected void Throttle(int bufferSizeInBytes)
{
var toSleep = CaculateThrottlingMilliseconds(bufferSizeInBytes);
if (toSleep > 1)
{
try
{
Thread.Sleep(toSleep);
}
catch (ThreadAbortException)
{
// 忽略ThreadAbortException。
}
// 睡眠已經完成，重置限流
Reset();
}
}
/// <summary>
/// 如果位元率大於最大位元率，嘗試限流。
/// </summary>
/// <param name="bufferSizeInBytes">緩衝區大小（位元組）。</param>
/// <param name="cancellationToken">取消令牌。</param>
protected async Task ThrottleAsync(int bufferSizeInBytes, CancellationToken cancellationToken)
{
var toSleep = CaculateThrottlingMilliseconds(bufferSizeInBytes);
if (toSleep > 1)
{
try
{
await Task.Delay(toSleep, cancellationToken);
}
catch (TaskCanceledException)
{
// 忽略TaskCanceledException。
}
// 延遲已經完成，重置限流。
Reset();
}
}
/// <summary>
/// 計算在操作流之前應當延遲的時間（單位：毫秒）。
/// 更新流當前的位元率。
/// </summary>
/// <param name="bufferSizeInBytes">緩衝區大小（位元組）。</param>
/// <returns>應當延遲的時間（毫秒）。</returns>
protected int CaculateThrottlingMilliseconds(int bufferSizeInBytes)
{
int toSleep = 0;
// 確保緩衝區不為null
if (bufferSizeInBytes <= 0)
{
CurrentBitsPerSecond = 0;
}
else
{
_byteCount += bufferSizeInBytes;
long elapsedMilliseconds = CurrentMilliseconds - _start;
if (elapsedMilliseconds > 0)
{
// 計算當前瞬時位元率
var bp = _byteCount * 1000L;
var bps = bp / elapsedMilliseconds;
var avgBps = bps;
//如果bps大於最大bps，返回應當延遲的時間。
if (_maximumBytesPerSecond > 0 && bps > _maximumBytesPerSecond)
{
// 計算延遲時間
long wakeElapsed = bp / _maximumBytesPerSecond;
var result = (int)(wakeElapsed - elapsedMilliseconds);
// 計算平均位元率
var div = result / 1000.0;
avgBps = (long)(bps / (div == 0 ? 1 : div));
if (result > 1)
{
toSleep = result; ;
}
}
// 更新當前（平均）位元率
CurrentBitsPerSecond = (long)(avgBps / 8);
}
}
return toSleep;
}
/// <summary>
/// 將位元組數重置為0，並將開始時間重置為當前時間。
/// </summary>
protected void Reset()
{
long difference = CurrentMilliseconds - _start;
// 只有在已知歷史記錄可用時間超過1秒時才重置計數器。
if (difference > 1000)
{
_byteCount = 0;
_start = CurrentMilliseconds;
}
}
#endregion
}
CaculateThrottleMilliseconds 、Throttle和ThrottleAsync是這個流的核心。CaculateThrottleMilliseconds方法負責計算在寫入或讀取流之前應該延遲多久和更新流當前的傳輸速率，Throttle和ThrottleAsync方法負責同步和非同步延遲。
限流響應正文
using Microsoft.AspNetCore.Http.Features;
using Microsoft.Extensions.Options;
using System.IO.Pipelines;
using System;
namespace AccessControlElementary;
// 自定義的HTTP功能介面，提供獲取限流速率設定和當前速率的獲取能力
public interface IHttpResponseThrottlingFeature
{
public long? MaximumBytesPerSecond { get; }
public long? CurrentBitsPerSecond { get; }
}
// 限流響應正文的實現類，實現了自定義的功能介面
public class ThrottlingResponseBody : Stream, IHttpResponseBodyFeature, IHttpResponseThrottlingFeature
{
private readonly IHttpResponseBodyFeature _innerBodyFeature;
private readonly IOptionsSnapshot<ResponseThrottlingOptions> _options;
private readonly HttpContext _httpContext;
private readonly Stream _innerStream;
private ThrottlingStream? _throttlingStream;
private PipeWriter? _pipeAdapter;
private bool _throttlingChecked;
private bool _complete;
private int _throttlingRefreshCycleCount;
public ThrottlingResponseBody(IHttpResponseBodyFeature innerBodyFeature, HttpContext httpContext, IOptionsSnapshot<ResponseThrottlingOptions> options)
{
_options = options ?? throw new ArgumentNullException(nameof(options));
_httpContext = httpContext ?? throw new ArgumentNullException(nameof(httpContext));
_innerBodyFeature = innerBodyFeature ?? throw new ArgumentNullException(nameof(innerBodyFeature));
_innerStream = innerBodyFeature.Stream;
_throttlingRefreshCycleCount = 0;
}
public override bool CanRead => false;
public override bool CanSeek => false;
public override bool CanWrite => _innerStream.CanWrite;
public override long Length => _innerStream.Length;
public override long Position
{
get => throw new NotSupportedException();
set => throw new NotSupportedException();
}
public Stream Stream => this;
public PipeWriter Writer
{
get
{
if (_pipeAdapter == null)
{
_pipeAdapter = PipeWriter.Create(Stream, new StreamPipeWriterOptions(leaveOpen: true));
if (_complete)
{
_pipeAdapter.Complete();
}
}
return _pipeAdapter;
}
}
public long? MaximumBytesPerSecond => _throttlingStream?.MaximumBytesPerSecond;
public long? CurrentBitsPerSecond => _throttlingStream?.CurrentBitsPerSecond;
public override int Read(byte[] buffer, int offset, int count) => throw new NotSupportedException();
public override long Seek(long offset, SeekOrigin origin) => throw new NotSupportedException();
public override void SetLength(long value) => throw new NotSupportedException();
public override void Write(byte[] buffer, int offset, int count)
{
OnWriteAsync().ConfigureAwait(false).GetAwaiter().GetResult();
if (_throttlingStream != null)
{
_throttlingStream.Write(buffer, offset, count);
_throttlingStream.Flush();
}
else
{
_innerStream.Write(buffer, offset, count);
}
}
public override async Task WriteAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken)
{
await WriteAsync(buffer.AsMemory(offset, count), cancellationToken);
}
public override async ValueTask WriteAsync(ReadOnlyMemory<byte> buffer, CancellationToken cancellationToken = default)
{
await OnWriteAsync();
if (_throttlingStream != null)
{
await _throttlingStream.WriteAsync(buffer, cancellationToken);
await _throttlingStream.FlushAsync(cancellationToken);
}
else
{
await _innerStream.WriteAsync(buffer, cancellationToken);
}
}
public override IAsyncResult BeginWrite(byte[] buffer, int offset, int count, AsyncCallback? callback, object? state)
{
var tcs = new TaskCompletionSource(state: state, TaskCreationOptions.RunContinuationsAsynchronously);
InternalWriteAsync(buffer, offset, count, callback, tcs);
return tcs.Task;
}
private async void InternalWriteAsync(byte[] buffer, int offset, int count, AsyncCallback? callback, TaskCompletionSource tcs)
{
try
{
await WriteAsync(buffer.AsMemory(offset, count));
tcs.TrySetResult();
}
catch (Exception ex)
{
tcs.TrySetException(ex);
}
if (callback != null)
{
// Offload callbacks to avoid stack dives on sync completions.
var ignored = Task.Run(() =>
{
try
{
callback(tcs.Task);
}
catch (Exception)
{
// Suppress exceptions on background threads.
}
});
}
}
public override void EndWrite(IAsyncResult asyncResult)
{
if (asyncResult == null)
{
throw new ArgumentNullException(nameof(asyncResult));
}
var task = (Task)asyncResult;
task.GetAwaiter().GetResult();
}
public async Task CompleteAsync()
{
if (_complete)
{
return;
}
await FinishThrottlingAsync(); // Sets _complete
await _innerBodyFeature.CompleteAsync();
}
public void DisableBuffering()
{
_innerBodyFeature?.DisableBuffering();
}
public override void Flush()
{
if (!_throttlingChecked)
{
OnWriteAsync().ConfigureAwait(false).GetAwaiter().GetResult();
// Flush the original stream to send the headers. Flushing the compression stream won't
// flush the original stream if no data has been written yet.
_innerStream.Flush();
return;
}
if (_throttlingStream != null)
{
_throttlingStream.Flush();
}
else
{
_innerStream.Flush();
}
}
public override async Task FlushAsync(CancellationToken cancellationToken)
{
if (!_throttlingChecked)
{
await OnWriteAsync();
// Flush the original stream to send the headers. Flushing the compression stream won't
// flush the original stream if no data has been written yet.
await _innerStream.FlushAsync(cancellationToken);
return;
}
if (_throttlingStream != null)
{
await _throttlingStream.FlushAsync(cancellationToken);
return;
}
await _innerStream.FlushAsync(cancellationToken);
}
public async Task SendFileAsync(string path, long offset, long? count, CancellationToken cancellationToken)
{
await OnWriteAsync();
if (_throttlingStream != null)
{
await SendFileFallback.SendFileAsync(Stream, path, offset, count, cancellationToken);
return;
}
await _innerBodyFeature.SendFileAsync(path, offset, count, cancellationToken);
}
public async Task StartAsync(CancellationToken cancellationToken = default)
{
await OnWriteAsync();
await _innerBodyFeature.StartAsync(cancellationToken);
}
internal async Task FinishThrottlingAsync()
{
if (_complete)
{
return;
}
_complete = true;
if (_pipeAdapter != null)
{
await _pipeAdapter.CompleteAsync();
}
if (_throttlingStream != null)
{
await _throttlingStream.DisposeAsync();
}
}
private async Task OnWriteAsync()
{
if (!_throttlingChecked)
{
_throttlingChecked = true;
var maxValue = await _options.Value.ThrottlingProvider.Invoke(_httpContext);
_throttlingStream = new ThrottlingStream(_innerStream, maxValue < 0 ? 0 : maxValue);
}
if (_throttlingStream != null && _options?.Value?.ThrottlingRefreshCycle > 0)
{
if (_throttlingRefreshCycleCount >= _options.Value.ThrottlingRefreshCycle)
{
_throttlingRefreshCycleCount = 0;
var maxValue = await _options.Value.ThrottlingProvider.Invoke(_httpContext);
_throttlingStream.MaximumBytesPerSecond = maxValue < 0 ? 0 : maxValue;
}
else
{
_throttlingRefreshCycleCount++;
}
}
}
}
自定義的響應正文類必須實現IHttpResponseBodyFeature介面才能作為應用的底層響應流使用，設計和實現參考ASP.NET Core的ResponseCompressionBody。
響應限流中介軟體
using Microsoft.AspNetCore.Http.Features;
using Microsoft.Extensions.Options;
using Timer = System.Timers.Timer;
namespace AccessControlElementary;
public class ResponseThrottlingMiddleware
{
private readonly RequestDelegate _next;
public ResponseThrottlingMiddleware(RequestDelegate next)
{
_next = next;
}
public async Task Invoke(HttpContext context, IOptionsSnapshot<ResponseThrottlingOptions> options, ILogger<ResponseThrottlingMiddleware> logger)
{
ThrottlingResponseBody throttlingBody = null;
IHttpResponseBodyFeature originalBodyFeature = null;
var shouldThrottling = await options?.Value?.ShouldThrottling?.Invoke(context);
if (shouldThrottling == true)
{
//獲取原始輸出Body
originalBodyFeature = context.Features.Get<IHttpResponseBodyFeature>();
//初始化限流Body
throttlingBody = new ThrottlingResponseBody(originalBodyFeature, context, options);
//設定成限流Body
context.Features.Set<IHttpResponseBodyFeature>(throttlingBody);
context.Features.Set<IHttpResponseThrottlingFeature>(throttlingBody);
// 用定時器定期向外彙報資訊，這可能導致效能下降，僅用於演示目的
var timer = new Timer(1000);
timer.AutoReset = true;
long? currentBitsPerSecond = null;
var traceIdentifier = context.TraceIdentifier;
timer.Elapsed += (sender, arg) =>
{
if (throttlingBody.CurrentBitsPerSecond != currentBitsPerSecond)
{
currentBitsPerSecond = throttlingBody.CurrentBitsPerSecond;
var bps = (double)(throttlingBody.CurrentBitsPerSecond ?? 0);
var (unitBps, unit) = bps switch
{
< 1000 => (bps, "bps"),
< 1000_000 => (bps / 1000, "kbps"),
_ => (bps / 1000_000, "mbps"),
};
logger.LogDebug("請求：{RequestTraceIdentifier} 當前響應傳送速率：{CurrentBitsPerSecond} {Unit}。", traceIdentifier, unitBps, unit);
}
};
// 開始傳送響應後啟動定時器
context.Response.OnStarting(async () =>
{
logger.LogInformation("請求：{RequestTraceIdentifier} 開始傳送響應。", traceIdentifier);
timer.Start();
});
// 響應傳送完成後銷燬定時器
context.Response.OnCompleted(async () =>
{
logger.LogInformation("請求：{RequestTraceIdentifier} 響應傳送完成。", traceIdentifier);
timer.Stop();
timer?.Dispose();
});
// 請求取消後銷燬定時器
context.RequestAborted.Register(() =>
{
logger.LogInformation("請求：{RequestTraceIdentifier} 已中止。", traceIdentifier);
timer.Stop();
timer?.Dispose();
});
}
try
{
await _next(context);
if (shouldThrottling == true)
{
// 重新整理響應流，確保所有資料都傳送到網路卡
await throttlingBody.FinishThrottlingAsync();
}
}
finally
{
if (shouldThrottling == true)
{
//限流發生錯誤，恢復原始Body
context.Features.Set(originalBodyFeature);
}
}
}
}
中介軟體負責把基礎響應流替換為限流響應流，併為每個請求重新讀取選項，使每個請求都能夠獨立控制限流的速率，然後在響應傳送啟動後記錄響應的傳送速率。
響應限流選項
namespace AccessControlElementary;
public class ResponseThrottlingOptions
{
/// <summary>
/// 獲取或設定流量限制的值的重新整理週期，重新整理時會重新呼叫<see cref="ThrottlingProvider"/>設定限制值。
/// 值越大重新整理間隔越久，0或負數表示永不重新整理。
/// </summary>
public int ThrottlingRefreshCycle { get; set; }
/// <summary>
/// 獲取或設定指示是否應該啟用流量控制的委託
/// </summary>
public Func<HttpContext, Task<bool>> ShouldThrottling { get; set; }
/// <summary>
/// 獲取或設定指示流量限制大小的委託（單位：Byte/s）
/// </summary>
public Func<HttpContext, Task<int>> ThrottlingProvider { get; set; }
}
響應限流服務註冊和中介軟體配置擴充套件
namespace AccessControlElementary;
// 配置中介軟體用的輔助類和擴充套件方法
public static class ResponseThrottlingMiddlewareExtensions
{
public static IApplicationBuilder UseResponseThrottling(this IApplicationBuilder app)
{
return app.UseMiddleware<ResponseThrottlingMiddleware>();
}
}
// 註冊中介軟體需要的服務的輔助類和擴充套件方法
public static class ResponseThrottlingServicesExtensions
{
public static IServiceCollection AddResponseThrottling(this IServiceCollection services, Action<ResponseThrottlingOptions> configureOptions = null)
{
services.Configure(configureOptions);
return services;
}
}
使用節流元件
服務註冊和請求管道配置
Startup啟動配置
namespace AccessControlElementary;
public class Startup
{
public void ConfigureServices(IServiceCollection services)
{
// 註冊限流服務和選項
services.AddResponseThrottling(options =>
{
options.ThrottlingRefreshCycle = 100;
options.ShouldThrottling = static async _ => true;
options.ThrottlingProvider = static async _ => 100 * 1024; // 100KB/s
});
services.AddRazorPages();
}
public void Configure(IApplicationBuilder app)
{
// 配置響應限流中介軟體
app.UseResponseThrottling();
app.UseStaticFiles();
app.UseRouting();
app.UseAuthentication();
app.UseAuthorization();
app.UseEndpoints(endpoints =>
{
endpoints.MapRazorPages();
});
}
}
示例展示瞭如何配置和啟用響應限流。ThrottlingRefreshCycle設定為每100次響應流寫入週期重新整理一次流量限制的值，使限流值能在響應傳送中動態調整；ShouldThrottling設定為無條件啟用限流；ThrottlingProvider設定為限速100 KB/s。
請求只有在UseResponseThrottling之前配置的短路中介軟體處被處理時不會受影響，請求沒有被短路的話，只要經過限流中介軟體，基礎響應流就被替換了。如果同時使用了響應壓縮，會變成限流響應包裹壓縮響應（或者相反），壓縮響應（或者限流響應）又包裹基礎響應的巢狀結構。
結語
本書在介紹.NET 6基礎知識時會盡可能使用具有現實意義的示例避免學習和實踐脫節，本文就是其中之一，如果本文對您有價值，歡迎繼續瞭解和購買本書。《C#與.NET6 開發從入門到實踐》預售，作者親自來打廣告了！