WebOptimizer 使用教程

1. 项目介绍

WebOptimizer 是一个用于 ASP.NET Core 的捆绑和压缩中间件。它通过设置一个静态文件的管道，使得这些文件在发送到浏览器之前可以被转换（如压缩、捆绑等）。这个管道非常灵活，可以用于组合多种不同的转换，以实现对同一文件的高效处理。WebOptimizer 确保了管道的性能和兼容性，同时允许用户进行完全的自定义和扩展。

2. 项目快速启动

安装和配置

首先，通过 NuGet 安装 LigerShark.WebOptimizer.Core 包：

dotnet add package LigerShark.WebOptimizer.Core

然后在 Startup.cs 文件中进行配置：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }

    app.UseWebOptimizer();
    app.UseStaticFiles();
    app.UseRouting();
    app.UseEndpoints(endpoints =>
    {
        endpoints.MapControllerRoute(
            name: "default",
            pattern: "{controller=Home}/{action=Index}/{id?}");
    });
}

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllersWithViews();
    services.AddWebOptimizer();
}

启用压缩

默认情况下，WebOptimizer 会自动压缩 CSS 和 JavaScript 文件。你也可以手动指定需要压缩的文件：

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllersWithViews();
    services.AddWebOptimizer(pipeline =>
    {
        pipeline.MinifyJsFiles("js/a.js", "js/b.js", "js/c.js");
        pipeline.MinifyCssFiles("css/**/*.css");
    });
}

捆绑文件

你可以将多个文件捆绑成一个文件：

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllersWithViews();
    services.AddWebOptimizer(pipeline =>
    {
        pipeline.AddCssBundle("/css/bundle.css", "css/a.css", "css/b.css");
        pipeline.AddJavaScriptBundle("/js/bundle.js", "js/plus.js", "js/minus.js");
    });
}

3. 应用案例和最佳实践

案例1：自动压缩和捆绑

在生产环境中，自动压缩和捆绑可以显著减少文件大小，提高页面加载速度。通过 WebOptimizer，你可以轻松实现这一点，而无需手动管理压缩后的文件。

案例2：缓存控制

WebOptimizer 支持缓存控制，通过设置 Cache-Control HTTP 头，可以确保浏览器缓存优化后的文件，减少重复请求。

最佳实践

• 开发环境禁用压缩：在开发环境中，建议禁用压缩功能，以便更容易调试代码。
• 使用 Tag Helpers：WebOptimizer 提供了 Tag Helpers，可以自动处理缓存破坏和 CDN 前缀，建议在项目中使用。

4. 典型生态项目

WebOptimizer.Sass

WebOptimizer.Sass 是一个扩展，允许 WebOptimizer 编译 Sass 文件为 CSS。通过安装 LigerShark.WebOptimizer.Sass 包，你可以轻松地将 Sass 文件集成到 WebOptimizer 的管道中。

WebOptimizer.TypeScript

WebOptimizer.TypeScript 允许你将 TypeScript/ES6+/JSX 文件编译为 JavaScript (ES5)。这对于使用现代 JavaScript 语法的项目非常有用。

WebOptimizer.AutoPrefixer

WebOptimizer.AutoPrefixer 是一个 CSS 自动前缀工具，可以自动为 CSS 添加浏览器前缀，确保兼容性。

通过这些生态项目，WebOptimizer 可以进一步扩展其功能，满足更多复杂的需求。