在fullstackhero/dotnet-webapi-starter-kit中使用高级过滤功能

在开发基于fullstackhero/dotnet-webapi-starter-kit的项目时，开发者经常需要对API返回的数据进行筛选和过滤。本文将详细介绍如何在该框架中正确使用过滤功能，特别是针对PaymentTypes实体的搜索过滤。

基础过滤方法的问题

初学者可能会尝试使用类似以下的简单过滤方式：

_client.SearchPaymentTypesEndpointAsync("1", new SearchPaymentTypesCommand() { IsActive=true });

然而，这种方法往往无法达到预期的过滤效果。这是因为框架设计了一套更灵活、更强大的过滤机制，而不是简单的属性匹配。

高级过滤解决方案

正确的做法是使用框架提供的AdvancedFilter功能。这个功能允许开发者构建更复杂的查询条件，支持多种比较操作符和逻辑组合。

使用AdvancedFilter的基本语法

var filter = new AdvancedFilter
{
    Keyword = "1",
    Criteria = new List<FilterCriteria>
    {
        new FilterCriteria
        {
            Field = "IsActive",
            Operator = FilterOperator.Equal,
            Value = "true"
        }
    }
};

var result = await _client.SearchPaymentTypesEndpointAsync(filter);

过滤条件的构建

AdvancedFilter提供了丰富的过滤选项：

1. 关键词搜索：通过Keyword属性进行全局搜索
2. 精确条件过滤：使用Criteria列表添加多个过滤条件
3. 排序控制：可以指定排序字段和方向
4. 分页支持：内置分页参数

支持的过滤操作符

框架提供了多种过滤操作符，满足不同场景需求：

• Equal：等于
• NotEqual：不等于
• GreaterThan：大于
• GreaterThanOrEqual：大于等于
• LessThan：小于
• LessThanOrEqual：小于等于
• Contains：包含
• StartsWith：以...开头
• EndsWith：以...结尾

实际应用示例

假设我们需要查询所有活跃的、名称包含"信用卡"的支付类型，并按名称升序排列：

var filter = new AdvancedFilter
{
    Keyword = "信用卡",
    Criteria = new List<FilterCriteria>
    {
        new FilterCriteria { Field = "IsActive", Operator = FilterOperator.Equal, Value = "true" }
    },
    OrderBy = "Name",
    OrderDirection = OrderDirection.Ascending
};

var paymentTypes = await _client.SearchPaymentTypesEndpointAsync(filter);

性能考虑

在使用过滤功能时，需要注意以下几点以保证查询性能：

1. 尽量避免在大型数据集上使用Contains操作
2. 为常用过滤字段添加数据库索引
3. 合理使用分页，避免一次性返回过多数据
4. 考虑缓存频繁使用的过滤结果

总结

fullstackhero/dotnet-webapi-starter-kit提供了强大的AdvancedFilter功能来满足各种数据过滤需求。相比简单的属性过滤，这种方式更加灵活和可扩展，能够构建复杂的查询条件。开发者应该熟悉这套过滤机制，以便在项目中高效地实现数据筛选功能。

通过掌握这些高级过滤技巧，开发者可以更精确地控制API返回的数据，提升应用程序的性能和用户体验。