Asp.net使用HttpModule压缩并删除空白Html请求

当我们压缩我的Response后再传到Client端时,可以明显节省宽带. 提升Site的性能. 现在的浏览器大部分都支持Gzip,Deflate压缩。同时我们还可以删除一些空白段、空行、注释等以使得HTML文档的尺寸变得更小. 让我们先来实现压缩与删除空白类, 继承自Stream类:。

当我们压缩我的Response后再传到Client端时,可以明显节省宽带. 提升Site的性能. 现在的浏览器大部分都支持Gzip,Deflate压缩。同时我们还可以删除一些空白段、空行、注释等以使得HTML文档的尺寸变得更小. 让我们先来实现压缩与删除空白类, 继承自Stream类：

2. /// <summary> 
3. /// CompressWhitespaceFilter 
4. /// </summary> 
5. public class CompressWhitespaceFilter : Stream 
6. { 
7. private GZipStream _contentGZipStream; 
8. private DeflateStream _content_DeflateStream; 
9. private Stream _contentStream; 
10. private CompressOptions _compressOptions; 
11. /// <summary> 
12. /// Initializes a new instance of the <see cref="CompressWhitespaceFilter"/> class. 
13. /// </summary> 
14. /// <param name="contentStream">The content stream.</param> 
15. /// <param name="compressOptions">The compress options.</param> 
16. public CompressWhitespaceFilter(Stream contentStream, CompressOptions compressOptions) 
17. { 
18. if (compressOptions == CompressOptions.GZip) 
19. { 
20. this._contentGZipStream = new GZipStream(contentStream, CompressionMode.Compress); 
21. this._contentStream = this._contentGZipStream; 
22. } 
23. else if (compressOptions == CompressOptions.Deflate) 
24. { 
25. this._content_DeflateStream = new DeflateStream(contentStream,CompressionMode.Compress); 
26. this._contentStream = this._content_DeflateStream; 
27. } 
28. else 
29. { 
30. this._contentStream = contentStream; 
31. } 
32. this._compressOptions = compressOptions; 
33. } 
34. public override bool CanRead 
35. { 
36. get { return this._contentStream.CanRead; } 
37. } 
38. public override bool CanSeek 
39. { 
40. get { return this._contentStream.CanSeek; } 
41. } 
42. public override bool CanWrite 
43. { 
44. get { return this._contentStream.CanWrite; } 
45. } 
46. public override void Flush() 
47. { 
48. this._contentStream.Flush(); 
49. } 
50. public override long Length 
51. { 
52. get { return this._contentStream.Length; } 
53. } 
54. public override long Position 
55. { 
56. get 
57. { 
58. return this._contentStream.Position; 
59. } 
60. set 
61. { 
62. this._contentStream.Position = value; 
63. } 
64. } 
65. public override int Read(byte[] buffer, int offset, int count) 
66. { 
67. return this._contentStream.Read(buffer, offset, count); 
68. } 
69. public override long Seek(long offset, SeekOrigin origin) 
70. { 
71. return this._contentStream.Seek(offset, origin); 
72. } 
73. public override void SetLength(long value) 
74. { 
75. this._contentStream.SetLength(value); 
76. } 
77. public override void Write(byte[] buffer, int offset, int count) 
78. { 
79. byte[] data = new byte[count + 1]; 
80. Buffer.BlockCopy(buffer, offset, data, 0, count); 
81. string strtext = System.Text.Encoding.UTF8.GetString(data); 
82. strtext = Regex.Replace(strtext, "^\\s*", string.Empty, RegexOptions.Compiled | RegexOptions.Multiline); 
83. strtext = Regex.Replace(strtext, "\\r\\n", string.Empty, RegexOptions.Compiled | RegexOptions.Multiline); 
84. strtext = Regex.Replace(strtext, "<!--*.*?-->", string.Empty, RegexOptions.Compiled | RegexOptions.Multiline); 
85. byte[] outdata = System.Text.Encoding.UTF8.GetBytes(strtext); 
86. this._contentStream.Write(outdata, 0, outdata.GetLength(0)); 
87. } 
88. } 
89. /// <summary> 
90. /// CompressOptions 
91. /// </summary> 
92. /// <seealso cref="http://en.wikipedia.org/wiki/Zcat#gunzip_and_zcat"/> 
93. /// <seealso cref="http://en.wikipedia.org/wiki/DEFLATE"/> 
94. public enum CompressOptions 
95. { 
96. GZip, 
97. Deflate, 
98. None 
99. }

