前言
最近一个Asp.net core项目需要静态化页面,百度查找了一下,没有发现合适的。原因如下
- 配置麻烦。
- 类库引用了第三方类,修改起来麻烦。
- 有只支持MVC,不支持PageModel。
- 继承ActionFilterAttribute类,只重写了OnActionExecutionAsync,看似静态化了,其实运行时该查数据库还是查数据库,没有真正静态化。
- 缺少灵活性,没有在线更新静态文件方法,不能测试查看实时页面,没有进行Html压缩,没有使用gzip、br压缩文件.
于是我开始了页面静态化项目,只过几分钟就遇到了Asp.net core的一个大坑——Response.Body是一个只写Stream,无法读取返回的信息。
参考lwqlun的博客解决了,相关地址:https://www.jb51.net/article/187210.htm
代码如下:
var filePath = GetOutputFilePath(context); var response = context.HttpContext.Response; if (!response.Body.CanRead || !response.Body.CanSeek) { using (var ms = new MemoryStream()) { var old = response.Body; response.Body = ms; await base.OnResultExecutionAsync(context, next); if (response.StatusCode == 200) { await SaveHtmlResult(response.Body, filePath); } ms.Position = 0; await ms.CopyToAsync(old); response.Body = old; } } else { await base.OnResultExecutionAsync(context, next); var old = response.Body.Position; if (response.StatusCode == 200) { await SaveHtmlResult(response.Body, filePath); } response.Body.Position = old; }
解决了这个大坑后,就没遇过什么问题了。
项目地址:https://github.com/toolgood/StaticPage
快速入门
1、将HtmlStaticFileAttribute.cs放到项目下;
2、添加[HtmlStaticFile]
2.1、在控制器文件中,在类名或Action方法上添加[HtmlStaticFile]。
using Microsoft.AspNetCore.Mvc; namespace StaticPage.Mvc.Controllers { public class HomeController : Controller { [HtmlStaticFile] [HttpGet("/Count")] public IActionResult Count() { return View(); } } }
2.2或 在PageModel文件中,在类名上添加[HtmlStaticFile]。
注:PageModel文件中,在方法上添加[HtmlStaticFile]是无效的。
using Microsoft.AspNetCore.Mvc; namespace StaticPage.Pages { [HtmlStaticFile] public class CountModel : PageModel { public void OnGet() { } } }
其他配置
设置缓存文件夹
HtmlStaticFileAttribute.OutputFolder = @"D:\html";
使用压缩
HtmlStaticFileAttribute.UseBrCompress = true;
HtmlStaticFileAttribute.UseGzipCompress = true;
设置页面缓存时间
HtmlStaticFileAttribute.ExpireMinutes = 3;
使用开发模式 ,在开发模式,页面不会被缓存,便于开发调试。
HtmlStaticFileAttribute.IsDevelopmentMode = true;
支持Url参数,不推荐使用
HtmlStaticFileAttribute.UseQueryString = true;
使用Html压缩,推荐使用WebMarkupMin来压缩Html。
HtmlStaticFileAttribute.MiniFunc += (string html) => { var js = new NUglifyJsMinifier(); var css = new NUglifyCssMinifier(); XhtmlMinifier htmlMinifier = new XhtmlMinifier(null, css, js, null); var result = htmlMinifier.Minify(html); if (result.Errors.Count == 0) { return result.MinifiedContent; } return html; };
更新文件缓存
在Url地址后面添加参数“update”,访问一下就可以生成新的静态页面。
如:
https://localhost:44304/Count"external nofollow" target="_blank" href="https://github.com/toolgood/StaticPage">https://github.com/toolgood/StaticPage
总结