Swashbuckle.AspNetCore中过滤器实例化性能优化实践

问题背景

在使用Swashbuckle.AspNetCore这个流行的ASP.NET Core API文档生成工具时，开发人员可能会遇到一个性能问题：当注册了IDocumentFilter和IOperationFilter等过滤器后，这些过滤器的构造函数会在首次HTTP请求时被频繁调用，导致明显的延迟和内存压力。

现象分析

通过实际测试发现，当在Startup中注册多个文档过滤器和操作过滤器时，首次请求（不限于Swagger UI请求）会触发大量过滤器实例的创建。例如，注册10个文档过滤器和10个操作过滤器，每个过滤器的构造函数耗时20ms，就会导致约400ms的延迟（20ms × 20次）。在实际项目中，如果构造函数中包含更复杂的初始化逻辑，这种延迟会更加明显。

根本原因

Swashbuckle.AspNetCore在内部处理过滤器时，默认会为每个文档版本创建新的过滤器实例。这意味着：

1. 每个注册的过滤器类型都会被多次实例化
2. 实例化次数与注册的文档版本数量成正比
3. 这种设计在过滤器有状态或包含复杂初始化逻辑时会带来性能问题

解决方案

从Swashbuckle.AspNetCore 6.6.0版本开始，提供了新的API来优化这个问题：

1. 使用实例注册替代类型注册

原先的注册方式：

services.AddSwaggerGen(c => {
    c.DocumentFilter<DocumentFilter>();
    c.OperationFilter<OperationFilter>();
});

优化后的注册方式：

var documentFilter = new DocumentFilter();
var operationFilter = new OperationFilter();

services.AddSwaggerGen(c => {
    c.AddDocumentFilterInstance(documentFilter);
    c.AddOperationFilterInstance(operationFilter);
});

2. 优势对比

• 性能提升：避免了重复实例化，减少GC压力
• 内存优化：共享单例实例，降低内存占用
• 初始化控制：可以在注册前完成复杂初始化

最佳实践建议

1. 无状态过滤器：如果过滤器是无状态的，优先使用实例注册方式
2. 有状态过滤器：需要评估是否适合共享实例，必要时仍使用类型注册
3. 复杂初始化：将耗时操作移到构造函数外部，或使用懒加载模式
4. 版本兼容：确保项目使用6.6.0或更高版本

总结

Swashbuckle.AspNetCore提供了灵活的过滤器扩展机制，但在性能敏感场景下需要注意过滤器的实例化方式。通过使用AddDocumentFilterInstance和AddOperationFilterInstance等新API，可以显著提升首次请求的响应速度，特别是在文档版本较多或过滤器初始化较重的场景下。开发人员应根据具体需求选择合适的注册方式，平衡灵活性和性能。