/// <summary> 
/// CompressWhitespaceFilter 
/// </summary> 
public class CompressWhitespaceFilter : Stream 
{ 
private GZipStream _contentGZipStream; 
private DeflateStream _content_DeflateStream; 
private Stream _contentStream; 
private CompressOptions _compressOptions; 
/// <summary> 
/// Initializes a new instance of the <see cref="CompressWhitespaceFilter"/> class. 
/// </summary> 
/// <param name="contentStream">The content stream.</param> 
/// <param name="compressOptions">The compress options.</param> 
public CompressWhitespaceFilter(Stream contentStream, CompressOptions compressOptions) 
{ 
if (compressOptions == CompressOptions.GZip) 
{ 
this._contentGZipStream = new GZipStream(contentStream, CompressionMode.Compress); 
this._contentStream = this._contentGZipStream; 
} 
else if (compressOptions == CompressOptions.Deflate) 
{ 
this._content_DeflateStream = new DeflateStream(contentStream,CompressionMode.Compress); 
this._contentStream = this._content_DeflateStream; 
} 
else 
{ 
this._contentStream = contentStream; 
} 
this._compressOptions = compressOptions; 
} 
public override bool CanRead 
{ 
get { return this._contentStream.CanRead; } 
} 
public override bool CanSeek 
{ 
get { return this._contentStream.CanSeek; } 
} 
public override bool CanWrite 
{ 
get { return this._contentStream.CanWrite; } 
} 
public override void Flush() 
{ 
this._contentStream.Flush(); 
} 
public override long Length 
{ 
get { return this._contentStream.Length; } 
} 
public override long Position 
{ 
get 
{ 
return this._contentStream.Position; 
} 
set 
{ 
this._contentStream.Position = value; 
} 
} 
public override int Read(byte[] buffer, int offset, int count) 
{ 
return this._contentStream.Read(buffer, offset, count); 
} 
public override long Seek(long offset, SeekOrigin origin) 
{ 
return this._contentStream.Seek(offset, origin); 
} 
public override void SetLength(long value) 
{ 
this._contentStream.SetLength(value); 
} 
public override void Write(byte[] buffer, int offset, int count) 
{ 
byte[] data = new byte[count + 1]; 
Buffer.BlockCopy(buffer, offset, data, 0, count); 
string strtext = System.Text.Encoding.UTF8.GetString(data); 
strtext = Regex.Replace(strtext, "^\\s*", string.Empty, RegexOptions.Compiled | RegexOptions.Multiline); 
strtext = Regex.Replace(strtext, "\\r\\n", string.Empty, RegexOptions.Compiled | RegexOptions.Multiline); 
strtext = Regex.Replace(strtext, "<!--*.*?-->", string.Empty, RegexOptions.Compiled | RegexOptions.Multiline); 
byte[] outdata = System.Text.Encoding.UTF8.GetBytes(strtext); 
this._contentStream.Write(outdata, 0, outdata.GetLength(0)); 
} 
} 
/// <summary> 
/// CompressOptions 
/// </summary> 
/// <seealso cref="http://en.wikipedia.org/wiki/Zcat#gunzip_and_zcat"/> 
/// <seealso cref="http://en.wikipedia.org/wiki/DEFLATE"/> 
public enum CompressOptions 
{ 
GZip, 
Deflate, 
None 
} 

上面的代码使用正则表达式替换字符串,你可以修改那些正则表达式来满足你的需求. 我们同时使用了GZipStream与DeflateStream实现了压缩. 好的,接下来与HttpModule结合：

2. /// <summary> 
3. /// CompressWhitespaceModule 
4. /// </summary> 
5. public class CompressWhitespaceModule : IHttpModule 
6. { 
7. #region IHttpModule Members 
8. /// <summary> 
9. /// Disposes of the resources (other than memory) used by the module that implements <see cref="T:System.Web.IHttpModule"/>. 
10. /// </summary> 
11. public void Dispose() 
12. { 
13. // Nothing to dispose; 
14. } 
15. /// <summary> 
16. /// Initializes a module and prepares it to handle requests. 
17. /// </summary> 
18. /// <param name="context">An <see cref="T:System.Web.HttpApplication"/> that provides access to the methods, properties, and events common to all application objects within an ASP.NET application</param> 
19. public void Init(HttpApplication context) 
20. { 
21. context.BeginRequest += new EventHandler(context_BeginRequest); 
22. } 
23. /// <summary> 
24. /// Handles the BeginRequest event of the context control. 
25. /// </summary> 
26. /// <param name="sender">The source of the event.</param> 
27. /// <param name="e">The <see cref="System.EventArgs"/> instance containing the event data.</param> 
28. void context_BeginRequest(object sender, EventArgs e) 
29. { 
30. HttpApplication app = sender as HttpApplication; 
31. if (app.Request.RawUrl.Contains(".aspx")) 
32. { 
33. HttpContext context = app.Context; 
34. HttpRequest request = context.Request; 
35. string acceptEncoding = request.Headers["Accept-Encoding"]; 
36. HttpResponse response = context.Response; 
37. if (!string.IsNullOrEmpty(acceptEncoding)) 
38. { 
39. acceptEncoding = acceptEncoding.ToUpperInvariant(); 
40. if (acceptEncoding.Contains("GZIP")) 
41. { 
42. response.Filter = new CompressWhitespaceFilter(context.Response.Filter, CompressOptions.GZip); 
43. response.AppendHeader("Content-encoding", "gzip"); 
44. } 
45. else if (acceptEncoding.Contains("DEFLATE")) 
46. { 
47. response.Filter = new CompressWhitespaceFilter(context.Response.Filter, CompressOptions.Deflate); 
48. response.AppendHeader("Content-encoding", "deflate"); 
49. } 
50. } 
51. response.Cache.VaryByHeaders["Accept-Encoding"] = true; 
52. } 
53. } 
54. #endregion 
55. }

/// <summary> 
/// CompressWhitespaceModule 
/// </summary> 
public class CompressWhitespaceModule : IHttpModule 
{ 
#region IHttpModule Members 
/// <summary> 
/// Disposes of the resources (other than memory) used by the module that implements <see cref="T:System.Web.IHttpModule"/>. 
/// </summary> 
public void Dispose() 
{ 
// Nothing to dispose; 
} 
/// <summary> 
/// Initializes a module and prepares it to handle requests. 
/// </summary> 
/// <param name="context">An <see cref="T:System.Web.HttpApplication"/> that provides access to the methods, properties, and events common to all application objects within an ASP.NET application</param> 
public void Init(HttpApplication context) 
{ 
context.BeginRequest += new EventHandler(context_BeginRequest); 
} 
/// <summary> 
/// Handles the BeginRequest event of the context control. 
/// </summary> 
/// <param name="sender">The source of the event.</param> 
/// <param name="e">The <see cref="System.EventArgs"/> instance containing the event data.</param> 
void context_BeginRequest(object sender, EventArgs e) 
{ 
HttpApplication app = sender as HttpApplication; 
if (app.Request.RawUrl.Contains(".aspx")) 
{ 
HttpContext context = app.Context; 
HttpRequest request = context.Request; 
string acceptEncoding = request.Headers["Accept-Encoding"]; 
HttpResponse response = context.Response; 
if (!string.IsNullOrEmpty(acceptEncoding)) 
{ 
acceptEncoding = acceptEncoding.ToUpperInvariant(); 
if (acceptEncoding.Contains("GZIP")) 
{ 
response.Filter = new CompressWhitespaceFilter(context.Response.Filter, CompressOptions.GZip); 
response.AppendHeader("Content-encoding", "gzip"); 
} 
else if (acceptEncoding.Contains("DEFLATE")) 
{ 
response.Filter = new CompressWhitespaceFilter(context.Response.Filter, CompressOptions.Deflate); 
response.AppendHeader("Content-encoding", "deflate"); 
} 
} 
response.Cache.VaryByHeaders["Accept-Encoding"] = true; 
} 
} 
#endregion 
} 

HttpApplication.BeginRequest 事件是 在 ASP.NET 响应请求时作为 HTTP 执行管线链中的第一个事件发生。 在WEB.CONFIG中你还需要配置：

2. <httpModules> 
3. <add name="CompressWhitespaceModule" type="MyWeb.CompressWhitespaceModule" /> 
4. </httpModules>

<httpModules> 
<add name="CompressWhitespaceModule" type="MyWeb.CompressWhitespaceModule" /> 
</httpModules> 

我们来看一下效果。 没有使用压缩时为4.8K

使用压缩后，为1.6K

很简单,你可以按需求来增加更多的功能. 希望对您开发有帮助。